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



Get information about the connection with the provided id.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


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


--connection-id (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.

See 'aws help' for descriptions of global parameters.


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= \


    "ConnectedAt": "2020-04-30T20:10:33.236Z",
    "Identity": {
        "SourceIp": ""
    "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.


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.