Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430120109.8 KB

Registers an endpoint under an Amazon Chime <code>AppInstanceUser</code>. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

post/app-instance-users/{appInstanceUserArn}/endpoints

Path parameters

appInstanceUserArnstring password required

The ARN of the <code>AppInstanceUser</code>.

Request body

Namestring password

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

Type'APNS' | 'APNS_SANDBOX' | 'GCM' required
<p>The type of the <code>AppInstanceUserEndpoint</code>. Supported types:</p> <ul> <li> <p> <code>APNS</code>: The mobile notification service for an Apple device.</p> </li> <li> <p> <code>APNS_SANDBOX</code>: The sandbox environment of the mobile notification service for an Apple device.</p> </li> <li> <p> <code>GCM</code>: The mobile notification service for an Android device.</p> </li> </ul> <p>Populate the <code>ResourceArn</code> value of each type as <code>PinpointAppArn</code>.</p>
ResourceArnstring required

The ARN of the resource to which the endpoint belongs.

ClientRequestTokenstring required

The unique ID assigned to the request. Use different tokens to register other endpoints.

AllowMessages'ALL' | 'NONE'

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. <code>ALL</code> indicates the endpoint receives all messages. <code>NONE</code> indicates the endpoint receives no messages.

Response

Success

AppInstanceUserArnstring

The ARN of the <code>AppInstanceUser</code>.

EndpointIdstring

The unique identifier of the <code>AppInstanceUserEndpoint</code>.