Menu
Amazon Cloud Directory
API Reference

CreateSchema

Creates a new schema in a development state. A schema can exist in three phases:

  • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.

  • Published: Published schemas are immutable and have a version associated with them.

  • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

Request Syntax

Copy
PUT /amazonclouddirectory/2017-01-11/schema/create HTTP/1.1 Content-type: application/json { "Name": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Name

The name that is associated with the schema. This is unique to each account and in each region.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-zA-Z0-9._-]*$

Required: Yes

Response Syntax

Copy
HTTP/1.1 200 Content-type: application/json { "SchemaArn": "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.

SchemaArn

The Amazon Resource Name (ARN) that is associated with the 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

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

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: