Table of Contents
AppIntegrationsService.Client¶A low-level client representing Amazon AppIntegrations Service
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 and Deliver information to agents using Amazon Connect Wisdom in the Amazon Connect Administrator Guide .
import boto3
client = boto3.client('appintegrations')
These are the available methods:
can_paginate()close()create_data_integration()create_event_integration()delete_data_integration()delete_event_integration()get_data_integration()get_event_integration()get_paginator()get_waiter()list_data_integration_associations()list_data_integrations()list_event_integration_associations()list_event_integrations()list_tags_for_resource()tag_resource()untag_resource()update_data_integration()update_event_integration()can_paginate(operation_name)¶Check if an operation can be paginated.
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.close()¶Closes underlying endpoint connections.
create_data_integration(**kwargs)¶Creates and persists a DataIntegration resource.
Note
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
See also: AWS API Documentation
Request Syntax
response = client.create_data_integration(
Name='string',
Description='string',
KmsKey='string',
SourceURI='string',
ScheduleConfig={
'FirstExecutionFrom': 'string',
'Object': 'string',
'ScheduleExpression': 'string'
},
Tags={
'string': 'string'
},
ClientToken='string'
)
[REQUIRED]
The name of the DataIntegration.
The name of the data and how often it should be pulled from the source.
The start date for objects to import in the first flow run.
The name of the object to pull from the data source.
How often the data should be pulled from data source.
One or more tags.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'KmsKey': 'string',
'SourceURI': 'string',
'ScheduleConfiguration': {
'FirstExecutionFrom': 'string',
'Object': 'string',
'ScheduleExpression': 'string'
},
'Tags': {
'string': 'string'
},
'ClientToken': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN)
Id (string) --
A unique identifier.
Name (string) --
The name of the DataIntegration.
Description (string) --
A description of the DataIntegration.
KmsKey (string) --
The KMS key for the DataIntegration.
SourceURI (string) --
The URI of the data source.
ScheduleConfiguration (dict) --
The name of the data and how often it should be pulled from the source.
FirstExecutionFrom (string) --
The start date for objects to import in the first flow run.
Object (string) --
The name of the object to pull from the data source.
ScheduleExpression (string) --
How often the data should be pulled from data source.
Tags (dict) --
One or more tags.
ClientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ResourceQuotaExceededExceptionAppIntegrationsService.Client.exceptions.DuplicateResourceExceptionAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptioncreate_event_integration(**kwargs)¶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 pushes 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'
}
)
[REQUIRED]
The name of the event integration.
[REQUIRED]
The event filter.
The source of the events.
[REQUIRED]
The EventBridge bus.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
One or more tags.
dict
Response Syntax
{
'EventIntegrationArn': 'string'
}
Response Structure
(dict) --
EventIntegrationArn (string) --
The Amazon Resource Name (ARN) of the event integration.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ResourceQuotaExceededExceptionAppIntegrationsService.Client.exceptions.DuplicateResourceExceptionAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptiondelete_data_integration(**kwargs)¶Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role.
Note
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
See also: AWS API Documentation
Request Syntax
response = client.delete_data_integration(
DataIntegrationIdentifier='string'
)
[REQUIRED]
A unique identifier for the DataIntegration.
{}
Response Structure
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptiondelete_event_integration(**kwargs)¶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'
)
[REQUIRED]
The name of the event integration.
{}
Response Structure
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionget_data_integration(**kwargs)¶Returns information about the DataIntegration.
Note
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
See also: AWS API Documentation
Request Syntax
response = client.get_data_integration(
Identifier='string'
)
[REQUIRED]
A unique identifier.
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'KmsKey': 'string',
'SourceURI': 'string',
'ScheduleConfiguration': {
'FirstExecutionFrom': 'string',
'Object': 'string',
'ScheduleExpression': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
The Amazon Resource Name (ARN) for the DataIntegration.
A unique identifier.
The name of the DataIntegration.
The KMS key for the DataIntegration.
The KMS key for the DataIntegration.
The URI of the data source.
The name of the data and how often it should be pulled from the source.
The start date for objects to import in the first flow run.
The name of the object to pull from the data source.
How often the data should be pulled from data source.
One or more tags.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionget_event_integration(**kwargs)¶Returns information about the event integration.
See also: AWS API Documentation
Request Syntax
response = client.get_event_integration(
Name='string'
)
[REQUIRED]
The name of the event integration.
{
'Name': 'string',
'Description': 'string',
'EventIntegrationArn': 'string',
'EventBridgeBus': 'string',
'EventFilter': {
'Source': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
The name of the event integration.
The description of the event integration.
The Amazon Resource Name (ARN) for the event integration.
The EventBridge bus.
The event filter.
The source of the events.
One or more tags.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_data_integration_associations(**kwargs)¶Returns a paginated list of DataIntegration associations in the account.
Note
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
See also: AWS API Documentation
Request Syntax
response = client.list_data_integration_associations(
DataIntegrationIdentifier='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
A unique identifier for the DataIntegration.
dict
Response Syntax
{
'DataIntegrationAssociations': [
{
'DataIntegrationAssociationArn': 'string',
'DataIntegrationArn': 'string',
'ClientId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DataIntegrationAssociations (list) --
The Amazon Resource Name (ARN) and unique ID of the DataIntegration association.
(dict) --
Summary information about the DataIntegration association.
DataIntegrationAssociationArn (string) --
The Amazon Resource Name (ARN) of the DataIntegration association.
DataIntegrationArn (string) --
The Amazon Resource Name (ARN)of the DataIntegration.
ClientId (string) --
The identifier for teh client that is associated with the DataIntegration association.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionlist_data_integrations(**kwargs)¶Returns a paginated list of DataIntegrations in the account.
Note
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
See also: AWS API Documentation
Request Syntax
response = client.list_data_integrations(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'DataIntegrations': [
{
'Arn': 'string',
'Name': 'string',
'SourceURI': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DataIntegrations (list) --
The DataIntegrations associated with this account.
(dict) --
Summary information about the DataIntegration.
Arn (string) --
The Amazon Resource Name (ARN) of the DataIntegration.
Name (string) --
The name of the DataIntegration.
SourceURI (string) --
The URI of the data source.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionlist_event_integration_associations(**kwargs)¶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
)
[REQUIRED]
The name of the event integration.
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 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.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionlist_event_integrations(**kwargs)¶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
)
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 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.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionLists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
Information about the tags.
Exceptions
AppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.ThrottlingExceptiontag_resource(**kwargs)¶Adds the specified tags to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
One or more tags.
dict
Response Syntax
{}
Response Structure
Exceptions
AppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.ThrottlingExceptionuntag_resource(**kwargs)¶Removes the specified tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys.
dict
Response Syntax
{}
Response Structure
Exceptions
AppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.ThrottlingExceptionupdate_data_integration(**kwargs)¶Updates the description of a DataIntegration.
Note
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
See also: AWS API Documentation
Request Syntax
response = client.update_data_integration(
Identifier='string',
Name='string',
Description='string'
)
[REQUIRED]
A unique identifier for the DataIntegration.
dict
Response Syntax
{}
Response Structure
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionupdate_event_integration(**kwargs)¶Updates the description of an event integration.
See also: AWS API Documentation
Request Syntax
response = client.update_event_integration(
Name='string',
Description='string'
)
[REQUIRED]
The name of the event integration.
dict
Response Syntax
{}
Response Structure
Exceptions
AppIntegrationsService.Client.exceptions.InternalServiceErrorAppIntegrationsService.Client.exceptions.ThrottlingExceptionAppIntegrationsService.Client.exceptions.ResourceNotFoundExceptionAppIntegrationsService.Client.exceptions.InvalidRequestExceptionAppIntegrationsService.Client.exceptions.AccessDeniedExceptionThe available paginators are: