/AWS1/CL_CHI=>REGISTERAPPINSTANCEUSERENDPT()
¶
About 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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_APPINSTANCEUSERARN
TYPE /AWS1/CHISENSITIVECHIMEARN
/AWS1/CHISENSITIVECHIMEARN
¶
The ARN of the
AppInstanceUser
.
IV_TYPE
TYPE /AWS1/CHIAPPINSTUSERENDPTTYPE
/AWS1/CHIAPPINSTUSERENDPTTYPE
¶
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 asPinpointAppArn
.
IV_RESOURCEARN
TYPE /AWS1/CHICHIMEARN
/AWS1/CHICHIMEARN
¶
The ARN of the resource to which the endpoint belongs.
IO_ENDPOINTATTRIBUTES
TYPE REF TO /AWS1/CL_CHIENDPOINTATTRIBUTES
/AWS1/CL_CHIENDPOINTATTRIBUTES
¶
The attributes of an
Endpoint
.
IV_CLIENTREQUESTTOKEN
TYPE /AWS1/CHICLIENTREQUESTTOKEN
/AWS1/CHICLIENTREQUESTTOKEN
¶
The unique ID assigned to the request. Use different tokens to register other endpoints.
Optional arguments:¶
IV_NAME
TYPE /AWS1/CHISENSITIVESTRING1600
/AWS1/CHISENSITIVESTRING1600
¶
The name of the
AppInstanceUserEndpoint
.
IV_ALLOWMESSAGES
TYPE /AWS1/CHIALLOWMESSAGES
/AWS1/CHIALLOWMESSAGES
¶
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.