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