CloudDirectory / Client / get_schema_as_json

get_schema_as_json#

CloudDirectory.Client.get_schema_as_json(**kwargs)#

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

See also: AWS API Documentation

Request Syntax

response = client.get_schema_as_json(
    SchemaArn='string'
)
Parameters:

SchemaArn (string) –

[REQUIRED]

The ARN of the schema to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Document': 'string'
}

Response Structure

  • (dict) –

    • Name (string) –

      The name of the retrieved schema.

    • Document (string) –

      The JSON representation of the schema document.

Exceptions

  • CloudDirectory.Client.exceptions.InternalServiceException

  • CloudDirectory.Client.exceptions.InvalidArnException

  • CloudDirectory.Client.exceptions.RetryableConflictException

  • CloudDirectory.Client.exceptions.ValidationException

  • CloudDirectory.Client.exceptions.LimitExceededException

  • CloudDirectory.Client.exceptions.AccessDeniedException

  • CloudDirectory.Client.exceptions.ResourceNotFoundException

  • CloudDirectory.Client.exceptions.ValidationException