[ aws . chime-sdk-identity ]

list-app-instance-user-endpoints

Description

Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-app-instance-user-endpoints
--app-instance-user-arn <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

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

The ARN of the AppInstanceUser .

--max-results (integer)

The maximum number of endpoints that you want to return.

--next-token (string)

The token passed by previous API calls until all requested endpoints are returned.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

AppInstanceUserEndpoints -> (list)

The information for each requested AppInstanceUserEndpoint .

(structure)

Summary of the details of an AppInstanceUserEndpoint .

AppInstanceUserArn -> (string)

The ARN of the AppInstanceUser .

EndpointId -> (string)

The unique identifier of the AppInstanceUserEndpoint .

Name -> (string)

The name of the AppInstanceUserEndpoint .

Type -> (string)

The type of the AppInstanceUserEndpoint .

AllowMessages -> (string)

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

EndpointState -> (structure)

A read-only field that represent the state of an AppInstanceUserEndpoint .

Status -> (string)

Enum that indicates the Status of an AppInstanceUserEndpoint .

StatusReason -> (string)

The reason for the EndpointStatus .

NextToken -> (string)

The token passed by previous API calls until all requested endpoints are returned.