AWS SDK for JavaScript Vpc Lattice Client for Node.js, Browser and React Native
npm install @aws-sdk/client-vpc-latticeAWS SDK for JavaScript VPCLattice Client for Node.js, Browser and React Native.
Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide
npm install @aws-sdk/client-vpc-latticeyarn add @aws-sdk/client-vpc-latticepnpm add @aws-sdk/client-vpc-latticeThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the VPCLatticeClient and
the commands you need, for example ListServicesCommand:
``js`
// ES5 example
const { VPCLatticeClient, ListServicesCommand } = require("@aws-sdk/client-vpc-lattice");
`ts`
// ES6+ example
import { VPCLatticeClient, ListServicesCommand } from "@aws-sdk/client-vpc-lattice";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new VPCLatticeClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListServicesCommand(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-vpc-lattice";
const client = new AWS.VPCLattice({ region: "REGION" });
// async/await.
try {
const data = await client.listServices(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listServices(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listServices(params, (err, data) => {
// process err and data.
});
`
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;
* }
*/
}
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.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-vpc-lattice` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
BatchUpdateRule
Command API Reference / Input / Output
CreateAccessLogSubscription
Command API Reference / Input / Output
CreateListener
Command API Reference / Input / Output
CreateResourceConfiguration
Command API Reference / Input / Output
CreateResourceGateway
Command API Reference / Input / Output
CreateRule
Command API Reference / Input / Output
CreateService
Command API Reference / Input / Output
CreateServiceNetwork
Command API Reference / Input / Output
CreateServiceNetworkResourceAssociation
Command API Reference / Input / Output
CreateServiceNetworkServiceAssociation
Command API Reference / Input / Output
CreateServiceNetworkVpcAssociation
Command API Reference / Input / Output
CreateTargetGroup
Command API Reference / Input / Output
DeleteAccessLogSubscription
Command API Reference / Input / Output
DeleteAuthPolicy
Command API Reference / Input / Output
DeleteDomainVerification
Command API Reference / Input / Output
DeleteListener
Command API Reference / Input / Output
DeleteResourceConfiguration
Command API Reference / Input / Output
DeleteResourceEndpointAssociation
Command API Reference / Input / Output
DeleteResourceGateway
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeleteRule
Command API Reference / Input / Output
DeleteService
Command API Reference / Input / Output
DeleteServiceNetwork
Command API Reference / Input / Output
DeleteServiceNetworkResourceAssociation
Command API Reference / Input / Output
DeleteServiceNetworkServiceAssociation
Command API Reference / Input / Output
DeleteServiceNetworkVpcAssociation
Command API Reference / Input / Output
DeleteTargetGroup
Command API Reference / Input / Output
DeregisterTargets
Command API Reference / Input / Output
GetAccessLogSubscription
Command API Reference / Input / Output
GetAuthPolicy
Command API Reference / Input / Output
GetDomainVerification
Command API Reference / Input / Output
GetListener
Command API Reference / Input / Output
GetResourceConfiguration
Command API Reference / Input / Output
GetResourceGateway
Command API Reference / Input / Output
GetResourcePolicy
Command API Reference / Input / Output
GetRule
Command API Reference / Input / Output
GetService
Command API Reference / Input / Output
GetServiceNetwork
Command API Reference / Input / Output
GetServiceNetworkResourceAssociation
Command API Reference / Input / Output
GetServiceNetworkServiceAssociation
Command API Reference / Input / Output
GetServiceNetworkVpcAssociation
Command API Reference / Input / Output
GetTargetGroup
Command API Reference / Input / Output
ListAccessLogSubscriptions
Command API Reference / Input / Output
ListDomainVerifications
Command API Reference / Input / Output
ListListeners
Command API Reference / Input / Output
ListResourceConfigurations
Command API Reference / Input / Output
ListResourceEndpointAssociations
Command API Reference / Input / Output
ListResourceGateways
Command API Reference / Input / Output
ListRules
Command API Reference / Input / Output
ListServiceNetworkResourceAssociations
Command API Reference / Input / Output
ListServiceNetworks
Command API Reference / Input / Output
ListServiceNetworkServiceAssociations
Command API Reference / Input / Output
ListServiceNetworkVpcAssociations
Command API Reference / Input / Output
ListServiceNetworkVpcEndpointAssociations
Command API Reference / Input / Output
ListServices
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListTargetGroups
Command API Reference / Input / Output
ListTargets
Command API Reference / Input / Output
PutAuthPolicy
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
RegisterTargets
Command API Reference / Input / Output
StartDomainVerification
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateAccessLogSubscription
Command API Reference / Input / Output
UpdateListener
Command API Reference / Input / Output
UpdateResourceConfiguration
Command API Reference / Input / Output
UpdateResourceGateway
Command API Reference / Input / Output
UpdateRule
Command API Reference / Input / Output
UpdateService
Command API Reference / Input / Output
UpdateServiceNetwork
Command API Reference / Input / Output
UpdateServiceNetworkVpcAssociation
Command API Reference / Input / Output
UpdateTargetGroup