Amazon Cloud Directory
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpgradeAppliedSchema

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.

Request Syntax

PUT /amazonclouddirectory/2017-01-11/schema/upgradeapplied HTTP/1.1 Content-type: application/json { "DirectoryArn": "string", "DryRun": boolean, "PublishedSchemaArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DirectoryArn

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

Type: String

Required: Yes

DryRun

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.

Type: Boolean

Required: No

PublishedSchemaArn

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

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DirectoryArn": "string", "UpgradedSchemaArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DirectoryArn

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

Type: String

UpgradedSchemaArn

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

HTTP Status Code: 403

IncompatibleSchemaException

Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.

HTTP Status Code: 400

InternalServiceException

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

HTTP Status Code: 500

InvalidArnException

Indicates that the provided ARN value is not valid.

HTTP Status Code: 400

InvalidAttachmentException

Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

RetryableConflictException

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 409

SchemaAlreadyExistsException

Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.

HTTP Status Code: 400

ValidationException

Indicates that your request is malformed in some manner. See the exception message.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: