NAME
Paws::DevOpsGuru - Perl Interface to AWS Amazon DevOps Guru
SYNOPSIS
use Paws;
my $obj = Paws->service('DevOpsGuru');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html).
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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html#how-it-works). To learn about DevOps Guru concepts, see Concepts in DevOps Guru (https://docs.aws.amazon.com/devops-guru/latest/userguide/concepts.html).
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/devops-guru-2020-12-01
METHODS
AddNotificationChannel
Each argument is described in detail in: Paws::DevOpsGuru::AddNotificationChannel
Returns: a Paws::DevOpsGuru::AddNotificationChannelResponse instance
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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html).
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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).
DescribeAccountHealth
Each argument is described in detail in: Paws::DevOpsGuru::DescribeAccountHealth
Returns: a Paws::DevOpsGuru::DescribeAccountHealthResponse instance
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.
DescribeAccountOverview
Each argument is described in detail in: Paws::DevOpsGuru::DescribeAccountOverview
Returns: a Paws::DevOpsGuru::DescribeAccountOverviewResponse instance
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
Each argument is described in detail in: Paws::DevOpsGuru::DescribeAnomaly
Returns: a Paws::DevOpsGuru::DescribeAnomalyResponse instance
Returns details about an anomaly that you specify using its ID.
DescribeFeedback
Each argument is described in detail in: Paws::DevOpsGuru::DescribeFeedback
Returns: a Paws::DevOpsGuru::DescribeFeedbackResponse instance
Returns the most recent feedback submitted in the current AWS account and Region.
DescribeInsight
Each argument is described in detail in: Paws::DevOpsGuru::DescribeInsight
Returns: a Paws::DevOpsGuru::DescribeInsightResponse instance
Returns details about an insight that you specify using its ID.
DescribeResourceCollectionHealth
Each argument is described in detail in: Paws::DevOpsGuru::DescribeResourceCollectionHealth
Returns: a Paws::DevOpsGuru::DescribeResourceCollectionHealthResponse instance
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.
DescribeServiceIntegration
Each argument is described in detail in: Paws::DevOpsGuru::DescribeServiceIntegration
Returns: a Paws::DevOpsGuru::DescribeServiceIntegrationResponse instance
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.
GetCostEstimation
Each argument is described in detail in: Paws::DevOpsGuru::GetCostEstimation
Returns: a Paws::DevOpsGuru::GetCostEstimationResponse instance
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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/).
GetResourceCollection
Each argument is described in detail in: Paws::DevOpsGuru::GetResourceCollection
Returns: a Paws::DevOpsGuru::GetResourceCollectionResponse instance
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.
ListAnomaliesForInsight
- InsightId => Str
- [MaxResults => Int]
- [NextToken => Str]
- [StartTimeRange => Paws::DevOpsGuru::StartTimeRange]
Each argument is described in detail in: Paws::DevOpsGuru::ListAnomaliesForInsight
Returns: a Paws::DevOpsGuru::ListAnomaliesForInsightResponse instance
Returns a list of the anomalies that belong to an insight that you specify using its ID.
ListEvents
- Filters => Paws::DevOpsGuru::ListEventsFilters
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::DevOpsGuru::ListEvents
Returns: a Paws::DevOpsGuru::ListEventsResponse instance
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
- StatusFilter => Paws::DevOpsGuru::ListInsightsStatusFilter
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::DevOpsGuru::ListInsights
Returns: a Paws::DevOpsGuru::ListInsightsResponse instance
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).
ListNotificationChannels
Each argument is described in detail in: Paws::DevOpsGuru::ListNotificationChannels
Returns: a Paws::DevOpsGuru::ListNotificationChannelsResponse instance
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).
ListRecommendations
Each argument is described in detail in: Paws::DevOpsGuru::ListRecommendations
Returns: a Paws::DevOpsGuru::ListRecommendationsResponse instance
Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.
PutFeedback
- [InsightFeedback => Paws::DevOpsGuru::InsightFeedback]
Each argument is described in detail in: Paws::DevOpsGuru::PutFeedback
Returns: a Paws::DevOpsGuru::PutFeedbackResponse instance
Collects customer feedback about the specified insight.
RemoveNotificationChannel
Each argument is described in detail in: Paws::DevOpsGuru::RemoveNotificationChannel
Returns: a Paws::DevOpsGuru::RemoveNotificationChannelResponse instance
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
- StartTimeRange => Paws::DevOpsGuru::StartTimeRange
- Type => Str
- [Filters => Paws::DevOpsGuru::SearchInsightsFilters]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::DevOpsGuru::SearchInsights
Returns: a Paws::DevOpsGuru::SearchInsightsResponse instance
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.
StartCostEstimation
- ResourceCollection => Paws::DevOpsGuru::CostEstimationResourceCollectionFilter
- [ClientToken => Str]
Each argument is described in detail in: Paws::DevOpsGuru::StartCostEstimation
Returns: a Paws::DevOpsGuru::StartCostEstimationResponse instance
Starts the creation of an estimate of the monthly cost to analyze your AWS resources.
UpdateResourceCollection
- Action => Str
- ResourceCollection => Paws::DevOpsGuru::UpdateResourceCollectionFilter
Each argument is described in detail in: Paws::DevOpsGuru::UpdateResourceCollection
Returns: a Paws::DevOpsGuru::UpdateResourceCollectionResponse instance
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.
UpdateServiceIntegration
- ServiceIntegration => Paws::DevOpsGuru::UpdateServiceIntegrationConfig
Each argument is described in detail in: Paws::DevOpsGuru::UpdateServiceIntegration
Returns: a Paws::DevOpsGuru::UpdateServiceIntegrationResponse instance
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.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
DescribeAllResourceCollectionHealth(sub { },ResourceCollectionType => Str, [NextToken => Str])
DescribeAllResourceCollectionHealth(ResourceCollectionType => Str, [NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- CloudFormation, passing the object as the first parameter, and the string 'CloudFormation' as the second parameter
- Service, passing the object as the first parameter, and the string 'Service' as the second parameter If not, it will return a a Paws::DevOpsGuru::DescribeResourceCollectionHealthResponse instance with all the params; andparams; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
GetAllCostEstimation(sub { },[NextToken => Str])
GetAllCostEstimation([NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Costs, passing the object as the first parameter, and the string 'Costs' as the second parameter If not, it will return a a Paws::DevOpsGuru::GetCostEstimationResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
GetAllResourceCollection(sub { },ResourceCollectionType => Str, [NextToken => Str])
GetAllResourceCollection(ResourceCollectionType => Str, [NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ResourceCollection.CloudFormation.StackNames, passing the object as the first parameter, and the string 'ResourceCollection.CloudFormation.StackNames' as the second parameter If not, it will return a a Paws::DevOpsGuru::GetResourceCollectionResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllAnomaliesForInsight(sub { },InsightId => Str, [MaxResults => Int, NextToken => Str, StartTimeRange => Paws::DevOpsGuru::StartTimeRange])
ListAllAnomaliesForInsight(InsightId => Str, [MaxResults => Int, NextToken => Str, StartTimeRange => Paws::DevOpsGuru::StartTimeRange])
If passed a sub as first parameter, it will call the sub for each element found in :
- ReactiveAnomalies, passing the object as the first parameter, and the string 'ReactiveAnomalies' as the second parameter
- ProactiveAnomalies, passing the object as the first parameter, and the string 'ProactiveAnomalies' as the second parameter If not, it will return a a Paws::DevOpsGuru::ListAnomaliesForInsightResponse instance with all the params; andparams; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllEvents(sub { },Filters => Paws::DevOpsGuru::ListEventsFilters, [MaxResults => Int, NextToken => Str])
ListAllEvents(Filters => Paws::DevOpsGuru::ListEventsFilters, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Events, passing the object as the first parameter, and the string 'Events' as the second parameter If not, it will return a a Paws::DevOpsGuru::ListEventsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllInsights(sub { },StatusFilter => Paws::DevOpsGuru::ListInsightsStatusFilter, [MaxResults => Int, NextToken => Str])
ListAllInsights(StatusFilter => Paws::DevOpsGuru::ListInsightsStatusFilter, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ProactiveInsights, passing the object as the first parameter, and the string 'ProactiveInsights' as the second parameter
- ReactiveInsights, passing the object as the first parameter, and the string 'ReactiveInsights' as the second parameter If not, it will return a a Paws::DevOpsGuru::ListInsightsResponse instance with all the params; andparams; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllNotificationChannels(sub { },[NextToken => Str])
ListAllNotificationChannels([NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Channels, passing the object as the first parameter, and the string 'Channels' as the second parameter If not, it will return a a Paws::DevOpsGuru::ListNotificationChannelsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllRecommendations(sub { },InsightId => Str, [Locale => Str, NextToken => Str])
ListAllRecommendations(InsightId => Str, [Locale => Str, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Recommendations, passing the object as the first parameter, and the string 'Recommendations' as the second parameter If not, it will return a a Paws::DevOpsGuru::ListRecommendationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SearchAllInsights(sub { },StartTimeRange => Paws::DevOpsGuru::StartTimeRange, Type => Str, [Filters => Paws::DevOpsGuru::SearchInsightsFilters, MaxResults => Int, NextToken => Str])
SearchAllInsights(StartTimeRange => Paws::DevOpsGuru::StartTimeRange, Type => Str, [Filters => Paws::DevOpsGuru::SearchInsightsFilters, MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ProactiveInsights, passing the object as the first parameter, and the string 'ProactiveInsights' as the second parameter
- ReactiveInsights, passing the object as the first parameter, and the string 'ReactiveInsights' as the second parameter If not, it will return a a Paws::DevOpsGuru::SearchInsightsResponse instance with all the params; andparams; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues