com.amazonaws.services.devopsguru.AmazonDevOpsGuru Maven / Gradle / Ivy
Show all versions of aws-java-sdk-devopsguru Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.devopsguru;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.devopsguru.model.*;
/**
* Interface for accessing Amazon DevOps Guru.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.devopsguru.AbstractAmazonDevOpsGuru} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDevOpsGuru {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "devops-guru";
/**
*
* 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.
*
*
* @param addNotificationChannelRequest
* @return Result of the AddNotificationChannel operation returned by the service.
* @throws 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.
* @throws ConflictException
* An exception that is thrown when a conflict occurs.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ServiceQuotaExceededException
* The request contains a value that exceeds a maximum quota.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.AddNotificationChannel
* @see AWS API Documentation
*/
AddNotificationChannelResult addNotificationChannel(AddNotificationChannelRequest addNotificationChannelRequest);
/**
*
* Deletes the insight along with the associated anomalies, events and recommendations.
*
*
* @param deleteInsightRequest
* @return Result of the DeleteInsight operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ConflictException
* An exception that is thrown when a conflict occurs.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DeleteInsight
* @see AWS API
* Documentation
*/
DeleteInsightResult deleteInsight(DeleteInsightRequest deleteInsightRequest);
/**
*
* 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.
*
*
* @param describeAccountHealthRequest
* @return Result of the DescribeAccountHealth operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeAccountHealth
* @see AWS API Documentation
*/
DescribeAccountHealthResult describeAccountHealth(DescribeAccountHealthRequest describeAccountHealthRequest);
/**
*
* 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.
*
*
* @param describeAccountOverviewRequest
* @return Result of the DescribeAccountOverview operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeAccountOverview
* @see AWS API Documentation
*/
DescribeAccountOverviewResult describeAccountOverview(DescribeAccountOverviewRequest describeAccountOverviewRequest);
/**
*
* Returns details about an anomaly that you specify using its ID.
*
*
* @param describeAnomalyRequest
* @return Result of the DescribeAnomaly operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeAnomaly
* @see AWS
* API Documentation
*/
DescribeAnomalyResult describeAnomaly(DescribeAnomalyRequest describeAnomalyRequest);
/**
*
* 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.
*
*
* @param describeEventSourcesConfigRequest
* @return Result of the DescribeEventSourcesConfig operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeEventSourcesConfig
* @see AWS API Documentation
*/
DescribeEventSourcesConfigResult describeEventSourcesConfig(DescribeEventSourcesConfigRequest describeEventSourcesConfigRequest);
/**
*
* Returns the most recent feedback submitted in the current Amazon Web Services account and Region.
*
*
* @param describeFeedbackRequest
* @return Result of the DescribeFeedback operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeFeedback
* @see AWS
* API Documentation
*/
DescribeFeedbackResult describeFeedback(DescribeFeedbackRequest describeFeedbackRequest);
/**
*
* Returns details about an insight that you specify using its ID.
*
*
* @param describeInsightRequest
* @return Result of the DescribeInsight operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeInsight
* @see AWS
* API Documentation
*/
DescribeInsightResult describeInsight(DescribeInsightRequest describeInsightRequest);
/**
*
* Returns active insights, predictive insights, and resource hours analyzed in last hour.
*
*
* @param describeOrganizationHealthRequest
* @return Result of the DescribeOrganizationHealth operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeOrganizationHealth
* @see AWS API Documentation
*/
DescribeOrganizationHealthResult describeOrganizationHealth(DescribeOrganizationHealthRequest describeOrganizationHealthRequest);
/**
*
* Returns an overview of your organization's history based on the specified time range. The overview includes the
* total reactive and proactive insights.
*
*
* @param describeOrganizationOverviewRequest
* @return Result of the DescribeOrganizationOverview operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeOrganizationOverview
* @see AWS API Documentation
*/
DescribeOrganizationOverviewResult describeOrganizationOverview(DescribeOrganizationOverviewRequest describeOrganizationOverviewRequest);
/**
*
* 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.
*
*
* @param describeOrganizationResourceCollectionHealthRequest
* @return Result of the DescribeOrganizationResourceCollectionHealth operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeOrganizationResourceCollectionHealth
* @see AWS API Documentation
*/
DescribeOrganizationResourceCollectionHealthResult describeOrganizationResourceCollectionHealth(
DescribeOrganizationResourceCollectionHealthRequest describeOrganizationResourceCollectionHealthRequest);
/**
*
* 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.
*
*
* @param describeResourceCollectionHealthRequest
* @return Result of the DescribeResourceCollectionHealth operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeResourceCollectionHealth
* @see AWS API Documentation
*/
DescribeResourceCollectionHealthResult describeResourceCollectionHealth(DescribeResourceCollectionHealthRequest describeResourceCollectionHealthRequest);
/**
*
* 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.
*
*
* @param describeServiceIntegrationRequest
* @return Result of the DescribeServiceIntegration operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.DescribeServiceIntegration
* @see AWS API Documentation
*/
DescribeServiceIntegrationResult describeServiceIntegration(DescribeServiceIntegrationRequest describeServiceIntegrationRequest);
/**
*
* Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. For more
* information, see Estimate
* your Amazon DevOps Guru costs and Amazon DevOps Guru
* pricing.
*
*
* @param getCostEstimationRequest
* @return Result of the GetCostEstimation operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.GetCostEstimation
* @see AWS
* API Documentation
*/
GetCostEstimationResult getCostEstimation(GetCostEstimationRequest getCostEstimationRequest);
/**
*
* 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.
*
*
* @param getResourceCollectionRequest
* @return Result of the GetResourceCollection operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.GetResourceCollection
* @see AWS API Documentation
*/
GetResourceCollectionResult getResourceCollection(GetResourceCollectionRequest getResourceCollectionRequest);
/**
*
* Returns a list of the anomalies that belong to an insight that you specify using its ID.
*
*
* @param listAnomaliesForInsightRequest
* @return Result of the ListAnomaliesForInsight operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.ListAnomaliesForInsight
* @see AWS API Documentation
*/
ListAnomaliesForInsightResult listAnomaliesForInsight(ListAnomaliesForInsightRequest listAnomaliesForInsightRequest);
/**
*
* Returns the list of log groups that contain log anomalies.
*
*
* @param listAnomalousLogGroupsRequest
* @return Result of the ListAnomalousLogGroups operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.ListAnomalousLogGroups
* @see AWS API Documentation
*/
ListAnomalousLogGroupsResult listAnomalousLogGroups(ListAnomalousLogGroupsRequest listAnomalousLogGroupsRequest);
/**
*
* 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.
*
*
* @param listEventsRequest
* @return Result of the ListEvents operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.ListEvents
* @see AWS API
* Documentation
*/
ListEventsResult listEvents(ListEventsRequest listEventsRequest);
/**
*
* 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
).
*
*
* @param listInsightsRequest
* @return Result of the ListInsights operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.ListInsights
* @see AWS API
* Documentation
*/
ListInsightsResult listInsights(ListInsightsRequest listInsightsRequest);
/**
*
* Returns the list of all log groups that are being monitored and tagged by DevOps Guru.
*
*
* @param listMonitoredResourcesRequest
* @return Result of the ListMonitoredResources operation returned by the service.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.ListMonitoredResources
* @see AWS API Documentation
*/
ListMonitoredResourcesResult listMonitoredResources(ListMonitoredResourcesRequest listMonitoredResourcesRequest);
/**
*
* 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).
*
*
* @param listNotificationChannelsRequest
* @return Result of the ListNotificationChannels operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.ListNotificationChannels
* @see AWS API Documentation
*/
ListNotificationChannelsResult listNotificationChannels(ListNotificationChannelsRequest listNotificationChannelsRequest);
/**
*
* Returns a list of insights associated with the account or OU Id.
*
*
* @param listOrganizationInsightsRequest
* @return Result of the ListOrganizationInsights operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.ListOrganizationInsights
* @see AWS API Documentation
*/
ListOrganizationInsightsResult listOrganizationInsights(ListOrganizationInsightsRequest listOrganizationInsightsRequest);
/**
*
* Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics
* and a list of related events.
*
*
* @param listRecommendationsRequest
* @return Result of the ListRecommendations operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.ListRecommendations
* @see AWS API Documentation
*/
ListRecommendationsResult listRecommendations(ListRecommendationsRequest listRecommendationsRequest);
/**
*
* Collects customer feedback about the specified insight.
*
*
* @param putFeedbackRequest
* @return Result of the PutFeedback operation returned by the service.
* @throws 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.
* @throws ConflictException
* An exception that is thrown when a conflict occurs.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.PutFeedback
* @see AWS API
* Documentation
*/
PutFeedbackResult putFeedback(PutFeedbackRequest putFeedbackRequest);
/**
*
* 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.
*
*
* @param removeNotificationChannelRequest
* @return Result of the RemoveNotificationChannel operation returned by the service.
* @throws 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.
* @throws ConflictException
* An exception that is thrown when a conflict occurs.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.RemoveNotificationChannel
* @see AWS API Documentation
*/
RemoveNotificationChannelResult removeNotificationChannel(RemoveNotificationChannelRequest removeNotificationChannelRequest);
/**
*
* 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.
*
*
* @param searchInsightsRequest
* @return Result of the SearchInsights operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.SearchInsights
* @see AWS API
* Documentation
*/
SearchInsightsResult searchInsights(SearchInsightsRequest searchInsightsRequest);
/**
*
* 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.
*
*
* @param searchOrganizationInsightsRequest
* @return Result of the SearchOrganizationInsights operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.SearchOrganizationInsights
* @see AWS API Documentation
*/
SearchOrganizationInsightsResult searchOrganizationInsights(SearchOrganizationInsightsRequest searchOrganizationInsightsRequest);
/**
*
* Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.
*
*
* @param startCostEstimationRequest
* @return Result of the StartCostEstimation operation returned by the service.
* @throws 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.
* @throws ConflictException
* An exception that is thrown when a conflict occurs.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ResourceNotFoundException
* A requested resource could not be found
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.StartCostEstimation
* @see AWS API Documentation
*/
StartCostEstimationResult startCostEstimation(StartCostEstimationRequest startCostEstimationRequest);
/**
*
* 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.
*
*
* @param updateEventSourcesConfigRequest
* @return Result of the UpdateEventSourcesConfig operation returned by the service.
* @throws 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.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.UpdateEventSourcesConfig
* @see AWS API Documentation
*/
UpdateEventSourcesConfigResult updateEventSourcesConfig(UpdateEventSourcesConfigRequest updateEventSourcesConfigRequest);
/**
*
* 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.
*
*
* @param updateResourceCollectionRequest
* @return Result of the UpdateResourceCollection operation returned by the service.
* @throws 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.
* @throws ConflictException
* An exception that is thrown when a conflict occurs.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.UpdateResourceCollection
* @see AWS API Documentation
*/
UpdateResourceCollectionResult updateResourceCollection(UpdateResourceCollectionRequest updateResourceCollectionRequest);
/**
*
* 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.
*
*
* @param updateServiceIntegrationRequest
* @return Result of the UpdateServiceIntegration operation returned by the service.
* @throws 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.
* @throws ConflictException
* An exception that is thrown when a conflict occurs.
* @throws InternalServerException
* An internal failure in an Amazon service occurred.
* @throws ThrottlingException
* The request was denied due to a request throttling.
* @throws ValidationException
* Contains information about data passed in to a field during a request that is not valid.
* @sample AmazonDevOpsGuru.UpdateServiceIntegration
* @see AWS API Documentation
*/
UpdateServiceIntegrationResult updateServiceIntegration(UpdateServiceIntegrationRequest updateServiceIntegrationRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* 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 a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}