Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-api-gateway

@aws-sdk/client-api-gateway

Description

AWS SDK for JavaScript APIGateway Client for Node.js, Browser and React Native.

Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Installing

To install the this package, simply type add or install @aws-sdk/client-api-gateway using your favorite package manager:

  • npm install @aws-sdk/client-api-gateway
  • yarn add @aws-sdk/client-api-gateway
  • pnpm add @aws-sdk/client-api-gateway

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the APIGatewayClient and the commands you need, for example GetAccountCommand:

// ES5 example
const { APIGatewayClient, GetAccountCommand } = require("@aws-sdk/client-api-gateway");
// ES6+ example
import { APIGatewayClient, GetAccountCommand } from "@aws-sdk/client-api-gateway";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new APIGatewayClient({ region: "REGION" });

const params = {
/** input parameters */
};
const command = new GetAccountCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);

Promises can also be called using .catch() and .finally() as follows:

client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
// process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-api-gateway";
const client = new AWS.APIGateway({ region: "REGION" });

// async/await.
try {
const data = await client.getAccount(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.getAccount(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.getAccount(params, (err, data) => {
// process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-api-gateway package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CreateApiKey

Command API Reference / Input / Output

CreateAuthorizer

Command API Reference / Input / Output

CreateBasePathMapping

Command API Reference / Input / Output

CreateDeployment

Command API Reference / Input / Output

CreateDocumentationPart

Command API Reference / Input / Output

CreateDocumentationVersion

Command API Reference / Input / Output

CreateDomainName

Command API Reference / Input / Output

CreateModel

Command API Reference / Input / Output

CreateRequestValidator

Command API Reference / Input / Output

CreateResource

Command API Reference / Input / Output

CreateRestApi

Command API Reference / Input / Output

CreateStage

Command API Reference / Input / Output

CreateUsagePlan

Command API Reference / Input / Output

CreateUsagePlanKey

Command API Reference / Input / Output

CreateVpcLink

Command API Reference / Input / Output

DeleteApiKey

Command API Reference / Input / Output

DeleteAuthorizer

Command API Reference / Input / Output

DeleteBasePathMapping

Command API Reference / Input / Output

DeleteClientCertificate

Command API Reference / Input / Output

DeleteDeployment

Command API Reference / Input / Output

DeleteDocumentationPart

Command API Reference / Input / Output

DeleteDocumentationVersion

Command API Reference / Input / Output

DeleteDomainName

Command API Reference / Input / Output

DeleteGatewayResponse

Command API Reference / Input / Output

DeleteIntegration

Command API Reference / Input / Output

DeleteIntegrationResponse

Command API Reference / Input / Output

DeleteMethod

Command API Reference / Input / Output

DeleteMethodResponse

Command API Reference / Input / Output

DeleteModel

Command API Reference / Input / Output

DeleteRequestValidator

Command API Reference / Input / Output

DeleteResource

Command API Reference / Input / Output

DeleteRestApi

Command API Reference / Input / Output

DeleteStage

Command API Reference / Input / Output

DeleteUsagePlan

Command API Reference / Input / Output

DeleteUsagePlanKey

Command API Reference / Input / Output

DeleteVpcLink

Command API Reference / Input / Output

FlushStageAuthorizersCache

Command API Reference / Input / Output

FlushStageCache

Command API Reference / Input / Output

GenerateClientCertificate

Command API Reference / Input / Output

GetAccount

Command API Reference / Input / Output

GetApiKey

Command API Reference / Input / Output

GetApiKeys

Command API Reference / Input / Output

GetAuthorizer

Command API Reference / Input / Output

GetAuthorizers

Command API Reference / Input / Output

GetBasePathMapping

Command API Reference / Input / Output

GetBasePathMappings

Command API Reference / Input / Output

GetClientCertificate

Command API Reference / Input / Output

GetClientCertificates

Command API Reference / Input / Output

GetDeployment

Command API Reference / Input / Output

GetDeployments

Command API Reference / Input / Output

GetDocumentationPart

Command API Reference / Input / Output

GetDocumentationParts

Command API Reference / Input / Output

GetDocumentationVersion

Command API Reference / Input / Output

GetDocumentationVersions

Command API Reference / Input / Output

GetDomainName

Command API Reference / Input / Output

GetDomainNames

Command API Reference / Input / Output

GetExport

Command API Reference / Input / Output

GetGatewayResponse

Command API Reference / Input / Output

GetGatewayResponses

Command API Reference / Input / Output

GetIntegration

Command API Reference / Input / Output

GetIntegrationResponse

Command API Reference / Input / Output

GetMethod

Command API Reference / Input / Output

GetMethodResponse

Command API Reference / Input / Output

GetModel

Command API Reference / Input / Output

GetModels

Command API Reference / Input / Output

GetModelTemplate

Command API Reference / Input / Output

GetRequestValidator

Command API Reference / Input / Output

GetRequestValidators

Command API Reference / Input / Output

GetResource

Command API Reference / Input / Output

GetResources

Command API Reference / Input / Output

GetRestApi

Command API Reference / Input / Output

GetRestApis

Command API Reference / Input / Output

GetSdk

Command API Reference / Input / Output

GetSdkType

Command API Reference / Input / Output

GetSdkTypes

Command API Reference / Input / Output

GetStage

Command API Reference / Input / Output

GetStages

Command API Reference / Input / Output

GetTags

Command API Reference / Input / Output

GetUsage

Command API Reference / Input / Output

GetUsagePlan

Command API Reference / Input / Output

GetUsagePlanKey

Command API Reference / Input / Output

GetUsagePlanKeys

Command API Reference / Input / Output

GetUsagePlans

Command API Reference / Input / Output

GetVpcLink

Command API Reference / Input / Output

GetVpcLinks

Command API Reference / Input / Output

ImportApiKeys

Command API Reference / Input / Output

ImportDocumentationParts

Command API Reference / Input / Output

ImportRestApi

Command API Reference / Input / Output

PutGatewayResponse

Command API Reference / Input / Output

PutIntegration

Command API Reference / Input / Output

PutIntegrationResponse

Command API Reference / Input / Output

PutMethod

Command API Reference / Input / Output

PutMethodResponse

Command API Reference / Input / Output

PutRestApi

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

TestInvokeAuthorizer

Command API Reference / Input / Output

TestInvokeMethod

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAccount

Command API Reference / Input / Output

UpdateApiKey

Command API Reference / Input / Output

UpdateAuthorizer

Command API Reference / Input / Output

UpdateBasePathMapping

Command API Reference / Input / Output

UpdateClientCertificate

Command API Reference / Input / Output

UpdateDeployment

Command API Reference / Input / Output

UpdateDocumentationPart

Command API Reference / Input / Output

UpdateDocumentationVersion

Command API Reference / Input / Output

UpdateDomainName

Command API Reference / Input / Output

UpdateGatewayResponse

Command API Reference / Input / Output

UpdateIntegration

Command API Reference / Input / Output

UpdateIntegrationResponse

Command API Reference / Input / Output

UpdateMethod

Command API Reference / Input / Output

UpdateMethodResponse

Command API Reference / Input / Output

UpdateModel

Command API Reference / Input / Output

UpdateRequestValidator

Command API Reference / Input / Output

UpdateResource

Command API Reference / Input / Output

UpdateRestApi

Command API Reference / Input / Output

UpdateStage

Command API Reference / Input / Output

UpdateUsage

Command API Reference / Input / Output

UpdateUsagePlan

Command API Reference / Input / Output

UpdateVpcLink

Command API Reference / Input / Output