AppSync / Client / get_type

get_type

AppSync.Client.get_type(**kwargs)

Retrieves a Type object.

See also: AWS API Documentation

Request Syntax

response = client.get_type(
    apiId='string',
    typeName='string',
    format='SDL'|'JSON'
)

Parameters:

• apiId (string) –

  [REQUIRED]

  The API ID.

• typeName (string) –

  [REQUIRED]

  The type name.

• format (string) –

  [REQUIRED]

  The type format: SDL or JSON.

Return type:

dict

Returns:

Response Syntax

{
    'type': {
        'name': 'string',
        'description': 'string',
        'arn': 'string',
        'definition': 'string',
        'format': 'SDL'|'JSON'
    }
}

Response Structure

• (dict) –

  • type (dict) –

    The Type object.

    • 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.

Exceptions

• AppSync.Client.exceptions.BadRequestException

• AppSync.Client.exceptions.ConcurrentModificationException

• AppSync.Client.exceptions.NotFoundException

• AppSync.Client.exceptions.UnauthorizedException

• AppSync.Client.exceptions.InternalFailureException