AppSync / Paginator / ListSourceApiAssociations

ListSourceApiAssociations

class AppSync.Paginator.ListSourceApiAssociations

paginator = client.get_paginator('list_source_api_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AppSync.Client.list_source_api_associations().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• apiId (string) –

  [REQUIRED]

  The API ID.

• 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

{
    'sourceApiAssociationSummaries': [
        {
            'associationId': 'string',
            'associationArn': 'string',
            'sourceApiId': 'string',
            'sourceApiArn': 'string',
            'mergedApiId': 'string',
            'mergedApiArn': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • sourceApiAssociationSummaries (list) –

    The SourceApiAssociationSummary object data.

    • (dict) –

      Describes the ARNs and IDs of associations, Merged APIs, and source APIs.

      • associationId (string) –

        The ID generated by the AppSync service for the source API association.

      • associationArn (string) –

        The Amazon Resource Name (ARN) of the source API association.

      • sourceApiId (string) –

        The ID of the AppSync source API.

      • sourceApiArn (string) –

        The Amazon Resource Name (ARN) of the AppSync Source API.

      • mergedApiId (string) –

        The ID of the AppSync Merged API.

      • mergedApiArn (string) –

        The Amazon Resource Name (ARN) of the AppSync Merged API.

      • description (string) –

        The description field.

  • NextToken (string) –

    A token to resume pagination.