Menu
Amazon Cloud Directory
API Reference

PublishSchema

Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.

Request Syntax

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

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

URI Request Parameters

The request requires the following URI parameters.

DevelopmentSchemaArn

The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see Arn Examples.

Request Body

The request accepts the following data in JSON format.

Name

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

The version under which the schema will be published.

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

The ARN that is associated with the published schema. For more information, see Arn Examples.

Type: String

Errors

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

AccessDeniedException

Access denied. 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 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 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: