list-proxy-sessions¶

Description¶

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

Synopsis¶

  list-proxy-sessions
--voice-connector-id <value>
[--status <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--voice-connector-id (string)

The Amazon Chime voice connector ID.

--status (string)

The proxy session status.

Possible values:

Open

InProgress

Closed

--next-token (string)

The token to use to retrieve the next page of results.

--max-results (integer)

The maximum number of results to return in a single call.

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

Examples¶

To list proxy sessions

The following list-proxy-sessions example lists the proxy sessions for your Amazon Chime Voice Connector.

aws chime list-proxy-sessions \
    --voice-connector-id abcdef1ghij2klmno3pqr4

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¶

ProxySessions -> (list)

The proxy session details.

(structure)

The proxy session for an Amazon Chime Voice Connector.

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.

NextToken -> (string)