@aws-sdk/client-app-mesh

Description

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

App Mesh is a service mesh based on the Envoy proxy that makes it easy to
monitor and control microservices. App Mesh standardizes how your microservices
communicate, giving you end-to-end visibility and helping to ensure high availability for
your applications.

App Mesh gives you consistent visibility and network traffic controls for
every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and
Amazon EC2.

App Mesh supports microservice applications that use service discovery
naming for their components. For more information about service discovery on Amazon ECS, see Service
Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes
kube-dns and coredns are supported. For more information,
see DNS
for Services and Pods in the Kubernetes documentation.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { AppMeshClient, ListMeshesCommand } = require("@aws-sdk/client-app-mesh");
`

`ts
// ES6+ example
import { AppMeshClient, ListMeshesCommand } from "@aws-sdk/client-app-mesh";
`

$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 AppMeshClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListMeshesCommand(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-app-mesh";
const client = new AWS.AppMesh({ region: "REGION" });

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

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

// callbacks.
client.listMeshes(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-app-mesh` 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)

CreateGatewayRoute

Command API Reference / Input / Output

CreateMesh

Command API Reference / Input / Output

CreateRoute

Command API Reference / Input / Output

CreateVirtualGateway

Command API Reference / Input / Output

CreateVirtualNode

Command API Reference / Input / Output

CreateVirtualRouter

Command API Reference / Input / Output

CreateVirtualService

Command API Reference / Input / Output

DeleteGatewayRoute

Command API Reference / Input / Output

DeleteMesh

Command API Reference / Input / Output

DeleteRoute

Command API Reference / Input / Output

DeleteVirtualGateway

Command API Reference / Input / Output

DeleteVirtualNode

Command API Reference / Input / Output

DeleteVirtualRouter

Command API Reference / Input / Output

DeleteVirtualService

Command API Reference / Input / Output

DescribeGatewayRoute

Command API Reference / Input / Output

DescribeMesh

Command API Reference / Input / Output

DescribeRoute

Command API Reference / Input / Output

DescribeVirtualGateway

Command API Reference / Input / Output

DescribeVirtualNode

Command API Reference / Input / Output

DescribeVirtualRouter

Command API Reference / Input / Output

DescribeVirtualService

Command API Reference / Input / Output

ListGatewayRoutes

Command API Reference / Input / Output

ListMeshes

Command API Reference / Input / Output

ListRoutes

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListVirtualGateways

Command API Reference / Input / Output

ListVirtualNodes

Command API Reference / Input / Output

ListVirtualRouters

Command API Reference / Input / Output

ListVirtualServices

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateGatewayRoute

Command API Reference / Input / Output

UpdateMesh

Command API Reference / Input / Output

UpdateRoute

Command API Reference / Input / Output

UpdateVirtualGateway

Command API Reference / Input / Output

UpdateVirtualNode

Command API Reference / Input / Output

UpdateVirtualRouter

Command API Reference / Input / Output

UpdateVirtualService

Command API Reference / Input / Output