# Amazon Chime SDK Identity API

> Amazon Chime SDK Identity API on Apizie: 30 endpoints (Lists all Amazon Chime AppInstance s created under a single AWS account., Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use…, Returns a list of the administrators in the AppInstance ., Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin . The promoted entity can perform the…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-chime-sdk-identity`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-chime-sdk-identity
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-chime-sdk-identity/openapi.json

The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending…

## Endpoints

### Lists all Amazon Chime AppInstance s created under a single AWS account.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/list-app-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| max-results | integer | no | The maximum number of AppInstance s that you want to return. |
| next-token | string | no | The token passed by previous API requests until you reach the maximum number of AppInstances . |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/create-app-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns a list of the administrators in the AppInstance .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/list-app-instance-admins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceArn | string | yes | The ARN of the AppInstance . |
| max-results | integer | no | The maximum number of administrators that you want to return. |
| next-token | string | no | The token returned from previous API requests until the number of administrators is reached. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Promotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin . The promoted entity can perform the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/create-app-instance-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceArn | string | yes | The ARN of the AppInstance . |
| body | object | yes | JSON request body |

### Creates a bot under an Amazon Chime AppInstance . The request consists of a unique Configuration and Name…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/create-app-instance-bot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a user under an Amazon Chime AppInstance . The request consists of a unique appInstanceUserId and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/create-app-instance-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns the full details of an AppInstance .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/describe-app-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceArn | string | yes | The ARN of the AppInstance . |

### Updates AppInstance metadata.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/update-app-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceArn | string | yes | The ARN of the AppInstance . |
| body | object | yes | JSON request body |

### Deletes an AppInstance and all associated data asynchronously.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/delete-app-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceArn | string | yes | The ARN of the AppInstance . |

### Returns the full details of an AppInstanceAdmin .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/describe-app-instance-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceAdminArn | string | yes | The ARN of the AppInstanceAdmin . |
| appInstanceArn | string | yes | The ARN of the AppInstance . |

### Demotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot . This action does not delete the user.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/delete-app-instance-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceAdminArn | string | yes | The ARN of the AppInstance 's administrator. |
| appInstanceArn | string | yes | The ARN of the AppInstance . |

### The AppInstanceBot's information.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/describe-app-instance-bot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceBotArn | string | yes | The ARN of the AppInstanceBot . |

### Updates the name and metadata of an AppInstanceBot .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/update-app-instance-bot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceBotArn | string | yes | The ARN of the AppInstanceBot . |
| body | object | yes | JSON request body |

### Deletes an AppInstanceBot .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/delete-app-instance-bot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceBotArn | string | yes | The ARN of the AppInstanceBot being deleted. |

### Returns the full details of an AppInstanceUser .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/describe-app-instance-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the AppInstanceUser . |

### Updates the details of an AppInstanceUser . You can update names and metadata.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/update-app-instance-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the AppInstanceUser . |
| body | object | yes | JSON request body |

### Deletes an AppInstanceUser .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/delete-app-instance-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the user request being deleted. |

### Returns the full details of an AppInstanceUserEndpoint .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/describe-app-instance-user-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the AppInstanceUser . |
| endpointId | string | yes | The unique identifier of the AppInstanceUserEndpoint . |

### Updates the details of an AppInstanceUserEndpoint . You can update the name and AllowMessage values.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/update-app-instance-user-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the AppInstanceUser . |
| endpointId | string | yes | The unique identifier of the AppInstanceUserEndpoint . |
| body | object | yes | JSON request body |

### Deregisters an AppInstanceUserEndpoint .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/deregister-app-instance-user-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the AppInstanceUser . |
| endpointId | string | yes | The unique identifier of the AppInstanceUserEndpoint . |

### Gets the retention settings for an AppInstance .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/get-app-instance-retention-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceArn | string | yes | The ARN of the AppInstance . |

### Sets the amount of time in days that a given AppInstance retains data.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/put-app-instance-retention-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceArn | string | yes | The ARN of the AppInstance . |
| body | object | yes | JSON request body |

### Lists all AppInstanceBots created under a single AppInstance .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/list-app-instance-bots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| app-instance-arn | string | yes | The ARN of the AppInstance . |
| max-results | integer | no | The maximum number of requests to return. |
| next-token | string | no | The token passed by previous API calls until all requested bots are returned. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/list-app-instance-user-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the AppInstanceUser . |
| max-results | integer | no | The maximum number of endpoints that you want to return. |
| next-token | string | no | The token passed by previous API calls until all requested endpoints are returned. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Registers an endpoint under an Amazon Chime AppInstanceUser . The endpoint receives messages for a user. For…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/register-app-instance-user-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the AppInstanceUser . |
| body | object | yes | JSON request body |

### List all AppInstanceUsers created under a single AppInstance .
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/list-app-instance-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| app-instance-arn | string | yes | The ARN of the AppInstance . |
| max-results | integer | no | The maximum number of requests that you want returned. |
| next-token | string | no | The token passed by previous API calls until all requested users are returned. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Lists the tags applied to an Amazon Chime SDK identity resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | The ARN of the resource. |

### Sets the number of days before the AppInstanceUser is automatically deleted. A background process deletes…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/put-app-instance-user-expiration-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| appInstanceUserArn | string | yes | The ARN of the AppInstanceUser . |
| body | object | yes | JSON request body |

### Applies the specified tags to the specified Amazon Chime SDK identity resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| operation | string | yes |  |
| body | object | yes | JSON request body |

### Removes the specified tags from the specified Amazon Chime SDK identity resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| operation | string | yes |  |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/list-app-instances" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon Chime SDK Identity API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:amazonaws-chime-sdk-identity/list-app-instances with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon Chime SDK Identity API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Chime SDK Identity itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon Chime SDK Identity API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-chime-sdk-identity.

### What is the status of the Amazon Chime SDK Identity API?
Needs your own provider key (bring your own key)