AppSync / Client / list_types_by_association

list_types_by_association#

AppSync.Client.list_types_by_association(**kwargs)#

Lists Type objects by the source API association ID.

See also: AWS API Documentation

Request Syntax

response = client.list_types_by_association(
    mergedApiIdentifier='string',
    associationId='string',
    format='SDL'|'JSON',
    nextToken='string',
    maxResults=123
)
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.

  • nextToken (string) – An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

  • maxResults (integer) – The maximum number of results that you want the request to return.

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) –

      An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Exceptions

  • AppSync.Client.exceptions.BadRequestException

  • AppSync.Client.exceptions.ConcurrentModificationException

  • AppSync.Client.exceptions.NotFoundException

  • AppSync.Client.exceptions.UnauthorizedException

  • AppSync.Client.exceptions.InternalFailureException