[ aws . chime-sdk-identity ]

update-app-instance-user-endpoint

Description

Updates the details of an AppInstanceUserEndpoint . You can update the name and AllowMessage values.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-app-instance-user-endpoint
--app-instance-user-arn <value>
--endpoint-id <value>
[--name <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 .

--endpoint-id (string)

The unique identifier of the AppInstanceUserEndpoint .

--name (string)

The name of the AppInstanceUserEndpoint .

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

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 .