aws_sdk_devopsguru

Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Amazon DevOps Guru can respond with.

Structs§

AccountHealth

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.

AccountInsightHealth

Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.

AmazonCodeGuruProfilerIntegration

Information about your account's integration with Amazon CodeGuru Profiler. This returns whether DevOps Guru is configured to consume recommendations generated from Amazon CodeGuru Profiler.

AnomalousLogGroup

An Amazon CloudWatch log group that contains log anomalies and is used to generate an insight.

AnomalyReportedTimeRange

A time range that specifies when DevOps Guru opens and then closes an anomaly. This is different from AnomalyTimeRange, which specifies the time range when DevOps Guru actually observes the anomalous behavior.

AnomalyResource

The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in the generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates and insight with details about the anomalous behavior and suggestions about how to correct the problem.

AnomalySourceDetails

Details about the source of the anomalous operational data that triggered the anomaly.

AnomalySourceMetadata

Metadata about the detection source that generates proactive anomalies. The anomaly is detected using analysis of the metric data
 over a period of time

AnomalyTimeRange

A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly.

CloudFormationCollection

Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.

CloudFormationCollectionFilter

Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.

CloudFormationCostEstimationResourceCollectionFilter

Information about an Amazon Web Services CloudFormation stack used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of stacks you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the stack. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.

CloudFormationHealth

Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack.

CloudWatchMetricsDataSummary

Contains information about the analyzed metrics that displayed anomalous behavior.

CloudWatchMetricsDetail

Information about an Amazon CloudWatch metric.

CloudWatchMetricsDimension

The dimension of an Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide.

CostEstimationResourceCollectionFilter

Information about a filter used to specify which Amazon Web Services resources are analyzed to create a monthly DevOps Guru cost estimate. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

CostEstimationTimeRange

The time range of a cost estimation.

EndTimeRange

A range of time that specifies when anomalous behavior in an anomaly or insight ended.

Event

An Amazon Web Services resource event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

EventResource

The Amazon Web Services resource that emitted an event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

EventSourcesConfig

Information about the integration of DevOps Guru as consumer with another AWS service, such as AWS CodeGuru Profiler via EventBridge.

EventTimeRange

The time range during which an Amazon Web Services event occurred. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

InsightFeedback

Information about insight feedback received from a customer.

InsightHealth

Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.

InsightTimeRange

A time ranged that specifies when the observed behavior in an insight started and ended.

KmsServerSideEncryptionIntegration

Information about the KMS encryption used with DevOps Guru.

KmsServerSideEncryptionIntegrationConfig

Information about whether DevOps Guru is configured to encrypt server-side data using KMS.

ListAnomaliesForInsightFilters

Specifies one or more service names that are used to list anomalies.

ListEventsFilters

Filters you can use to specify which events are returned when ListEvents is called.

ListInsightsAnyStatusFilter

Used to filter for insights that have any status.

ListInsightsClosedStatusFilter

Used to filter for insights that have the status CLOSED.

ListInsightsOngoingStatusFilter

Used to filter for insights that have the status ONGOING.

ListInsightsStatusFilter

A filter used by ListInsights to specify which insights to return.

ListMonitoredResourcesFilters

Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status.

LogAnomalyClass

Information about an anomalous log event found within a log group.

LogAnomalyShowcase

A cluster of similar anomalous log events found within a log group.

LogsAnomalyDetectionIntegration

Information about the integration of DevOps Guru with CloudWatch log groups for log anomaly detection.

LogsAnomalyDetectionIntegrationConfig

Information about the integration of DevOps Guru with CloudWatch log groups for log anomaly detection. You can use this to update the configuration.

MonitoredResourceIdentifier

Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource.

NotificationChannel

Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

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.

NotificationChannelConfig

Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

NotificationFilterConfig

The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. You can choose to specify which events or message types to receive notifications for. You can also choose to specify which severity levels to receive notifications for.

OpsCenterIntegration

Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight.

OpsCenterIntegrationConfig

Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight. You can use this to update the configuration.

PerformanceInsightsMetricDimensionGroup

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

PerformanceInsightsMetricQuery

A single query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics in the Amazon RDS Performance Insights API Reference.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

PerformanceInsightsMetricsDetail

Details about Performance Insights metrics.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

PerformanceInsightsReferenceComparisonValues

Reference scalar values and other metrics that DevOps Guru displays on a graph in its console along with the actual metrics it analyzed. Compare these reference values to your actual metrics to help you understand anomalous behavior that DevOps Guru detected.

PerformanceInsightsReferenceData

Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.

PerformanceInsightsReferenceMetric

Information about a reference metric used to evaluate Performance Insights.

PerformanceInsightsReferenceScalar

A reference value to compare Performance Insights metrics against to determine if the metrics demonstrate anomalous behavior.

PerformanceInsightsStat

A statistic in a Performance Insights collection.

PredictionTimeRange

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

ProactiveAnomaly

Information about an anomaly. This object is returned by ListAnomalies.

ProactiveAnomalySummary

Details about a proactive anomaly. This object is returned by DescribeAnomaly.

ProactiveInsight

Details about a proactive insight. This object is returned by ListInsights.

ProactiveInsightSummary

Details about a proactive insight. This object is returned by DescribeInsight.

ProactiveOrganizationInsightSummary

