@aws-sdk/client-apigatewayv2

Description

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

Amazon API Gateway V2

Installing

To install this package, simply type add or install @aws-sdk/client-apigatewayv2
using your favorite package manager:
- npm install @aws-sdk/client-apigatewayv2
- yarn add @aws-sdk/client-apigatewayv2
- pnpm add @aws-sdk/client-apigatewayv2

Getting Started

$3

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

``js
// ES5 example
const { ApiGatewayV2Client, ListPortalsCommand } = require("@aws-sdk/client-apigatewayv2");
`

`ts
// ES6+ example
import { ApiGatewayV2Client, ListPortalsCommand } from "@aws-sdk/client-apigatewayv2";
`

$3

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.

`js
// a client can be shared by different commands.
const client = new ApiGatewayV2Client({ region: "REGION" });

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

#### Async/await

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

`js
// 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.

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

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

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

`js
// 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

`ts
import * as AWS from "@aws-sdk/client-apigatewayv2";
const client = new AWS.ApiGatewayV2({ region: "REGION" });

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

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

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

$3

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

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

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

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-apigatewayv2` 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)

CreateApi

Command API Reference / Input / Output

CreateApiMapping

Command API Reference / Input / Output

CreateAuthorizer

Command API Reference / Input / Output

CreateDeployment

Command API Reference / Input / Output

CreateDomainName

Command API Reference / Input / Output

CreateIntegration

Command API Reference / Input / Output

CreateIntegrationResponse

Command API Reference / Input / Output

CreateModel

Command API Reference / Input / Output

CreatePortal

Command API Reference / Input / Output

CreatePortalProduct

Command API Reference / Input / Output

CreateProductPage

Command API Reference / Input / Output

CreateProductRestEndpointPage

Command API Reference / Input / Output

CreateRoute

Command API Reference / Input / Output

CreateRouteResponse

Command API Reference / Input / Output

CreateRoutingRule

Command API Reference / Input / Output

CreateStage

Command API Reference / Input / Output

CreateVpcLink

Command API Reference / Input / Output

DeleteAccessLogSettings

Command API Reference / Input / Output

DeleteApi

Command API Reference / Input / Output

DeleteApiMapping

Command API Reference / Input / Output

DeleteAuthorizer

Command API Reference / Input / Output

DeleteCorsConfiguration

Command API Reference / Input / Output

DeleteDeployment

Command API Reference / Input / Output

DeleteDomainName

Command API Reference / Input / Output

DeleteIntegration

Command API Reference / Input / Output

DeleteIntegrationResponse

Command API Reference / Input / Output

DeleteModel

Command API Reference / Input / Output

DeletePortal

Command API Reference / Input / Output

DeletePortalProduct

Command API Reference / Input / Output

DeletePortalProductSharingPolicy

Command API Reference / Input / Output

DeleteProductPage

Command API Reference / Input / Output

DeleteProductRestEndpointPage

Command API Reference / Input / Output

DeleteRoute

Command API Reference / Input / Output

DeleteRouteRequestParameter

Command API Reference / Input / Output

DeleteRouteResponse

Command API Reference / Input / Output

DeleteRouteSettings

Command API Reference / Input / Output

DeleteRoutingRule

Command API Reference / Input / Output

DeleteStage

Command API Reference / Input / Output

DeleteVpcLink

Command API Reference / Input / Output

DisablePortal

Command API Reference / Input / Output

ExportApi

Command API Reference / Input / Output

GetApi

Command API Reference / Input / Output

GetApiMapping

Command API Reference / Input / Output

GetApiMappings

Command API Reference / Input / Output

GetApis

Command API Reference / Input / Output

GetAuthorizer

Command API Reference / Input / Output

GetAuthorizers

Command API Reference / Input / Output

GetDeployment

Command API Reference / Input / Output

GetDeployments

Command API Reference / Input / Output

GetDomainName

Command API Reference / Input / Output

GetDomainNames

Command API Reference / Input / Output

GetIntegration

Command API Reference / Input / Output

GetIntegrationResponse

Command API Reference / Input / Output

GetIntegrationResponses

Command API Reference / Input / Output

GetIntegrations

Command API Reference / Input / Output

GetModel

Command API Reference / Input / Output

GetModels

Command API Reference / Input / Output

GetModelTemplate

Command API Reference / Input / Output

GetPortal

Command API Reference / Input / Output

GetPortalProduct

Command API Reference / Input / Output

GetPortalProductSharingPolicy

Command API Reference / Input / Output

GetProductPage

Command API Reference / Input / Output

GetProductRestEndpointPage

Command API Reference / Input / Output

GetRoute

Command API Reference / Input / Output

GetRouteResponse

Command API Reference / Input / Output

GetRouteResponses

Command API Reference / Input / Output

GetRoutes

Command API Reference / Input / Output

GetRoutingRule

Command API Reference / Input / Output

GetStage

Command API Reference / Input / Output

GetStages

Command API Reference / Input / Output

GetTags

Command API Reference / Input / Output

GetVpcLink

Command API Reference / Input / Output

GetVpcLinks

Command API Reference / Input / Output

ImportApi

Command API Reference / Input / Output

ListPortalProducts

Command API Reference / Input / Output

ListPortals

Command API Reference / Input / Output

ListProductPages

Command API Reference / Input / Output

ListProductRestEndpointPages

Command API Reference / Input / Output

ListRoutingRules

Command API Reference / Input / Output

PreviewPortal

Command API Reference / Input / Output

PublishPortal

Command API Reference / Input / Output

PutPortalProductSharingPolicy

Command API Reference / Input / Output

PutRoutingRule

Command API Reference / Input / Output

ReimportApi

Command API Reference / Input / Output

ResetAuthorizersCache

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateApi

Command API Reference / Input / Output

UpdateApiMapping

Command API Reference / Input / Output

UpdateAuthorizer

Command API Reference / Input / Output

UpdateDeployment

Command API Reference / Input / Output

UpdateDomainName

Command API Reference / Input / Output

UpdateIntegration

Command API Reference / Input / Output

UpdateIntegrationResponse

Command API Reference / Input / Output

UpdateModel

Command API Reference / Input / Output

UpdatePortal

Command API Reference / Input / Output

UpdatePortalProduct

Command API Reference / Input / Output

UpdateProductPage

Command API Reference / Input / Output

UpdateProductRestEndpointPage

Command API Reference / Input / Output

UpdateRoute

Command API Reference / Input / Output

UpdateRouteResponse

Command API Reference / Input / Output

UpdateStage

Command API Reference / Input / Output

UpdateVpcLink

Command API Reference / Input / Output