com.amazonaws.services.devopsguru

Class AmazonDevOpsGuruClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.devopsguru.AmazonDevOpsGuruClient

All Implemented Interfaces:

AmazonDevOpsGuru

Direct Known Subclasses:

AmazonDevOpsGuruAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonDevOpsGuruClient
extends AmazonWebServiceClient
implements AmazonDevOpsGuru

Client for accessing Amazon DevOps Guru. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.devopsguru.AmazonDevOpsGuru

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AddNotificationChannelResult	addNotificationChannel(AddNotificationChannelRequest request) Adds a notification channel to DevOps Guru.
static AmazonDevOpsGuruClientBuilder	builder()
DeleteInsightResult	deleteInsight(DeleteInsightRequest request) Deletes the insight along with the associated anomalies, events and recommendations.
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 Amazon Web Services 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.
DescribeEventSourcesConfigResult	describeEventSourcesConfig(DescribeEventSourcesConfigRequest request) Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge.
DescribeFeedbackResult	describeFeedback(DescribeFeedbackRequest request) Returns the most recent feedback submitted in the current Amazon Web Services account and Region.
DescribeInsightResult	describeInsight(DescribeInsightRequest request) Returns details about an insight that you specify using its ID.
DescribeOrganizationHealthResult	describeOrganizationHealth(DescribeOrganizationHealthRequest request) Returns active insights, predictive insights, and resource hours analyzed in last hour.
DescribeOrganizationOverviewResult	describeOrganizationOverview(DescribeOrganizationOverviewRequest request) Returns an overview of your organization's history based on the specified time range.
DescribeOrganizationResourceCollectionHealthResult	describeOrganizationResourceCollectionHealth(DescribeOrganizationResourceCollectionHealthRequest request) Provides an overview of your system's health.
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 Amazon Web Services resources.
GetResourceCollectionResult	getResourceCollection(GetResourceCollectionRequest request) Returns lists Amazon Web Services 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 Amazon Web Services account.
ListNotificationChannelsResult	listNotificationChannels(ListNotificationChannelsRequest request) Returns a list of notification channels configured for DevOps Guru.
ListOrganizationInsightsResult	listOrganizationInsights(ListOrganizationInsightsRequest request) Returns a list of insights associated with the account or OU Id.
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 Amazon Web Services account.
SearchOrganizationInsightsResult	searchOrganizationInsights(SearchOrganizationInsightsRequest request) Returns a list of insights in your organization.
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 Amazon Web Services resources.
UpdateEventSourcesConfigResult	updateEventSourcesConfig(UpdateEventSourcesConfigRequest request) Enables or disables integration with a service that can be integrated with DevOps Guru.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonDevOpsGuruClientBuilder builder()

addNotificationChannel

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. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.

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

Specified by:

addNotificationChannel in interface AmazonDevOpsGuru

Parameters:

addNotificationChannelRequest -

Returns:

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.

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 found

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

See Also:

AWS API Documentation

deleteInsight

public DeleteInsightResult deleteInsight(DeleteInsightRequest request)

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

Specified by:

deleteInsight in interface AmazonDevOpsGuru

Parameters:

deleteInsightRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

ConflictException - An exception that is thrown when a conflict occurs.

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.

See Also:

AWS API Documentation

describeAccountHealth

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 Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account.

Specified by:

describeAccountHealth in interface AmazonDevOpsGuru

Parameters:

describeAccountHealthRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

describeAccountOverview

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.

Specified by:

describeAccountOverview in interface AmazonDevOpsGuru

Parameters:

describeAccountOverviewRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

describeAnomaly

public DescribeAnomalyResult describeAnomaly(DescribeAnomalyRequest request)

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

Specified by:

describeAnomaly in interface AmazonDevOpsGuru

Parameters:

describeAnomalyRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

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.

See Also:

AWS API Documentation

describeEventSourcesConfig

public DescribeEventSourcesConfigResult describeEventSourcesConfig(DescribeEventSourcesConfigRequest request)

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

Specified by:

describeEventSourcesConfig in interface AmazonDevOpsGuru

Parameters:

describeEventSourcesConfigRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

describeFeedback

public DescribeFeedbackResult describeFeedback(DescribeFeedbackRequest request)

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

Specified by:

describeFeedback in interface AmazonDevOpsGuru

Parameters:

describeFeedbackRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

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.

See Also:

AWS API Documentation

describeInsight

public DescribeInsightResult describeInsight(DescribeInsightRequest request)

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

Specified by:

describeInsight in interface AmazonDevOpsGuru

Parameters:

describeInsightRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

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.

See Also:

AWS API Documentation

describeOrganizationHealth

public DescribeOrganizationHealthResult describeOrganizationHealth(DescribeOrganizationHealthRequest request)

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

Specified by:

describeOrganizationHealth in interface AmazonDevOpsGuru

Parameters:

describeOrganizationHealthRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

describeOrganizationOverview

