

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/).

# PublishSchema


Publishes a development schema with a major version and a recommended minor version.

## Request Syntax


```
PUT /amazonclouddirectory/2017-01-11/schema/publish HTTP/1.1
x-amz-data-partition: DevelopmentSchemaArn
Content-type: application/json

{
   "MinorVersion": "string",
   "Name": "string",
   "Version": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [DevelopmentSchemaArn](#API_PublishSchema_RequestSyntax) **   <a name="amazoncds-PublishSchema-request-DevelopmentSchemaArn"></a>
The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see [Arn Examples](arns.md).  
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [MinorVersion](#API_PublishSchema_RequestSyntax) **   <a name="amazoncds-PublishSchema-request-MinorVersion"></a>
The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: No

 ** [Name](#API_PublishSchema_RequestSyntax) **   <a name="amazoncds-PublishSchema-request-Name"></a>
The new name under which the schema will be published. If this is not provided, the development schema is considered.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: No

 ** [Version](#API_PublishSchema_RequestSyntax) **   <a name="amazoncds-PublishSchema-request-Version"></a>
The major version under which the schema will be published. Schemas have both a major and minor version associated with them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: Yes

## Response Syntax


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

{
   "PublishedSchemaArn": "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.

 ** [PublishedSchemaArn](#API_PublishSchema_ResponseSyntax) **   <a name="amazoncds-PublishSchema-response-PublishedSchemaArn"></a>
The ARN that is associated with the published schema. For more information, see [Arn Examples](arns.md).  
Type: String

## Errors


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

 ** 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

 ** 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

 ** SchemaAlreadyPublishedException **   
Indicates that a schema is already published.  
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:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/clouddirectory-2017-01-11/PublishSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/PublishSchema) 