AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime ]

create-proxy-session

Description

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateProxySession , in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide .

See also: AWS API Documentation

Synopsis

  create-proxy-session
--voice-connector-id <value>
--participant-phone-numbers <value>
[--name <value>]
[--expiry-minutes <value>]
--capabilities <value>
[--number-selection-behavior <value>]
[--geo-match-level <value>]
[--geo-match-params <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--voice-connector-id (string)

The Amazon Chime voice connector ID.

--participant-phone-numbers (list)

The participant phone numbers.

(string)

Syntax:

"string" "string" ...

--name (string)

The name of the proxy session.

--expiry-minutes (integer)

The number of minutes allowed for the proxy session.

--capabilities (list)

The proxy session capabilities.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Voice
  SMS

--number-selection-behavior (string)

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

Possible values:

  • PreferSticky
  • AvoidSticky

--geo-match-level (string)

The preference for matching the country or area code of the proxy phone number with that of the first participant.

Possible values:

  • Country
  • AreaCode

--geo-match-params (structure)

The country and area code for the proxy phone number.

Country -> (string)

The country.

AreaCode -> (string)

The area code.

Shorthand Syntax:

Country=string,AreaCode=string

JSON Syntax:

{
  "Country": "string",
  "AreaCode": "string"
}

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a proxy session

The following create-proxy-session example creates a proxy session with voice and SMS capabilities.

aws chime create-proxy-session \
    --voice-connector-id abcdef1ghij2klmno3pqr4 \
    --participant-phone-numbers "+14015550101" "+12065550100" \
    --capabilities "Voice" "SMS"

Output:

{
    "ProxySession": {
        "VoiceConnectorId": "abcdef1ghij2klmno3pqr4",
        "ProxySessionId": "123a4bc5-67d8-901e-2f3g-h4ghjk56789l",
        "Status": "Open",
        "ExpiryMinutes": 60,
        "Capabilities": [
            "SMS",
            "Voice"
        ],
        "CreatedTimestamp": "2020-04-15T16:10:10.288Z",
        "UpdatedTimestamp": "2020-04-15T16:10:10.288Z",
        "Participants": [
            {
                "PhoneNumber": "+12065550100",
                "ProxyPhoneNumber": "+19135550199"
            },
            {
                "PhoneNumber": "+14015550101",
                "ProxyPhoneNumber": "+19135550199"
            }
        ]
    }
}

For more information, see Proxy Phone Sessions in the Amazon Chime Developer Guide.

Output

ProxySession -> (structure)

The proxy session details.

VoiceConnectorId -> (string)

The Amazon Chime voice connector ID.

ProxySessionId -> (string)

The proxy session ID.

Name -> (string)

The name of the proxy session.

Status -> (string)

The status of the proxy session.

ExpiryMinutes -> (integer)

The number of minutes allowed for the proxy session.

Capabilities -> (list)

The proxy session capabilities.

(string)

CreatedTimestamp -> (timestamp)

The created time stamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated time stamp, in ISO 8601 format.

EndedTimestamp -> (timestamp)

The ended time stamp, in ISO 8601 format.

Participants -> (list)

The proxy session participants.

(structure)

The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

PhoneNumber -> (string)

The participant's phone number.

ProxyPhoneNumber -> (string)

The participant's proxy phone number.

NumberSelectionBehavior -> (string)

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

GeoMatchLevel -> (string)

The preference for matching the country or area code of the proxy phone number with that of the first participant.

GeoMatchParams -> (structure)

The country and area code for the proxy phone number.

Country -> (string)

The country.

AreaCode -> (string)

The area code.