@aws-sdk/client-synthetics

Description

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

Amazon CloudWatch Synthetics

You can use Amazon CloudWatch Synthetics to continually monitor your services. You can
create and manage canaries, which are modular, lightweight scripts
that monitor your endpoints and APIs
from the outside-in. You can set up your canaries to run
24 hours a day, once per minute. The canaries help you check the availability and latency
of your web services and troubleshoot anomalies by investigating load time data,
screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch
ServiceLens to help you trace the causes of impacted nodes in your applications. For more
information, see Using ServiceLens to Monitor
the Health of Your Applications in the Amazon CloudWatch User
Guide.

Before you create and manage canaries, be aware of the security considerations. For more
information, see Security
Considerations for Synthetics Canaries.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { SyntheticsClient, ListGroupsCommand } = require("@aws-sdk/client-synthetics");
`

`ts
// ES6+ example
import { SyntheticsClient, ListGroupsCommand } from "@aws-sdk/client-synthetics";
`

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

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

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

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

// callbacks.
client.listGroups(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-synthetics` 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)

AssociateResource

Command API Reference / Input / Output

CreateCanary

Command API Reference / Input / Output

CreateGroup

Command API Reference / Input / Output

DeleteCanary

Command API Reference / Input / Output

DeleteGroup

Command API Reference / Input / Output

DescribeCanaries

Command API Reference / Input / Output

DescribeCanariesLastRun

Command API Reference / Input / Output

DescribeRuntimeVersions

Command API Reference / Input / Output

DisassociateResource

Command API Reference / Input / Output

GetCanary

Command API Reference / Input / Output

GetCanaryRuns

Command API Reference / Input / Output

GetGroup

Command API Reference / Input / Output

ListAssociatedGroups

Command API Reference / Input / Output

ListGroupResources

Command API Reference / Input / Output

ListGroups

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

StartCanary

Command API Reference / Input / Output

StartCanaryDryRun

Command API Reference / Input / Output

StopCanary

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateCanary

Command API Reference / Input / Output