Details about a proactive insight. This object is returned by DescribeInsight.

ReactiveAnomaly

Details about a reactive anomaly. This object is returned by ListAnomalies.

ReactiveAnomalySummary

Details about a reactive anomaly. This object is returned by DescribeAnomaly.

ReactiveInsight

Information about a reactive insight. This object is returned by ListInsights.

ReactiveInsightSummary

Information about a reactive insight. This object is returned by DescribeInsight.

ReactiveOrganizationInsightSummary

Information about a reactive insight. This object is returned by DescribeInsight.

Recommendation

Recommendation information to help you remediate detected anomalous behavior that generated an insight.

RecommendationRelatedAnomaly

Information about an anomaly that is related to a recommendation.

RecommendationRelatedAnomalyResource

Information about a resource in which DevOps Guru detected anomalous behavior.

RecommendationRelatedAnomalySourceDetail

Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name and namespace of an Amazon CloudWatch metric.

RecommendationRelatedCloudWatchMetricsSourceDetail

Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics that are used to generate insights.

RecommendationRelatedEvent

Information about an event that is related to a recommendation.

RecommendationRelatedEventResource

Information about an Amazon Web Services resource that emitted and event that is related to a recommendation in an insight.

ResourceCollection

A collection of Amazon Web Services resources supported by DevOps Guru. 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.

ResourceCollectionFilter

Information about a filter used to specify which Amazon Web Services resources are analyzed for anomalous behavior by DevOps Guru.

SearchInsightsFilters

Specifies values used to filter responses when searching for insights. You can use a ResourceCollection, ServiceCollection, array of severities, and an array of status values. Each filter type contains one or more values to search for. If you specify multiple filter types, the filter types are joined with an AND, and the request returns only results that match all of the specified filters.

SearchOrganizationInsightsFilters

Filters you can use to specify which events are returned when ListEvents is called.

ServiceCollection

A collection of the names of Amazon Web Services services.

ServiceHealth

Represents the health of an Amazon Web Services service.

ServiceInsightHealth

Contains the number of open proactive and reactive insights in an analyzed Amazon Web Services service.

ServiceIntegrationConfig

Information about the integration of DevOps Guru with another Amazon Web Services service, such as Amazon Web Services Systems Manager.

ServiceResourceCost

An object that contains information about the estimated monthly cost to analyze an Amazon Web Services resource. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

SnsChannelConfig

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

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.

StartTimeRange

A time range used to specify when the behavior of an insight or anomaly started.

TagCollection

A collection of Amazon Web Services tags.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services tag has two parts.

  • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

  • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

Together these are known as key-value pairs.

The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

TagCollectionFilter

A collection of Amazon Web Services tags used to filter insights. This is used to return insights generated from only resources that contain the tags in the tag collection.

TagCostEstimationResourceCollectionFilter

Information about a collection of Amazon Web Services resources that are identified by an Amazon Web Services tag. This collection of resources is used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the tag. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.

TagHealth

Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key.

TimestampMetricValuePair

A pair that contains metric values at the respective timestamp.

UpdateCloudFormationCollectionFilter

Contains the names of Amazon Web Services CloudFormation stacks used to update a collection of stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

UpdateResourceCollectionFilter

Contains information used to update a collection of Amazon Web Services resources.

UpdateServiceIntegrationConfig

Information about updating the integration status of an Amazon Web Services service, such as Amazon Web Services Systems Manager, with DevOps Guru.

UpdateTagCollectionFilter

A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag key/value pair.

ValidationExceptionField

The field associated with the validation exception.

Enums§

AnomalySeverity
When writing a match expression against AnomalySeverity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AnomalyStatus
When writing a match expression against AnomalyStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AnomalyType
When writing a match expression against AnomalyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CloudWatchMetricDataStatusCode
When writing a match expression against CloudWatchMetricDataStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CloudWatchMetricsStat
When writing a match expression against CloudWatchMetricsStat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CostEstimationServiceResourceState
When writing a match expression against CostEstimationServiceResourceState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CostEstimationStatus
When writing a match expression against CostEstimationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EventClass
When writing a match expression against EventClass, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EventDataSource
When writing a match expression against EventDataSource, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EventSourceOptInStatus
When writing a match expression against EventSourceOptInStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InsightFeedbackOption
When writing a match expression against InsightFeedbackOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InsightSeverity
When writing a match expression against InsightSeverity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InsightStatus
When writing a match expression against InsightStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
InsightType
When writing a match expression against InsightType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Locale
When writing a match expression against Locale, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LogAnomalyType
When writing a match expression against LogAnomalyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NotificationMessageType
When writing a match expression against NotificationMessageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OptInStatus
When writing a match expression against OptInStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OrganizationResourceCollectionType
When writing a match expression against OrganizationResourceCollectionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceCollectionType
When writing a match expression against ResourceCollectionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourcePermission
When writing a match expression against ResourcePermission, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceTypeFilter
When writing a match expression against ResourceTypeFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ServerSideEncryptionType
When writing a match expression against ServerSideEncryptionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ServiceName
When writing a match expression against ServiceName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
UpdateResourceCollectionAction
When writing a match expression against UpdateResourceCollectionAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ValidationExceptionReason
When writing a match expression against ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.