PUT

/amazonclouddirectory/2017-01-11/schema/upgradepublished

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

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

Access Token Required: API Key

Body Params

DryRunboolean

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.

MinorVersionstringrequired

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

PublishedSchemaArnstringrequired

The ARN of the published schema to be upgraded.

DevelopmentSchemaArnstringrequired

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

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/upgradepublished' \
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