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.
Contents
Status
The status of the CodeGuru Profiler integration. Specifies if DevOps Guru is enabled to consume recommendations that are generated from Amazon CodeGuru Profiler.
Type: String
Valid Values: ENABLED | DISABLED Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AnomalyReportedTimeRange
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.
Contents
CloseTime
The time when an anomaly is closed.
Type: Timestamp Required: No OpenTime
The time when an anomaly is opened.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AnomalyResource
AnomalyResource
The AWS 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.
Contents
Name
The name of the AWS resource.
Type: String Required: No Type
The type of the AWS resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^[a-zA-Z]+[a-zA-Z0-9-_:]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AnomalySourceDetails
AnomalySourceDetails
Details about the source of the anomalous operational data that triggered the anomaly.
Contents
CloudWatchMetrics
An array of CloudWatchMetricsDetail objects that contain information about analyzed CloudWatch metrics that show anomalous behavior.
Type: Array of CloudWatchMetricsDetail (p. 111) objects Required: No
PerformanceInsightsMetrics
An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.
Type: Array of PerformanceInsightsMetricsDetail (p. 140) objects Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AnomalySourceMetadata
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
Contents
Source
The source of the anomaly.
Type: String Required: No SourceResourceName
The name of the anomaly's resource.
Type: String Required: No SourceResourceType
The anomaly's resource type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^[a-zA-Z]+[a-zA-Z0-9-_:]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AnomalyTimeRange
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.
Contents
EndTime
The time when the anomalous behavior ended.
Type: Timestamp Required: No StartTime
The time when the anomalous behavior started.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudFormationCollection
CloudFormationCollection
Information about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
Contents
StackNames
An array of CloudFormation stack names.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z*]+[a-zA-Z0-9-]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudFormationCollectionFilter
CloudFormationCollectionFilter
Information about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
Contents
StackNames
An array of CloudFormation stack names.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z*]+[a-zA-Z0-9-]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudFormationCostEstimationResourceCollectionFilter
CloudFormationCostEstimationResourceCollectionFilter
Information about an AWS CloudFormation stack used to create a monthly cost estimate for DevOps Guru to analyze AWS 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 AWS resources defined by the stack. For more information, see Stacks in the AWS CloudFormation User Guide.
Contents
StackNames
An array of CloudFormation stack names. Its size is fixed at 1 item.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z*]+[a-zA-Z0-9-]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudFormationHealth
CloudFormationHealth
Information about the health of AWS resources in your account that are specified by an AWS CloudFormation stack.
Contents
Insight
Information about the health of the AWS resources in your account that are specified by an AWS CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
Type: InsightHealth (p. 124) object Required: No
StackName
The name of the CloudFormation stack.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z*]+[a-zA-Z0-9-]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudWatchMetricsDataSummary
CloudWatchMetricsDataSummary
Contains information about the analyzed metrics that displayed anomalous behavior.
Contents
StatusCode
This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.
Type: String
Valid Values: Complete | InternalError | PartialData Required: No
TimestampMetricValuePairList
This is a list of Amazon CloudWatch metric values at given timestamp.
Type: Array of TimestampMetricValuePair (p. 201) objects Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudWatchMetricsDetail
CloudWatchMetricsDetail
Information about an Amazon CloudWatch metric.
Contents
Dimensions
An array of CloudWatch dimensions associated with
Type: Array of CloudWatchMetricsDimension (p. 113) objects Required: No
MetricDataSummary
This object returns anomaly metric data.
Type: CloudWatchMetricsDataSummary (p. 110) object Required: No
MetricName
The name of the CloudWatch metric.
Type: String Required: No Namespace
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
Type: String Required: No Period
The length of time associated with the CloudWatch metric in number of seconds.
Type: Integer Required: No Stat
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide.
Type: String
Valid Values: Sum | Average | SampleCount | Minimum | Maximum | p99 | p90 | p50 Required: No
Unit
The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, Count, and Percent.
Type: String
See Also
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CloudWatchMetricsDimension
CloudWatchMetricsDimension
The dimension of am 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.
Contents
Name
The name of the CloudWatch dimension.
Type: String Required: No Value
The value of the CloudWatch dimension.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CostEstimationResourceCollectionFilter
CostEstimationResourceCollectionFilter
Information about a filter used to specify which AWS 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.
Contents
CloudFormation
An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.
Type: CloudFormationCostEstimationResourceCollectionFilter (p. 108) object Required: No
Tags
The AWS tags used to filter the resource collection that is used for a cost estimate.
Tags help you identify and organize your AWS resources. Many AWS 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 AWS Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each AWS 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.
Important
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-Devops-guru-deployment-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Type: Array of TagCostEstimationResourceCollectionFilter (p. 197) objects Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for Ruby V3
CostEstimationTimeRange
CostEstimationTimeRange
The time range of a cost estimation.
Contents
EndTime
The end time of the cost estimation.
Type: Timestamp Required: No StartTime
The start time of the cost estimation.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EndTimeRange
EndTimeRange
A range of time that specifies when anomalous behavior in an anomaly or insight ended.
Contents
FromTime
The earliest end time in the time range.
Type: Timestamp Required: No ToTime
The latest end time in the time range.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Event
Event
An AWS resource event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
Contents
DataSource
The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found the event.
Type: String
Valid Values: AWS_CLOUD_TRAIL | AWS_CODE_DEPLOY Required: No
EventClass
The class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change.
Type: String
Valid Values: INFRASTRUCTURE | DEPLOYMENT | SECURITY_CHANGE | CONFIG_CHANGE | SCHEMA_CHANGE
Required: No EventSource
The AWS source that emitted the event.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 50.
Pattern: ^[a-z]+[a-z0-9]*\.amazonaws\.com|aws\.events$
Required: No Id
The ID of the event.
Type: String Required: No Name
The name of the event.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Required: No ResourceCollection
A collection of AWS resources supported by DevOps Guru. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag.
See Also
DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 AWS CloudFormation stacks.
Type: ResourceCollection (p. 180) object Required: No
Resources
An EventResource object that contains information about the resource that emitted the event.
Type: Array of EventResource (p. 120) objects Required: No
Time
A Timestamp that specifies the time the event occurred.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EventResource
EventResource
The AWS resource that emitted an event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
Contents
Arn
The Amazon Resource Name (ARN) of the resource that emitted an event.
Type: String
Length Constraints: Minimum length of 36. Maximum length of 2048.
Pattern: ^arn:aws[-a-z]*:[a-z0-9-]*:[a-z0-9-]*:\d{12}:.*$
Required: No Name
The name of the resource that emitted an event.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ^.*$
Required: No Type
The type of resource that emitted an event.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: ^.*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EventSourcesConfig
EventSourcesConfig
Information about the integration of DevOps Guru as consumer with another AWS service, such as AWS CodeGuru Profiler via EventBridge.
Contents
AmazonCodeGuruProfiler
Information about whether DevOps Guru is configured to consume recommendations which are generated from AWS CodeGuru Profiler.
Type: AmazonCodeGuruProfilerIntegration (p. 100) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EventTimeRange
EventTimeRange
The time range during which an AWS event occurred. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.
Contents
FromTime
The time when the event started.
Type: Timestamp Required: Yes ToTime
The time when the event ended.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InsightFeedback
InsightFeedback
Information about insight feedback received from a customer.
Contents
Feedback
The feedback provided by the customer.
Type: String
Valid Values: VALID_COLLECTION | RECOMMENDATION_USEFUL | ALERT_TOO_SENSITIVE | DATA_NOISY_ANOMALY | DATA_INCORRECT
Required: No Id
The insight feedback ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w-]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InsightHealth
InsightHealth
Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.
Contents
MeanTimeToRecoverInMilliseconds
The Meant Time to Recover (MTTR) for the insight.
Type: Long Required: No OpenProactiveInsights
The number of open proactive insights.
Type: Integer Required: No OpenReactiveInsights
The number of open reactive insights.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InsightTimeRange
InsightTimeRange
A time ranged that specifies when the observed behavior in an insight started and ended.
Contents
EndTime
The time when the behavior described in an insight ended.
Type: Timestamp Required: No StartTime
The time when the behavior described in an insight started.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ListEventsFilters
ListEventsFilters
Filters you can use to specify which events are returned when ListEvents is called.
Contents
DataSource
The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned.
Type: String
Valid Values: AWS_CLOUD_TRAIL | AWS_CODE_DEPLOY Required: No
EventClass
The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change.
Type: String
Valid Values: INFRASTRUCTURE | DEPLOYMENT | SECURITY_CHANGE | CONFIG_CHANGE | SCHEMA_CHANGE
Required: No EventSource
The AWS source that emitted the events you want to filter for.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 50.
Pattern: ^[a-z]+[a-z0-9]*\.amazonaws\.com|aws\.events$
Required: No EventTimeRange
A time range during which you want the filtered events to have occurred.
Type: EventTimeRange (p. 122) object Required: No
InsightId
An ID of an insight that is related to the events you want to filter for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w-]*$
Required: No ResourceCollection
A collection of AWS resources supported by DevOps Guru. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag.
See Also
DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 AWS CloudFormation stacks.
Type: ResourceCollection (p. 180) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ListInsightsAnyStatusFilter
ListInsightsAnyStatusFilter
Used to filter for insights that have any status.
Contents
StartTimeRange
A time range used to specify when the behavior of the filtered insights started.
Type: StartTimeRange (p. 193) object Required: Yes
Type
Use to filter for either REACTIVE or PROACTIVE insights.
Type: String
Valid Values: REACTIVE | PROACTIVE
Valid Values: REACTIVE | PROACTIVE