Redshift / Paginator / DescribeInboundIntegrations

DescribeInboundIntegrations

class Redshift.Paginator.DescribeInboundIntegrations

paginator = client.get_paginator('describe_inbound_integrations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    IntegrationArn='string',
    TargetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

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

• 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

{
    'InboundIntegrations': [
        {
            'IntegrationArn': 'string',
            'SourceArn': 'string',
            'TargetArn': 'string',
            'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
            'Errors': [
                {
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ],
            'CreateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • InboundIntegrations (list) –

    A list of InboundIntegration instances.

    • (dict) –

      The content of an inbound integration.

      • IntegrationArn (string) –

        The Amazon Resource Name (ARN) of an inbound integration.

      • SourceArn (string) –

        The Amazon Resource Name (ARN) of the source of an inbound integration.

      • TargetArn (string) –

        The Amazon Resource Name (ARN) of the target of an inbound integration.

      • Status (string) –

        The status of an inbound integration.

      • Errors (list) –

        The outstanding errors of an inbound integration. Each item is an “IntegrationError”. This is null if there is no error.

        • (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 creation time of an inbound integration.

  • NextToken (string) –

    A token to resume pagination.