github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/devops-guru/2020-12-01/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<p> Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the AWS resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and AWS CloudTrail events related to those resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an <i>insight</i> that includes recommendations, related events, and related metrics that can help you improve your operational applications. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html\">What is Amazon DevOps Guru</a>. </p> <p> 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 AWS Systems Manager for each insight to help you manage and track your work addressing insights. </p> <p> To learn about the DevOps Guru workflow, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html#how-it-works\">How DevOps Guru works</a>. To learn about DevOps Guru concepts, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/concepts.html\">Concepts in DevOps Guru</a>. </p>", 4 "operations": { 5 "AddNotificationChannel": "<p> 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. </p> <p>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 <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html\">Permissions for cross account Amazon SNS topics</a>.</p> <p>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 <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html\">Permissions for AWS KMS–encrypted Amazon SNS topics</a>.</p>", 6 "DescribeAccountHealth": "<p> Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account. Use these numbers to gauge the health of operations in your AWS account. </p>", 7 "DescribeAccountOverview": "<p> 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. </p>", 8 "DescribeAnomaly": "<p> Returns details about an anomaly that you specify using its ID. </p>", 9 "DescribeFeedback": "<p> Returns the most recent feedback submitted in the current AWS account and Region. </p>", 10 "DescribeInsight": "<p> Returns details about an insight that you specify using its ID. </p>", 11 "DescribeResourceCollectionHealth": "<p> 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 AWS resources collection. 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. </p>", 12 "DescribeServiceIntegration": "<p> Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight. </p>", 13 "GetCostEstimation": "<p>Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html\">Estimate your Amazon DevOps Guru costs</a> and <a href=\"http://aws.amazon.com/devops-guru/pricing/\">Amazon DevOps Guru pricing</a>.</p>", 14 "GetResourceCollection": "<p> Returns lists AWS resources that are of the specified resource collection type. 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. </p>", 15 "ListAnomaliesForInsight": "<p> Returns a list of the anomalies that belong to an insight that you specify using its ID. </p>", 16 "ListEvents": "<p> 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. </p>", 17 "ListInsights": "<p> Returns a list of insights in your AWS account. You can specify which insights are returned by their start time and status (<code>ONGOING</code>, <code>CLOSED</code>, or <code>ANY</code>). </p>", 18 "ListNotificationChannels": "<p> 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). </p>", 19 "ListRecommendations": "<p> Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events. </p>", 20 "PutFeedback": "<p> Collects customer feedback about the specified insight. </p>", 21 "RemoveNotificationChannel": "<p> 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. </p>", 22 "SearchInsights": "<p> Returns a list of insights in your AWS account. You can specify which insights are returned by their start time, one or more statuses (<code>ONGOING</code>, <code>CLOSED</code>, and <code>CLOSED</code>), one or more severities (<code>LOW</code>, <code>MEDIUM</code>, and <code>HIGH</code>), and type (<code>REACTIVE</code> or <code>PROACTIVE</code>). </p> <p> Use the <code>Filters</code> parameter to specify status and severity search parameters. Use the <code>Type</code> parameter to specify <code>REACTIVE</code> or <code>PROACTIVE</code> in your search. </p>", 23 "StartCostEstimation": "<p>Starts the creation of an estimate of the monthly cost to analyze your AWS resources.</p>", 24 "UpdateResourceCollection": "<p> Updates the collection of resources that DevOps Guru analyzes. 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. This method also creates the IAM role required for you to use DevOps Guru. </p>", 25 "UpdateServiceIntegration": "<p> 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 AWS Systems Manager, which can be used to create an OpsItem for each generated insight. </p>" 26 }, 27 "shapes": { 28 "AccessDeniedException": { 29 "base": "<p> You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html\">Access Management</a> in the <i>IAM User Guide</i>. </p>", 30 "refs": { 31 } 32 }, 33 "AddNotificationChannelRequest": { 34 "base": null, 35 "refs": { 36 } 37 }, 38 "AddNotificationChannelResponse": { 39 "base": null, 40 "refs": { 41 } 42 }, 43 "AnomalyId": { 44 "base": null, 45 "refs": { 46 "DescribeAnomalyRequest$Id": "<p> The ID of the anomaly. </p>", 47 "ProactiveAnomaly$Id": "<p> The ID of a proactive anomaly. </p>", 48 "ProactiveAnomalySummary$Id": "<p>The ID of the anomaly.</p>", 49 "ReactiveAnomaly$Id": "<p>The ID of the reactive anomaly. </p>", 50 "ReactiveAnomalySummary$Id": "<p> The ID of the reactive anomaly. </p>" 51 } 52 }, 53 "AnomalyLimit": { 54 "base": null, 55 "refs": { 56 "ProactiveAnomaly$Limit": "<p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly. </p>", 57 "ProactiveAnomalySummary$Limit": "<p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly. </p>" 58 } 59 }, 60 "AnomalyReportedTimeRange": { 61 "base": "<p> A time range that specifies when DevOps Guru opens and then closes an anomaly. This is different from <code>AnomalyTimeRange</code>, which specifies the time range when DevOps Guru actually observes the anomalous behavior. </p>", 62 "refs": { 63 "ProactiveAnomaly$AnomalyReportedTimeRange": "<p> A <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed. </p>", 64 "ProactiveAnomalySummary$AnomalyReportedTimeRange": "<p> A <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed. </p>", 65 "ReactiveAnomaly$AnomalyReportedTimeRange": "<p> A <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed. </p>", 66 "ReactiveAnomalySummary$AnomalyReportedTimeRange": "<p> A <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed. </p>" 67 } 68 }, 69 "AnomalySeverity": { 70 "base": null, 71 "refs": { 72 "ProactiveAnomaly$Severity": "<p> The severity of a proactive anomaly. </p>", 73 "ProactiveAnomalySummary$Severity": "<p>The severity of the anomaly.</p>", 74 "ReactiveAnomaly$Severity": "<p>The severity of the anomaly. </p>", 75 "ReactiveAnomalySummary$Severity": "<p> The severity of the reactive anomaly. </p>" 76 } 77 }, 78 "AnomalySourceDetails": { 79 "base": "<p> Details about the source of the anomalous operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>", 80 "refs": { 81 "ProactiveAnomaly$SourceDetails": "<p> Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>", 82 "ProactiveAnomalySummary$SourceDetails": "<p> Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>", 83 "ReactiveAnomaly$SourceDetails": "<p> Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>", 84 "ReactiveAnomalySummary$SourceDetails": "<p> Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. </p>" 85 } 86 }, 87 "AnomalyStatus": { 88 "base": null, 89 "refs": { 90 "ProactiveAnomaly$Status": "<p> The status of a proactive anomaly. </p>", 91 "ProactiveAnomalySummary$Status": "<p>The status of the anomaly.</p>", 92 "ReactiveAnomaly$Status": "<p> The status of the anomaly. </p>", 93 "ReactiveAnomalySummary$Status": "<p> The status of the reactive anomaly. </p>" 94 } 95 }, 96 "AnomalyTimeRange": { 97 "base": "<p> A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies the time range when DevOps Guru opens and then closes an anomaly. </p>", 98 "refs": { 99 "ProactiveAnomaly$AnomalyTimeRange": null, 100 "ProactiveAnomalySummary$AnomalyTimeRange": null, 101 "ReactiveAnomaly$AnomalyTimeRange": null, 102 "ReactiveAnomalySummary$AnomalyTimeRange": null 103 } 104 }, 105 "Channels": { 106 "base": null, 107 "refs": { 108 "ListNotificationChannelsResponse$Channels": "<p> An array that contains the requested notification channels. </p>" 109 } 110 }, 111 "ClientToken": { 112 "base": null, 113 "refs": { 114 "StartCostEstimationRequest$ClientToken": "<p>The idempotency token used to identify each cost estimate request.</p>" 115 } 116 }, 117 "CloudFormationCollection": { 118 "base": "<p> 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 <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html\">Stacks</a> in the <i>AWS CloudFormation User Guide</i>. </p>", 119 "refs": { 120 "ResourceCollection$CloudFormation": "<p> 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. </p>" 121 } 122 }, 123 "CloudFormationCollectionFilter": { 124 "base": "<p> 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 <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html\">Stacks</a> in the <i>AWS CloudFormation User Guide</i>. </p>", 125 "refs": { 126 "ResourceCollectionFilter$CloudFormation": "<p> 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 <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html\">Stacks</a> in the <i>AWS CloudFormation User Guide</i>. </p>" 127 } 128 }, 129 "CloudFormationCostEstimationResourceCollectionFilter": { 130 "base": "<p>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 <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html\">Stacks</a> in the <i>AWS CloudFormation User Guide</i>.</p>", 131 "refs": { 132 "CostEstimationResourceCollectionFilter$CloudFormation": "<p>An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.</p>" 133 } 134 }, 135 "CloudFormationHealth": { 136 "base": "<p> Information about the health of AWS resources in your account that are specified by an AWS CloudFormation stack. </p>", 137 "refs": { 138 "CloudFormationHealths$member": null 139 } 140 }, 141 "CloudFormationHealths": { 142 "base": null, 143 "refs": { 144 "DescribeResourceCollectionHealthResponse$CloudFormation": "<p> The returned <code>CloudFormationHealthOverview</code> object that contains an <code>InsightHealthOverview</code> object with the requested system health information. </p>" 145 } 146 }, 147 "CloudWatchMetricsDetail": { 148 "base": "<p> Information about an Amazon CloudWatch metric. </p>", 149 "refs": { 150 "CloudWatchMetricsDetails$member": null 151 } 152 }, 153 "CloudWatchMetricsDetails": { 154 "base": null, 155 "refs": { 156 "AnomalySourceDetails$CloudWatchMetrics": "<p> An array of <code>CloudWatchMetricsDetail</code> object that contains information about the analyzed metrics that displayed anomalous behavior. </p>" 157 } 158 }, 159 "CloudWatchMetricsDimension": { 160 "base": "<p> The dimension of a 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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension\">Dimensions</a> in the <i>Amazon CloudWatch User Guide</i>. </p>", 161 "refs": { 162 "CloudWatchMetricsDimensions$member": null 163 } 164 }, 165 "CloudWatchMetricsDimensionName": { 166 "base": null, 167 "refs": { 168 "CloudWatchMetricsDimension$Name": "<p> The name of the CloudWatch dimension. </p>" 169 } 170 }, 171 "CloudWatchMetricsDimensionValue": { 172 "base": null, 173 "refs": { 174 "CloudWatchMetricsDimension$Value": "<p> The value of the CloudWatch dimension. </p>" 175 } 176 }, 177 "CloudWatchMetricsDimensions": { 178 "base": null, 179 "refs": { 180 "CloudWatchMetricsDetail$Dimensions": "<p> An array of CloudWatch dimensions associated with </p>" 181 } 182 }, 183 "CloudWatchMetricsMetricName": { 184 "base": null, 185 "refs": { 186 "CloudWatchMetricsDetail$MetricName": "<p> The name of the CloudWatch metric. </p>" 187 } 188 }, 189 "CloudWatchMetricsNamespace": { 190 "base": null, 191 "refs": { 192 "CloudWatchMetricsDetail$Namespace": "<p> The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics. </p>" 193 } 194 }, 195 "CloudWatchMetricsPeriod": { 196 "base": null, 197 "refs": { 198 "CloudWatchMetricsDetail$Period": "<p> The length of time associated with the CloudWatch metric in number of seconds. </p>" 199 } 200 }, 201 "CloudWatchMetricsStat": { 202 "base": null, 203 "refs": { 204 "CloudWatchMetricsDetail$Stat": "<p> The type of statistic associated with the CloudWatch metric. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic\">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>. </p>" 205 } 206 }, 207 "CloudWatchMetricsUnit": { 208 "base": null, 209 "refs": { 210 "CloudWatchMetricsDetail$Unit": "<p> The unit of measure used for the CloudWatch metric. For example, <code>Bytes</code>, <code>Seconds</code>, <code>Count</code>, and <code>Percent</code>. </p>" 211 } 212 }, 213 "ConflictException": { 214 "base": "<p> An exception that is thrown when a conflict occurs. </p>", 215 "refs": { 216 } 217 }, 218 "Cost": { 219 "base": null, 220 "refs": { 221 "GetCostEstimationResponse$TotalCost": "<p>The estimated monthly cost to analyze the AWS resources. This value is the sum of the estimated costs to analyze each resource in the <code>Costs</code> object in this response.</p>", 222 "ServiceResourceCost$UnitCost": "<p>The price per hour to analyze the resources in the service. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html\">Estimate your Amazon DevOps Guru costs</a> and <a href=\"http://aws.amazon.com/devops-guru/pricing/\">Amazon DevOps Guru pricing</a>.</p>", 223 "ServiceResourceCost$Cost": "<p>The total estimated monthly cost to analyze the active resources for this resource.</p>" 224 } 225 }, 226 "CostEstimationResourceCollectionFilter": { 227 "base": "<p>Information about a filter used to specify which AWS resources are analyzed to create a monthly DevOps Guru cost estimate. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html\">Estimate your Amazon DevOps Guru costs</a> and <a href=\"http://aws.amazon.com/devops-guru/pricing/\">Amazon DevOps Guru pricing</a>. </p>", 228 "refs": { 229 "GetCostEstimationResponse$ResourceCollection": "<p>The collection of the AWS resources used to create your monthly DevOps Guru cost estimate.</p>", 230 "StartCostEstimationRequest$ResourceCollection": "<p>The collection of AWS resources used to create a monthly DevOps Guru cost estimate.</p>" 231 } 232 }, 233 "CostEstimationServiceResourceCount": { 234 "base": null, 235 "refs": { 236 "ServiceResourceCost$Count": "<p>The number of active resources analyzed for this service to create a monthly cost estimate.</p>" 237 } 238 }, 239 "CostEstimationServiceResourceState": { 240 "base": null, 241 "refs": { 242 "ServiceResourceCost$State": "<p>The state of the resource. The resource is <code>ACTIVE</code> if it produces metrics, events, or logs within an hour, otherwise it is <code>INACTIVE</code>. You pay for the number of active AWS resource hours analyzed for each resource. Inactive resources are not charged. </p>" 243 } 244 }, 245 "CostEstimationStackNames": { 246 "base": null, 247 "refs": { 248 "CloudFormationCostEstimationResourceCollectionFilter$StackNames": "<p>An array of CloudFormation stack names. Its size is fixed at 1 item.</p>" 249 } 250 }, 251 "CostEstimationStatus": { 252 "base": null, 253 "refs": { 254 "GetCostEstimationResponse$Status": "<p>The status of creating this cost estimate. If it's still in progress, the status <code>ONGOING</code> is returned. If it is finished, the status <code>COMPLETED</code> is returned.</p>" 255 } 256 }, 257 "CostEstimationTimeRange": { 258 "base": "<p>The time range of a cost estimation.</p>", 259 "refs": { 260 "GetCostEstimationResponse$TimeRange": "<p>The start and end time of the cost estimation.</p>" 261 } 262 }, 263 "DescribeAccountHealthRequest": { 264 "base": null, 265 "refs": { 266 } 267 }, 268 "DescribeAccountHealthResponse": { 269 "base": null, 270 "refs": { 271 } 272 }, 273 "DescribeAccountOverviewRequest": { 274 "base": null, 275 "refs": { 276 } 277 }, 278 "DescribeAccountOverviewResponse": { 279 "base": null, 280 "refs": { 281 } 282 }, 283 "DescribeAnomalyRequest": { 284 "base": null, 285 "refs": { 286 } 287 }, 288 "DescribeAnomalyResponse": { 289 "base": null, 290 "refs": { 291 } 292 }, 293 "DescribeFeedbackRequest": { 294 "base": null, 295 "refs": { 296 } 297 }, 298 "DescribeFeedbackResponse": { 299 "base": null, 300 "refs": { 301 } 302 }, 303 "DescribeInsightRequest": { 304 "base": null, 305 "refs": { 306 } 307 }, 308 "DescribeInsightResponse": { 309 "base": null, 310 "refs": { 311 } 312 }, 313 "DescribeResourceCollectionHealthRequest": { 314 "base": null, 315 "refs": { 316 } 317 }, 318 "DescribeResourceCollectionHealthResponse": { 319 "base": null, 320 "refs": { 321 } 322 }, 323 "DescribeServiceIntegrationRequest": { 324 "base": null, 325 "refs": { 326 } 327 }, 328 "DescribeServiceIntegrationResponse": { 329 "base": null, 330 "refs": { 331 } 332 }, 333 "EndTimeRange": { 334 "base": "<p> A range of time that specifies when anomalous behavior in an anomaly or insight ended. </p>", 335 "refs": { 336 "ListInsightsClosedStatusFilter$EndTimeRange": "<p> A time range used to specify when the behavior of the filtered insights ended. </p>" 337 } 338 }, 339 "ErrorMessageString": { 340 "base": null, 341 "refs": { 342 "AccessDeniedException$Message": null, 343 "ConflictException$Message": null, 344 "InternalServerException$Message": null, 345 "ResourceNotFoundException$Message": null, 346 "ServiceQuotaExceededException$Message": null, 347 "ThrottlingException$Message": null, 348 "ValidationException$Message": "<p> A message that describes the validation exception. </p>", 349 "ValidationExceptionField$Message": "<p> The message associated with the validation exception with information to help determine its cause. </p>" 350 } 351 }, 352 "ErrorNameString": { 353 "base": null, 354 "refs": { 355 "ValidationExceptionField$Name": "<p> The name of the field. </p>" 356 } 357 }, 358 "ErrorQuotaCodeString": { 359 "base": null, 360 "refs": { 361 "ThrottlingException$QuotaCode": "<p> The code of the quota that was exceeded, causing the throttling exception. </p>" 362 } 363 }, 364 "ErrorServiceCodeString": { 365 "base": null, 366 "refs": { 367 "ThrottlingException$ServiceCode": "<p> The code of the service that caused the throttling exception. </p>" 368 } 369 }, 370 "Event": { 371 "base": "<p> 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. </p>", 372 "refs": { 373 "Events$member": null 374 } 375 }, 376 "EventClass": { 377 "base": null, 378 "refs": { 379 "Event$EventClass": "<p> 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. </p>", 380 "ListEventsFilters$EventClass": "<p> The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change. </p>" 381 } 382 }, 383 "EventDataSource": { 384 "base": null, 385 "refs": { 386 "Event$DataSource": "<p> The source, <code>AWS_CLOUD_TRAIL</code> or <code>AWS_CODE_DEPLOY</code>, where DevOps Guru analysis found the event. </p>", 387 "ListEventsFilters$DataSource": "<p> The source, <code>AWS_CLOUD_TRAIL</code> or <code>AWS_CODE_DEPLOY</code>, of the events you want returned. </p>" 388 } 389 }, 390 "EventId": { 391 "base": null, 392 "refs": { 393 "Event$Id": "<p> The ID of the event. </p>" 394 } 395 }, 396 "EventName": { 397 "base": null, 398 "refs": { 399 "Event$Name": "<p> The name of the event. </p>" 400 } 401 }, 402 "EventResource": { 403 "base": "<p> 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. </p>", 404 "refs": { 405 "EventResources$member": null 406 } 407 }, 408 "EventResourceArn": { 409 "base": null, 410 "refs": { 411 "EventResource$Arn": "<p> The Amazon Resource Name (ARN) of the resource that emitted an event. </p>" 412 } 413 }, 414 "EventResourceName": { 415 "base": null, 416 "refs": { 417 "EventResource$Name": "<p> The name of the resource that emitted an event. </p>" 418 } 419 }, 420 "EventResourceType": { 421 "base": null, 422 "refs": { 423 "EventResource$Type": "<p> The type of resource that emitted an event. </p>" 424 } 425 }, 426 "EventResources": { 427 "base": null, 428 "refs": { 429 "Event$Resources": "<p> An <code>EventResource</code> object that contains information about the resource that emitted the event. </p>" 430 } 431 }, 432 "EventSource": { 433 "base": null, 434 "refs": { 435 "Event$EventSource": "<p> The AWS source that emitted the event. </p>", 436 "ListEventsFilters$EventSource": "<p> The AWS source that emitted the events you want to filter for. </p>" 437 } 438 }, 439 "EventTimeRange": { 440 "base": "<p> 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. </p>", 441 "refs": { 442 "ListEventsFilters$EventTimeRange": "<p> A time range during which you want the filtered events to have occurred. </p>" 443 } 444 }, 445 "Events": { 446 "base": null, 447 "refs": { 448 "ListEventsResponse$Events": "<p> A list of the requested events. </p>" 449 } 450 }, 451 "GetCostEstimationRequest": { 452 "base": null, 453 "refs": { 454 } 455 }, 456 "GetCostEstimationResponse": { 457 "base": null, 458 "refs": { 459 } 460 }, 461 "GetResourceCollectionRequest": { 462 "base": null, 463 "refs": { 464 } 465 }, 466 "GetResourceCollectionResponse": { 467 "base": null, 468 "refs": { 469 } 470 }, 471 "InsightFeedback": { 472 "base": "<p> Information about insight feedback received from a customer. </p>", 473 "refs": { 474 "DescribeFeedbackResponse$InsightFeedback": null, 475 "PutFeedbackRequest$InsightFeedback": "<p> The feedback from customers is about the recommendations in this insight. </p>" 476 } 477 }, 478 "InsightFeedbackOption": { 479 "base": null, 480 "refs": { 481 "InsightFeedback$Feedback": "<p> The feedback provided by the customer. </p>" 482 } 483 }, 484 "InsightHealth": { 485 "base": "<p> Information about the number of open reactive and proactive insights that can be used to gauge the health of your system. </p>", 486 "refs": { 487 "CloudFormationHealth$Insight": "<p> 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. </p>" 488 } 489 }, 490 "InsightId": { 491 "base": null, 492 "refs": { 493 "DescribeFeedbackRequest$InsightId": "<p> The ID of the insight for which the feedback was provided. </p>", 494 "DescribeInsightRequest$Id": "<p> The ID of the insight. </p>", 495 "InsightFeedback$Id": "<p> The insight feedback ID. </p>", 496 "ListAnomaliesForInsightRequest$InsightId": "<p> The ID of the insight. The returned anomalies belong to this insight. </p>", 497 "ListEventsFilters$InsightId": "<p> An ID of an insight that is related to the events you want to filter for. </p>", 498 "ListRecommendationsRequest$InsightId": "<p> The ID of the requested insight. </p>", 499 "ProactiveAnomaly$AssociatedInsightId": "<p> The ID of the insight that contains this anomaly. An insight is composed of related anomalies. </p>", 500 "ProactiveAnomalySummary$AssociatedInsightId": "<p> The ID of the insight that contains this anomaly. An insight is composed of related anomalies. </p>", 501 "ProactiveInsight$Id": "<p>The ID of the proactive insight. </p>", 502 "ProactiveInsightSummary$Id": "<p>The ID of the proactive insight. </p>", 503 "ReactiveAnomaly$AssociatedInsightId": "<p> The ID of the insight that contains this anomaly. An insight is composed of related anomalies. </p>", 504 "ReactiveAnomalySummary$AssociatedInsightId": "<p> The ID of the insight that contains this anomaly. An insight is composed of related anomalies. </p>", 505 "ReactiveInsight$Id": "<p> The ID of a reactive insight. </p>", 506 "ReactiveInsightSummary$Id": "<p> The ID of a reactive summary. </p>" 507 } 508 }, 509 "InsightName": { 510 "base": null, 511 "refs": { 512 "ProactiveInsight$Name": "<p>The name of the proactive insight. </p>", 513 "ProactiveInsightSummary$Name": "<p>The name of the proactive insight. </p>", 514 "ReactiveInsight$Name": "<p> The name of a reactive insight. </p>", 515 "ReactiveInsightSummary$Name": "<p> The name of a reactive insight. </p>" 516 } 517 }, 518 "InsightSeverities": { 519 "base": null, 520 "refs": { 521 "SearchInsightsFilters$Severities": "<p> An array of severity values used to search for insights. </p>" 522 } 523 }, 524 "InsightSeverity": { 525 "base": null, 526 "refs": { 527 "InsightSeverities$member": null, 528 "ProactiveInsight$Severity": "<p>The severity of the proactive insight. </p>", 529 "ProactiveInsightSummary$Severity": "<p>The severity of the proactive insight. </p>", 530 "ReactiveInsight$Severity": "<p> The severity of a reactive insight. </p>", 531 "ReactiveInsightSummary$Severity": "<p> The severity of a reactive insight. </p>" 532 } 533 }, 534 "InsightStatus": { 535 "base": null, 536 "refs": { 537 "InsightStatuses$member": null, 538 "ProactiveInsight$Status": "<p>The status of the proactive insight. </p>", 539 "ProactiveInsightSummary$Status": "<p>The status of the proactive insight. </p>", 540 "ReactiveInsight$Status": "<p> The status of a reactive insight. </p>", 541 "ReactiveInsightSummary$Status": "<p> The status of a reactive insight. </p>" 542 } 543 }, 544 "InsightStatuses": { 545 "base": null, 546 "refs": { 547 "SearchInsightsFilters$Statuses": "<p> An array of status values used to search for insights. </p>" 548 } 549 }, 550 "InsightTimeRange": { 551 "base": "<p> A time ranged that specifies when the observed behavior in an insight started and ended. </p>", 552 "refs": { 553 "ProactiveInsight$InsightTimeRange": null, 554 "ProactiveInsightSummary$InsightTimeRange": null, 555 "ReactiveInsight$InsightTimeRange": null, 556 "ReactiveInsightSummary$InsightTimeRange": null 557 } 558 }, 559 "InsightType": { 560 "base": null, 561 "refs": { 562 "ListInsightsAnyStatusFilter$Type": "<p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. </p>", 563 "ListInsightsClosedStatusFilter$Type": "<p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. </p>", 564 "ListInsightsOngoingStatusFilter$Type": "<p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights. </p>", 565 "SearchInsightsRequest$Type": "<p> The type of insights you are searching for (<code>REACTIVE</code> or <code>PROACTIVE</code>). </p>" 566 } 567 }, 568 "InternalServerException": { 569 "base": "<p>An internal failure in an Amazon service occurred.</p>", 570 "refs": { 571 } 572 }, 573 "ListAnomaliesForInsightMaxResults": { 574 "base": null, 575 "refs": { 576 "ListAnomaliesForInsightRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" 577 } 578 }, 579 "ListAnomaliesForInsightRequest": { 580 "base": null, 581 "refs": { 582 } 583 }, 584 "ListAnomaliesForInsightResponse": { 585 "base": null, 586 "refs": { 587 } 588 }, 589 "ListEventsFilters": { 590 "base": "<p> Filters you can use to specify which events are returned when <code>ListEvents</code> is called. </p>", 591 "refs": { 592 "ListEventsRequest$Filters": "<p> A <code>ListEventsFilters</code> object used to specify which events to return. </p>" 593 } 594 }, 595 "ListEventsMaxResults": { 596 "base": null, 597 "refs": { 598 "ListEventsRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" 599 } 600 }, 601 "ListEventsRequest": { 602 "base": null, 603 "refs": { 604 } 605 }, 606 "ListEventsResponse": { 607 "base": null, 608 "refs": { 609 } 610 }, 611 "ListInsightsAnyStatusFilter": { 612 "base": "<p> Used to filter for insights that have any status. </p>", 613 "refs": { 614 "ListInsightsStatusFilter$Any": "<p> A <code>ListInsightsAnyStatusFilter</code> that specifies insights of any status that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>" 615 } 616 }, 617 "ListInsightsClosedStatusFilter": { 618 "base": "<p> Used to filter for insights that have the status <code>CLOSED</code>. </p>", 619 "refs": { 620 "ListInsightsStatusFilter$Closed": "<p> A <code>ListInsightsClosedStatusFilter</code> that specifies closed insights that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>" 621 } 622 }, 623 "ListInsightsMaxResults": { 624 "base": null, 625 "refs": { 626 "ListInsightsRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" 627 } 628 }, 629 "ListInsightsOngoingStatusFilter": { 630 "base": "<p> Used to filter for insights that have the status <code>ONGOING</code>. </p>", 631 "refs": { 632 "ListInsightsStatusFilter$Ongoing": "<p> A <code>ListInsightsAnyStatusFilter</code> that specifies ongoing insights that are either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>" 633 } 634 }, 635 "ListInsightsRequest": { 636 "base": null, 637 "refs": { 638 } 639 }, 640 "ListInsightsResponse": { 641 "base": null, 642 "refs": { 643 } 644 }, 645 "ListInsightsStatusFilter": { 646 "base": "<p> A filter used by <code>ListInsights</code> to specify which insights to return. </p>", 647 "refs": { 648 "ListInsightsRequest$StatusFilter": "<p> A filter used to filter the returned insights by their status. You can specify one status filter. </p>" 649 } 650 }, 651 "ListNotificationChannelsRequest": { 652 "base": null, 653 "refs": { 654 } 655 }, 656 "ListNotificationChannelsResponse": { 657 "base": null, 658 "refs": { 659 } 660 }, 661 "ListRecommendationsRequest": { 662 "base": null, 663 "refs": { 664 } 665 }, 666 "ListRecommendationsResponse": { 667 "base": null, 668 "refs": { 669 } 670 }, 671 "Locale": { 672 "base": null, 673 "refs": { 674 "ListRecommendationsRequest$Locale": "<p>A locale that specifies the language to use for recommendations.</p>" 675 } 676 }, 677 "MeanTimeToRecoverInMilliseconds": { 678 "base": null, 679 "refs": { 680 "DescribeAccountOverviewResponse$MeanTimeToRecoverInMilliseconds": "<p> The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in. </p>", 681 "InsightHealth$MeanTimeToRecoverInMilliseconds": "<p> The Meant Time to Recover (MTTR) for the insight. </p>" 682 } 683 }, 684 "NotificationChannel": { 685 "base": "<p> 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). </p> <p>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 <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html\">Permissions for cross account Amazon SNS topics</a>.</p> <p>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 <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html\">Permissions for AWS KMS–encrypted Amazon SNS topics</a>.</p>", 686 "refs": { 687 "Channels$member": null 688 } 689 }, 690 "NotificationChannelConfig": { 691 "base": "<p> Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).</p>", 692 "refs": { 693 "AddNotificationChannelRequest$Config": "<p> A <code>NotificationChannelConfig</code> object that specifies what type of notification channel to add. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS). </p>", 694 "NotificationChannel$Config": "<p> A <code>NotificationChannelConfig</code> object that contains information about configured notification channels. </p>" 695 } 696 }, 697 "NotificationChannelId": { 698 "base": null, 699 "refs": { 700 "AddNotificationChannelResponse$Id": "<p> The ID of the added notification channel. </p>", 701 "NotificationChannel$Id": "<p> The ID of a notification channel. </p>", 702 "RemoveNotificationChannelRequest$Id": "<p> The ID of the notification channel to be removed. </p>" 703 } 704 }, 705 "NumMetricsAnalyzed": { 706 "base": null, 707 "refs": { 708 "DescribeAccountHealthResponse$MetricsAnalyzed": "<p> An integer that specifies the number of metrics that have been analyzed in your AWS account. </p>" 709 } 710 }, 711 "NumOpenProactiveInsights": { 712 "base": null, 713 "refs": { 714 "DescribeAccountHealthResponse$OpenProactiveInsights": "<p> An integer that specifies the number of open proactive insights in your AWS account. </p>", 715 "InsightHealth$OpenProactiveInsights": "<p> The number of open proactive insights. </p>", 716 "ServiceInsightHealth$OpenProactiveInsights": "<p>The number of open proactive insights in the AWS service</p>" 717 } 718 }, 719 "NumOpenReactiveInsights": { 720 "base": null, 721 "refs": { 722 "DescribeAccountHealthResponse$OpenReactiveInsights": "<p> An integer that specifies the number of open reactive insights in your AWS account. </p>", 723 "InsightHealth$OpenReactiveInsights": "<p> The number of open reactive insights. </p>", 724 "ServiceInsightHealth$OpenReactiveInsights": "<p>The number of open reactive insights in the AWS service</p>" 725 } 726 }, 727 "NumProactiveInsights": { 728 "base": null, 729 "refs": { 730 "DescribeAccountOverviewResponse$ProactiveInsights": "<p> An integer that specifies the number of open proactive insights in your AWS account that were created during the time range passed in. </p>" 731 } 732 }, 733 "NumReactiveInsights": { 734 "base": null, 735 "refs": { 736 "DescribeAccountOverviewResponse$ReactiveInsights": "<p> An integer that specifies the number of open reactive insights in your AWS account that were created during the time range passed in. </p>" 737 } 738 }, 739 "OpsCenterIntegration": { 740 "base": "<p> Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight. </p>", 741 "refs": { 742 "ServiceIntegrationConfig$OpsCenter": "<p> Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight. </p>" 743 } 744 }, 745 "OpsCenterIntegrationConfig": { 746 "base": "<p> Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight. </p>", 747 "refs": { 748 "UpdateServiceIntegrationConfig$OpsCenter": null 749 } 750 }, 751 "OptInStatus": { 752 "base": "<p> Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight. </p>", 753 "refs": { 754 "OpsCenterIntegration$OptInStatus": "<p> Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight. </p>", 755 "OpsCenterIntegrationConfig$OptInStatus": "<p> Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight. </p>" 756 } 757 }, 758 "PredictionTimeRange": { 759 "base": "<p> The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur. </p>", 760 "refs": { 761 "ProactiveAnomaly$PredictionTimeRange": null, 762 "ProactiveAnomalySummary$PredictionTimeRange": null, 763 "ProactiveInsight$PredictionTimeRange": null, 764 "ProactiveInsightSummary$PredictionTimeRange": null 765 } 766 }, 767 "ProactiveAnomalies": { 768 "base": null, 769 "refs": { 770 "ListAnomaliesForInsightResponse$ProactiveAnomalies": "<p> An array of <code>ProactiveAnomalySummary</code> objects that represent the requested anomalies </p>" 771 } 772 }, 773 "ProactiveAnomaly": { 774 "base": "<p>Information about an anomaly. This object is returned by <code>ListAnomalies</code>.</p>", 775 "refs": { 776 "DescribeAnomalyResponse$ProactiveAnomaly": "<p> A <code>ReactiveAnomaly</code> object that represents the requested anomaly. </p>" 777 } 778 }, 779 "ProactiveAnomalySummary": { 780 "base": "<p>Details about a proactive anomaly. This object is returned by <code>DescribeAnomaly.</code> </p>", 781 "refs": { 782 "ProactiveAnomalies$member": null 783 } 784 }, 785 "ProactiveInsight": { 786 "base": "<p>Details about a proactive insight. This object is returned by <code>ListInsights</code>.</p>", 787 "refs": { 788 "DescribeInsightResponse$ProactiveInsight": "<p> A <code>ProactiveInsight</code> object that represents the requested insight. </p>" 789 } 790 }, 791 "ProactiveInsightSummary": { 792 "base": "<p>Details about a proactive insight. This object is returned by <code>DescribeInsight.</code> </p>", 793 "refs": { 794 "ProactiveInsights$member": null 795 } 796 }, 797 "ProactiveInsights": { 798 "base": null, 799 "refs": { 800 "ListInsightsResponse$ProactiveInsights": "<p> The returned list of proactive insights. </p>", 801 "SearchInsightsResponse$ProactiveInsights": "<p> The returned proactive insights. </p>" 802 } 803 }, 804 "PutFeedbackRequest": { 805 "base": null, 806 "refs": { 807 } 808 }, 809 "PutFeedbackResponse": { 810 "base": null, 811 "refs": { 812 } 813 }, 814 "ReactiveAnomalies": { 815 "base": null, 816 "refs": { 817 "ListAnomaliesForInsightResponse$ReactiveAnomalies": "<p> An array of <code>ReactiveAnomalySummary</code> objects that represent the requested anomalies </p>" 818 } 819 }, 820 "ReactiveAnomaly": { 821 "base": "<p>Details about a reactive anomaly. This object is returned by <code>ListAnomalies</code>.</p>", 822 "refs": { 823 "DescribeAnomalyResponse$ReactiveAnomaly": "<p> A <code>ProactiveAnomaly</code> object that represents the requested anomaly. </p>" 824 } 825 }, 826 "ReactiveAnomalySummary": { 827 "base": "<p>Details about a reactive anomaly. This object is returned by <code>DescribeAnomaly.</code> </p>", 828 "refs": { 829 "ReactiveAnomalies$member": null 830 } 831 }, 832 "ReactiveInsight": { 833 "base": "<p> Information about a reactive insight. This object is returned by <code>ListInsights</code>. </p>", 834 "refs": { 835 "DescribeInsightResponse$ReactiveInsight": "<p> A <code>ReactiveInsight</code> object that represents the requested insight. </p>" 836 } 837 }, 838 "ReactiveInsightSummary": { 839 "base": "<p> Information about a reactive insight. This object is returned by <code>DescribeInsight.</code> </p>", 840 "refs": { 841 "ReactiveInsights$member": null 842 } 843 }, 844 "ReactiveInsights": { 845 "base": null, 846 "refs": { 847 "ListInsightsResponse$ReactiveInsights": "<p> The returned list of reactive insights. </p>", 848 "SearchInsightsResponse$ReactiveInsights": "<p> The returned reactive insights. </p>" 849 } 850 }, 851 "Recommendation": { 852 "base": "<p> Recommendation information to help you remediate detected anomalous behavior that generated an insight. </p>", 853 "refs": { 854 "Recommendations$member": null 855 } 856 }, 857 "RecommendationDescription": { 858 "base": null, 859 "refs": { 860 "Recommendation$Description": "<p> A description of the problem. </p>" 861 } 862 }, 863 "RecommendationLink": { 864 "base": null, 865 "refs": { 866 "Recommendation$Link": "<p> A hyperlink to information to help you address the problem. </p>" 867 } 868 }, 869 "RecommendationName": { 870 "base": null, 871 "refs": { 872 "Recommendation$Name": "<p> The name of the recommendation. </p>" 873 } 874 }, 875 "RecommendationReason": { 876 "base": null, 877 "refs": { 878 "Recommendation$Reason": "<p> The reason DevOps Guru flagged the anomalous behavior as a problem. </p>" 879 } 880 }, 881 "RecommendationRelatedAnomalies": { 882 "base": null, 883 "refs": { 884 "Recommendation$RelatedAnomalies": "<p> Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue. </p>" 885 } 886 }, 887 "RecommendationRelatedAnomaly": { 888 "base": "<p> Information about an anomaly that is related to a recommendation. </p>", 889 "refs": { 890 "RecommendationRelatedAnomalies$member": null 891 } 892 }, 893 "RecommendationRelatedAnomalyResource": { 894 "base": "<p> Information about a resource in which DevOps Guru detected anomalous behavior. </p>", 895 "refs": { 896 "RecommendationRelatedAnomalyResources$member": null 897 } 898 }, 899 "RecommendationRelatedAnomalyResourceName": { 900 "base": null, 901 "refs": { 902 "RecommendationRelatedAnomalyResource$Name": "<p> The name of the resource. </p>" 903 } 904 }, 905 "RecommendationRelatedAnomalyResourceType": { 906 "base": null, 907 "refs": { 908 "RecommendationRelatedAnomalyResource$Type": "<p> The type of the resource. </p>" 909 } 910 }, 911 "RecommendationRelatedAnomalyResources": { 912 "base": null, 913 "refs": { 914 "RecommendationRelatedAnomaly$Resources": "<p> An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource. </p>" 915 } 916 }, 917 "RecommendationRelatedAnomalySourceDetail": { 918 "base": "<p> Contains an array of <code>RecommendationRelatedCloudWatchMetricsSourceDetail</code> objects that contain the name and namespace of an Amazon CloudWatch metric. </p>", 919 "refs": { 920 "RelatedAnomalySourceDetails$member": null 921 } 922 }, 923 "RecommendationRelatedCloudWatchMetricsSourceDetail": { 924 "base": "<p> 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. </p>", 925 "refs": { 926 "RecommendationRelatedCloudWatchMetricsSourceDetails$member": null 927 } 928 }, 929 "RecommendationRelatedCloudWatchMetricsSourceDetails": { 930 "base": null, 931 "refs": { 932 "RecommendationRelatedAnomalySourceDetail$CloudWatchMetrics": "<p> An array of <code>CloudWatchMetricsDetail</code> objects that contains information about the analyzed metrics that displayed anomalous behavior. </p>" 933 } 934 }, 935 "RecommendationRelatedCloudWatchMetricsSourceMetricName": { 936 "base": null, 937 "refs": { 938 "RecommendationRelatedCloudWatchMetricsSourceDetail$MetricName": "<p>The name of the CloudWatch metric.</p>" 939 } 940 }, 941 "RecommendationRelatedCloudWatchMetricsSourceNamespace": { 942 "base": null, 943 "refs": { 944 "RecommendationRelatedCloudWatchMetricsSourceDetail$Namespace": "<p>The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.</p>" 945 } 946 }, 947 "RecommendationRelatedEvent": { 948 "base": "<p> Information about an event that is related to a recommendation. </p>", 949 "refs": { 950 "RecommendationRelatedEvents$member": null 951 } 952 }, 953 "RecommendationRelatedEventName": { 954 "base": null, 955 "refs": { 956 "RecommendationRelatedEvent$Name": "<p> The name of the event. This corresponds to the <code>Name</code> field in an <code>Event</code> object. </p>" 957 } 958 }, 959 "RecommendationRelatedEventResource": { 960 "base": "<p> Information about an AWS resource that emitted and event that is related to a recommendation in an insight. </p>", 961 "refs": { 962 "RecommendationRelatedEventResources$member": null 963 } 964 }, 965 "RecommendationRelatedEventResourceName": { 966 "base": null, 967 "refs": { 968 "RecommendationRelatedEventResource$Name": "<p> The name of the resource that emitted the event. This corresponds to the <code>Name</code> field in an <code>EventResource</code> object. </p>" 969 } 970 }, 971 "RecommendationRelatedEventResourceType": { 972 "base": null, 973 "refs": { 974 "RecommendationRelatedEventResource$Type": "<p> The type of the resource that emitted the event. This corresponds to the <code>Type</code> field in an <code>EventResource</code> object. </p>" 975 } 976 }, 977 "RecommendationRelatedEventResources": { 978 "base": null, 979 "refs": { 980 "RecommendationRelatedEvent$Resources": "<p> A <code>ResourceCollection</code> object that contains arrays of the names of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks. </p>" 981 } 982 }, 983 "RecommendationRelatedEvents": { 984 "base": null, 985 "refs": { 986 "Recommendation$RelatedEvents": "<p> Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue. </p>" 987 } 988 }, 989 "Recommendations": { 990 "base": null, 991 "refs": { 992 "ListRecommendationsResponse$Recommendations": "<p> An array of the requested recommendations. </p>" 993 } 994 }, 995 "RelatedAnomalySourceDetails": { 996 "base": null, 997 "refs": { 998 "RecommendationRelatedAnomaly$SourceDetails": "<p> Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics. </p>" 999 } 1000 }, 1001 "RemoveNotificationChannelRequest": { 1002 "base": null, 1003 "refs": { 1004 } 1005 }, 1006 "RemoveNotificationChannelResponse": { 1007 "base": null, 1008 "refs": { 1009 } 1010 }, 1011 "ResourceCollection": { 1012 "base": "<p> A collection of AWS resources supported by DevOps Guru. 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. </p>", 1013 "refs": { 1014 "Event$ResourceCollection": null, 1015 "ListEventsFilters$ResourceCollection": null, 1016 "ProactiveAnomaly$ResourceCollection": null, 1017 "ProactiveAnomalySummary$ResourceCollection": null, 1018 "ProactiveInsight$ResourceCollection": null, 1019 "ProactiveInsightSummary$ResourceCollection": null, 1020 "ReactiveAnomaly$ResourceCollection": null, 1021 "ReactiveAnomalySummary$ResourceCollection": null, 1022 "ReactiveInsight$ResourceCollection": null, 1023 "ReactiveInsightSummary$ResourceCollection": null, 1024 "SearchInsightsFilters$ResourceCollection": null 1025 } 1026 }, 1027 "ResourceCollectionFilter": { 1028 "base": "<p> Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru. </p>", 1029 "refs": { 1030 "GetResourceCollectionResponse$ResourceCollection": "<p> 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. </p>" 1031 } 1032 }, 1033 "ResourceCollectionType": { 1034 "base": null, 1035 "refs": { 1036 "DescribeResourceCollectionHealthRequest$ResourceCollectionType": "<p> 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. </p>", 1037 "GetResourceCollectionRequest$ResourceCollectionType": "<p> The type of AWS resource collections to return. The one valid value is <code>CLOUD_FORMATION</code> for AWS CloudFormation stacks. </p>" 1038 } 1039 }, 1040 "ResourceHours": { 1041 "base": null, 1042 "refs": { 1043 "DescribeAccountHealthResponse$ResourceHours": "<p>The number of Amazon DevOps Guru resource analysis hours billed to the current AWS account in the last hour. </p>" 1044 } 1045 }, 1046 "ResourceIdString": { 1047 "base": null, 1048 "refs": { 1049 "ConflictException$ResourceId": "<p> The ID of the AWS resource in which a conflict occurred. </p>", 1050 "ResourceNotFoundException$ResourceId": "<p> The ID of the AWS resource that could not be found. </p>" 1051 } 1052 }, 1053 "ResourceIdType": { 1054 "base": null, 1055 "refs": { 1056 "ConflictException$ResourceType": "<p> The type of the AWS resource in which a conflict occurred. </p>", 1057 "ResourceNotFoundException$ResourceType": "<p> The type of the AWS resource that could not be found. </p>" 1058 } 1059 }, 1060 "ResourceNotFoundException": { 1061 "base": "<p>A requested resource could not be found</p>", 1062 "refs": { 1063 } 1064 }, 1065 "ResourceType": { 1066 "base": null, 1067 "refs": { 1068 "ServiceResourceCost$Type": "<p>The type of the AWS resource.</p>" 1069 } 1070 }, 1071 "RetryAfterSeconds": { 1072 "base": null, 1073 "refs": { 1074 "InternalServerException$RetryAfterSeconds": "<p> The number of seconds after which the action that caused the internal server exception can be retried. </p>", 1075 "ThrottlingException$RetryAfterSeconds": "<p> The number of seconds after which the action that caused the throttling exception can be retried. </p>" 1076 } 1077 }, 1078 "SearchInsightsFilters": { 1079 "base": "<p> Specifies one or more severity values and one or more status values that are used to search for insights. </p>", 1080 "refs": { 1081 "SearchInsightsRequest$Filters": "<p> A <code>SearchInsightsFilters</code> object that is used to set the severity and status filters on your insight search. </p>" 1082 } 1083 }, 1084 "SearchInsightsMaxResults": { 1085 "base": null, 1086 "refs": { 1087 "SearchInsightsRequest$MaxResults": "<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>" 1088 } 1089 }, 1090 "SearchInsightsRequest": { 1091 "base": null, 1092 "refs": { 1093 } 1094 }, 1095 "SearchInsightsResponse": { 1096 "base": null, 1097 "refs": { 1098 } 1099 }, 1100 "ServiceCollection": { 1101 "base": "<p>A collection of the names of AWS services.</p>", 1102 "refs": { 1103 "ProactiveInsightSummary$ServiceCollection": "<p>A collection of the names of AWS services.</p>", 1104 "ReactiveInsightSummary$ServiceCollection": "<p>A collection of the names of AWS services.</p>", 1105 "SearchInsightsFilters$ServiceCollection": "<p>A collection of the names of AWS services.</p>" 1106 } 1107 }, 1108 "ServiceHealth": { 1109 "base": "<p>Represents the health of an AWS service.</p>", 1110 "refs": { 1111 "ServiceHealths$member": null 1112 } 1113 }, 1114 "ServiceHealths": { 1115 "base": null, 1116 "refs": { 1117 "DescribeResourceCollectionHealthResponse$Service": "<p>An array of <code>ServiceHealth</code> objects that describes the health of the AWS services associated with the resources in the collection.</p>" 1118 } 1119 }, 1120 "ServiceInsightHealth": { 1121 "base": "<p>Contains the number of open proactive and reactive insights in an analyzed AWS service.</p>", 1122 "refs": { 1123 "ServiceHealth$Insight": "<p>Represents the health of an AWS service. This is a <code>ServiceInsightHealth</code> that contains the number of open proactive and reactive insights for this service.</p>" 1124 } 1125 }, 1126 "ServiceIntegrationConfig": { 1127 "base": "<p> Information about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager. </p>", 1128 "refs": { 1129 "DescribeServiceIntegrationResponse$ServiceIntegration": null 1130 } 1131 }, 1132 "ServiceName": { 1133 "base": null, 1134 "refs": { 1135 "ServiceHealth$ServiceName": "<p>The name of the AWS service.</p>", 1136 "ServiceNames$member": null 1137 } 1138 }, 1139 "ServiceNames": { 1140 "base": null, 1141 "refs": { 1142 "ServiceCollection$ServiceNames": "<p>An array of strings that each specifies the name of an AWS service.</p>" 1143 } 1144 }, 1145 "ServiceQuotaExceededException": { 1146 "base": "<p>The request contains a value that exceeds a maximum quota.</p>", 1147 "refs": { 1148 } 1149 }, 1150 "ServiceResourceCost": { 1151 "base": "<p>An object that contains information about the estimated monthly cost to analyze an AWS resource. For more information, see <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html\">Estimate your Amazon DevOps Guru costs</a> and <a href=\"http://aws.amazon.com/devops-guru/pricing/\">Amazon DevOps Guru pricing</a>.</p>", 1152 "refs": { 1153 "ServiceResourceCosts$member": null 1154 } 1155 }, 1156 "ServiceResourceCosts": { 1157 "base": null, 1158 "refs": { 1159 "GetCostEstimationResponse$Costs": "<p>An array of <code>ResourceCost</code> objects that each contains details about the monthly cost estimate to analyze one of your AWS resources.</p>" 1160 } 1161 }, 1162 "SnsChannelConfig": { 1163 "base": "<p> Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. </p> <p>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 <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html\">Permissions for cross account Amazon SNS topics</a>.</p> <p>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 <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html\">Permissions for AWS KMS–encrypted Amazon SNS topics</a>.</p>", 1164 "refs": { 1165 "NotificationChannelConfig$Sns": "<p> Information about a notification channel configured in DevOps Guru to send notifications when insights are created. </p> <p>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 <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html\">Permissions for cross account Amazon SNS topics</a>.</p> <p>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 <a href=\"https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html\">Permissions for AWS KMS–encrypted Amazon SNS topics</a>.</p>" 1166 } 1167 }, 1168 "SsmOpsItemId": { 1169 "base": null, 1170 "refs": { 1171 "ProactiveInsight$SsmOpsItemId": "<p> 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. </p>", 1172 "ReactiveInsight$SsmOpsItemId": "<p> 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. </p>" 1173 } 1174 }, 1175 "StackName": { 1176 "base": null, 1177 "refs": { 1178 "CloudFormationHealth$StackName": "<p> The name of the CloudFormation stack. </p>", 1179 "CostEstimationStackNames$member": null, 1180 "StackNames$member": null, 1181 "UpdateStackNames$member": null 1182 } 1183 }, 1184 "StackNames": { 1185 "base": null, 1186 "refs": { 1187 "CloudFormationCollection$StackNames": "<p> An array of CloudFormation stack names. </p>", 1188 "CloudFormationCollectionFilter$StackNames": "<p> An array of CloudFormation stack names. </p>" 1189 } 1190 }, 1191 "StartCostEstimationRequest": { 1192 "base": null, 1193 "refs": { 1194 } 1195 }, 1196 "StartCostEstimationResponse": { 1197 "base": null, 1198 "refs": { 1199 } 1200 }, 1201 "StartTimeRange": { 1202 "base": "<p> A time range used to specify when the behavior of an insight or anomaly started. </p>", 1203 "refs": { 1204 "ListAnomaliesForInsightRequest$StartTimeRange": "<p> A time range used to specify when the requested anomalies started. All returned anomalies started during this time range. </p>", 1205 "ListInsightsAnyStatusFilter$StartTimeRange": "<p> A time range used to specify when the behavior of the filtered insights started. </p>", 1206 "SearchInsightsRequest$StartTimeRange": "<p> The start of the time range passed in. Returned insights occurred after this time. </p>" 1207 } 1208 }, 1209 "ThrottlingException": { 1210 "base": "<p>The request was denied due to a request throttling.</p>", 1211 "refs": { 1212 } 1213 }, 1214 "Timestamp": { 1215 "base": null, 1216 "refs": { 1217 "AnomalyReportedTimeRange$OpenTime": "<p> The time when an anomaly is opened. </p>", 1218 "AnomalyReportedTimeRange$CloseTime": "<p> The time when an anomaly is closed. </p>", 1219 "AnomalyTimeRange$StartTime": "<p> The time when the anomalous behavior started. </p>", 1220 "AnomalyTimeRange$EndTime": "<p> The time when the anomalous behavior ended. </p>", 1221 "CostEstimationTimeRange$StartTime": "<p>The start time of the cost estimation.</p>", 1222 "CostEstimationTimeRange$EndTime": "<p>The end time of the cost estimation.</p>", 1223 "DescribeAccountOverviewRequest$FromTime": "<p> 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. </p>", 1224 "DescribeAccountOverviewRequest$ToTime": "<p> 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. </p>", 1225 "EndTimeRange$FromTime": "<p> The earliest end time in the time range. </p>", 1226 "EndTimeRange$ToTime": "<p> The latest end time in the time range. </p>", 1227 "Event$Time": "<p> A <code>Timestamp</code> that specifies the time the event occurred. </p>", 1228 "EventTimeRange$FromTime": "<p> The time when the event started. </p>", 1229 "EventTimeRange$ToTime": "<p> The time when the event ended. </p>", 1230 "InsightTimeRange$StartTime": "<p> The time when the behavior described in an insight started. </p>", 1231 "InsightTimeRange$EndTime": "<p> The time when the behavior described in an insight ended. </p>", 1232 "PredictionTimeRange$StartTime": "<p> The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only. </p>", 1233 "PredictionTimeRange$EndTime": "<p> The time when the behavior in a proactive insight is expected to end. </p>", 1234 "ProactiveAnomaly$UpdateTime": "<p> The time of the anomaly's most recent update. </p>", 1235 "ProactiveAnomalySummary$UpdateTime": "<p> The time of the anomaly's most recent update. </p>", 1236 "StartTimeRange$FromTime": "<p> The start time of the time range. </p>", 1237 "StartTimeRange$ToTime": "<p> The end time of the time range. </p>" 1238 } 1239 }, 1240 "TopicArn": { 1241 "base": null, 1242 "refs": { 1243 "SnsChannelConfig$TopicArn": "<p> The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. </p>" 1244 } 1245 }, 1246 "UpdateCloudFormationCollectionFilter": { 1247 "base": "<p> Contains the names of AWS CloudFormation stacks used to update a collection of stacks. You can specify up to 500 AWS CloudFormation stacks.</p>", 1248 "refs": { 1249 "UpdateResourceCollectionFilter$CloudFormation": "<p> An collection of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks. </p>" 1250 } 1251 }, 1252 "UpdateResourceCollectionAction": { 1253 "base": null, 1254 "refs": { 1255 "UpdateResourceCollectionRequest$Action": "<p> Specifies if the resource collection in the request is added or deleted to the resource collection. </p>" 1256 } 1257 }, 1258 "UpdateResourceCollectionFilter": { 1259 "base": "<p> Contains information used to update a collection of AWS resources. </p>", 1260 "refs": { 1261 "UpdateResourceCollectionRequest$ResourceCollection": null 1262 } 1263 }, 1264 "UpdateResourceCollectionRequest": { 1265 "base": null, 1266 "refs": { 1267 } 1268 }, 1269 "UpdateResourceCollectionResponse": { 1270 "base": null, 1271 "refs": { 1272 } 1273 }, 1274 "UpdateServiceIntegrationConfig": { 1275 "base": "<p> Information about updating the integration status of an AWS service, such as AWS Systems Manager, with DevOps Guru. </p>", 1276 "refs": { 1277 "UpdateServiceIntegrationRequest$ServiceIntegration": "<p> An <code>IntegratedServiceConfig</code> object used to specify the integrated service you want to update, and whether you want to update it to enabled or disabled. </p>" 1278 } 1279 }, 1280 "UpdateServiceIntegrationRequest": { 1281 "base": null, 1282 "refs": { 1283 } 1284 }, 1285 "UpdateServiceIntegrationResponse": { 1286 "base": null, 1287 "refs": { 1288 } 1289 }, 1290 "UpdateStackNames": { 1291 "base": null, 1292 "refs": { 1293 "UpdateCloudFormationCollectionFilter$StackNames": "<p> An array of the names of the AWS CloudFormation stacks to update. You can specify up to 500 AWS CloudFormation stacks. </p>" 1294 } 1295 }, 1296 "UuidNextToken": { 1297 "base": null, 1298 "refs": { 1299 "DescribeResourceCollectionHealthRequest$NextToken": "<p>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.</p>", 1300 "DescribeResourceCollectionHealthResponse$NextToken": "<p>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.</p>", 1301 "GetCostEstimationRequest$NextToken": "<p>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.</p>", 1302 "GetCostEstimationResponse$NextToken": "<p>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.</p>", 1303 "GetResourceCollectionRequest$NextToken": "<p>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.</p>", 1304 "GetResourceCollectionResponse$NextToken": "<p>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.</p>", 1305 "ListAnomaliesForInsightRequest$NextToken": "<p>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.</p>", 1306 "ListAnomaliesForInsightResponse$NextToken": "<p>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.</p>", 1307 "ListEventsRequest$NextToken": "<p>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.</p>", 1308 "ListEventsResponse$NextToken": "<p>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.</p>", 1309 "ListInsightsRequest$NextToken": "<p>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.</p>", 1310 "ListInsightsResponse$NextToken": "<p>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.</p>", 1311 "ListNotificationChannelsRequest$NextToken": "<p>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.</p>", 1312 "ListNotificationChannelsResponse$NextToken": "<p>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.</p>", 1313 "ListRecommendationsRequest$NextToken": "<p>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.</p>", 1314 "ListRecommendationsResponse$NextToken": "<p>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.</p>", 1315 "SearchInsightsRequest$NextToken": "<p>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.</p>", 1316 "SearchInsightsResponse$NextToken": "<p>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.</p>" 1317 } 1318 }, 1319 "ValidationException": { 1320 "base": "<p> Contains information about data passed in to a field during a request that is not valid. </p>", 1321 "refs": { 1322 } 1323 }, 1324 "ValidationExceptionField": { 1325 "base": "<p> The field associated with the validation exception. </p>", 1326 "refs": { 1327 "ValidationExceptionFields$member": null 1328 } 1329 }, 1330 "ValidationExceptionFields": { 1331 "base": "<p> An array of fields that are associated with the validation exception. </p>", 1332 "refs": { 1333 "ValidationException$Fields": null 1334 } 1335 }, 1336 "ValidationExceptionReason": { 1337 "base": null, 1338 "refs": { 1339 "ValidationException$Reason": "<p> The reason the validation exception was thrown. </p>" 1340 } 1341 } 1342 } 1343 }