AWS.DevOpsGuru (aws-elixir v0.8.0) View Source

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications.

You specify the AWS resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and AWS 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 AWS 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.

Link to this section Summary

Functions

Adds a notification channel to DevOps Guru.

Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account.

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.

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

Returns the most recent feedback submitted in the current AWS account and Region.

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

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.

Returns the integration status of services that are integrated with DevOps Guru.

Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources.

Returns lists AWS resources that are of the specified resource collection type.

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

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru.

Returns a list of insights in your AWS account.

Returns a list of notification channels configured for DevOps Guru.

Returns a list of a specified insight's recommendations.

Collects customer feedback about the specified insight.

Removes a notification channel from DevOps Guru.

Returns a list of insights in your AWS account.

Starts the creation of an estimate of the monthly cost to analyze your AWS resources.

Updates the collection of resources that DevOps Guru analyzes.

Enables or disables integration with a service that can be integrated with DevOps Guru.

Link to this section Functions

Link to this function

add_notification_channel(client, input, options \\ [])

View Source

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 it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

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

Link to this function

describe_account_health(client, options \\ [])

View Source

Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account.

Use these numbers to gauge the health of operations in your AWS account.

Link to this function

describe_account_overview(client, input, options \\ [])

View Source

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.

Link to this function

describe_anomaly(client, id, options \\ [])

View Source

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

Link to this function

describe_feedback(client, input, options \\ [])

View Source

Returns the most recent feedback submitted in the current AWS account and Region.

Link to this function

describe_insight(client, id, options \\ [])

View Source

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

Link to this function

describe_resource_collection_health(client, resource_collection_type, next_token \\ nil, options \\ [])

View Source

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 AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

Link to this function

describe_service_integration(client, options \\ [])

View Source

Returns the integration status of services that are integrated with DevOps Guru.

The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.

Link to this function

get_cost_estimation(client, next_token \\ nil, options \\ [])

View Source

Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources.

For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

Link to this function

get_resource_collection(client, resource_collection_type, next_token \\ nil, options \\ [])

View Source

Returns lists AWS resources that are of the specified resource collection type.

The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

Link to this function

list_anomalies_for_insight(client, insight_id, input, options \\ [])

View Source

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

Link to this function

list_events(client, input, options \\ [])

View Source

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.

Link to this function

list_insights(client, input, options \\ [])

View Source

Returns a list of insights in your AWS account.

You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).

Link to this function

list_notification_channels(client, input, options \\ [])

View Source

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).

Link to this function

list_recommendations(client, input, options \\ [])

View Source

Returns a list of a specified insight's recommendations.

Each recommendation includes a list of related metrics and a list of related events.

Link to this function

put_feedback(client, input, options \\ [])

View Source

Collects customer feedback about the specified insight.

Link to this function

remove_notification_channel(client, id, input, options \\ [])

View Source

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.

Link to this function

search_insights(client, input, options \\ [])

View Source

Returns a list of insights in your AWS account.

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.

Link to this function

start_cost_estimation(client, input, options \\ [])

View Source

Starts the creation of an estimate of the monthly cost to analyze your AWS resources.

Link to this function

update_resource_collection(client, input, options \\ [])

View Source

Updates the collection of resources that DevOps Guru analyzes.

The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

Link to this function

update_service_integration(client, input, options \\ [])

View Source

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 AWS Systems Manager, which can be used to create an OpsItem for each generated insight.