[ aws . connect ]

claim-phone-number

Description

Claims an available phone number to your Amazon Connect instance.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  claim-phone-number
--target-arn <value>
--phone-number <value>
[--phone-number-description <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--target-arn (string)

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

--phone-number (string)

The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code] .

--phone-number-description (string)

The description of the phone number.

--tags (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

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

See ‘aws help’ for descriptions of global parameters.

Output

PhoneNumberId -> (string)

A unique identifier for the phone number.

PhoneNumberArn -> (string)

The Amazon Resource Name (ARN) of the phone number.