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

• AppIntegrationsService.Client.exceptions.InvalidRequestException

• AppIntegrationsService.Client.exceptions.AccessDeniedException