AppIntegrationsService ¶

Table of Contents

AppIntegrationsService
- Client
- Paginators

Client ¶

class 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.

Parameters: 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").
Returns: 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'
)

Parameters

Name (string) --
[REQUIRED]

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.
ScheduleConfig (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.
- (string) --
  - (string) --
ClientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

Return type

dict

Returns

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.
  - (string) --
    - (string) --
- ClientToken (string) --
  
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

create_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'
    }
)

Parameters

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) --

Return type

dict

Returns

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_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'
)

Parameters

DataIntegrationIdentifier (string) --

[REQUIRED]

A unique identifier for the DataIntegration.

Return type

dict

Returns

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

delete_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'
)

Parameters

Name (string) --

[REQUIRED]

The name of the event integration.

Return type

dict

Returns

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

get_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'
)

Parameters

Identifier (string) --

[REQUIRED]

A unique identifier.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'KmsKey': 'string',
    'SourceURI': 'string',
    'ScheduleConfiguration': {
        'FirstExecutionFrom': 'string',
        'Object': 'string',
        'ScheduleExpression': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Arn (string) --
  The Amazon Resource Name (ARN) for the DataIntegration.
- Id (string) --
  A unique identifier.
- Name (string) --
  The name of the DataIntegration.
- Description (string) --
  The KMS key for 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.
  - (string) --
    - (string) --

Exceptions

AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException

get_event_integration(**kwargs)¶

Returns information about the event integration.

See also: AWS API Documentation

Request Syntax

response = client.get_event_integration(
    Name='string'
)

Parameters

Name (string) --

[REQUIRED]

The name of the event integration.

Return type

dict

Returns

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.

Parameters: 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").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

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
)

Parameters

DataIntegrationIdentifier (string) --
[REQUIRED]

A unique identifier for the DataIntegration.
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.

Return type

dict

Returns

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.InternalServiceError
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException

list_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
)

Parameters

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.

Return type

dict

Returns

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.InternalServiceError
AppIntegrationsService.Client.exceptions.ThrottlingException
AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException

list_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
)

Parameters

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.

Return type

dict

Returns

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.
      - (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)¶

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
)

Parameters

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.

Return type

dict

Returns

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.
      - (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.InvalidRequestException
AppIntegrationsService.Client.exceptions.AccessDeniedException

list_tags_for_resource(**kwargs)¶

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)

Parameters

resourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type

dict

Returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  Information about the tags.
  - (string) --
    - (string) --

Exceptions

AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.ThrottlingException

tag_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'
    }
)

Parameters

resourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
tags (dict) --
[REQUIRED]

One or more tags.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.ThrottlingException

untag_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',
    ]
)

Parameters

resourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
tagKeys (list) --
[REQUIRED]

The tag keys.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

AppIntegrationsService.Client.exceptions.InvalidRequestException
AppIntegrationsService.Client.exceptions.InternalServiceError
AppIntegrationsService.Client.exceptions.ResourceNotFoundException
AppIntegrationsService.Client.exceptions.ThrottlingException

update_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'
)

Parameters

Identifier (string) --
[REQUIRED]

A unique identifier for the DataIntegration.
Name (string) -- The name of the DataIntegration.
Description (string) -- A description of the DataIntegration.

Return type

dict

Returns

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

update_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'
)

Parameters

Name (string) --
[REQUIRED]

The name of the event integration.
Description (string) -- The description of the event inegration.

Return type

dict

Returns

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

Paginators ¶

The available paginators are:

Table Of Contents

AppIntegrationsService¶

Client¶

Paginators¶

AppIntegrationsService ¶

Client ¶

Paginators ¶