CloudDirectory / Client / upgrade_applied_schema

upgrade_applied_schema#

CloudDirectory.Client.upgrade_applied_schema(**kwargs)#

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

See also: AWS API Documentation

Request Syntax

response = client.upgrade_applied_schema(
    PublishedSchemaArn='string',
    DirectoryArn='string',
    DryRun=True|False
)
Parameters:

  • PublishedSchemaArn (string) –

    [REQUIRED]

    The revision of the published schema to upgrade the directory to.

  • DirectoryArn (string) –

    [REQUIRED]

    The ARN for the directory to which the upgraded schema will be applied.

  • DryRun (boolean) – Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

Return type:

dict

Returns:

Response Syntax

{
    'UpgradedSchemaArn': 'string',
    'DirectoryArn': 'string'
}

Response Structure

  • (dict) –

    • UpgradedSchemaArn (string) –

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

    • DirectoryArn (string) –

      The ARN of the directory that is returned as part of the response.

Exceptions