AWS.DevOpsGuru — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.DevOpsGuru

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using DevOpsGuru

var devopsguru = new AWS.DevOpsGuru();
devopsguru.addNotificationChannel(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DevOpsGuru object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var devopsguru = new AWS.DevOpsGuru({apiVersion: '2020-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the devopsguru service identifier:

AWS.config.apiVersions = {
  devopsguru: '2020-12-01',
  // other service API versions
};

var devopsguru = new AWS.DevOpsGuru();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DevOpsGuru(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

addNotificationChannel(params = {}, callback) ⇒ AWS.Request

Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics.

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.

deleteInsight(params = {}, callback) ⇒ AWS.Request

Deletes the insight along with the associated anomalies, events and recommendations.

describeAccountHealth(params = {}, callback) ⇒ AWS.Request

Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account.

describeAccountOverview(params = {}, callback) ⇒ AWS.Request

For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.

describeAnomaly(params = {}, callback) ⇒ AWS.Request

Returns details about an anomaly that you specify using its ID.

describeEventSourcesConfig(params = {}, callback) ⇒ AWS.Request

Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.

describeFeedback(params = {}, callback) ⇒ AWS.Request

Returns the most recent feedback submitted in the current Amazon Web Services account and Region.

describeInsight(params = {}, callback) ⇒ AWS.Request

Returns details about an insight that you specify using its ID.

describeOrganizationHealth(params = {}, callback) ⇒ AWS.Request

Returns active insights, predictive insights, and resource hours analyzed in last hour.

describeOrganizationOverview(params = {}, callback) ⇒ AWS.Request

Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.

describeOrganizationResourceCollectionHealth(params = {}, callback) ⇒ AWS.Request

Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field.

describeResourceCollectionHealth(params = {}, callback) ⇒ AWS.Request

Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

describeServiceIntegration(params = {}, callback) ⇒ AWS.Request

Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

getCostEstimation(params = {}, callback) ⇒ AWS.Request

getResourceCollection(params = {}, callback) ⇒ AWS.Request

Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

listAnomaliesForInsight(params = {}, callback) ⇒ AWS.Request

Returns a list of the anomalies that belong to an insight that you specify using its ID.

listAnomalousLogGroups(params = {}, callback) ⇒ AWS.Request

Returns the list of log groups that contain log anomalies.

listEvents(params = {}, callback) ⇒ AWS.Request

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

listInsights(params = {}, callback) ⇒ AWS.Request

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).

listMonitoredResources(params = {}, callback) ⇒ AWS.Request

Returns the list of all log groups that are being monitored and tagged by DevOps Guru.

listNotificationChannels(params = {}, callback) ⇒ AWS.Request

Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

listOrganizationInsights(params = {}, callback) ⇒ AWS.Request

Returns a list of insights associated with the account or OU Id.

listRecommendations(params = {}, callback) ⇒ AWS.Request

Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

putFeedback(params = {}, callback) ⇒ AWS.Request

Collects customer feedback about the specified insight.

removeNotificationChannel(params = {}, callback) ⇒ AWS.Request

Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations.

searchInsights(params = {}, callback) ⇒ AWS.Request

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING or CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

searchOrganizationInsights(params = {}, callback) ⇒ AWS.Request

Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

startCostEstimation(params = {}, callback) ⇒ AWS.Request

Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.

updateEventSourcesConfig(params = {}, callback) ⇒ AWS.Request

Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.

updateResourceCollection(params = {}, callback) ⇒ AWS.Request

Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

updateServiceIntegration(params = {}, callback) ⇒ AWS.Request

Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.