Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDatastore

Create a data store.

Request Syntax


POST /datastore HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "datastoreName": "string",
   "kmsKeyArn": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique identifier for API idempotency.

Type: String

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

Pattern: [A-Za-z0-9._-]+

Required: Yes

datastoreName

The data store name.

Type: String

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

Pattern: [A-Za-z0-9._/#-]+

Required: No

kmsKeyArn

The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

Type: String

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

Pattern: arn:aws[a-zA-Z-]{0,16}:kms:[a-z]{2}(-[a-z]{1,16}){1,3}-\d{1}:\d{12}:((key/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})|(alias/[a-zA-Z0-9:/_-]{1,256}))

Required: No

tags

The tags provided when creating a data store.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "datastoreId": "string",
   "datastoreStatus": "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.

datastoreId

The data store identifier.

Type: String

Pattern: [0-9a-z]{32}

datastoreStatus

The data store status.

Type: String

Valid Values: CREATING | CREATE_FAILED | ACTIVE | DELETING | DELETED

Errors

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

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during processing of the request.

HTTP Status Code: 500

ServiceQuotaExceededException

The request caused a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

The request was denied due to throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints set by the service.

HTTP Status Code: 400