Client: Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient

Service ID: apigatewaymanagementapi

Version: 2018-11-29

This page describes the parameters and results for the operations of the AmazonApiGatewayManagementApi (2018-11-29), and shows how to use the Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient object to call the described operations. This documentation is specific to the 2018-11-29 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DeleteConnection ( array $params = [] )

Delete the connection with the provided id.

GetConnection ( array $params = [] )

Get information about the connection with the provided id.

PostToConnection ( array $params = [] )

Sends the provided data to the specified connection.

$result = $client->deleteConnection([/* ... */]);
$promise = $client->deleteConnectionAsync([/* ... */]);

$result = $client->deleteConnection([
    'ConnectionId' => '<string>', // REQUIRED
]);

[]

$result = $client->getConnection([/* ... */]);
$promise = $client->getConnectionAsync([/* ... */]);

$result = $client->getConnection([
    'ConnectionId' => '<string>', // REQUIRED
]);

[
    'ConnectedAt' => <DateTime>,
    'Identity' => [
        'SourceIp' => '<string>',
        'UserAgent' => '<string>',
    ],
    'LastActiveAt' => <DateTime>,
]

$result = $client->postToConnection([/* ... */]);
$promise = $client->postToConnectionAsync([/* ... */]);

$result = $client->postToConnection([
    'ConnectionId' => '<string>', // REQUIRED
    'Data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
]);

[]