[ aws . chime ]

get-phone-number-settings

Description

Retrieves the phone number settings for the administrator’s AWS account, such as the default outbound calling name.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--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 an outbound calling name

The following get-phone-number-settings example retrieves the default outbound calling name for the calling user’s AWS account.

aws chime get-phone-number-settings

This command produces no output. Output:

{
    "CallingName": "myName",
    "CallingNameUpdatedTimestamp": "2019-10-28T18:56:42.911Z"
}

For more information, see Working with Phone Numbers in the Amazon Chime Administration Guide.

Output

CallingName -> (string)

The default outbound calling name for the account.

CallingNameUpdatedTimestamp -> (timestamp)

The updated outbound calling name timestamp, in ISO 8601 format.