[ aws . chime ]

get-voice-connector-termination-health

Description

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-voice-connector-termination-health
--voice-connector-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--voice-connector-id (string)

The Amazon Chime Voice Connector 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.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve termination health details

The following get-voice-connector-termination-health example retrieves the termination health details for the specified Amazon Chime Voice Connector.

aws chime get-voice-connector-termination-health \
    --voice-connector-id abcdef1ghij2klmno3pqr4

Output:

{
    "TerminationHealth": {
        "Timestamp": "Fri Aug 23 16:45:55 UTC 2019",
        "Source": "10.24.34.0"
    }
}

For more information, see Working with Amazon Chime Voice Connectors in the Amazon Chime Administration Guide.

Output

TerminationHealth -> (structure)

The termination health details.

Timestamp -> (timestamp)

The timestamp, in ISO 8601 format.

Source -> (string)

The source IP address.