@aws-sdk/client-devops-guru

Description

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

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in
business critical operational applications. You specify the Amazon Web Services resources that you
want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those
resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an
insight that includes recommendations, related events, and
related metrics that can help you improve your operational applications. For more
information, see What is Amazon DevOps Guru.

You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight
is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each
insight to help you manage and track your work addressing insights.

To learn about the DevOps Guru workflow, see How DevOps Guru works. To
learn about DevOps Guru concepts, see Concepts in DevOps Guru.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { DevOpsGuruClient, ListEventsCommand } = require("@aws-sdk/client-devops-guru");
`

`ts
// ES6+ example
import { DevOpsGuruClient, ListEventsCommand } from "@aws-sdk/client-devops-guru";
`

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

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

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

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

// callbacks.
client.listEvents(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-devops-guru` 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)

AddNotificationChannel

Command API Reference / Input / Output

DeleteInsight

Command API Reference / Input / Output

DescribeAccountHealth

Command API Reference / Input / Output

DescribeAccountOverview

Command API Reference / Input / Output

DescribeAnomaly

Command API Reference / Input / Output

DescribeEventSourcesConfig

Command API Reference / Input / Output

DescribeFeedback

Command API Reference / Input / Output

DescribeInsight

Command API Reference / Input / Output

DescribeOrganizationHealth

Command API Reference / Input / Output

DescribeOrganizationOverview

Command API Reference / Input / Output

DescribeOrganizationResourceCollectionHealth

Command API Reference / Input / Output

DescribeResourceCollectionHealth

Command API Reference / Input / Output

DescribeServiceIntegration

Command API Reference / Input / Output

GetCostEstimation

Command API Reference / Input / Output

GetResourceCollection

Command API Reference / Input / Output

ListAnomaliesForInsight

Command API Reference / Input / Output

ListAnomalousLogGroups

Command API Reference / Input / Output

ListEvents

Command API Reference / Input / Output

ListInsights

Command API Reference / Input / Output

ListMonitoredResources

Command API Reference / Input / Output

ListNotificationChannels

Command API Reference / Input / Output

ListOrganizationInsights

Command API Reference / Input / Output

ListRecommendations

Command API Reference / Input / Output

PutFeedback

Command API Reference / Input / Output

RemoveNotificationChannel

Command API Reference / Input / Output

SearchInsights

Command API Reference / Input / Output

SearchOrganizationInsights

Command API Reference / Input / Output

StartCostEstimation

Command API Reference / Input / Output

UpdateEventSourcesConfig

Command API Reference / Input / Output

UpdateResourceCollection

Command API Reference / Input / Output

UpdateServiceIntegration

Command API Reference / Input / Output