PUT

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

http://clouddirectory.{region}.amazonaws.com/amazonclouddirectory/2017-01-11/schema/upgradeapplied

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.

Access Token Required: API Key

Body Params

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.

DirectoryArnstringrequired

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

PublishedSchemaArnstringrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://clouddirectory.{region}.amazonaws.com/amazonclouddirectory/2017-01-11/schema/upgradeapplied' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT