Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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 ]

post-to-connection

Description

Sends the provided data to the specified connection.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--data (blob)

The data to be sent to the client specified by its connection id.

--connection-id (string)

The identifier of the connection that a specific client is using.

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

Examples

To send data to a WebSocket connection

The following post-to-connection example sends a message to a client that's connected to the specified WebSocket API.

aws apigatewaymanagementapi post-to-connection \
    --connection-id L0SM9cOFvHcCIhw= \
    --data "Hello from API Gateway!" \
    --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod

This command produces no output.

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

Output

None