NotificationChannelConfig config
A NotificationChannelConfig object that specifies what type of notification channel to add. The one
supported notification channel is Amazon Simple Notification Service (Amazon SNS).
String id
The ID of the added notification channel.
String stackName
The name of the CloudFormation stack.
InsightHealth 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.
String metricName
The name of the CloudWatch metric.
String namespace
The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
List<E> dimensions
An array of CloudWatch dimensions associated with
String stat
The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide.
String unit
The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds,
Count, and Percent.
Integer period
The length of time associated with the CloudWatch metric in number of seconds.
CloudFormationCostEstimationResourceCollectionFilter cloudFormation
An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.
Integer openReactiveInsights
An integer that specifies the number of open reactive insights in your AWS account.
Integer openProactiveInsights
An integer that specifies the number of open proactive insights in your AWS account.
Integer metricsAnalyzed
An integer that specifies the number of metrics that have been analyzed in your AWS account.
Long resourceHours
The number of Amazon DevOps Guru resource analysis hours billed to the current AWS account in the last hour.
Date fromTime
The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day.
Date toTime
The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.
Integer reactiveInsights
An integer that specifies the number of open reactive insights in your AWS account that were created during the time range passed in.
Integer proactiveInsights
An integer that specifies the number of open proactive insights in your AWS account that were created during the time range passed in.
Long meanTimeToRecoverInMilliseconds
The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in.
String id
The ID of the anomaly.
ProactiveAnomaly proactiveAnomaly
A ReactiveAnomaly object that represents the requested anomaly.
ReactiveAnomaly reactiveAnomaly
A ProactiveAnomaly object that represents the requested anomaly.
String insightId
The ID of the insight for which the feedback was provided.
InsightFeedback insightFeedback
String id
The ID of the insight.
ProactiveInsight proactiveInsight
A ProactiveInsight object that represents the requested insight.
ReactiveInsight reactiveInsight
A ReactiveInsight object that represents the requested insight.
String resourceCollectionType
An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
List<E> cloudFormation
The returned CloudFormationHealthOverview object that contains an InsightHealthOverview
object with the requested system health information.
List<E> service
An array of ServiceHealth objects that describes the health of the AWS services associated with the
resources in the collection.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
ServiceIntegrationConfig serviceIntegration
ResourceCollection resourceCollection
String id
The ID of the event.
Date time
A Timestamp that specifies the time the event occurred.
String eventSource
The AWS source that emitted the event.
String name
The name of the event.
String dataSource
The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found the
event.
String 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.
List<E> resources
An EventResource object that contains information about the resource that emitted the event.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
CostEstimationResourceCollectionFilter resourceCollection
The collection of the AWS resources used to create your monthly DevOps Guru cost estimate.
String status
The status of creating this cost estimate. If it's still in progress, the status ONGOING is
returned. If it is finished, the status COMPLETED is returned.
List<E> costs
An array of ResourceCost objects that each contains details about the monthly cost estimate to
analyze one of your AWS resources.
CostEstimationTimeRange timeRange
The start and end time of the cost estimation.
Double totalCost
The estimated monthly cost to analyze the AWS resources. This value is the sum of the estimated costs to analyze
each resource in the Costs object in this response.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
String resourceCollectionType
The type of AWS resource collections to return. The one valid value is CLOUD_FORMATION for AWS
CloudFormation stacks.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
ResourceCollectionFilter resourceCollection
The requested list of AWS resource collections. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Integer retryAfterSeconds
The number of seconds after which the action that caused the internal server exception can be retried.
String insightId
The ID of the insight. The returned anomalies belong to this insight.
StartTimeRange startTimeRange
A time range used to specify when the requested anomalies started. All returned anomalies started during this time range.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken value.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
List<E> proactiveAnomalies
An array of ProactiveAnomalySummary objects that represent the requested anomalies
List<E> reactiveAnomalies
An array of ReactiveAnomalySummary objects that represent the requested anomalies
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
String insightId
An ID of an insight that is related to the events you want to filter for.
EventTimeRange eventTimeRange
A time range during which you want the filtered events to have occurred.
String eventClass
The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change.
String eventSource
The AWS source that emitted the events you want to filter for.
String dataSource
The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned.
ResourceCollection resourceCollection
ListEventsFilters filters
A ListEventsFilters object used to specify which events to return.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken value.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
String type
Use to filter for either REACTIVE or PROACTIVE insights.
StartTimeRange startTimeRange
A time range used to specify when the behavior of the filtered insights started.
String type
Use to filter for either REACTIVE or PROACTIVE insights.
EndTimeRange endTimeRange
A time range used to specify when the behavior of the filtered insights ended.
String type
Use to filter for either REACTIVE or PROACTIVE insights.
ListInsightsStatusFilter statusFilter
A filter used to filter the returned insights by their status. You can specify one status filter.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken value.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
List<E> proactiveInsights
The returned list of proactive insights.
List<E> reactiveInsights
The returned list of reactive insights.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
ListInsightsOngoingStatusFilter ongoing
A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE
or PROACTIVE.
ListInsightsClosedStatusFilter closed
A ListInsightsClosedStatusFilter that specifies closed insights that are either
REACTIVE or PROACTIVE.
ListInsightsAnyStatusFilter any
A ListInsightsAnyStatusFilter that specifies insights of any status that are either
REACTIVE or PROACTIVE.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
String insightId
The ID of the requested insight.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
String locale
A locale that specifies the language to use for recommendations.
String id
The ID of a notification channel.
NotificationChannelConfig config
A NotificationChannelConfig object that contains information about configured notification channels.
SnsChannelConfig sns
Information about a notification channel configured in DevOps Guru to send notifications when insights are created.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.
String optInStatus
Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.
String optInStatus
Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.
String id
The ID of a proactive anomaly.
String severity
The severity of a proactive anomaly.
String status
The status of a proactive anomaly.
Date updateTime
The time of the anomaly's most recent update.
AnomalyTimeRange anomalyTimeRange
PredictionTimeRange predictionTimeRange
AnomalySourceDetails sourceDetails
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
String associatedInsightId
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection resourceCollection
Double limit
A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.
String id
The ID of the anomaly.
String severity
The severity of the anomaly.
String status
The status of the anomaly.
Date updateTime
The time of the anomaly's most recent update.
AnomalyTimeRange anomalyTimeRange
PredictionTimeRange predictionTimeRange
AnomalySourceDetails sourceDetails
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
String associatedInsightId
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection resourceCollection
Double limit
A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.
String id
The ID of the proactive insight.
String name
The name of the proactive insight.
String severity
The severity of the proactive insight.
String status
The status of the proactive insight.
InsightTimeRange insightTimeRange
PredictionTimeRange predictionTimeRange
ResourceCollection resourceCollection
String ssmOpsItemId
The ID of the AWS System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.
String id
The ID of the proactive insight.
String name
The name of the proactive insight.
String severity
The severity of the proactive insight.
String status
The status of the proactive insight.
InsightTimeRange insightTimeRange
PredictionTimeRange predictionTimeRange
ResourceCollection resourceCollection
ServiceCollection serviceCollection
A collection of the names of AWS services.
InsightFeedback insightFeedback
The feedback from customers is about the recommendations in this insight.
String id
The ID of the reactive anomaly.
String severity
The severity of the anomaly.
String status
The status of the anomaly.
AnomalyTimeRange anomalyTimeRange
AnomalySourceDetails sourceDetails
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
String associatedInsightId
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection resourceCollection
String id
The ID of the reactive anomaly.
String severity
The severity of the reactive anomaly.
String status
The status of the reactive anomaly.
AnomalyTimeRange anomalyTimeRange
AnomalySourceDetails sourceDetails
Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.
String associatedInsightId
The ID of the insight that contains this anomaly. An insight is composed of related anomalies.
ResourceCollection resourceCollection
String id
The ID of a reactive insight.
String name
The name of a reactive insight.
String severity
The severity of a reactive insight.
String status
The status of a reactive insight.
InsightTimeRange insightTimeRange
ResourceCollection resourceCollection
String ssmOpsItemId
The ID of the AWS System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.
String id
The ID of a reactive summary.
String name
The name of a reactive insight.
String severity
The severity of a reactive insight.
String status
The status of a reactive insight.
InsightTimeRange insightTimeRange
ResourceCollection resourceCollection
ServiceCollection serviceCollection
A collection of the names of AWS services.
String description
A description of the problem.
String link
A hyperlink to information to help you address the problem.
String name
The name of the recommendation.
String reason
The reason DevOps Guru flagged the anomalous behavior as a problem.
List<E> relatedEvents
Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue.
List<E> relatedAnomalies
Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.
List<E> resources
An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource.
List<E> sourceDetails
Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.
String id
The ID of the notification channel to be removed.
CloudFormationCollection cloudFormation
An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
CloudFormationCollectionFilter cloudFormation
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.
List<E> severities
An array of severity values used to search for insights.
List<E> statuses
An array of status values used to search for insights.
ResourceCollection resourceCollection
ServiceCollection serviceCollection
A collection of the names of AWS services.
StartTimeRange startTimeRange
The start of the time range passed in. Returned insights occurred after this time.
SearchInsightsFilters filters
A SearchInsightsFilters object that is used to set the severity and status filters on your insight
search.
Integer maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call
with the returned nextToken value.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
String type
The type of insights you are searching for (REACTIVE or PROACTIVE).
List<E> proactiveInsights
The returned proactive insights.
List<E> reactiveInsights
The returned reactive insights.
String nextToken
The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
String serviceName
The name of the AWS service.
ServiceInsightHealth insight
Represents the health of an AWS service. This is a ServiceInsightHealth that contains the number of
open proactive and reactive insights for this service.
OpsCenterIntegration opsCenter
Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.
String type
The type of the AWS resource.
String state
The state of the resource. The resource is ACTIVE if it produces metrics, events, or logs within an
hour, otherwise it is INACTIVE. You pay for the number of active AWS resource hours analyzed for
each resource. Inactive resources are not charged.
Integer count
The number of active resources analyzed for this service to create a monthly cost estimate.
Double unitCost
The price per hour to analyze the resources in the service. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
Double cost
The total estimated monthly cost to analyze the active resources for this resource.
String topicArn
The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
CostEstimationResourceCollectionFilter resourceCollection
The collection of AWS resources used to create a monthly DevOps Guru cost estimate.
String clientToken
The idempotency token used to identify each cost estimate request.
String quotaCode
The code of the quota that was exceeded, causing the throttling exception.
String serviceCode
The code of the service that caused the throttling exception.
Integer retryAfterSeconds
The number of seconds after which the action that caused the throttling exception can be retried.
UpdateCloudFormationCollectionFilter cloudFormation
An collection of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.
String action
Specifies if the resource collection in the request is added or deleted to the resource collection.
UpdateResourceCollectionFilter resourceCollection
OpsCenterIntegrationConfig opsCenter
UpdateServiceIntegrationConfig serviceIntegration
An IntegratedServiceConfig object used to specify the integrated service you want to update, and
whether you want to update it to enabled or disabled.
Copyright © 2021. All rights reserved.