Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466336354.1 KB

Upgrades a single directory in-place using the <code>PublishedSchemaArn</code> with schema updates found in <code>MinorVersion</code>. 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.

put/amazonclouddirectory/2017-01-11/schema/upgradeapplied

Request body

PublishedSchemaArnstring required

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

DirectoryArnstring required

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

DryRunboolean

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.

Response

Success

UpgradedSchemaArnstring

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

DirectoryArnstring

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