PUT

/amazonclouddirectory/2017-01-11/schema/create

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

Creates a new schema in a development state. A schema can exist in three phases: <ul> <li> 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. </li> <li> Published: Published schemas are immutable and have a version associated with them. </li> <li> 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. </li> </ul>

Access Token Required: API Key

Body Params

Namestringrequired

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

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