Class: AWS.ApiGatewayManagementApi
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.ApiGatewayManagementApi
- Identifier:
- apigatewaymanagementapi
- API Version:
- 2018-11-29
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://`[api-id].execute-api.[region].amazonaws.com/[stage]`, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.
Sending a Request Using ApiGatewayManagementApi
var apigatewaymanagementapi = new AWS.ApiGatewayManagementApi();
apigatewaymanagementapi.deleteConnection(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the ApiGatewayManagementApi object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var apigatewaymanagementapi = new AWS.ApiGatewayManagementApi({apiVersion: '2018-11-29'});
You can also set the API version globally in AWS.config.apiVersions
using
the apigatewaymanagementapi service identifier:
AWS.config.apiVersions = {
apigatewaymanagementapi: '2018-11-29',
// other service API versions
};
var apigatewaymanagementapi = new AWS.ApiGatewayManagementApi();
Constructor Summary collapse
-
new AWS.ApiGatewayManagementApi(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
deleteConnection(params = {}, callback) ⇒ AWS.Request
Delete the connection with the provided id.
.
-
getConnection(params = {}, callback) ⇒ AWS.Request
Get information about the connection with the provided id.
.
-
postToConnection(params = {}, callback) ⇒ AWS.Request
Sends the provided data to the specified connection.
.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.ApiGatewayManagementApi(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.