[ aws . chime ]

get-account-settings

Description

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-account-settings
--account-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--account-id (string)

The Amazon Chime account ID.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve settings for an account

The following get-account-settings example retrieves the account settings for the specified account.

aws chime get-account-settings --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

Output:

{
    "AccountSettings": {
        "DisableRemoteControl": false,
        "EnableDialOut": false
    }
}

For more information, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Output

AccountSettings -> (structure)

The Amazon Chime account settings.

DisableRemoteControl -> (boolean)

Setting that stops or starts remote control of shared screens during meetings.

EnableDialOut -> (boolean)

Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App .