AmazonDevOpsGuruClient Class | AWS SDK for .NET V3

Implementation for accessing DevOpsGuru

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.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonServiceClient
Amazon.DevOpsGuru.AmazonDevOpsGuruClient

Namespace: Amazon.DevOpsGuru
Assembly: AWSSDK.DevOpsGuru.dll
Version: 3.x.y.z

Syntax

public class AmazonDevOpsGuruClient : AmazonServiceClient
         IAmazonDevOpsGuru, IAmazonService, IDisposable

The AmazonDevOpsGuruClient type exposes the following members

Constructors

	Name	Description
	AmazonDevOpsGuruClient()	Constructs AmazonDevOpsGuruClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
	AmazonDevOpsGuruClient(RegionEndpoint)	Constructs AmazonDevOpsGuruClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
	AmazonDevOpsGuruClient(AmazonDevOpsGuruConfig)	Constructs AmazonDevOpsGuruClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>
	AmazonDevOpsGuruClient(AWSCredentials)	Constructs AmazonDevOpsGuruClient with AWS Credentials
	AmazonDevOpsGuruClient(AWSCredentials, RegionEndpoint)	Constructs AmazonDevOpsGuruClient with AWS Credentials
	AmazonDevOpsGuruClient(AWSCredentials, AmazonDevOpsGuruConfig)	Constructs AmazonDevOpsGuruClient with AWS Credentials and an AmazonDevOpsGuruClient Configuration object.
	AmazonDevOpsGuruClient(string, string)	Constructs AmazonDevOpsGuruClient with AWS Access Key ID and AWS Secret Key
	AmazonDevOpsGuruClient(string, string, RegionEndpoint)	Constructs AmazonDevOpsGuruClient with AWS Access Key ID and AWS Secret Key
	AmazonDevOpsGuruClient(string, string, AmazonDevOpsGuruConfig)	Constructs AmazonDevOpsGuruClient with AWS Access Key ID, AWS Secret Key and an AmazonDevOpsGuruClient Configuration object.
	AmazonDevOpsGuruClient(string, string, string)	Constructs AmazonDevOpsGuruClient with AWS Access Key ID and AWS Secret Key
	AmazonDevOpsGuruClient(string, string, string, RegionEndpoint)	Constructs AmazonDevOpsGuruClient with AWS Access Key ID and AWS Secret Key
	AmazonDevOpsGuruClient(string, string, string, AmazonDevOpsGuruConfig)	Constructs AmazonDevOpsGuruClient with AWS Access Key ID, AWS Secret Key and an AmazonDevOpsGuruClient Configuration object.

