Amazon AppIntegrations Service

Updates and persists a DataIntegrationAssociation resource.

See also: AWS API Documentation

Request Syntax

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

type DataIntegrationIdentifier:

string

param DataIntegrationIdentifier:

[REQUIRED]

A unique identifier for the DataIntegration.

type DataIntegrationAssociationIdentifier:

string

param DataIntegrationAssociationIdentifier:

[REQUIRED]

A unique identifier. of the DataIntegrationAssociation resource

type ExecutionConfiguration:

dict

param ExecutionConfiguration:

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Creates and persists a DataIntegrationAssociation resource.

See also: AWS API Documentation

Request Syntax

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

type DataIntegrationIdentifier:

string

param DataIntegrationIdentifier:

[REQUIRED]

A unique identifier for the DataIntegration.

type ClientId:

string

param ClientId:

The identifier for the client that is associated with the DataIntegration association.

type ObjectConfiguration:

dict

param ObjectConfiguration:

The configuration for what data should be pulled from the source.

• (string) --

  • (dict) --

    • (string) --

      • (list) --

        • (string) --

type DestinationURI:

string

param DestinationURI:

The URI of the data destination.

type ClientAssociationMetadata:

dict

param ClientAssociationMetadata:

The mapping of metadata to be extracted from the data.

• (string) --

  • (string) --

type ClientToken:

string

param ClientToken:

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.

type ExecutionConfiguration:

dict

param ExecutionConfiguration:

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.

rtype:

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.

{'DataIntegrationAssociations': {'DestinationURI': 'string',
                                 'ExecutionConfiguration': {'ExecutionMode': 'ON_DEMAND '
                                                                             '| '
                                                                             'SCHEDULED',
                                                            'OnDemandConfiguration': {'EndTime': 'string',
                                                                                      'StartTime': 'string'},
                                                            'ScheduleConfiguration': {'FirstExecutionFrom': 'string',
                                                                                      'Object': 'string',
                                                                                      'ScheduleExpression': 'string'}},
                                 'LastExecutionStatus': {'ExecutionStatus': 'COMPLETED '
                                                                            '| '
                                                                            'IN_PROGRESS '
                                                                            '| '
                                                                            'FAILED',
                                                         'StatusMessage': 'string'}}}

Returns a paginated list of DataIntegration associations in the account.

See also: AWS API Documentation

Request Syntax

client.list_data_integration_associations(
    DataIntegrationIdentifier='string',
    NextToken='string',
    MaxResults=123
)

type DataIntegrationIdentifier:

string

param DataIntegrationIdentifier:

[REQUIRED]

A unique identifier for the DataIntegration.

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

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.