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

CreateKxEnvironment

Creates a managed kdb environment for the account.

Request Syntax


POST /kx/environments HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "kmsKeyId": "string",
   "name": "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.

kmsKeyId

The KMS key ID to encrypt your data in the FinSpace environment.

Type: String

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

Pattern: ^arn:aws:kms:.*:\d+:.*$

Required: Yes

name

The name of the kdb environment that you want to create.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

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

Required: Yes

clientToken

A token that ensures idempotency. This token expires in 10 minutes.

Type: String

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

Pattern: .*\S.*

Required: No

description

A description for the kdb environment.

Type: String

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

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

Required: No

tags

A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

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

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

Value Pattern: ^[a-zA-Z0-9+-=._:@ ]+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTimestamp": number,
   "description": "string",
   "environmentArn": "string",
   "environmentId": "string",
   "kmsKeyId": "string",
   "name": "string",
   "status": "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.

creationTimestamp

The timestamp at which the kdb environment was created in FinSpace.

Type: Timestamp

description

A description for the kdb environment.

Type: String

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

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

environmentArn

The ARN identifier of the environment.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:environment/[0-9A-Za-z_-]{1,128}$

environmentId

A unique identifier for the kdb environment.

Type: String

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

Pattern: ^[a-zA-Z0-9]{1,26}$

kmsKeyId

The KMS key ID to encrypt your data in the FinSpace environment.

Type: String

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

Pattern: ^[a-zA-Z-0-9-:\/]*$

name

The name of the kdb environment.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

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

status

The status of the kdb environment.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There was a conflict with this action, and it could not be completed.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

LimitExceededException

A service limit or quota is exceeded.

HTTP Status Code: 400

ServiceQuotaExceededException

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400