[ aws . chime-sdk-identity ]

register-app-instance-user-endpoint

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  register-app-instance-user-endpoint
--app-instance-user-arn <value>
[--name <value>]
--type <value>
--resource-arn <value>
--endpoint-attributes <value>
[--client-request-token <value>]
[--allow-messages <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-instance-user-arn (string)

The ARN of the AppInstanceUser .

--name (string)

The name of the AppInstanceUserEndpoint .

--type (string)

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 .

Possible values:

• APNS

• APNS_SANDBOX

• GCM

--resource-arn (string)

The ARN of the resource to which the endpoint belongs.

--endpoint-attributes (structure)

The attributes of an Endpoint .

DeviceToken -> (string)

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.

Shorthand Syntax:

DeviceToken=string,VoipDeviceToken=string

JSON Syntax:

{
  "DeviceToken": "string",
  "VoipDeviceToken": "string"
}

--client-request-token (string)

The idempotency token for each client request.

--allow-messages (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.

Possible values:

• ALL

• NONE

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

AppInstanceUserArn -> (string)

The ARN of the AppInstanceUser .

EndpointId -> (string)

The unique identifier of the AppInstanceUserEndpoint .