AppIntegrationsService ********************** Client ====== class AppIntegrationsService.Client A low-level client representing Amazon AppIntegrations Service * Amazon AppIntegrations actions * Amazon AppIntegrations data types 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 the following topics in the *Amazon Connect Administrator Guide*: * Third-party applications (3p apps) in the agent workspace * Use Amazon Q in Connect for generative AI–powered agent assistance in real-time import boto3 client = boto3.client('appintegrations') These are the available methods: * can_paginate * close * create_application * create_data_integration * create_data_integration_association * create_event_integration * delete_application * delete_data_integration * delete_event_integration * get_application * get_data_integration * get_event_integration * get_paginator * get_waiter * list_application_associations * list_applications * list_data_integration_associations * list_data_integrations * list_event_integration_associations * list_event_integrations * list_tags_for_resource * tag_resource * untag_resource * update_application * update_data_integration * update_data_integration_association * update_event_integration Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListApplicationAssociations * ListApplications * ListDataIntegrationAssociations * ListDataIntegrations * ListEventIntegrationAssociations * ListEventIntegrations AppIntegrationsService / Paginator / ListEventIntegrationAssociations ListEventIntegrationAssociations ******************************** class AppIntegrationsService.Paginator.ListEventIntegrationAssociations paginator = client.get_paginator('list_event_integration_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " AppIntegrationsService.Client.list_event_integration_associatio ns()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( EventIntegrationName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **EventIntegrationName** (*string*) -- **[REQUIRED]** The name of the event integration. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EventIntegrationAssociations': [ { 'EventIntegrationAssociationArn': 'string', 'EventIntegrationAssociationId': 'string', 'EventIntegrationName': 'string', 'ClientId': 'string', 'EventBridgeRuleName': 'string', 'ClientAssociationMetadata': { 'string': '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) --* AppIntegrationsService / Paginator / ListEventIntegrations ListEventIntegrations ********************* class AppIntegrationsService.Paginator.ListEventIntegrations paginator = client.get_paginator('list_event_integrations') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppIntegrationsService.Client.list_event_integrations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EventIntegrations': [ { 'EventIntegrationArn': 'string', 'Name': 'string', 'Description': 'string', 'EventFilter': { 'Source': 'string' }, 'EventBridgeBus': 'string', 'Tags': { 'string': '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 used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* AppIntegrationsService / Paginator / ListDataIntegrationAssociations ListDataIntegrationAssociations ******************************* class AppIntegrationsService.Paginator.ListDataIntegrationAssociations paginator = client.get_paginator('list_data_integration_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " AppIntegrationsService.Client.list_data_integration_association s()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DataIntegrationIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DataIntegrationIdentifier** (*string*) -- **[REQUIRED]** A unique identifier for the DataIntegration. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataIntegrationAssociations': [ { 'DataIntegrationAssociationArn': 'string', 'DataIntegrationArn': 'string', 'ClientId': 'string', 'DestinationURI': 'string', 'LastExecutionStatus': { 'ExecutionStatus': 'COMPLETED'|'IN_PROGRESS'|'FAILED', 'StatusMessage': 'string' }, 'ExecutionConfiguration': { 'ExecutionMode': 'ON_DEMAND'|'SCHEDULED', 'OnDemandConfiguration': { 'StartTime': 'string', 'EndTime': 'string' }, 'ScheduleConfiguration': { 'FirstExecutionFrom': 'string', 'Object': 'string', 'ScheduleExpression': '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 the client that is associated with the DataIntegration association. * **DestinationURI** *(string) --* The URI of the data destination. * **LastExecutionStatus** *(dict) --* The execution status of the last job. * **ExecutionStatus** *(string) --* The job status enum string. * **StatusMessage** *(string) --* The status message of a job. * **ExecutionConfiguration** *(dict) --* The configuration for how the files should be pulled from the source. * **ExecutionMode** *(string) --* The mode for data import/export execution. * **OnDemandConfiguration** *(dict) --* The start and end time for data pull from the source. * **StartTime** *(string) --* The start time for data pull from the source as an Unix/epoch string in milliseconds * **EndTime** *(string) --* The end time for data pull from the source as an Unix/epoch string in milliseconds * **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 as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. * **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. AppIntegrationsService / Paginator / ListDataIntegrations ListDataIntegrations ******************** class AppIntegrationsService.Paginator.ListDataIntegrations paginator = client.get_paginator('list_data_integrations') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppIntegrationsService.Client.list_data_integrations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataIntegrations': [ { 'Arn': 'string', 'Name': 'string', 'SourceURI': '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. AppIntegrationsService / Paginator / ListApplicationAssociations ListApplicationAssociations *************************** class AppIntegrationsService.Paginator.ListApplicationAssociations paginator = client.get_paginator('list_application_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppIntegrationsService.Client.list_application_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** A unique identifier for the Application. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ApplicationAssociations': [ { 'ApplicationAssociationArn': 'string', 'ApplicationArn': 'string', 'ClientId': 'string' }, ], } **Response Structure** * *(dict) --* * **ApplicationAssociations** *(list) --* List of Application Associations for the Application. * *(dict) --* Summary information about the Application Association. * **ApplicationAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the Application Association. * **ApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the Application. * **ClientId** *(string) --* The identifier for the client that is associated with the Application Association. AppIntegrationsService / Paginator / ListApplications ListApplications **************** class AppIntegrationsService.Paginator.ListApplications paginator = client.get_paginator('list_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "AppIntegrationsService.Client.list_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Applications': [ { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'Namespace': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'IsService': True|False }, ], } **Response Structure** * *(dict) --* * **Applications** *(list) --* The Applications associated with this account. * *(dict) --* Summary information about the Application. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Application. * **Id** *(string) --* A unique identifier for the Application. * **Name** *(string) --* The name of the application. * **Namespace** *(string) --* The namespace of the application. * **CreatedTime** *(datetime) --* The time when the application was created. * **LastModifiedTime** *(datetime) --* The time when the application was last modified. * **IsService** *(boolean) --* Indicates whether the application is a service. AppIntegrationsService / Client / create_data_integration_association create_data_integration_association *********************************** AppIntegrationsService.Client.create_data_integration_association(**kwargs) Creates and persists a DataIntegrationAssociation resource. See also: AWS API Documentation **Request Syntax** response = client.create_data_integration_association( DataIntegrationIdentifier='string', ClientId='string', ObjectConfiguration={ 'string': { 'string': [ 'string', ] } }, DestinationURI='string', ClientAssociationMetadata={ 'string': 'string' }, ClientToken='string', ExecutionConfiguration={ 'ExecutionMode': 'ON_DEMAND'|'SCHEDULED', 'OnDemandConfiguration': { 'StartTime': 'string', 'EndTime': 'string' }, 'ScheduleConfiguration': { 'FirstExecutionFrom': 'string', 'Object': 'string', 'ScheduleExpression': 'string' } } ) Parameters: * **DataIntegrationIdentifier** (*string*) -- **[REQUIRED]** A unique identifier for the DataIntegration. * **ClientId** (*string*) -- The identifier for the client that is associated with the DataIntegration association. * **ObjectConfiguration** (*dict*) -- The configuration for what data should be pulled from the source. * *(string) --* * *(dict) --* * *(string) --* * *(list) --* * *(string) --* * **DestinationURI** (*string*) -- The URI of the data destination. * **ClientAssociationMetadata** (*dict*) -- The mapping of metadata to be extracted from the data. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **ExecutionConfiguration** (*dict*) -- The configuration for how the files should be pulled from the source. * **ExecutionMode** *(string) --* **[REQUIRED]** The mode for data import/export execution. * **OnDemandConfiguration** *(dict) --* The start and end time for data pull from the source. * **StartTime** *(string) --* **[REQUIRED]** The start time for data pull from the source as an Unix/epoch string in milliseconds * **EndTime** *(string) --* The end time for data pull from the source as an Unix/epoch string in milliseconds * **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 as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. * **Object** *(string) --* The name of the object to pull from the data source. * **ScheduleExpression** *(string) --* **[REQUIRED]** How often the data should be pulled from data source. Return type: dict Returns: **Response Syntax** { 'DataIntegrationAssociationId': 'string', 'DataIntegrationArn': 'string' } **Response Structure** * *(dict) --* * **DataIntegrationAssociationId** *(string) --* A unique identifier. for the DataIntegrationAssociation. * **DataIntegrationArn** *(string) --* The Amazon Resource Name (ARN) for the DataIntegration. **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ResourceQuotaExceededE xception" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / list_applications list_applications ***************** AppIntegrationsService.Client.list_applications(**kwargs) Lists applications in the account. See also: AWS API Documentation **Request Syntax** response = client.list_applications( 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** { 'Applications': [ { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'Namespace': 'string', 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'IsService': True|False }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Applications** *(list) --* The Applications associated with this account. * *(dict) --* Summary information about the Application. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Application. * **Id** *(string) --* A unique identifier for the Application. * **Name** *(string) --* The name of the application. * **Namespace** *(string) --* The namespace of the application. * **CreatedTime** *(datetime) --* The time when the application was created. * **LastModifiedTime** *(datetime) --* The time when the application was last modified. * **IsService** *(boolean) --* Indicates whether the application is a service. * **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.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / get_paginator get_paginator ************* AppIntegrationsService.Client.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: "botocore.paginate.Paginator" Returns: A paginator object. AppIntegrationsService / Client / delete_data_integration delete_data_integration *********************** AppIntegrationsService.Client.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.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / get_data_integration get_data_integration ******************** AppIntegrationsService.Client.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' }, 'FileConfiguration': { 'Folders': [ 'string', ], 'Filters': { 'string': [ 'string', ] } }, 'ObjectConfiguration': { 'string': { '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 ARN for the DataIntegration. * **KmsKey** *(string) --* The KMS key ARN 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 as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. * **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) --* The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **FileConfiguration** *(dict) --* The configuration for what files should be pulled from the source. * **Folders** *(list) --* Identifiers for the source folders to pull all files from recursively. * *(string) --* * **Filters** *(dict) --* Restrictions for what files should be pulled from the source. * *(string) --* * *(list) --* * *(string) --* * **ObjectConfiguration** *(dict) --* The configuration for what data should be pulled from the source. * *(string) --* * *(dict) --* * *(string) --* * *(list) --* * *(string) --* **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / can_paginate can_paginate ************ AppIntegrationsService.Client.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. AppIntegrationsService / Client / update_event_integration update_event_integration ************************ AppIntegrationsService.Client.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 integration. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / list_event_integration_associations list_event_integration_associations *********************************** AppIntegrationsService.Client.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.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / list_event_integrations list_event_integrations *********************** AppIntegrationsService.Client.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 used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(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.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / list_tags_for_resource list_tags_for_resource ********************** AppIntegrationsService.Client.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.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.ThrottlingException" AppIntegrationsService / Client / untag_resource untag_resource ************** AppIntegrationsService.Client.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.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.ThrottlingException" AppIntegrationsService / Client / update_data_integration update_data_integration *********************** AppIntegrationsService.Client.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.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / create_data_integration create_data_integration *********************** AppIntegrationsService.Client.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', FileConfiguration={ 'Folders': [ 'string', ], 'Filters': { 'string': [ 'string', ] } }, ObjectConfiguration={ 'string': { 'string': [ 'string', ] } } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the DataIntegration. * **Description** (*string*) -- A description of the DataIntegration. * **KmsKey** (*string*) -- **[REQUIRED]** The KMS key ARN 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 as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. * **Object** *(string) --* The name of the object to pull from the data source. * **ScheduleExpression** *(string) --* **[REQUIRED]** How often the data should be pulled from data source. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **FileConfiguration** (*dict*) -- The configuration for what files should be pulled from the source. * **Folders** *(list) --* **[REQUIRED]** Identifiers for the source folders to pull all files from recursively. * *(string) --* * **Filters** *(dict) --* Restrictions for what files should be pulled from the source. * *(string) --* * *(list) --* * *(string) --* * **ObjectConfiguration** (*dict*) -- The configuration for what data should be pulled from the source. * *(string) --* * *(dict) --* * *(string) --* * *(list) --* * *(string) --* 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', 'FileConfiguration': { 'Folders': [ 'string', ], 'Filters': { 'string': [ 'string', ] } }, 'ObjectConfiguration': { 'string': { 'string': [ '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 ARN 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 as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. * **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) --* The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **ClientToken** *(string) --* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. * **FileConfiguration** *(dict) --* The configuration for what files should be pulled from the source. * **Folders** *(list) --* Identifiers for the source folders to pull all files from recursively. * *(string) --* * **Filters** *(dict) --* Restrictions for what files should be pulled from the source. * *(string) --* * *(list) --* * *(string) --* * **ObjectConfiguration** *(dict) --* The configuration for what data should be pulled from the source. * *(string) --* * *(dict) --* * *(string) --* * *(list) --* * *(string) --* **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ResourceQuotaExceededE xception" * "AppIntegrationsService.Client.exceptions.DuplicateResourceExcep tion" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / get_waiter get_waiter ********** AppIntegrationsService.Client.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" AppIntegrationsService / Client / create_event_integration create_event_integration ************************ AppIntegrationsService.Client.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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(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.ResourceQuotaExceededE xception" * "AppIntegrationsService.Client.exceptions.DuplicateResourceExcep tion" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / delete_event_integration delete_event_integration ************************ AppIntegrationsService.Client.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.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / get_event_integration get_event_integration ********************* AppIntegrationsService.Client.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) --* The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / list_data_integrations list_data_integrations ********************** AppIntegrationsService.Client.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.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / update_application update_application ****************** AppIntegrationsService.Client.update_application(**kwargs) Updates and persists an Application resource. See also: AWS API Documentation **Request Syntax** response = client.update_application( Arn='string', Name='string', Description='string', ApplicationSourceConfig={ 'ExternalUrlConfig': { 'AccessUrl': 'string', 'ApprovedOrigins': [ 'string', ] } }, Subscriptions=[ { 'Event': 'string', 'Description': 'string' }, ], Publications=[ { 'Event': 'string', 'Schema': 'string', 'Description': 'string' }, ], Permissions=[ 'string', ], IsService=True|False, InitializationTimeout=123, ApplicationConfig={ 'ContactHandling': { 'Scope': 'CROSS_CONTACTS'|'PER_CONTACT' } }, IframeConfig={ 'Allow': [ 'string', ], 'Sandbox': [ 'string', ] } ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Application. * **Name** (*string*) -- The name of the application. * **Description** (*string*) -- The description of the application. * **ApplicationSourceConfig** (*dict*) -- The configuration for where the application should be loaded from. * **ExternalUrlConfig** *(dict) --* The external URL source for the application. * **AccessUrl** *(string) --* **[REQUIRED]** The URL to access the application. * **ApprovedOrigins** *(list) --* Additional URLs to allow list if different than the access URL. * *(string) --* * **Subscriptions** (*list*) -- The events that the application subscribes. * *(dict) --* The configuration of an event that the application subscribes. * **Event** *(string) --* **[REQUIRED]** The name of the subscription. * **Description** *(string) --* The description of the subscription. * **Publications** (*list*) -- The events that the application publishes. * *(dict) --* The configuration of an event that the application publishes. * **Event** *(string) --* **[REQUIRED]** The name of the publication. * **Schema** *(string) --* **[REQUIRED]** The JSON schema of the publication event. * **Description** *(string) --* The description of the publication. * **Permissions** (*list*) -- The configuration of events or requests that the application has access to. * *(string) --* The permission of an event or request that the application has access to. * **IsService** (*boolean*) -- Indicates whether the application is a service. * **InitializationTimeout** (*integer*) -- The maximum time in milliseconds allowed to establish a connection with the workspace. * **ApplicationConfig** (*dict*) -- The configuration settings for the application. * **ContactHandling** *(dict) --* The contact handling configuration for the application. * **Scope** *(string) --* Indicates whether the application refreshes for each contact or refreshes only with each new browser session. * **IframeConfig** (*dict*) -- The iframe configuration for the application. * **Allow** *(list) --* The list of features that are allowed in the iframe. * *(string) --* A permission for the iframe. * **Sandbox** *(list) --* The list of sandbox attributes for the iframe. * *(string) --* A permission for the iframe. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" * "AppIntegrationsService.Client.exceptions.UnsupportedOperationEx ception" AppIntegrationsService / Client / close close ***** AppIntegrationsService.Client.close() Closes underlying endpoint connections. AppIntegrationsService / Client / list_data_integration_associations list_data_integration_associations ********************************** AppIntegrationsService.Client.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', 'DestinationURI': 'string', 'LastExecutionStatus': { 'ExecutionStatus': 'COMPLETED'|'IN_PROGRESS'|'FAILED', 'StatusMessage': 'string' }, 'ExecutionConfiguration': { 'ExecutionMode': 'ON_DEMAND'|'SCHEDULED', 'OnDemandConfiguration': { 'StartTime': 'string', 'EndTime': 'string' }, 'ScheduleConfiguration': { 'FirstExecutionFrom': 'string', 'Object': 'string', 'ScheduleExpression': '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 the client that is associated with the DataIntegration association. * **DestinationURI** *(string) --* The URI of the data destination. * **LastExecutionStatus** *(dict) --* The execution status of the last job. * **ExecutionStatus** *(string) --* The job status enum string. * **StatusMessage** *(string) --* The status message of a job. * **ExecutionConfiguration** *(dict) --* The configuration for how the files should be pulled from the source. * **ExecutionMode** *(string) --* The mode for data import/export execution. * **OnDemandConfiguration** *(dict) --* The start and end time for data pull from the source. * **StartTime** *(string) --* The start time for data pull from the source as an Unix/epoch string in milliseconds * **EndTime** *(string) --* The end time for data pull from the source as an Unix/epoch string in milliseconds * **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 as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. * **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. * **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.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / list_application_associations list_application_associations ***************************** AppIntegrationsService.Client.list_application_associations(**kwargs) Returns a paginated list of application associations for an application. See also: AWS API Documentation **Request Syntax** response = client.list_application_associations( ApplicationId='string', NextToken='string', MaxResults=123 ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** A unique identifier for the Application. * **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** { 'ApplicationAssociations': [ { 'ApplicationAssociationArn': 'string', 'ApplicationArn': 'string', 'ClientId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ApplicationAssociations** *(list) --* List of Application Associations for the Application. * *(dict) --* Summary information about the Application Association. * **ApplicationAssociationArn** *(string) --* The Amazon Resource Name (ARN) of the Application Association. * **ApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the Application. * **ClientId** *(string) --* The identifier for the client that is associated with the Application 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.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / delete_application delete_application ****************** AppIntegrationsService.Client.delete_application(**kwargs) Deletes the Application. Only Applications that don't have any Application Associations can be deleted. See also: AWS API Documentation **Request Syntax** response = client.delete_application( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Application. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / create_application create_application ****************** AppIntegrationsService.Client.create_application(**kwargs) Creates and persists an Application resource. See also: AWS API Documentation **Request Syntax** response = client.create_application( Name='string', Namespace='string', Description='string', ApplicationSourceConfig={ 'ExternalUrlConfig': { 'AccessUrl': 'string', 'ApprovedOrigins': [ 'string', ] } }, Subscriptions=[ { 'Event': 'string', 'Description': 'string' }, ], Publications=[ { 'Event': 'string', 'Schema': 'string', 'Description': 'string' }, ], ClientToken='string', Tags={ 'string': 'string' }, Permissions=[ 'string', ], IsService=True|False, InitializationTimeout=123, ApplicationConfig={ 'ContactHandling': { 'Scope': 'CROSS_CONTACTS'|'PER_CONTACT' } }, IframeConfig={ 'Allow': [ 'string', ], 'Sandbox': [ 'string', ] } ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name of the application. * **Namespace** (*string*) -- **[REQUIRED]** The namespace of the application. * **Description** (*string*) -- The description of the application. * **ApplicationSourceConfig** (*dict*) -- **[REQUIRED]** The configuration for where the application should be loaded from. * **ExternalUrlConfig** *(dict) --* The external URL source for the application. * **AccessUrl** *(string) --* **[REQUIRED]** The URL to access the application. * **ApprovedOrigins** *(list) --* Additional URLs to allow list if different than the access URL. * *(string) --* * **Subscriptions** (*list*) -- The events that the application subscribes. * *(dict) --* The configuration of an event that the application subscribes. * **Event** *(string) --* **[REQUIRED]** The name of the subscription. * **Description** *(string) --* The description of the subscription. * **Publications** (*list*) -- The events that the application publishes. * *(dict) --* The configuration of an event that the application publishes. * **Event** *(string) --* **[REQUIRED]** The name of the publication. * **Schema** *(string) --* **[REQUIRED]** The JSON schema of the publication event. * **Description** *(string) --* The description of the publication. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **Tags** (*dict*) -- The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **Permissions** (*list*) -- The configuration of events or requests that the application has access to. * *(string) --* The permission of an event or request that the application has access to. * **IsService** (*boolean*) -- Indicates whether the application is a service. * **InitializationTimeout** (*integer*) -- The maximum time in milliseconds allowed to establish a connection with the workspace. * **ApplicationConfig** (*dict*) -- The configuration settings for the application. * **ContactHandling** *(dict) --* The contact handling configuration for the application. * **Scope** *(string) --* Indicates whether the application refreshes for each contact or refreshes only with each new browser session. * **IframeConfig** (*dict*) -- The iframe configuration for the application. * **Allow** *(list) --* The list of features that are allowed in the iframe. * *(string) --* A permission for the iframe. * **Sandbox** *(list) --* The list of sandbox attributes for the iframe. * *(string) --* A permission for the iframe. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Id': 'string' } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Application. * **Id** *(string) --* A unique identifier for the Application. **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ResourceQuotaExceededE xception" * "AppIntegrationsService.Client.exceptions.DuplicateResourceExcep tion" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" * "AppIntegrationsService.Client.exceptions.UnsupportedOperationEx ception" AppIntegrationsService / Client / tag_resource tag_resource ************ AppIntegrationsService.Client.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]** The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.ThrottlingException" AppIntegrationsService / Client / get_application get_application *************** AppIntegrationsService.Client.get_application(**kwargs) Get an Application resource. See also: AWS API Documentation **Request Syntax** response = client.get_application( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Application. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'Id': 'string', 'Name': 'string', 'Namespace': 'string', 'Description': 'string', 'ApplicationSourceConfig': { 'ExternalUrlConfig': { 'AccessUrl': 'string', 'ApprovedOrigins': [ 'string', ] } }, 'Subscriptions': [ { 'Event': 'string', 'Description': 'string' }, ], 'Publications': [ { 'Event': 'string', 'Schema': 'string', 'Description': 'string' }, ], 'CreatedTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'Tags': { 'string': 'string' }, 'Permissions': [ 'string', ], 'IsService': True|False, 'InitializationTimeout': 123, 'ApplicationConfig': { 'ContactHandling': { 'Scope': 'CROSS_CONTACTS'|'PER_CONTACT' } }, 'IframeConfig': { 'Allow': [ 'string', ], 'Sandbox': [ 'string', ] } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Application. * **Id** *(string) --* A unique identifier for the Application. * **Name** *(string) --* The name of the application. * **Namespace** *(string) --* The namespace of the application. * **Description** *(string) --* The description of the application. * **ApplicationSourceConfig** *(dict) --* The configuration for where the application should be loaded from. * **ExternalUrlConfig** *(dict) --* The external URL source for the application. * **AccessUrl** *(string) --* The URL to access the application. * **ApprovedOrigins** *(list) --* Additional URLs to allow list if different than the access URL. * *(string) --* * **Subscriptions** *(list) --* The events that the application subscribes. * *(dict) --* The configuration of an event that the application subscribes. * **Event** *(string) --* The name of the subscription. * **Description** *(string) --* The description of the subscription. * **Publications** *(list) --* The events that the application publishes. * *(dict) --* The configuration of an event that the application publishes. * **Event** *(string) --* The name of the publication. * **Schema** *(string) --* The JSON schema of the publication event. * **Description** *(string) --* The description of the publication. * **CreatedTime** *(datetime) --* The created time of the Application. * **LastModifiedTime** *(datetime) --* The last modified time of the Application. * **Tags** *(dict) --* The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. * *(string) --* * *(string) --* * **Permissions** *(list) --* The configuration of events or requests that the application has access to. * *(string) --* The permission of an event or request that the application has access to. * **IsService** *(boolean) --* Indicates whether the application is a service. * **InitializationTimeout** *(integer) --* The maximum time in milliseconds allowed to establish a connection with the workspace. * **ApplicationConfig** *(dict) --* The configuration settings for the application. * **ContactHandling** *(dict) --* The contact handling configuration for the application. * **Scope** *(string) --* Indicates whether the application refreshes for each contact or refreshes only with each new browser session. * **IframeConfig** *(dict) --* The iframe configuration for the application. * **Allow** *(list) --* The list of features that are allowed in the iframe. * *(string) --* A permission for the iframe. * **Sandbox** *(list) --* The list of sandbox attributes for the iframe. * *(string) --* A permission for the iframe. **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException" AppIntegrationsService / Client / update_data_integration_association update_data_integration_association *********************************** AppIntegrationsService.Client.update_data_integration_association(**kwargs) Updates and persists a DataIntegrationAssociation resource. Note: Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job. See also: AWS API Documentation **Request Syntax** response = client.update_data_integration_association( DataIntegrationIdentifier='string', DataIntegrationAssociationIdentifier='string', ExecutionConfiguration={ 'ExecutionMode': 'ON_DEMAND'|'SCHEDULED', 'OnDemandConfiguration': { 'StartTime': 'string', 'EndTime': 'string' }, 'ScheduleConfiguration': { 'FirstExecutionFrom': 'string', 'Object': 'string', 'ScheduleExpression': 'string' } } ) Parameters: * **DataIntegrationIdentifier** (*string*) -- **[REQUIRED]** A unique identifier for the DataIntegration. * **DataIntegrationAssociationIdentifier** (*string*) -- **[REQUIRED]** A unique identifier. of the DataIntegrationAssociation resource * **ExecutionConfiguration** (*dict*) -- **[REQUIRED]** The configuration for how the files should be pulled from the source. * **ExecutionMode** *(string) --* **[REQUIRED]** The mode for data import/export execution. * **OnDemandConfiguration** *(dict) --* The start and end time for data pull from the source. * **StartTime** *(string) --* **[REQUIRED]** The start time for data pull from the source as an Unix/epoch string in milliseconds * **EndTime** *(string) --* The end time for data pull from the source as an Unix/epoch string in milliseconds * **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 as an Unix/epoch timestamp in milliseconds or in ISO-8601 format. * **Object** *(string) --* The name of the object to pull from the data source. * **ScheduleExpression** *(string) --* **[REQUIRED]** How often the data should be pulled from data source. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "AppIntegrationsService.Client.exceptions.InternalServiceError" * "AppIntegrationsService.Client.exceptions.ThrottlingException" * "AppIntegrationsService.Client.exceptions.ResourceNotFoundExcept ion" * "AppIntegrationsService.Client.exceptions.InvalidRequestExceptio n" * "AppIntegrationsService.Client.exceptions.AccessDeniedException"