AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime-sdk-identity ]

describe-app-instance-user-endpoint

Description

Returns the full details of an AppInstanceUserEndpoint .

See also: AWS API Documentation

Synopsis

  describe-app-instance-user-endpoint
--app-instance-user-arn <value>
--endpoint-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

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

The ARN of the AppInstanceUser .

--endpoint-id (string)

The unique identifier of the AppInstanceUserEndpoint .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

AppInstanceUserEndpoint -> (structure)

The full details of an AppInstanceUserEndpoint : the AppInstanceUserArn , ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.

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 .

ResourceArn -> (string)

The ARN of the resource to which the endpoint belongs.

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

CreatedTimestamp -> (timestamp)

The time at which an AppInstanceUserEndpoint was created.

LastUpdatedTimestamp -> (timestamp)

The time at which an AppInstanceUserEndpoint was last updated.

AllowMessages -> (string)

Boolean 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 represents the state of an AppInstanceUserEndpoint . Supported values:

  • ACTIVE : The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE , the EndpointStatusReason remains empty.
  • INACTIVE : The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE , the corresponding reason will be conveyed through EndpointStatusReason .
  • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
  • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

Status -> (string)

Enum that indicates the Status of an AppInstanceUserEndpoint .

StatusReason -> (string)

The reason for the EndpointStatus .