Redshift / Paginator / DescribeIntegrations

DescribeIntegrations

class Redshift.Paginator.DescribeIntegrations

paginator = client.get_paginator('describe_integrations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_integrations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    IntegrationArn='string',
    Filters=[
        {
            'Name': 'integration-arn'|'source-arn'|'source-types'|'status',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• IntegrationArn (string) – The unique identifier of the integration.

• Filters (list) –

  A filter that specifies one or more resources to return.

  • (dict) –

    A set of elements to filter the returned integrations.

    • Name (string) – [REQUIRED]

      Specifies the type of integration filter.

    • Values (list) – [REQUIRED]

      Specifies the values to filter on.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Integrations': [
        {
            'IntegrationArn': 'string',
            'IntegrationName': 'string',
            'SourceArn': 'string',
            'TargetArn': 'string',
            'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
            'Errors': [
                {
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ],
            'CreateTime': datetime(2015, 1, 1),
            'Description': 'string',
            'KMSKeyId': 'string',
            'AdditionalEncryptionContext': {
                'string': 'string'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Integrations (list) –

    List of integrations that are described.

    • (dict) –

      • IntegrationArn (string) –

        The Amazon Resource Name (ARN) of the integration.

      • IntegrationName (string) –

        The name of the integration.

      • SourceArn (string) –

        The Amazon Resource Name (ARN) of the database used as the source for replication.

      • TargetArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

      • Status (string) –

        The current status of the integration.

      • Errors (list) –

        Any errors associated with the integration.

        • (dict) –

          The error of an inbound integration.

          • ErrorCode (string) –

            The error code of an inbound integration error.

          • ErrorMessage (string) –

            The error message of an inbound integration error.

      • CreateTime (datetime) –

        The time (UTC) when the integration was created.

      • Description (string) –

        The description of the integration.

      • KMSKeyId (string) –

        The Key Management Service (KMS) key identifier for the key used to encrypt the integration.

      • AdditionalEncryptionContext (dict) –

        The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

        • (string) –

          • (string) –

      • Tags (list) –

        The list of tags associated with the integration.

        • (dict) –

          A tag consisting of a name/value pair for a resource.

          • Key (string) –

            The key, or name, for the resource tag.

          • Value (string) –

            The value for the resource tag.

  • NextToken (string) –

    A token to resume pagination.