Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . chime ]

update-user-settings

Description

Updates the settings for the specified user, such as phone number settings.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-user-settings
--account-id <value>
--user-id <value>
--user-settings <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The Amazon Chime account ID.

--user-id (string)

The user ID.

--user-settings (structure)

The user settings to update.

Shorthand Syntax:

Telephony={InboundCalling=boolean,OutboundCalling=boolean,SMS=boolean}

JSON Syntax:

{
  "Telephony": {
    "InboundCalling": true|false,
    "OutboundCalling": true|false,
    "SMS": true|false
  }
}

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

See 'aws help' for descriptions of global parameters.

Examples

To update user settings

The following update-user-settings example enables the specified user to make inbound and outbound calls and send and receive SMS messages.

aws chime update-user-settings \
    --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \
    --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \
    --user-settings "Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}"

This command produces no output.

For more information, see Managing User Phone Numbers in the Amazon Chime Administration Guide.

Output

None