AppSync / Paginator / ListTypesByAssociation

ListTypesByAssociation

class AppSync.Paginator.ListTypesByAssociation

paginator = client.get_paginator('list_types_by_association')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    mergedApiIdentifier='string',
    associationId='string',
    format='SDL'|'JSON',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• mergedApiIdentifier (string) –

  [REQUIRED]

  The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

• associationId (string) –

  [REQUIRED]

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

• format (string) –

  [REQUIRED]

  The format type.

• 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

{
    'types': [
        {
            'name': 'string',
            'description': 'string',
            'arn': 'string',
            'definition': 'string',
            'format': 'SDL'|'JSON'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • types (list) –

    The Type objects.

    • (dict) –

      Describes a type.

      • name (string) –

        The type name.

      • description (string) –

        The type description.

      • arn (string) –

        The type Amazon Resource Name (ARN).

      • definition (string) –

        The type definition.

      • format (string) –

        The type format: SDL or JSON.

  • NextToken (string) –

    A token to resume pagination.