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

CreateKxUser

Creates a user in FinSpace kdb environment with an associated IAM role.

Request Syntax


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

{
   "clientToken": "string",
   "iamRole": "string",
   "tags": { 
      "string" : "string" 
   },
   "userName": "string"
}

URI Request Parameters

The request uses the following URI parameters.

environmentId

A unique identifier for the kdb environment where you want to create a user.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

iamRole

The IAM role ARN that will be associated with the user.

Type: String

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

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Required: Yes

userName

A unique identifier for the user.

Type: String

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

Pattern: ^[0-9A-Za-z_-]{1,50}$

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

tags

A list of key-value pairs to label the user. You can add up to 50 tags to a user.

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

{
   "environmentId": "string",
   "iamRole": "string",
   "userArn": "string",
   "userName": "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.

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}$

iamRole

The IAM role ARN that will be associated with the user.

Type: String

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

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

userArn

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Type: String

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

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

userName

A unique identifier for the user.

Type: String

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

Pattern: ^[0-9A-Za-z_-]{1,50}$

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

ResourceAlreadyExistsException

The specified resource group already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

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