register_app_instance_user_endpoint

ChimeSDKIdentity.Client.register_app_instance_user_endpoint(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.register_app_instance_user_endpoint(
    AppInstanceUserArn='string',
    Name='string',
    Type='APNS'|'APNS_SANDBOX'|'GCM',
    ResourceArn='string',
    EndpointAttributes={
        'DeviceToken': 'string',
        'VoipDeviceToken': 'string'
    },
    ClientRequestToken='string',
    AllowMessages='ALL'|'NONE'
)

Parameters

• AppInstanceUserArn (string) --

  [REQUIRED]

  The ARN of the AppInstanceUser .

• Name (string) -- The name of the AppInstanceUserEndpoint .
• Type (string) --

  [REQUIRED]

  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 .

• ResourceArn (string) --

  [REQUIRED]

  The ARN of the resource to which the endpoint belongs.

• EndpointAttributes (dict) --

  [REQUIRED]

  The attributes of an Endpoint .

  • DeviceToken (string) -- [REQUIRED]

    The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.

  • VoipDeviceToken (string) --

    The VOIP device token for the APNS and APNS_SANDBOX endpoint types.

• ClientRequestToken (string) --

  [REQUIRED]

  The idempotency token for each client request.

  This field is autopopulated if not provided.

• AllowMessages (string) -- 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.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceUserArn': 'string',
    'EndpointId': 'string'
}

Response Structure

• (dict) --

  • AppInstanceUserArn (string) --

    The ARN of the AppInstanceUser .

  • EndpointId (string) --

    The unique identifier of the AppInstanceUserEndpoint .

Exceptions

• ChimeSDKIdentity.Client.exceptions.BadRequestException
• ChimeSDKIdentity.Client.exceptions.ConflictException
• ChimeSDKIdentity.Client.exceptions.ForbiddenException
• ChimeSDKIdentity.Client.exceptions.ResourceLimitExceededException
• ChimeSDKIdentity.Client.exceptions.ThrottledClientException
• ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
• ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
• ChimeSDKIdentity.Client.exceptions.ServiceFailureException