POST

/app-instances

http://service.chime.aws.amazon.com/app-instances

Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account. Only SDK messaging customers use this API. <code>CreateAppInstance</code> supports idempotency behavior as described in the AWS API Standard.

Access Token Required: API Key

Body Params

Namestringrequired

The name of the <code>AppInstance</code>.

Tagsarray

Tags assigned to the <code>AppInstance</code>.

Metadatastring

The metadata of the <code>AppInstance</code>. Limited to a 1KB string in UTF-8.

ClientRequestTokenstringrequired

The <code>ClientRequestToken</code> of the <code>AppInstance</code>.

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 POST \
2     --url 'http://service.chime.aws.amazon.com/app-instances' \
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}