DevOpsGuruClient

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.

Properties

Link copied to clipboard
abstract override val config: DevOpsGuruClient.Config

DevOpsGuruClient's configuration

Functions

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun describeAccountHealth(input: DescribeAccountHealthRequest = DescribeAccountHealthRequest { }): DescribeAccountHealthResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun describeEventSourcesConfig(input: DescribeEventSourcesConfigRequest = DescribeEventSourcesConfigRequest { }): DescribeEventSourcesConfigResponse

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.

Link copied to clipboard
abstract suspend fun describeFeedback(input: DescribeFeedbackRequest = DescribeFeedbackRequest { }): DescribeFeedbackResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun describeOrganizationHealth(input: DescribeOrganizationHealthRequest = DescribeOrganizationHealthRequest { }): DescribeOrganizationHealthResponse

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

Link copied to clipboard

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

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.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun describeServiceIntegration(input: DescribeServiceIntegrationRequest = DescribeServiceIntegrationRequest { }): DescribeServiceIntegrationResponse

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.

Link copied to clipboard
abstract suspend fun getCostEstimation(input: GetCostEstimationRequest = GetCostEstimationRequest { }): GetCostEstimationResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Returns the list of log groups that contain log anomalies.

Link copied to clipboard
abstract suspend fun listEvents(input: ListEventsRequest): ListEventsResponse

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.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listMonitoredResources(input: ListMonitoredResourcesRequest = ListMonitoredResourcesRequest { }): ListMonitoredResourcesResponse

Returns the list of all log groups that are being monitored and tagged by DevOps Guru.

Link copied to clipboard
abstract suspend fun listNotificationChannels(input: ListNotificationChannelsRequest = ListNotificationChannelsRequest { }): ListNotificationChannelsResponse

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

Link copied to clipboard

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

Link copied to clipboard

Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

Link copied to clipboard
abstract suspend fun putFeedback(input: PutFeedbackRequest = PutFeedbackRequest { }): PutFeedbackResponse

Collects customer feedback about the specified insight.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun updateEventSourcesConfig(input: UpdateEventSourcesConfigRequest = UpdateEventSourcesConfigRequest { }): UpdateEventSourcesConfigResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Inherited functions

Link copied to clipboard

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.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Returns the list of log groups that contain log anomalies.

Link copied to clipboard
inline suspend fun DevOpsGuruClient.listEvents(crossinline block: ListEventsRequest.Builder.() -> Unit): ListEventsResponse

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.

Link copied to clipboard

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

Link copied to clipboard

Returns the list of all log groups that are being monitored and tagged by DevOps Guru.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

Link copied to clipboard

Collects customer feedback about the specified insight.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.