Table of Contents
AppIntegrationsService.
Client
¶A low-level client representing Amazon AppIntegrations Service
The Amazon AppIntegrations APIs are in preview release and are subject to change.
The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.
For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations in the Amazon Connect Administrator Guide .
client = session.create_client('appintegrations')
These are the available methods:
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
create_event_integration
(**kwargs)¶The Amazon AppIntegrations APIs are in preview release and are subject to change.
Creates an EventIntegration, given a specified name, description, and a reference to an Amazon Eventbridge bus in your account and a partner event source that will push events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.
See also: AWS API Documentation
Request Syntax
response = client.create_event_integration(
Name='string',
Description='string',
EventFilter={
'Source': 'string'
},
EventBridgeBus='string',
ClientToken='string',
Tags={
'string': 'string'
}
)
Name (string) –
[REQUIRED]
The name of the event integration.
Description (string) – The description of the event integration.
EventFilter (dict) –
[REQUIRED]
The event filter.
Source (string) – [REQUIRED]
The source of the events.
EventBridgeBus (string) –
[REQUIRED]
The Eventbridge bus.
ClientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
Tags (dict) –
One or more tags.
(string) –
(string) –
dict
Response Syntax
{
'EventIntegrationArn': 'string'
}
Response Structure
(dict) –
EventIntegrationArn (string) –
The Amazon Resource Name (ARN) of the event integration.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ResourceQuotaExceededException
AppIntegrationsService.Client.exceptions.DuplicateResourceException
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException
delete_event_integration
(**kwargs)¶The Amazon AppIntegrations APIs are in preview release and are subject to change.
Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_integration(
Name='string'
)
Name (string) –
[REQUIRED]
The name of the event integration.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod
.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
get_event_integration
(**kwargs)¶The Amazon AppIntegrations APIs are in preview release and are subject to change.
Return information about the event integration.
See also: AWS API Documentation
Request Syntax
response = client.get_event_integration(
Name='string'
)
Name (string) –
[REQUIRED]
The name of the event integration.
dict
Response Syntax
{
'Name': 'string',
'Description': 'string',
'EventIntegrationArn': 'string',
'EventBridgeBus': 'string',
'EventFilter': {
'Source': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
Name (string) –
The name of the event integration.
Description (string) –
The description of the event integration.
EventIntegrationArn (string) –
The Amazon Resource Name (ARN) for the event integration.
EventBridgeBus (string) –
The Eventbridge bus.
EventFilter (dict) –
The event filter.
Source (string) –
The source of the events.
Tags (dict) –
One or more tags.
(string) –
(string) –
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
list_event_integration_associations
(**kwargs)¶The Amazon AppIntegrations APIs are in preview release and are subject to change.
Returns a paginated list of event integration associations in the account.
See also: AWS API Documentation
Request Syntax
response = client.list_event_integration_associations(
EventIntegrationName='string',
NextToken='string',
MaxResults=123
)
EventIntegrationName (string) –
[REQUIRED]
The name of the event integration.
NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return per page.
dict
Response Syntax
{
'EventIntegrationAssociations': [
{
'EventIntegrationAssociationArn': 'string',
'EventIntegrationAssociationId': 'string',
'EventIntegrationName': 'string',
'ClientId': 'string',
'EventBridgeRuleName': 'string',
'ClientAssociationMetadata': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
EventIntegrationAssociations (list) –
The event integration associations.
(dict) –
The Amazon AppIntegrations APIs are in preview release and are subject to change.
The event integration association.
EventIntegrationAssociationArn (string) –
The Amazon Resource Name (ARN) for the event integration association.
EventIntegrationAssociationId (string) –
The identifier for the event integration association.
EventIntegrationName (string) –
The name of the event integration.
ClientId (string) –
The identifier for the client that is associated with the event integration.
EventBridgeRuleName (string) –
The name of the Eventbridge rule.
ClientAssociationMetadata (dict) –
The metadata associated with the client.
(string) –
(string) –
NextToken (string) –
If there are additional results, this is the token for the next set of results.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException
list_event_integrations
(**kwargs)¶The Amazon AppIntegrations APIs are in preview release and are subject to change.
Returns a paginated list of event integrations in the account.
See also: AWS API Documentation
Request Syntax
response = client.list_event_integrations(
NextToken='string',
MaxResults=123
)
NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return per page.
dict
Response Syntax
{
'EventIntegrations': [
{
'EventIntegrationArn': 'string',
'Name': 'string',
'Description': 'string',
'EventFilter': {
'Source': 'string'
},
'EventBridgeBus': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
EventIntegrations (list) –
The event integrations.
(dict) –
The Amazon AppIntegrations APIs are in preview release and are subject to change.
The event integration.
EventIntegrationArn (string) –
The Amazon Resource Name (ARN) of the event integration.
Name (string) –
The name of the event integration.
Description (string) –
The event integration description.
EventFilter (dict) –
The event integration filter.
Source (string) –
The source of the events.
EventBridgeBus (string) –
The Amazon Eventbridge bus for the event integration.
Tags (dict) –
The tags.
(string) –
(string) –
NextToken (string) –
If there are additional results, this is the token for the next set of results.
Exceptions
The Amazon AppIntegrations APIs are in preview release and are subject to change.
Lists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
resourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) –
tags (dict) –
Information about the tags.
(string) –
(string) –
Exceptions
tag_resource
(**kwargs)¶The Amazon AppIntegrations APIs are in preview release and are subject to change.
Adds the specified tags to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
resourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
tags (dict) –
[REQUIRED]
One or more tags.
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶The Amazon AppIntegrations APIs are in preview release and are subject to change.
Removes the specified tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
resourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
tagKeys (list) –
[REQUIRED]
The tag keys.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_event_integration
(**kwargs)¶The Amazon AppIntegrations APIs are in preview release and are subject to change.
Updates the description of an event integration.
See also: AWS API Documentation
Request Syntax
response = client.update_event_integration(
Name='string',
Description='string'
)
Name (string) –
[REQUIRED]
The name of the event integration.
Description (string) – The description of the event inegration.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
AppIntegrationsService.Client.exceptions.AccessDeniedException
AppIntegrationsService.Client.exceptions.DuplicateResourceException
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.ResourceQuotaExceededException
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.
AccessDeniedException
¶You do not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
You do not have sufficient access to perform this action.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AppIntegrationsService.Client.exceptions.
DuplicateResourceException
¶A resource with the specified name already exists.
Example
try:
...
except client.exceptions.DuplicateResourceException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
A resource with the specified name already exists.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AppIntegrationsService.Client.exceptions.
InternalServiceError
¶Request processing failed due to an error or failure with the service.
Example
try:
...
except client.exceptions.InternalServiceError as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Request processing failed due to an error or failure with the service.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AppIntegrationsService.Client.exceptions.
InvalidRequestException
¶The request is not valid.
Example
try:
...
except client.exceptions.InvalidRequestException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request is not valid.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AppIntegrationsService.Client.exceptions.
ResourceNotFoundException
¶The specified resource was not found.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified resource was not found.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AppIntegrationsService.Client.exceptions.
ResourceQuotaExceededException
¶The allowed quota for the resource has been exceeded.
Example
try:
...
except client.exceptions.ResourceQuotaExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The allowed quota for the resource has been exceeded.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
AppIntegrationsService.Client.exceptions.
ThrottlingException
¶The throttling limit has been exceeded.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The throttling limit has been exceeded.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are: