RegisterAppInstanceUserEndpoint - Amazon Chime SDK

RegisterAppInstanceUserEndpoint

Registers an endpoint under an Amazon Chime AppInstanceUser. 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.

Request Syntax

POST /app-instance-users/appInstanceUserArn/endpoints HTTP/1.1 Content-type: application/json { "AllowMessages": "string", "ClientRequestToken": "string", "EndpointAttributes": { "DeviceToken": "string", "VoipDeviceToken": "string" }, "Name": "string", "ResourceArn": "string", "Type": "string" }

URI Request Parameters

The request uses the following URI parameters.

appInstanceUserArn

The ARN of the AppInstanceUser.

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

Request Body

The request accepts the following data in JSON format.

AllowMessages

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

Type: String

Valid Values: ALL | NONE

Required: No

ClientRequestToken

The idempotency token for each client request.

Type: String

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

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

Required: Yes

EndpointAttributes

The attributes of an Endpoint.

Type: EndpointAttributes object

Required: Yes

Name

The name of the AppInstanceUserEndpoint.

Type: String

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

Pattern: .*

Required: No

ResourceArn

The ARN of the resource to which the endpoint belongs.

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

Type

The type of the AppInstanceUserEndpoint. Supported types:

  • APNS: The mobile notification service for an Apple device.

  • APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.

  • GCM: The mobile notification service for an Android device.

Populate the ResourceArn value of each type as PinpointAppArn.

Type: String

Valid Values: APNS | APNS_SANDBOX | GCM

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "AppInstanceUserArn": "string", "EndpointId": "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 ARN of the AppInstanceUser.

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}

EndpointId

The unique identifier of the AppInstanceUserEndpoint.

Type: String

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

Pattern: .*

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: