CloudDirectory / Client / publish_schema

publish_schema#

CloudDirectory.Client.publish_schema(**kwargs)#

Publishes a development schema with a major version and a recommended minor version.

See also: AWS API Documentation

Request Syntax

response = client.publish_schema(
    DevelopmentSchemaArn='string',
    Version='string',
    MinorVersion='string',
    Name='string'
)
Parameters:

  • DevelopmentSchemaArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.

  • Version (string) –

    [REQUIRED]

    The major version under which the schema will be published. Schemas have both a major and minor version associated with them.

  • MinorVersion (string) – The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.

  • Name (string) – The new name under which the schema will be published. If this is not provided, the development schema is considered.

Return type:

dict

Returns:

Response Syntax

{
    'PublishedSchemaArn': 'string'
}

Response Structure

  • (dict) –

    • PublishedSchemaArn (string) –

      The ARN that is associated with the published schema. For more information, see arns.

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