list_types

AppSync.Client.list_types(**kwargs)

Lists the types for a given API.

See also: AWS API Documentation

Request Syntax

response = client.list_types(
    apiId='string',
    format='SDL'|'JSON',
    nextToken='string',
    maxResults=123
)

Parameters

• apiId (string) --

  [REQUIRED]

  The API ID.

• format (string) --

  [REQUIRED]

  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.
• 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 to pass in the next request to this operation 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