Amazon Cloud Directory will no longer be open to new customers starting on November 7, 2025. For alternatives to Cloud Directory, explore [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and [Amazon Neptune](https://aws.amazon.com/neptune/). If you need help choosing the right alternative for your use case, or for any other questions, contact [AWS Support](https://aws.amazon.com/support/).

# UpgradePublishedSchema
<a name="API_UpgradePublishedSchema"></a>

Upgrades a published schema under a new minor version revision using the current contents of `DevelopmentSchemaArn`.

## Request Syntax
<a name="API_UpgradePublishedSchema_RequestSyntax"></a>

```
PUT /amazonclouddirectory/2017-01-11/schema/upgradepublished HTTP/1.1
Content-type: application/json

{
   "DevelopmentSchemaArn": "string",
   "DryRun": boolean,
   "MinorVersion": "string",
   "PublishedSchemaArn": "string"
}
```

## URI Request Parameters
<a name="API_UpgradePublishedSchema_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpgradePublishedSchema_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DevelopmentSchemaArn](#API_UpgradePublishedSchema_RequestSyntax) **   <a name="amazoncds-UpgradePublishedSchema-request-DevelopmentSchemaArn"></a>
The ARN of the development schema with the changes used for the upgrade.  
Type: String  
Required: Yes

 ** [DryRun](#API_UpgradePublishedSchema_RequestSyntax) **   <a name="amazoncds-UpgradePublishedSchema-request-DryRun"></a>
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.  
Type: Boolean  
Required: No

 ** [MinorVersion](#API_UpgradePublishedSchema_RequestSyntax) **   <a name="amazoncds-UpgradePublishedSchema-request-MinorVersion"></a>
Identifies the minor version of the published schema that will be created. This parameter is NOT optional.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: Yes

 ** [PublishedSchemaArn](#API_UpgradePublishedSchema_RequestSyntax) **   <a name="amazoncds-UpgradePublishedSchema-request-PublishedSchemaArn"></a>
The ARN of the published schema to be upgraded.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpgradePublishedSchema_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "UpgradedSchemaArn": "string"
}
```

## Response Elements
<a name="API_UpgradePublishedSchema_ResponseElements"></a>

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

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

 ** [UpgradedSchemaArn](#API_UpgradePublishedSchema_ResponseSyntax) **   <a name="amazoncds-UpgradePublishedSchema-response-UpgradedSchemaArn"></a>
The ARN of the upgraded schema that is returned as part of the response.  
Type: String

## Errors
<a name="API_UpgradePublishedSchema_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](API_ListDirectories.md) 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](http://status.aws.amazon.com/) 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

 ** LimitExceededException **   
Indicates that limits are exceeded. See [Limits](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html) for more information.  
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

 ** ValidationException **   
Indicates that your request is malformed in some manner. See the exception message.  
HTTP Status Code: 400

## See Also
<a name="API_UpgradePublishedSchema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/clouddirectory-2017-01-11/UpgradePublishedSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/UpgradePublishedSchema)