[ aws . apigatewaymanagementapi ]

get-connection

Description

Get information about the connection with the provided id.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-connection
--connection-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--connection-id (string)

--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 get information about a WebSocket connection

The following get-connection example describes a connection to the specified WebSocket API.

aws apigatewaymanagementapi get-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

Output:

{
    "ConnectedAt": "2020-04-30T20:10:33.236Z",
    "Identity": {
        "SourceIp": "192.0.2.1"
    },
    "LastActiveAt": "2020-04-30T20:10:42.997Z"
}

For more information, see Use @connections commands in your backend service in the Amazon API Gateway Developer Guide.

Output

ConnectedAt -> (timestamp)

The time in ISO 8601 format for when the connection was established.

Identity -> (structure)

SourceIp -> (string)

The source IP address of the TCP connection making the request to API Gateway.

UserAgent -> (string)

The User Agent of the API caller.

LastActiveAt -> (timestamp)

The time in ISO 8601 format for when the connection was last active.