create_data_integration

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