public DescribeOrganizationOverviewResult describeOrganizationOverview(DescribeOrganizationOverviewRequest request)

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

Specified by:

describeOrganizationOverview in interface AmazonDevOpsGuru

Parameters:

describeOrganizationOverviewRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

describeOrganizationResourceCollectionHealth

public DescribeOrganizationResourceCollectionHealthResult describeOrganizationResourceCollectionHealth(DescribeOrganizationResourceCollectionHealthRequest request)

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

Specified by:

describeOrganizationResourceCollectionHealth in interface AmazonDevOpsGuru

Parameters:

describeOrganizationResourceCollectionHealthRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

describeResourceCollectionHealth

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

Specified by:

describeResourceCollectionHealth in interface AmazonDevOpsGuru

Parameters:

describeResourceCollectionHealthRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

describeServiceIntegration

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

Specified by:

describeServiceIntegration in interface AmazonDevOpsGuru

Parameters:

describeServiceIntegrationRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

getCostEstimation

public GetCostEstimationResult getCostEstimation(GetCostEstimationRequest request)

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.

Specified by:

getCostEstimation in interface AmazonDevOpsGuru

Parameters:

getCostEstimationRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

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.

See Also:

AWS API Documentation

getResourceCollection

public GetResourceCollectionResult getResourceCollection(GetResourceCollectionRequest request)

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

Specified by:

getResourceCollection in interface AmazonDevOpsGuru

Parameters:

getResourceCollectionRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

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.

See Also:

AWS API Documentation

listAnomaliesForInsight

public ListAnomaliesForInsightResult listAnomaliesForInsight(ListAnomaliesForInsightRequest request)

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

Specified by:

listAnomaliesForInsight in interface AmazonDevOpsGuru

Parameters:

listAnomaliesForInsightRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

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.

See Also:

AWS API Documentation

listEvents

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.

Specified by:

listEvents in interface AmazonDevOpsGuru

Parameters:

listEventsRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

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.

See Also:

AWS API Documentation

listInsights

public ListInsightsResult listInsights(ListInsightsRequest request)

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

Specified by:

listInsights in interface AmazonDevOpsGuru

Parameters:

listInsightsRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

listNotificationChannels

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

Specified by:

listNotificationChannels in interface AmazonDevOpsGuru

Parameters:

listNotificationChannelsRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

listOrganizationInsights

public ListOrganizationInsightsResult listOrganizationInsights(ListOrganizationInsightsRequest request)

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

Specified by:

listOrganizationInsights in interface AmazonDevOpsGuru

Parameters:

listOrganizationInsightsRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

listRecommendations

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.

Specified by:

listRecommendations in interface AmazonDevOpsGuru

Parameters:

listRecommendationsRequest -

Returns:

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.

InternalServerException - An internal failure in an Amazon service occurred.

ResourceNotFoundException - A requested resource could not be found

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.

See Also:

AWS API Documentation

putFeedback

public PutFeedbackResult putFeedback(PutFeedbackRequest request)

Collects customer feedback about the specified insight.

Specified by:

putFeedback in interface AmazonDevOpsGuru

Parameters:

putFeedbackRequest -

Returns:

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.

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 found

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.

See Also:

AWS API Documentation

removeNotificationChannel

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.

Specified by:

removeNotificationChannel in interface AmazonDevOpsGuru

Parameters:

removeNotificationChannelRequest -

Returns:

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.

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 found

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.

See Also:

AWS API Documentation

searchInsights

public SearchInsightsResult searchInsights(SearchInsightsRequest request)

Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING, 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.

Specified by:

searchInsights in interface AmazonDevOpsGuru

Parameters:

searchInsightsRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

searchOrganizationInsights

public SearchOrganizationInsightsResult searchOrganizationInsights(SearchOrganizationInsightsRequest request)

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

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

Specified by:

searchOrganizationInsights in interface AmazonDevOpsGuru

Parameters:

searchOrganizationInsightsRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

startCostEstimation

public StartCostEstimationResult startCostEstimation(StartCostEstimationRequest request)

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

Specified by:

startCostEstimation in interface AmazonDevOpsGuru

Parameters:

startCostEstimationRequest -

Returns:

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.

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 found

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.

See Also:

AWS API Documentation

updateEventSourcesConfig

public UpdateEventSourcesConfigResult updateEventSourcesConfig(UpdateEventSourcesConfigRequest request)

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

Specified by:

updateEventSourcesConfig in interface AmazonDevOpsGuru

Parameters:

updateEventSourcesConfigRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

updateResourceCollection

public UpdateResourceCollectionResult updateResourceCollection(UpdateResourceCollectionRequest request)

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

Specified by:

updateResourceCollection in interface AmazonDevOpsGuru

Parameters:

updateResourceCollectionRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

updateServiceIntegration

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

Specified by:

updateServiceIntegration in interface AmazonDevOpsGuru

Parameters:

updateServiceIntegrationRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonDevOpsGuru

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonDevOpsGuru

Overrides:

shutdown in class AmazonWebServiceClient