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

CreateAppInstanceUser

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Request Syntax


POST /app-instance-users HTTP/1.1
Content-type: application/json

{
   "AppInstanceArn": "string",
   "AppInstanceUserId": "string",
   "ClientRequestToken": "string",
   "ExpirationSettings": { 
      "ExpirationCriterion": "string",
      "ExpirationDays": number
   },
   "Metadata": "string",
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AppInstanceArn

The ARN of the AppInstance request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

AppInstanceUserId

The user ID of the AppInstance.

Type: String

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

Pattern: [A-Za-z0-9]([A-Za-z0-9\:\-\_\.\@]{0,62}[A-Za-z0-9])?

Required: Yes

ClientRequestToken

The unique ID of the request. Use different tokens to request additional AppInstances.

Type: String

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

Pattern: [-_a-zA-Z0-9]*

Required: Yes

ExpirationSettings

Settings that control the interval after which the AppInstanceUser is automatically deleted.

Type: ExpirationSettings object

Required: No

Metadata

The request's metadata. Limited to a 1KB string in UTF-8.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*

Required: No

Name

The user's name.

Type: String

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

Pattern: .*\S.*

Required: Yes

Tags

Tags assigned to the AppInstanceUser.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "AppInstanceUserArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

AppInstanceUserArn

The user's ARN.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 1600.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Errors

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

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401