Glue / Client / describe_integrations

describe_integrations

Glue.Client.describe_integrations(**kwargs)

The API is used to retrieve a list of integrations.

See also: AWS API Documentation

Request Syntax

response = client.describe_integrations(
    IntegrationIdentifier='string',
    Marker='string',
    MaxRecords=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

• IntegrationIdentifier (string) – The Amazon Resource Name (ARN) for the integration.

• Marker (string) – A value that indicates the starting point for the next set of response records in a subsequent request.

• MaxRecords (integer) – The total number of items to return in the output.

• Filters (list) –

  A list of key and values, to filter down the results. Supported keys are “Status”, “IntegrationName”, and “SourceArn”. IntegrationName is limited to only one value.

  • (dict) –

    A filter that can be used when invoking a DescribeIntegrations request.

    • Name (string) –

      The name of the filter.

    • Values (list) –

      A list of filter values.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Integrations': [
        {
            'SourceArn': 'string',
            'TargetArn': 'string',
            'Description': 'string',
            'IntegrationName': 'string',
            'IntegrationArn': 'string',
            'KmsKeyId': 'string',
            'AdditionalEncryptionContext': {
                'string': 'string'
            },
            'Tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'Status': 'CREATING'|'ACTIVE'|'MODIFYING'|'FAILED'|'DELETING'|'SYNCING'|'NEEDS_ATTENTION',
            'CreateTime': datetime(2015, 1, 1),
            'Errors': [
                {
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ],
            'DataFilter': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

  • Integrations (list) –

    A list of zero-ETL integrations.

    • (dict) –

      Describes a zero-ETL integration.

      • SourceArn (string) –

        The ARN for the source of the integration.

      • TargetArn (string) –

        The ARN for the target of the integration.

      • Description (string) –

        A description for the integration.

      • IntegrationName (string) –

        A unique name for the integration.

      • IntegrationArn (string) –

        The Amazon Resource Name (ARN) for the integration.

      • KmsKeyId (string) –

        The ARN of a KMS key used for encrypting the channel.

      • AdditionalEncryptionContext (dict) –

        An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId is provided.

        • (string) –

          • (string) –

      • Tags (list) –

        Metadata assigned to the resource consisting of a list of key-value pairs.

        • (dict) –

          The Tag object represents a label that you can assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.

          For more information about tags, and controlling access to resources in Glue, see Amazon Web Services Tags in Glue and Specifying Glue Resource ARNs in the developer guide.

          • key (string) –

            The tag key. The key is required when you create a tag on an object. The key is case-sensitive, and must not contain the prefix aws.

          • value (string) –

            The tag value. The value is optional when you create a tag on an object. The value is case-sensitive, and must not contain the prefix aws.

      • Status (string) –

        The possible statuses are:

        • CREATING: The integration is being created.

        • ACTIVE: The integration creation succeeds.

        • MODIFYING: The integration is being modified.

        • FAILED: The integration creation fails.

        • DELETING: The integration is deleted.

        • SYNCING: The integration is synchronizing.

        • NEEDS_ATTENTION: The integration needs attention, such as synchronization.

      • CreateTime (datetime) –

        The time that the integration was created, in UTC.

      • Errors (list) –

        A list of errors associated with the integration.

        • (dict) –

          An error associated with a zero-ETL integration.

          • ErrorCode (string) –

            The code associated with this error.

          • ErrorMessage (string) –

            A message describing the error.

      • DataFilter (string) –

        Selects source tables for the integration using Maxwell filter syntax.

  • Marker (string) –

    A value that indicates the starting point for the next set of response records in a subsequent request.

Exceptions

• Glue.Client.exceptions.ValidationException

• Glue.Client.exceptions.AccessDeniedException

• Glue.Client.exceptions.InternalServerException

• Glue.Client.exceptions.IntegrationNotFoundFault

• Glue.Client.exceptions.EntityNotFoundException

• Glue.Client.exceptions.InternalServiceException

• Glue.Client.exceptions.InvalidInputException