@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonDevOpsGuruClient extends AmazonWebServiceClient implements AmazonDevOpsGuru
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddNotificationChannelResult |
addNotificationChannel(AddNotificationChannelRequest request)
Adds a notification channel to DevOps Guru.
|
static AmazonDevOpsGuruClientBuilder |
builder() |
DescribeAccountHealthResult |
describeAccountHealth(DescribeAccountHealthRequest request)
Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics
analyzed in your AWS account.
|
DescribeAccountOverviewResult |
describeAccountOverview(DescribeAccountOverviewRequest 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.
|
DescribeAnomalyResult |
describeAnomaly(DescribeAnomalyRequest request)
Returns details about an anomaly that you specify using its ID.
|
DescribeFeedbackResult |
describeFeedback(DescribeFeedbackRequest request)
Returns the most recent feedback submitted in the current AWS account and Region.
|
DescribeInsightResult |
describeInsight(DescribeInsightRequest request)
Returns details about an insight that you specify using its ID.
|
DescribeResourceCollectionHealthResult |
describeResourceCollectionHealth(DescribeResourceCollectionHealthRequest 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.
|
DescribeServiceIntegrationResult |
describeServiceIntegration(DescribeServiceIntegrationRequest request)
Returns the integration status of services that are integrated with DevOps Guru.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCostEstimationResult |
getCostEstimation(GetCostEstimationRequest request)
Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources.
|
GetResourceCollectionResult |
getResourceCollection(GetResourceCollectionRequest request)
Returns lists AWS resources that are of the specified resource collection type.
|
ListAnomaliesForInsightResult |
listAnomaliesForInsight(ListAnomaliesForInsightRequest request)
Returns a list of the anomalies that belong to an insight that you specify using its ID.
|
ListEventsResult |
listEvents(ListEventsRequest request)
Returns a list of the events emitted by the resources that are evaluated by DevOps Guru.
|
ListInsightsResult |
listInsights(ListInsightsRequest request)
Returns a list of insights in your AWS account.
|
ListNotificationChannelsResult |
listNotificationChannels(ListNotificationChannelsRequest request)
Returns a list of notification channels configured for DevOps Guru.
|
ListRecommendationsResult |
listRecommendations(ListRecommendationsRequest request)
Returns a list of a specified insight's recommendations.
|
PutFeedbackResult |
putFeedback(PutFeedbackRequest request)
Collects customer feedback about the specified insight.
|
RemoveNotificationChannelResult |
removeNotificationChannel(RemoveNotificationChannelRequest request)
Removes a notification channel from DevOps Guru.
|
SearchInsightsResult |
searchInsights(SearchInsightsRequest request)
Returns a list of insights in your AWS account.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartCostEstimationResult |
startCostEstimation(StartCostEstimationRequest request)
Starts the creation of an estimate of the monthly cost to analyze your AWS resources.
|
UpdateResourceCollectionResult |
updateResourceCollection(UpdateResourceCollectionRequest request)
Updates the collection of resources that DevOps Guru analyzes.
|
UpdateServiceIntegrationResult |
updateServiceIntegration(UpdateServiceIntegrationRequest request)
Enables or disables integration with a service that can be integrated with DevOps Guru.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonDevOpsGuruClientBuilder builder()
public AddNotificationChannelResult addNotificationChannel(AddNotificationChannelRequest 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 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.
addNotificationChannel
in interface AmazonDevOpsGuru
addNotificationChannelRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConflictException
- An exception that is thrown when a conflict occurs.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundServiceQuotaExceededException
- The request contains a value that exceeds a maximum quota.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public DescribeAccountHealthResult describeAccountHealth(DescribeAccountHealthRequest request)
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.
describeAccountHealth
in interface AmazonDevOpsGuru
describeAccountHealthRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public DescribeAccountOverviewResult describeAccountOverview(DescribeAccountOverviewRequest 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.
describeAccountOverview
in interface AmazonDevOpsGuru
describeAccountOverviewRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public DescribeAnomalyResult describeAnomaly(DescribeAnomalyRequest request)
Returns details about an anomaly that you specify using its ID.
describeAnomaly
in interface AmazonDevOpsGuru
describeAnomalyRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public DescribeFeedbackResult describeFeedback(DescribeFeedbackRequest request)
Returns the most recent feedback submitted in the current AWS account and Region.
describeFeedback
in interface AmazonDevOpsGuru
describeFeedbackRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public DescribeInsightResult describeInsight(DescribeInsightRequest request)
Returns details about an insight that you specify using its ID.
describeInsight
in interface AmazonDevOpsGuru
describeInsightRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public DescribeResourceCollectionHealthResult describeResourceCollectionHealth(DescribeResourceCollectionHealthRequest 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 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.
describeResourceCollectionHealth
in interface AmazonDevOpsGuru
describeResourceCollectionHealthRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public DescribeServiceIntegrationResult describeServiceIntegration(DescribeServiceIntegrationRequest request)
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.
describeServiceIntegration
in interface AmazonDevOpsGuru
describeServiceIntegrationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public GetCostEstimationResult getCostEstimation(GetCostEstimationRequest request)
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.
getCostEstimation
in interface AmazonDevOpsGuru
getCostEstimationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public GetResourceCollectionResult getResourceCollection(GetResourceCollectionRequest request)
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.
getResourceCollection
in interface AmazonDevOpsGuru
getResourceCollectionRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public ListAnomaliesForInsightResult listAnomaliesForInsight(ListAnomaliesForInsightRequest request)
Returns a list of the anomalies that belong to an insight that you specify using its ID.
listAnomaliesForInsight
in interface AmazonDevOpsGuru
listAnomaliesForInsightRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public ListEventsResult listEvents(ListEventsRequest 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.
listEvents
in interface AmazonDevOpsGuru
listEventsRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public ListInsightsResult listInsights(ListInsightsRequest request)
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
).
listInsights
in interface AmazonDevOpsGuru
listInsightsRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public ListNotificationChannelsResult listNotificationChannels(ListNotificationChannelsRequest 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).
listNotificationChannels
in interface AmazonDevOpsGuru
listNotificationChannelsRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public ListRecommendationsResult listRecommendations(ListRecommendationsRequest request)
Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.
listRecommendations
in interface AmazonDevOpsGuru
listRecommendationsRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public PutFeedbackResult putFeedback(PutFeedbackRequest request)
Collects customer feedback about the specified insight.
putFeedback
in interface AmazonDevOpsGuru
putFeedbackRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConflictException
- An exception that is thrown when a conflict occurs.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public RemoveNotificationChannelResult removeNotificationChannel(RemoveNotificationChannelRequest 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.
removeNotificationChannel
in interface AmazonDevOpsGuru
removeNotificationChannelRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConflictException
- An exception that is thrown when a conflict occurs.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public SearchInsightsResult searchInsights(SearchInsightsRequest request)
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.
searchInsights
in interface AmazonDevOpsGuru
searchInsightsRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public StartCostEstimationResult startCostEstimation(StartCostEstimationRequest request)
Starts the creation of an estimate of the monthly cost to analyze your AWS resources.
startCostEstimation
in interface AmazonDevOpsGuru
startCostEstimationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConflictException
- An exception that is thrown when a conflict occurs.InternalServerException
- An internal failure in an Amazon service occurred.ResourceNotFoundException
- A requested resource could not be foundThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public UpdateResourceCollectionResult updateResourceCollection(UpdateResourceCollectionRequest request)
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.
updateResourceCollection
in interface AmazonDevOpsGuru
updateResourceCollectionRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConflictException
- An exception that is thrown when a conflict occurs.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public UpdateServiceIntegrationResult updateServiceIntegration(UpdateServiceIntegrationRequest 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 AWS Systems Manager, which can be used to create an OpsItem for each generated insight.
updateServiceIntegration
in interface AmazonDevOpsGuru
updateServiceIntegrationRequest
- AccessDeniedException
- You don't have permissions to perform the requested operation. The user or role that is making the
request must have at least one IAM permissions policy attached that grants the required permissions. For
more information, see Access
Management in the IAM User Guide.ConflictException
- An exception that is thrown when a conflict occurs.InternalServerException
- An internal failure in an Amazon service occurred.ThrottlingException
- The request was denied due to a request throttling.ValidationException
- Contains information about data passed in to a field during a request that is not valid.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonDevOpsGuru
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonDevOpsGuru
shutdown
in class AmazonWebServiceClient