CloudDirectory / Client / upgrade_published_schema

upgrade_published_schema#

CloudDirectory.Client.upgrade_published_schema(**kwargs)#

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

See also: AWS API Documentation

Request Syntax

response = client.upgrade_published_schema(
    DevelopmentSchemaArn='string',
    PublishedSchemaArn='string',
    MinorVersion='string',
    DryRun=True|False
)
Parameters:

  • DevelopmentSchemaArn (string) –

    [REQUIRED]

    The ARN of the development schema with the changes used for the upgrade.

  • PublishedSchemaArn (string) –

    [REQUIRED]

    The ARN of the published schema to be upgraded.

  • MinorVersion (string) –

    [REQUIRED]

    Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

  • DryRun (boolean) – Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

Return type:

dict

Returns:

Response Syntax

{
    'UpgradedSchemaArn': 'string'
}

Response Structure

  • (dict) –

    • UpgradedSchemaArn (string) –

      The ARN of the upgraded schema that is returned as part of the response.

Exceptions

  • CloudDirectory.Client.exceptions.InternalServiceException

  • CloudDirectory.Client.exceptions.InvalidArnException

  • CloudDirectory.Client.exceptions.RetryableConflictException

  • CloudDirectory.Client.exceptions.ValidationException

  • CloudDirectory.Client.exceptions.IncompatibleSchemaException

  • CloudDirectory.Client.exceptions.AccessDeniedException

  • CloudDirectory.Client.exceptions.ResourceNotFoundException

  • CloudDirectory.Client.exceptions.InvalidAttachmentException

  • CloudDirectory.Client.exceptions.LimitExceededException