Properties

	Name	Type	Description
	Config	Amazon.Runtime.IClientConfig	Inherited from Amazon.Runtime.AmazonServiceClient.
	Paginators	Amazon.DevOpsGuru.Model.IDevOpsGuruPaginatorFactory	Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

	Name	Description
	AddNotificationChannel(AddNotificationChannelRequest)	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.
	AddNotificationChannelAsync(AddNotificationChannelRequest, CancellationToken)	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.
	DeleteInsight(DeleteInsightRequest)	Deletes the insight along with the associated anomalies, events and recommendations.
	DeleteInsightAsync(DeleteInsightRequest, CancellationToken)	Deletes the insight along with the associated anomalies, events and recommendations.
	DescribeAccountHealth(DescribeAccountHealthRequest)	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.
	DescribeAccountHealthAsync(DescribeAccountHealthRequest, CancellationToken)	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.
	DescribeAccountOverview(DescribeAccountOverviewRequest)	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.
	DescribeAccountOverviewAsync(DescribeAccountOverviewRequest, CancellationToken)	For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.
	DescribeAnomaly(DescribeAnomalyRequest)	Returns details about an anomaly that you specify using its ID.
	DescribeAnomalyAsync(DescribeAnomalyRequest, CancellationToken)	Returns details about an anomaly that you specify using its ID.
	DescribeEventSourcesConfig(DescribeEventSourcesConfigRequest)	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.
	DescribeEventSourcesConfigAsync(DescribeEventSourcesConfigRequest, CancellationToken)	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.
	DescribeFeedback(DescribeFeedbackRequest)	Returns the most recent feedback submitted in the current Amazon Web Services account and Region.
	DescribeFeedbackAsync(DescribeFeedbackRequest, CancellationToken)	Returns the most recent feedback submitted in the current Amazon Web Services account and Region.
	DescribeInsight(DescribeInsightRequest)	Returns details about an insight that you specify using its ID.
	DescribeInsightAsync(DescribeInsightRequest, CancellationToken)	Returns details about an insight that you specify using its ID.
	DescribeOrganizationHealth(DescribeOrganizationHealthRequest)	Returns active insights, predictive insights, and resource hours analyzed in last hour.
	DescribeOrganizationHealthAsync(DescribeOrganizationHealthRequest, CancellationToken)	Returns active insights, predictive insights, and resource hours analyzed in last hour.
	DescribeOrganizationOverview(DescribeOrganizationOverviewRequest)	Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.
	DescribeOrganizationOverviewAsync(DescribeOrganizationOverviewRequest, CancellationToken)	Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.
	DescribeOrganizationResourceCollectionHealth(DescribeOrganizationResourceCollectionHealthRequest)	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.
	DescribeOrganizationResourceCollectionHealthAsync(DescribeOrganizationResourceCollectionHealthRequest, CancellationToken)	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.
	DescribeResourceCollectionHealth(DescribeResourceCollectionHealthRequest)	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.
	DescribeResourceCollectionHealthAsync(DescribeResourceCollectionHealthRequest, CancellationToken)	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.
	DescribeServiceIntegration(DescribeServiceIntegrationRequest)	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.
	DescribeServiceIntegrationAsync(DescribeServiceIntegrationRequest, CancellationToken)	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.
	DetermineServiceOperationEndpoint(AmazonWebServiceRequest)	Returns the endpoint that will be used for a particular request.
	Dispose()	Inherited from Amazon.Runtime.AmazonServiceClient.
	GetCostEstimation(GetCostEstimationRequest)	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.
	GetCostEstimationAsync(GetCostEstimationRequest, CancellationToken)	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.
	GetResourceCollection(GetResourceCollectionRequest)	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.
	GetResourceCollectionAsync(GetResourceCollectionRequest, CancellationToken)	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.
	ListAnomaliesForInsight(ListAnomaliesForInsightRequest)	Returns a list of the anomalies that belong to an insight that you specify using its ID.
	ListAnomaliesForInsightAsync(ListAnomaliesForInsightRequest, CancellationToken)	Returns a list of the anomalies that belong to an insight that you specify using its ID.
	ListAnomalousLogGroups(ListAnomalousLogGroupsRequest)	Returns the list of log groups that contain log anomalies.
	ListAnomalousLogGroupsAsync(ListAnomalousLogGroupsRequest, CancellationToken)	Returns the list of log groups that contain log anomalies.
	ListEvents(ListEventsRequest)	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.
	ListEventsAsync(ListEventsRequest, CancellationToken)	Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.
	ListInsights(ListInsightsRequest)	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`).
	ListInsightsAsync(ListInsightsRequest, CancellationToken)	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`).
	ListMonitoredResources(ListMonitoredResourcesRequest)	Returns the list of all log groups that are being monitored and tagged by DevOps Guru.
	ListMonitoredResourcesAsync(ListMonitoredResourcesRequest, CancellationToken)	Returns the list of all log groups that are being monitored and tagged by DevOps Guru.
	ListNotificationChannels(ListNotificationChannelsRequest)	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).
	ListNotificationChannelsAsync(ListNotificationChannelsRequest, CancellationToken)	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).
	ListOrganizationInsights(ListOrganizationInsightsRequest)	Returns a list of insights associated with the account or OU Id.
	ListOrganizationInsightsAsync(ListOrganizationInsightsRequest, CancellationToken)	Returns a list of insights associated with the account or OU Id.
	ListRecommendations(ListRecommendationsRequest)	Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.
	ListRecommendationsAsync(ListRecommendationsRequest, CancellationToken)	Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.
	PutFeedback(PutFeedbackRequest)	Collects customer feedback about the specified insight.
	PutFeedbackAsync(PutFeedbackRequest, CancellationToken)	Collects customer feedback about the specified insight.
	RemoveNotificationChannel(RemoveNotificationChannelRequest)	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.
	RemoveNotificationChannelAsync(RemoveNotificationChannelRequest, CancellationToken)	Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations.
	SearchInsights(SearchInsightsRequest)	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.
	SearchInsightsAsync(SearchInsightsRequest, CancellationToken)	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.
	SearchOrganizationInsights(SearchOrganizationInsightsRequest)	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.
	SearchOrganizationInsightsAsync(SearchOrganizationInsightsRequest, CancellationToken)	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.
	StartCostEstimation(StartCostEstimationRequest)	Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.
	StartCostEstimationAsync(StartCostEstimationRequest, CancellationToken)	Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.
	UpdateEventSourcesConfig(UpdateEventSourcesConfigRequest)	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.
	UpdateEventSourcesConfigAsync(UpdateEventSourcesConfigRequest, CancellationToken)	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.
	UpdateResourceCollection(UpdateResourceCollectionRequest)	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.
	UpdateResourceCollectionAsync(UpdateResourceCollectionRequest, CancellationToken)	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.
	UpdateServiceIntegration(UpdateServiceIntegrationRequest)	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.
	UpdateServiceIntegrationAsync(UpdateServiceIntegrationRequest, CancellationToken)	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.

Events

	Name	Description
	AfterResponseEvent	Inherited from Amazon.Runtime.AmazonServiceClient.
	BeforeRequestEvent	Inherited from Amazon.Runtime.AmazonServiceClient.
	ExceptionEvent	Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5