Glue / Client / describe_inbound_integrations

describe_inbound_integrations

Glue.Client.describe_inbound_integrations(**kwargs)

Returns a list of inbound integrations for the specified integration.

See also: AWS API Documentation

Request Syntax

response = client.describe_inbound_integrations(
    IntegrationArn='string',
    Marker='string',
    MaxRecords=123,
    TargetArn='string'
)

Parameters:

• IntegrationArn (string) – The Amazon Resource Name (ARN) of the integration.

• Marker (string) – A token to specify where to start paginating. This is the marker from a previously truncated response.

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

• TargetArn (string) – The Amazon Resource Name (ARN) of the target resource in the integration.

Return type:

dict

Returns:

Response Syntax

{
    'InboundIntegrations': [
        {
            'SourceArn': 'string',
            'TargetArn': 'string',
            'IntegrationArn': 'string',
            'Status': 'CREATING'|'ACTIVE'|'MODIFYING'|'FAILED'|'DELETING'|'SYNCING'|'NEEDS_ATTENTION',
            'CreateTime': datetime(2015, 1, 1),
            'IntegrationConfig': {
                'RefreshInterval': 'string',
                'SourceProperties': {
                    'string': 'string'
                },
                'ContinuousSync': True|False,
                'TargetNamespace': 'string'
            },
            'Errors': [
                {
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

  • InboundIntegrations (list) –

    A list of inbound integrations.

    • (dict) –

      A structure for an integration that writes data into a resource.

      • SourceArn (string) –

        The ARN of the source resource for the integration.

      • TargetArn (string) –

        The ARN of the target resource for the integration.

      • IntegrationArn (string) –

        The ARN of the zero-ETL integration.

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

      • IntegrationConfig (dict) –

        Properties associated with the integration.

        • RefreshInterval (string) –

          Specifies the frequency at which CDC (Change Data Capture) pulls or incremental loads should occur. This parameter provides flexibility to align the refresh rate with your specific data update patterns, system load considerations, and performance optimization goals. Time increment can be set from 15 minutes to 8640 minutes (six days).

        • SourceProperties (dict) –

          A collection of key-value pairs that specify additional properties for the integration source. These properties provide configuration options that can be used to customize the behavior of the ODB source during data integration operations.

          • (string) –

            • (string) –

        • ContinuousSync (boolean) –

          Enables continuous synchronization for on-demand data extractions from SaaS applications to Amazon Web Services data services like Amazon Redshift and Amazon S3.

        • TargetNamespace (string) –

          An optional custom namespace for the integration’s target. Supply this parameter only when the target is an Amazon S3 Tables table bucket; it is not accepted for other target types. The integration replicates data into the namespace you specify, reusing it if it already exists. If you omit this parameter, the target namespace defaults to zetl_ followed by the integration ID, with hyphens converted to underscores.

          The value is immutable after the integration is created; ModifyIntegration rejects changes to it. It must be a valid Amazon S3 Tables namespace name: 1 to 255 characters using lowercase letters, numbers, and underscores, with no leading or trailing underscore and no reserved aws prefix.

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

  • 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.TargetResourceNotFound

• Glue.Client.exceptions.OperationNotSupportedException

• Glue.Client.exceptions.EntityNotFoundException

• Glue.Client.exceptions.InternalServiceException

• Glue.Client.exceptions.InvalidInputException