From 2de26a22ba8b2db393adce4828a90d7d9b079959 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Wed, 14 Dec 2022 19:09:24 +0000 Subject: [PATCH] Update API model --- .../sdk-codegen/aws-models/cloudwatch.json | 264 +- .../sdk-codegen/aws-models/cost-explorer.json | 73 +- .../aws-models/networkmanager.json | 2362 ++++++++++++----- .../sdk-codegen/aws-models/redshift-data.json | 558 +++- .../aws-models/sagemaker-metrics.json | 98 +- 5 files changed, 2477 insertions(+), 878 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/cloudwatch.json b/codegen/sdk-codegen/aws-models/cloudwatch.json index f8739e1c446..78af32f5a7c 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch.json @@ -301,7 +301,7 @@ "MetricTimezone": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone", "traits": { - "smithy.api#documentation": "

The time zone to use for the metric. This is useful to enable the model to automatically\n\t\t\taccount for daylight savings time changes if the metric is sensitive to such time\n\t\t\tchanges.

\n\t\t

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, \n\t\t\tsee tz database.

" + "smithy.api#documentation": "

The time zone to use for the metric. This is useful to enable the model to automatically\n\t\t\taccount for daylight savings time changes if the metric is sensitive to such time\n\t\t\tchanges.

\n

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, \n\t\t\tsee tz database.

" } } }, @@ -557,13 +557,13 @@ "ActionsSuppressorWaitPeriod": { "target": "com.amazonaws.cloudwatch#SuppressorPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n\t\t \n\t\t\t

\n\t\t\t\t WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n \n

\n WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n " } }, "ActionsSuppressorExtensionPeriod": { "target": "com.amazonaws.cloudwatch#SuppressorPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n\t\t \n\t\t\t

\n\t\t\t\t ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n \n

\n ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n " } } }, @@ -828,7 +828,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more\n\t\t\tthan one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't\n\t\t\tdelete two composite alarms with one operation.

\n\t\t

\n\t\t\tIn the event of an error, no alarms are\n\t\t\tdeleted.

\n\t\t \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n\t\t\t

To get out of such a situation, you must\n\t\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to false.

\n\t\t\t

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t\t

\n " + "smithy.api#documentation": "

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more\n\t\t\tthan one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't\n\t\t\tdelete two composite alarms with one operation.

\n

\n\t\t\tIn the event of an error, no alarms are\n\t\t\tdeleted.

\n \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n

To get out of such a situation, you must\n\t\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to false.

\n

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t\t

\n " } }, "com.amazonaws.cloudwatch#DeleteAlarmsInput": { @@ -914,13 +914,13 @@ "SingleMetricAnomalyDetector": { "target": "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector", "traits": { - "smithy.api#documentation": "

A single metric anomaly detector to be deleted.

\n\t\t

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the single metric anomaly detector attributes \n\t\t\tas part of the SingleMetricAnomalyDetector property.

" + "smithy.api#documentation": "

A single metric anomaly detector to be deleted.

\n

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n \n

Instead, specify the single metric anomaly detector attributes \n\t\t\tas part of the SingleMetricAnomalyDetector property.

" } }, "MetricMathAnomalyDetector": { "target": "com.amazonaws.cloudwatch#MetricMathAnomalyDetector", "traits": { - "smithy.api#documentation": "

The metric math anomaly detector to be deleted.

\n\t\t

When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the metric math anomaly detector attributes as part of the\n\t\t\tMetricMathAnomalyDetector property.

" + "smithy.api#documentation": "

The metric math anomaly detector to be deleted.

\n

When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:

\n \n

Instead, specify the metric math anomaly detector attributes as part of the\n\t\t\tMetricMathAnomalyDetector property.

" } } } @@ -985,7 +985,7 @@ } ], "traits": { - "smithy.api#documentation": "

Permanently deletes the specified Contributor Insights rules.

\n\t\t

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might\n\t\t\tnot be available.

" + "smithy.api#documentation": "

Permanently deletes the specified Contributor Insights rules.

\n

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might\n\t\t\tnot be available.

" } }, "com.amazonaws.cloudwatch#DeleteInsightRulesInput": { @@ -1064,7 +1064,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type.\n\t\t\tIf an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

\n\t\t

CloudWatch retains the history of an alarm even if you delete the alarm.

\n\t\t

To use this operation and return information about a composite alarm, you must be signed on with \n\t\t\tthe cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

", + "smithy.api#documentation": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type.\n\t\t\tIf an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

\n

CloudWatch retains the history of an alarm even if you delete the alarm.

\n

To use this operation and return information about a composite alarm, you must be signed on with \n\t\t\tthe cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1157,7 +1157,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm\n\t\t\tname, the alarm state, or a prefix for any action.

\n\t\t

To use this operation and return information about composite alarms, you must be signed on with \n\t\tthe cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

", + "smithy.api#documentation": "

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm\n\t\t\tname, the alarm state, or a prefix for any action.

\n

To use this operation and return information about composite alarms, you must be signed on with \n\t\tthe cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1206,7 +1206,7 @@ "target": "com.amazonaws.cloudwatch#DescribeAlarmsForMetricOutput" }, "traits": { - "smithy.api#documentation": "

Retrieves the alarms for the specified metric. To\n\t\t\tfilter the results, specify a statistic, period, or unit.

\n\t\t

This operation retrieves only standard alarms that are based on\n\t\tthe specified metric. It does not return alarms based on math expressions that\n\t\tuse the specified metric, or composite alarms that use the specified metric.

" + "smithy.api#documentation": "

Retrieves the alarms for the specified metric. To\n\t\t\tfilter the results, specify a statistic, period, or unit.

\n

This operation retrieves only standard alarms that are based on\n\t\tthe specified metric. It does not return alarms based on math expressions that\n\t\tuse the specified metric, or composite alarms that use the specified metric.

" } }, "com.amazonaws.cloudwatch#DescribeAlarmsForMetricInput": { @@ -1281,7 +1281,7 @@ "AlarmNamePrefix": { "target": "com.amazonaws.cloudwatch#AlarmNamePrefix", "traits": { - "smithy.api#documentation": "

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names\n\t\t\tthat start with this prefix.

\n\t\t

If this parameter\n\t\t\tis specified, you cannot specify AlarmNames.

" + "smithy.api#documentation": "

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names\n\t\t\tthat start with this prefix.

\n

If this parameter\n\t\t\tis specified, you cannot specify AlarmNames.

" } }, "AlarmTypes": { @@ -1293,13 +1293,13 @@ "ChildrenOfAlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { - "smithy.api#documentation": "

If you use this parameter and specify the name of a composite alarm, the operation returns \n\t\t\tinformation about the \"children\" alarms\n\t\t\tof the alarm you specify. These are the metric alarms and composite alarms referenced in the \n\t\t\tAlarmRule field of the composite alarm that you specify in \n\t\t\tChildrenOfAlarmName. Information about the composite alarm that you name in \n\t\t\tChildrenOfAlarmName is not returned.

\n\t\t

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you\n\t\t\treceive a validation\n\t\t\terror.

\n\t\t \n

Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp \n\t\t\tinformation are returned by this operation \n\t\t\twhen you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " + "smithy.api#documentation": "

If you use this parameter and specify the name of a composite alarm, the operation returns \n\t\t\tinformation about the \"children\" alarms\n\t\t\tof the alarm you specify. These are the metric alarms and composite alarms referenced in the \n\t\t\tAlarmRule field of the composite alarm that you specify in \n\t\t\tChildrenOfAlarmName. Information about the composite alarm that you name in \n\t\t\tChildrenOfAlarmName is not returned.

\n

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you\n\t\t\treceive a validation\n\t\t\terror.

\n \n

Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp \n\t\t\tinformation are returned by this operation \n\t\t\twhen you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " } }, "ParentsOfAlarmName": { "target": "com.amazonaws.cloudwatch#AlarmName", "traits": { - "smithy.api#documentation": "

If you use this parameter and specify the name of a metric or composite alarm, the operation returns \n\t\t\tinformation about the \"parent\" alarms\n\t\t\tof the alarm you specify. These are the composite alarms that have AlarmRule\n\t\t\tparameters that reference \n\t\t\tthe alarm named in ParentsOfAlarmName. Information about the alarm that you specify in\n\t\t\tParentsOfAlarmName is not returned.

\n\t\t

If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you receive a validation\n\t\t\terror.

\n\t\t \n

Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " + "smithy.api#documentation": "

If you use this parameter and specify the name of a metric or composite alarm, the operation returns \n\t\t\tinformation about the \"parent\" alarms\n\t\t\tof the alarm you specify. These are the composite alarms that have AlarmRule\n\t\t\tparameters that reference \n\t\t\tthe alarm named in ParentsOfAlarmName. Information about the alarm that you specify in\n\t\t\tParentsOfAlarmName is not returned.

\n

If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you receive a validation\n\t\t\terror.

\n \n

Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.

\n " } }, "StateValue": { @@ -1395,7 +1395,7 @@ "MaxResults": { "target": "com.amazonaws.cloudwatch#MaxReturnedResultsCount", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in one operation. The maximum\n\t\t\tvalue that you can specify is 100.

\n\t\t\t

To retrieve the remaining results, make another call with the returned \n\t\t\tNextToken value.

" + "smithy.api#documentation": "

The maximum number of results to return in one operation. The maximum\n\t\t\tvalue that you can specify is 100.

\n

To retrieve the remaining results, make another call with the returned \n\t\t\tNextToken value.

" } }, "Namespace": { @@ -1455,7 +1455,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all the Contributor Insights rules in your account.

\n\t\t\n\t\t

For more information about Contributor Insights, see \n\t\tUsing Contributor Insights to Analyze High-Cardinality Data.

", + "smithy.api#documentation": "

Returns a list of all the Contributor Insights rules in your account.

\n

For more information about Contributor Insights, see \n\t\tUsing Contributor Insights to Analyze High-Cardinality Data.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1516,7 +1516,7 @@ } }, "traits": { - "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n\t\t

You \n\t\tcan assign up to 30 dimensions to a metric.

" + "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n

You \n\t\tcan assign up to 30 dimensions to a metric.

" } }, "com.amazonaws.cloudwatch#DimensionFilter": { @@ -1745,6 +1745,17 @@ } } }, + "com.amazonaws.cloudwatch#EvaluationState": { + "type": "enum", + "members": { + "PARTIAL_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL_DATA" + } + } + } + }, "com.amazonaws.cloudwatch#ExceptionType": { "type": "string" }, @@ -1795,7 +1806,7 @@ } ], "traits": { - "smithy.api#documentation": "

Displays the details of the dashboard that you specify.

\n\t\t

To copy an existing dashboard, use GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard to create\n\t\t\tthe copy.

" + "smithy.api#documentation": "

Displays the details of the dashboard that you specify.

\n

To copy an existing dashboard, use GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard to create\n\t\t\tthe copy.

" } }, "com.amazonaws.cloudwatch#GetDashboardInput": { @@ -1853,7 +1864,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of \n\t\tcontributors to the log group.

\n\t\t

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

\n\t\t " + "smithy.api#documentation": "

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of \n\t\tcontributors to the log group.

\n

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

\n " } }, "com.amazonaws.cloudwatch#GetInsightRuleReportInput": { @@ -1896,7 +1907,7 @@ "Metrics": { "target": "com.amazonaws.cloudwatch#InsightRuleMetricList", "traits": { - "smithy.api#documentation": "

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more\n\t\tof the following metrics:

\n\t\t " + "smithy.api#documentation": "

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more\n\t\tof the following metrics:

\n " } }, "OrderBy": { @@ -1962,7 +1973,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can use the GetMetricData API to retrieve CloudWatch metric values. The operation \n\t\t\tcan also include a CloudWatch Metrics Insights query, and one or more metric math functions.

\n\t\t

A GetMetricData operation that does not include a query can retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform metric math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\t\tGuide.

\n\t\t\n\t\t\t\t\n\t\t

If you include a Metrics Insights query, each GetMetricData operation can include only one\n\t\t\tquery. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries\n\t\tcan query only the most recent three hours of metric data. For more information about Metrics Insights, \n\t\tsee Query your metrics with CloudWatch Metrics Insights.

\n\t\t\n\t\t

Calls to the GetMetricData API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.

\n\n\t\t

Amazon CloudWatch retains metric data as follows:

\n\t\t \n\t\t

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.

\n\t\t\n\t\t

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

\n\t\n\t\t

\n Using Metrics Insights queries with metric math\n

\n\t\t

You can't mix a Metric Insights query and metric math syntax in the same expression, but \n\t\t\tyou can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights \n\t\t\tquery without a GROUP BY clause returns a single time-series (TS), \n\t\t\tand can be used as input for a metric math expression that expects a single time series. A Metrics Insights \n\t\t\tquery with a GROUP BY clause returns an array of time-series (TS[]), \n\t\t\tand can be used as input for a metric math expression that expects an array of time series.

", + "smithy.api#documentation": "

You can use the GetMetricData API to retrieve CloudWatch metric values. The operation \n\t\t\tcan also include a CloudWatch Metrics Insights query, and one or more metric math functions.

\n

A GetMetricData operation that does not include a query can retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform metric math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\t\tGuide.

\n

If you include a Metrics Insights query, each GetMetricData operation can include only one\n\t\t\tquery. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries\n\t\tcan query only the most recent three hours of metric data. For more information about Metrics Insights, \n\t\tsee Query your metrics with CloudWatch Metrics Insights.

\n

Calls to the GetMetricData API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.

\n

Amazon CloudWatch retains metric data as follows:

\n \n

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.

\n

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

\n

\n Using Metrics Insights queries with metric math\n

\n

You can't mix a Metric Insights query and metric math syntax in the same expression, but \n\t\t\tyou can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights \n\t\t\tquery without a GROUP BY clause returns a single time-series (TS), \n\t\t\tand can be used as input for a metric math expression that expects a single time series. A Metrics Insights \n\t\t\tquery with a GROUP BY clause returns an array of time-series (TS[]), \n\t\t\tand can be used as input for a metric math expression that expects an array of time series.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1976,21 +1987,21 @@ "MetricDataQueries": { "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,\n\t\tor a math expression to perform on retrieved data.

", + "smithy.api#documentation": "

The metric queries to be returned. A single GetMetricData call can \n\t\t\tinclude as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,\n\t\tor a math expression to perform on retrieved data.

", "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp indicating the earliest data to be returned.

\n\t\t

The value specified is inclusive; results include data points with the specified time stamp.

\n\t\t

CloudWatch rounds the specified time stamp as follows:

\n\t\t \n\t\t

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

\n\t\t

For better performance, specify StartTime and EndTime\n\t\tvalues that align with the value of the metric's Period and sync up with\n\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\tis 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the StartTime.

", + "smithy.api#documentation": "

The time stamp indicating the earliest data to be returned.

\n

The value specified is inclusive; results include data points with the specified time stamp.

\n

CloudWatch rounds the specified time stamp as follows:

\n \n

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

\n

For better performance, specify StartTime and EndTime\n\t\tvalues that align with the value of the metric's Period and sync up with\n\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\tis 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the StartTime.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp indicating the latest data to be returned.

\n\t\t

The value specified is exclusive; results include data points up to the specified time stamp.

\n\t\t

For better performance, specify StartTime and EndTime\n\t\t\tvalues that align with the value of the metric's Period and sync up with\n\t\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\t\tis 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the EndTime.

", + "smithy.api#documentation": "

The time stamp indicating the latest data to be returned.

\n

The value specified is exclusive; results include data points up to the specified time stamp.

\n

For better performance, specify StartTime and EndTime\n\t\t\tvalues that align with the value of the metric's Period and sync up with\n\t\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\t\tis 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the EndTime.

", "smithy.api#required": {} } }, @@ -2044,7 +2055,7 @@ "Messages": { "target": "com.amazonaws.cloudwatch#MetricDataResultMessages", "traits": { - "smithy.api#documentation": "

Contains a message about this GetMetricData operation, if the operation results in such a message.\n\t\t\tAn example of a message that\n\t\t\tmight be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the\n\t\t\toperation as possible is still executed.

\n\t\t

A message appears here only if it is related to the global GetMetricData operation. Any message\n\t\t\tabout a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

" + "smithy.api#documentation": "

Contains a message about this GetMetricData operation, if the operation results in such a message.\n\t\t\tAn example of a message that\n\t\t\tmight be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the\n\t\t\toperation as possible is still executed.

\n

A message appears here only if it is related to the global GetMetricData operation. Any message\n\t\t\tabout a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

" } } } @@ -2072,7 +2083,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets statistics for the specified metric.

\n\n\n\n\t\t

The maximum number of data points returned from a single call is 1,440. If \n\t\t\tyou request more than 1,440 data points, CloudWatch returns an error. \n\t\t\tTo reduce the number of data points, you can narrow the specified time range and make \n\t\t\tmultiple requests across adjacent time ranges, or you can increase the specified period. \n\t\t\tData points are not returned in chronological order.

\n\n\t\t

CloudWatch aggregates data points based on the length of the period\n\t\t\tthat you specify. For example, if you request statistics with a one-hour period, \n\t\t\tCloudWatch aggregates all data points with time stamps that fall within each \n\t\t\tone-hour period. Therefore, the number of values aggregated by CloudWatch is larger than\n\t\t\tthe number of data points returned.

\n\t\t

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n\t\t \n\t\t

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

\n\t\t

Amazon CloudWatch retains metric data as follows:

\n\t\t \n\t\t

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\ta resolution of 1 hour.

\n\t\t

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

\t\n\n\t\t

For information about metrics and dimensions supported by Amazon Web Services services, see the \n\t\t\tAmazon CloudWatch Metrics and Dimensions Reference in the\n\t\t\tAmazon CloudWatch User Guide.

" + "smithy.api#documentation": "

Gets statistics for the specified metric.

\n

The maximum number of data points returned from a single call is 1,440. If \n\t\t\tyou request more than 1,440 data points, CloudWatch returns an error. \n\t\t\tTo reduce the number of data points, you can narrow the specified time range and make \n\t\t\tmultiple requests across adjacent time ranges, or you can increase the specified period. \n\t\t\tData points are not returned in chronological order.

\n

CloudWatch aggregates data points based on the length of the period\n\t\t\tthat you specify. For example, if you request statistics with a one-hour period, \n\t\t\tCloudWatch aggregates all data points with time stamps that fall within each \n\t\t\tone-hour period. Therefore, the number of values aggregated by CloudWatch is larger than\n\t\t\tthe number of data points returned.

\n

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n \n

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

\n

Amazon CloudWatch retains metric data as follows:

\n \n

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\ta resolution of 1 hour.

\n

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

\n

For information about metrics and dimensions supported by Amazon Web Services services, see the \n\t\t\tAmazon CloudWatch Metrics and Dimensions Reference in the\n\t\t\tAmazon CloudWatch User Guide.

" } }, "com.amazonaws.cloudwatch#GetMetricStatisticsInput": { @@ -2101,21 +2112,21 @@ "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp that determines the first data point to return. Start times are \n\t\t\tevaluated relative to the time that CloudWatch receives the request.

\n\t

The value specified is inclusive; results include data points with the specified time stamp. \n\t \tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

\n\t\t

CloudWatch rounds the specified time stamp as follows:

\n\t\t \n\t\t

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

", + "smithy.api#documentation": "

The time stamp that determines the first data point to return. Start times are \n\t\t\tevaluated relative to the time that CloudWatch receives the request.

\n

The value specified is inclusive; results include data points with the specified time stamp. \n\t \tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

\n

CloudWatch rounds the specified time stamp as follows:

\n \n

If you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp that determines the last data point to return.

\n\t\t

The value specified is exclusive; results include data points up to the specified time stamp.\n\t\t\tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

", + "smithy.api#documentation": "

The time stamp that determines the last data point to return.

\n

The value specified is exclusive; results include data points up to the specified time stamp.\n\t\t\tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

", "smithy.api#required": {} } }, "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n\t\t

If the StartTime parameter specifies a time stamp that is greater than\n\t\t 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n\t\t ", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n\t\t 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n ", "smithy.api#required": {} } }, @@ -2277,7 +2288,7 @@ "target": "com.amazonaws.cloudwatch#GetMetricWidgetImageOutput" }, "traits": { - "smithy.api#documentation": "

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of \n\t\t\tone or more Amazon CloudWatch metrics as a bitmap image. You can then embed this \n\t\t\timage into your services and products, such as wiki pages, reports, and documents. \n\t\t\tYou could also retrieve images regularly, such as every minute, and create your own \n\t\t\tcustom live dashboard.

\n\t\t\n\t\t

The graph you retrieve can include all CloudWatch metric graph features, including metric math\n\t\tand horizontal and vertical annotations.

\n\t\t\n\t\t

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

\n\t\t " + "smithy.api#documentation": "

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of \n\t\t\tone or more Amazon CloudWatch metrics as a bitmap image. You can then embed this \n\t\t\timage into your services and products, such as wiki pages, reports, and documents. \n\t\t\tYou could also retrieve images regularly, such as every minute, and create your own \n\t\t\tcustom live dashboard.

\n

The graph you retrieve can include all CloudWatch metric graph features, including metric math\n\t\tand horizontal and vertical annotations.

\n

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

\n " } }, "com.amazonaws.cloudwatch#GetMetricWidgetImageInput": { @@ -2286,14 +2297,14 @@ "MetricWidget": { "target": "com.amazonaws.cloudwatch#MetricWidget", "traits": { - "smithy.api#documentation": "

A JSON string that defines the bitmap graph to be retrieved. The string includes the \n\t\t\tmetrics to include in the graph, statistics, annotations, title, axis limits, and so on. \n\t\t\tYou can include only one MetricWidget parameter in each GetMetricWidgetImage call.

\n\t\t

For more information about the syntax of MetricWidget see \n\t\t\tGetMetricWidgetImage: Metric Widget Structure and Syntax.

\n\t\t\n\t\t

If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation\n\t\t\tpoint appears next to the graph legend.

", + "smithy.api#documentation": "

A JSON string that defines the bitmap graph to be retrieved. The string includes the \n\t\t\tmetrics to include in the graph, statistics, annotations, title, axis limits, and so on. \n\t\t\tYou can include only one MetricWidget parameter in each GetMetricWidgetImage call.

\n

For more information about the syntax of MetricWidget see \n\t\t\tGetMetricWidgetImage: Metric Widget Structure and Syntax.

\n

If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation\n\t\t\tpoint appears next to the graph legend.

", "smithy.api#required": {} } }, "OutputFormat": { "target": "com.amazonaws.cloudwatch#OutputFormat", "traits": { - "smithy.api#documentation": "

The format of the resulting image. Only PNG images are supported.

\n\n\t\t

The default is png. If you specify png, the API returns an HTTP response with the \n\t\t\tcontent-type set to text/xml. The image data is in a MetricWidgetImage \n\t\t\tfield. For example:

\n\t\t\n\t\t

\n \n\t\t\t>\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t

\n 6f0d4192-4d42-11e8-82c1-f539a07e0e3b\n

\n\t\t

\n \n

\n\t\t

\n \n

\n\t\t\n\t\t

The image/png setting is intended only for custom HTTP requests. For most\n\t\t\tuse cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify \n\t\t\timage/png, the HTTP response has a content-type set to image/png, \n\t\t\tand the body of the response is a PNG image.

" + "smithy.api#documentation": "

The format of the resulting image. Only PNG images are supported.

\n

The default is png. If you specify png, the API returns an HTTP response with the \n\t\t\tcontent-type set to text/xml. The image data is in a MetricWidgetImage \n\t\t\tfield. For example:

\n

\n \n\t\t\t>\n

\n

\n \n

\n

\n \n

\n

\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n

\n

\n \n

\n

\n \n

\n

\n \n

\n

\n 6f0d4192-4d42-11e8-82c1-f539a07e0e3b\n

\n

\n \n

\n

\n \n

\n

The image/png setting is intended only for custom HTTP requests. For most\n\t\t\tuse cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify \n\t\t\timage/png, the HTTP response has a content-type set to image/png, \n\t\t\tand the body of the response is a PNG image.

" } } } @@ -2440,7 +2451,7 @@ "name": "monitoring" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the\n\t\t\tapplications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track\n\t\t\tmetrics, which are the variables you want to measure for your resources and\n\t\t\tapplications.

\n\n\t\t

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules\n\t\t\tthat you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2\n\t\t\tinstances. Then, use this data to determine whether you should launch\n\t\t\tadditional instances to handle increased load. You can also use this data to stop\n\t\t\tunder-used instances to save\n\t\t\tmoney.

\n\n\t\t

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor\n\t\t\tyour own custom metrics. With CloudWatch, you gain system-wide visibility into resource\n\t\t\tutilization, application performance, and operational health.

", + "smithy.api#documentation": "

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the\n\t\t\tapplications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track\n\t\t\tmetrics, which are the variables you want to measure for your resources and\n\t\t\tapplications.

\n

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules\n\t\t\tthat you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2\n\t\t\tinstances. Then, use this data to determine whether you should launch\n\t\t\tadditional instances to handle increased load. You can also use this data to stop\n\t\t\tunder-used instances to save\n\t\t\tmoney.

\n

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor\n\t\t\tyour own custom metrics. With CloudWatch, you gain system-wide visibility into resource\n\t\t\tutilization, application performance, and operational health.

", "smithy.api#title": "Amazon CloudWatch", "smithy.api#xmlNamespace": { "uri": "http://monitoring.amazonaws.com/doc/2010-08-01/" @@ -2450,7 +2461,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -2499,15 +2510,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -4757,7 +4759,7 @@ } }, "traits": { - "smithy.api#documentation": "

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then\n\t\t\ta unique contributor is a unique combination of values from all the keys in the rule.

\n\t\t

If the rule contains a single key, then each unique contributor is each unique value for this key.

\n\t\t

For more information, see GetInsightRuleReport.

" + "smithy.api#documentation": "

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then\n\t\t\ta unique contributor is a unique combination of values from all the keys in the rule.

\n

If the rule contains a single key, then each unique contributor is each unique value for this key.

\n

For more information, see GetInsightRuleReport.

" } }, "com.amazonaws.cloudwatch#InsightRuleContributorDatapoint": { @@ -4779,7 +4781,7 @@ } }, "traits": { - "smithy.api#documentation": "

One data point related to one contributor.

\n\t\t

For more information, see GetInsightRuleReport and \n\t\t\tInsightRuleContributor.

" + "smithy.api#documentation": "

One data point related to one contributor.

\n

For more information, see GetInsightRuleReport and \n\t\t\tInsightRuleContributor.

" } }, "com.amazonaws.cloudwatch#InsightRuleContributorDatapoints": { @@ -4850,48 +4852,48 @@ "UniqueContributors": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The number of unique contributors who published data during this timestamp.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The number of unique contributors who published data during this timestamp.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "MaxContributorValue": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, \n\t\t\tso the identity of the max contributor\n\t\tcould be different for each timestamp.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, \n\t\t\tso the identity of the max contributor\n\t\tcould be different for each timestamp.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "SampleCount": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The number of occurrences that matched the rule during this data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The number of occurrences that matched the rule during this data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "Average": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The average value from all contributors during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The average value from all contributors during the time period represented by that data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "Sum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The sum of the values from all contributors during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The sum of the values from all contributors during the time period represented by that data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "Minimum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The minimum value from a single contributor during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The minimum value from a single contributor during the time period represented by that data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } }, "Maximum": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "

The maximum value from a single occurence from a single contributor during the time period represented by that data point.

\n\t\t

This statistic is returned only if you included it in the Metrics array in your request.

" + "smithy.api#documentation": "

The maximum value from a single occurence from a single contributor during the time period represented by that data point.

\n

This statistic is returned only if you included it in the Metrics array in your request.

" } } }, "traits": { - "smithy.api#documentation": "

One data point from the metric time series returned in a Contributor Insights rule report.

\n\t\t

For more information, see GetInsightRuleReport.

" + "smithy.api#documentation": "

One data point from the metric time series returned in a Contributor Insights rule report.

\n

For more information, see GetInsightRuleReport.

" } }, "com.amazonaws.cloudwatch#InsightRuleMetricDatapoints": { @@ -5081,7 +5083,7 @@ } }, "traits": { - "smithy.api#documentation": "

This structure includes the Timezone parameter, which you can use\n\t\t\tto specify your time zone so that the labels that are associated with returned metrics display the \n\t\t\tcorrect time\n\t\t\tfor your time zone.

\n\t\t

The Timezone value affects a label only if you have a time-based\n\t\tdynamic expression in the label. For more information about dynamic expressions in labels, \n\t\tsee Using Dynamic Labels.

" + "smithy.api#documentation": "

This structure includes the Timezone parameter, which you can use\n\t\t\tto specify your time zone so that the labels that are associated with returned metrics display the \n\t\t\tcorrect time\n\t\t\tfor your time zone.

\n

The Timezone value affects a label only if you have a time-based\n\t\tdynamic expression in the label. For more information about dynamic expressions in labels, \n\t\tsee Using Dynamic Labels.

" } }, "com.amazonaws.cloudwatch#LastModified": { @@ -5141,7 +5143,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only\n\t\t\tthose dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are\n\t\t\tlisted.\n\t

\n\t\t

\n ListDashboards returns up to 1000 results on one page. If there\n\t\t\tare more than 1000 dashboards, you can call ListDashboards again and\n\t\tinclude the value you received for NextToken in the first call, to receive\n\t\tthe next 1000 results.

", + "smithy.api#documentation": "

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only\n\t\t\tthose dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are\n\t\t\tlisted.\n\t

\n

\n ListDashboards returns up to 1000 results on one page. If there\n\t\t\tare more than 1000 dashboards, you can call ListDashboards again and\n\t\tinclude the value you received for NextToken in the first call, to receive\n\t\tthe next 1000 results.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5343,7 +5345,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.

\n\t\t

Up to 500 results are returned for any one call. To retrieve additional results,\n\t\t\tuse the returned token with subsequent calls.

\n\t\t

After you create a metric, allow up to 15 minutes for the metric to appear. To see metric\n\t\t\tstatistics sooner, use GetMetricData or GetMetricStatistics.

\n\t\t\n\t\t

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n\t\t\tview metrics from the linked source accounts. For more information, see \n\t\t\tCloudWatch cross-account observability.

\n\n\t

\n ListMetrics doesn't return information about metrics if those metrics haven't \n\treported data in the past two weeks. To retrieve those metrics, use \n\t\tGetMetricData or \n\t\tGetMetricStatistics.

", + "smithy.api#documentation": "

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.

\n

Up to 500 results are returned for any one call. To retrieve additional results,\n\t\t\tuse the returned token with subsequent calls.

\n

After you create a metric, allow up to 15 minutes for the metric to appear. To see metric\n\t\t\tstatistics sooner, use GetMetricData or GetMetricStatistics.

\n

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n\t\t\tview metrics from the linked source accounts. For more information, see \n\t\t\tCloudWatch cross-account observability.

\n

\n ListMetrics doesn't return information about metrics if those metrics haven't \n\treported data in the past two weeks. To retrieve those metrics, use \n\t\tGetMetricData or \n\t\tGetMetricStatistics.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken" @@ -5380,14 +5382,14 @@ "RecentlyActive": { "target": "com.amazonaws.cloudwatch#RecentlyActive", "traits": { - "smithy.api#documentation": "

To filter the results to show only metrics that have had data points published\n\t\t\tin the past three hours, specify this parameter\n\t\t\twith a value of PT3H. This is the only valid value\n\t\t\tfor this parameter.

\n\t\t

The results that are returned are an approximation of the value you specify. There\n\t\tis a low probability that the returned results include metrics with last published\n\t\tdata as much as 40 minutes more than the specified time interval.

" + "smithy.api#documentation": "

To filter the results to show only metrics that have had data points published\n\t\t\tin the past three hours, specify this parameter\n\t\t\twith a value of PT3H. This is the only valid value\n\t\t\tfor this parameter.

\n

The results that are returned are an approximation of the value you specify. There\n\t\tis a low probability that the returned results include metrics with last published\n\t\tdata as much as 40 minutes more than the specified time interval.

" } }, "IncludeLinkedAccounts": { "target": "com.amazonaws.cloudwatch#IncludeLinkedAccounts", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If you are using this operation in a monitoring account, \n\t\t\tspecify true to include metrics from source accounts in the returned data.

\n\t\t

The default is false.

" + "smithy.api#documentation": "

If you are using this operation in a monitoring account, \n\t\t\tspecify true to include metrics from source accounts in the returned data.

\n

The default is false.

" } }, "OwningAccount": { @@ -5416,7 +5418,7 @@ "OwningAccounts": { "target": "com.amazonaws.cloudwatch#OwningAccounts", "traits": { - "smithy.api#documentation": "

If you are using this operation in a monitoring account, this array contains the account IDs of the source \n\t\t\taccounts where the metrics in the returned data\n\t\tare from.

\n\t\t

This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.

" + "smithy.api#documentation": "

If you are using this operation in a monitoring account, this array contains the account IDs of the source \n\t\t\taccounts where the metrics in the returned data\n\t\tare from.

\n

This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.

" } } } @@ -5450,7 +5452,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch resource that you want to view tags for.

\n\t\t

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n\t\t

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n\t

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#documentation": "

The ARN of the CloudWatch resource that you want to view tags for.

\n

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", "smithy.api#required": {} } } @@ -5592,7 +5594,7 @@ } }, "traits": { - "smithy.api#documentation": "

A message returned by the GetMetricDataAPI, including a code and a description.

\n\t\t

If a cross-Region GetMetricData operation fails with a code of Forbidden and a \n\t\t\tvalue of Authentication too complex to \n\t\t\tretrieve cross region data, you can correct the problem by running the GetMetricData\n\t\toperation in the same Region where the metric data is.

" + "smithy.api#documentation": "

A message returned by the GetMetricDataAPI, including a code and a description.

\n

If a cross-Region GetMetricData operation fails with a code of Forbidden and a \n\t\t\tvalue of Authentication too complex to \n\t\t\tretrieve cross region data, you can correct the problem by running the GetMetricData\n\t\toperation in the same Region where the metric data is.

" } }, "com.amazonaws.cloudwatch#MessageDataCode": { @@ -5699,7 +5701,7 @@ "StateUpdatedTimestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp of the last update to the alarm state.

" + "smithy.api#documentation": "

The time stamp of the last update to the value of either the \n\t\t\tStateValue or EvaluationState parameters.

" } }, "MetricName": { @@ -5771,7 +5773,7 @@ "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. The valid values\n \tare breaching, notBreaching, ignore, and \n \tmissing. For more information, see\n \tConfiguring how CloudWatch alarms treat missing data.

\n\t\t

If this parameter is omitted, the default \n \tbehavior of missing is used.

" + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. The valid values\n \tare breaching, notBreaching, ignore, and \n \tmissing. For more information, see\n \tConfiguring how CloudWatch alarms treat missing data.

\n

If this parameter is omitted, the default \n \tbehavior of missing is used.

" } }, "EvaluateLowSampleCountPercentile": { @@ -5791,6 +5793,18 @@ "traits": { "smithy.api#documentation": "

In an alarm based on an anomaly detection model, this is the ID of the \n\t\t\tANOMALY_DETECTION_BAND function \n\t\t\tused as the threshold for the alarm.

" } + }, + "EvaluationState": { + "target": "com.amazonaws.cloudwatch#EvaluationState", + "traits": { + "smithy.api#documentation": "

If the value of this field is\n\tPARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the\n\tquery used for the alarm returns more than 10,000 metrics. For \n\tmore information, see \n\t\tCreate alarms on Metrics Insights queries.

" + } + }, + "StateTransitionedTimestamp": { + "target": "com.amazonaws.cloudwatch#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the alarm's StateValue most recently changed.

" + } } }, "traits": { @@ -5828,25 +5842,25 @@ "MetricStat": { "target": "com.amazonaws.cloudwatch#MetricStat", "traits": { - "smithy.api#documentation": "

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric \n\t\t\tand not performing a math expression on returned data.

\n\t\t

Within one MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" + "smithy.api#documentation": "

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric \n\t\t\tand not performing a math expression on returned data.

\n

Within one MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" } }, "Expression": { "target": "com.amazonaws.cloudwatch#MetricExpression", "traits": { - "smithy.api#documentation": "

This field can contain either a Metrics Insights query, or a metric math expression to be performed on the \n\t\t\treturned data. For more information about Metrics Insights queries, see \n\t\t\tMetrics Insights query components and syntax in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

A math expression\n\t\t\tcan use the Id of the other metrics or queries to refer to those metrics, and can also use \n\t\t\tthe Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" + "smithy.api#documentation": "

This field can contain either a Metrics Insights query, or a metric math expression to be performed on the \n\t\t\treturned data. For more information about Metrics Insights queries, see \n\t\t\tMetrics Insights query components and syntax in the\n\t\t\tAmazon CloudWatch User Guide.

\n

A math expression\n\t\t\tcan use the Id of the other metrics or queries to refer to those metrics, and can also use \n\t\t\tthe Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.

\n

Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" } }, "Label": { "target": "com.amazonaws.cloudwatch#MetricLabel", "traits": { - "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful \n\t\t\tif this is an expression, so that you know\n\t\t\twhat the value represents. If the metric or expression is shown in a \n\t\t\tCloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n\t\t\tgenerates a default.

\n\t\t

You can put dynamic expressions into a label, so that it is more descriptive. \n\t\t\tFor more information, see Using Dynamic Labels.

" + "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful \n\t\t\tif this is an expression, so that you know\n\t\t\twhat the value represents. If the metric or expression is shown in a \n\t\t\tCloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n\t\t\tgenerates a default.

\n

You can put dynamic expressions into a label, so that it is more descriptive. \n\t\t\tFor more information, see Using Dynamic Labels.

" } }, "ReturnData": { "target": "com.amazonaws.cloudwatch#ReturnData", "traits": { - "smithy.api#documentation": "

When used in GetMetricData, this option indicates whether to return the\n\t\t\ttimestamps and raw data values of this metric. If you are performing this call just to\n\t\t\tdo math expressions and do not also need the raw data returned, you can specify\n\t\t\t\tfalse. If you omit this, the default of true is\n\t\t\tused.

\n\t\t

When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all \n\t\tother metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

" + "smithy.api#documentation": "

When used in GetMetricData, this option indicates whether to return the\n\t\t\ttimestamps and raw data values of this metric. If you are performing this call just to\n\t\t\tdo math expressions and do not also need the raw data returned, you can specify\n\t\t\t\tfalse. If you omit this, the default of true is\n\t\t\tused.

\n

When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all \n\t\tother metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

" } }, "Period": { @@ -5858,12 +5872,12 @@ "AccountId": { "target": "com.amazonaws.cloudwatch#AccountId", "traits": { - "smithy.api#documentation": "

The ID of the account where the metrics are located.

\n\t\t

If you are performing a GetMetricData operation in a monitoring account, use this to specify \n\t\t\twhich account to retrieve this metric from.

\n\t\t

If you are performing a PutMetricAlarm operation, use this to specify \n\t\t\twhich account contains the metric that the alarm is watching.

" + "smithy.api#documentation": "

The ID of the account where the metrics are located.

\n

If you are performing a GetMetricData operation in a monitoring account, use this to specify \n\t\t\twhich account to retrieve this metric from.

\n

If you are performing a PutMetricAlarm operation, use this to specify \n\t\t\twhich account contains the metric that the alarm is watching.

" } } }, "traits": { - "smithy.api#documentation": "

This structure is used in both GetMetricData and PutMetricAlarm. The supported\n\t\t\tuse of this structure is different for those two operations.

\n\t\t

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A\n\t\t\tsingle GetMetricData call can include up to 500 MetricDataQuery\n\t\t\tstructures.

\n\t\t

When used in PutMetricAlarm, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm call can include up to 20\n\t\t\t\tMetricDataQuery structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression parameter\n\t\t\tto perform a math expression. Of those Expression structures, one must have true\n\t\tas the value for ReturnData. The result of this expression is the value the alarm watches.

\n\n\t\t

Any expression used in a PutMetricAlarm\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.

\n\n\t\t

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData\n\t\t\toperation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

" + "smithy.api#documentation": "

This structure is used in both GetMetricData and PutMetricAlarm. The supported\n\t\t\tuse of this structure is different for those two operations.

\n

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A\n\t\t\tsingle GetMetricData call can include up to 500 MetricDataQuery\n\t\t\tstructures.

\n

When used in PutMetricAlarm, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm call can include up to 20\n\t\t\t\tMetricDataQuery structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression parameter\n\t\t\tto perform a math expression. Of those Expression structures, one must have true\n\t\tas the value for ReturnData. The result of this expression is the value the alarm watches.

\n

Any expression used in a PutMetricAlarm\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.

\n

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData\n\t\t\toperation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

" } }, "com.amazonaws.cloudwatch#MetricDataResult": { @@ -5947,7 +5961,7 @@ "Value": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "

The value for the metric.

\n\t\t

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or\n\t\t\ttoo large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)\n\t\t\tare not supported.

" + "smithy.api#documentation": "

The value for the metric.

\n

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or\n\t\t\ttoo large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)\n\t\t\tare not supported.

" } }, "StatisticValues": { @@ -5959,25 +5973,25 @@ "Values": { "target": "com.amazonaws.cloudwatch#Values", "traits": { - "smithy.api#documentation": "

Array of numbers representing the values for the metric during the period. Each unique value is listed just once\n\t\tin this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period.\n\t\tYou can include up to 150 unique values in each PutMetricData action that specifies a Values array.

\n\t\t

Although the Values array accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

" + "smithy.api#documentation": "

Array of numbers representing the values for the metric during the period. Each unique value is listed just once\n\t\tin this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period.\n\t\tYou can include up to 150 unique values in each PutMetricData action that specifies a Values array.

\n

Although the Values array accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

" } }, "Counts": { "target": "com.amazonaws.cloudwatch#Counts", "traits": { - "smithy.api#documentation": "

Array of numbers that is used along with the Values array. Each number in the Count array \n\t\t\tis the number of times the corresponding value in the Values array occurred during the period.

\n\t\t

If you omit the Counts array, the default of 1 is used as the value for each count. If you\n\t\tinclude a Counts array, it must include the same amount of values as the Values array.

" + "smithy.api#documentation": "

Array of numbers that is used along with the Values array. Each number in the Count array \n\t\t\tis the number of times the corresponding value in the Values array occurred during the period.

\n

If you omit the Counts array, the default of 1 is used as the value for each count. If you\n\t\tinclude a Counts array, it must include the same amount of values as the Values array.

" } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n\t\t

In \n\t\ta Get operation, this displays the unit that is used for the metric.

" + "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n

In \n\t\ta Get operation, this displays the unit that is used for the metric.

" } }, "StorageResolution": { "target": "com.amazonaws.cloudwatch#StorageResolution", "traits": { - "smithy.api#documentation": "

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with \n\t\t\tsub-minute resolution down to one second.\n\t\tSetting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available\n\t\tonly for custom metrics. For more information about high-resolution metrics, \n\t\t\tsee High-Resolution Metrics in the\n\t\t\tAmazon CloudWatch User Guide.\n\t\t

\n\t

This field is optional, if you do not specify it the default of 60 is used.

" + "smithy.api#documentation": "

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with \n\t\t\tsub-minute resolution down to one second.\n\t\tSetting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available\n\t\tonly for custom metrics. For more information about high-resolution metrics, \n\t\t\tsee High-Resolution Metrics in the\n\t\t\tAmazon CloudWatch User Guide.\n\t\t

\n

This field is optional, if you do not specify it the default of 60 is used.

" } } }, @@ -6042,7 +6056,7 @@ "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n\t\t\t

If the StartTime parameter specifies a time stamp that is greater than\n\t\t\t\t3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n\t\t\t ", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n\t\t\t\t3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n ", "smithy.api#required": {} } }, @@ -6056,7 +6070,7 @@ "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n\t\t

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" + "smithy.api#documentation": "

When you are using a Put operation, this defines what unit you want to use when storing the metric.

\n

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" } } }, @@ -6196,14 +6210,14 @@ "IncludeMetrics": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsIncludeMetrics", "traits": { - "smithy.api#documentation": "

An array of metric name and namespace pairs that stream the additional statistics listed\n\t\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t\t100 pairs in the array.

\n\t\t

All metrics that match the combination of metric name and namespace will be streamed\n\t\t\twith the additional statistics, no matter their dimensions.

", + "smithy.api#documentation": "

An array of metric name and namespace pairs that stream the additional statistics listed\n\t\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t\t100 pairs in the array.

\n

All metrics that match the combination of metric name and namespace will be streamed\n\t\t\twith the additional statistics, no matter their dimensions.

", "smithy.api#required": {} } }, "AdditionalStatistics": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics", "traits": { - "smithy.api#documentation": "

The list of additional statistics that are to be streamed for the metrics listed\n\t\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n\t\t

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n\t\t

If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\t\ttm98, \n wm90, PR(:300), and so on.

", + "smithy.api#documentation": "

The list of additional statistics that are to be streamed for the metrics listed\n\t\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n

If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\t\ttm98, \n wm90, PR(:300), and so on.

", "smithy.api#required": {} } } @@ -6366,7 +6380,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an anomaly detection model for a CloudWatch metric. You can use the model\n\t\t\tto display a band of expected normal values when the metric is graphed.

\n\t\t

For more information, see CloudWatch Anomaly Detection.

" + "smithy.api#documentation": "

Creates an anomaly detection model for a CloudWatch metric. You can use the model\n\t\t\tto display a band of expected normal values when the metric is graphed.

\n

For more information, see CloudWatch Anomaly Detection.

" } }, "com.amazonaws.cloudwatch#PutAnomalyDetectorInput": { @@ -6411,19 +6425,19 @@ "Configuration": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration", "traits": { - "smithy.api#documentation": "

The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.

\n\t\t

The configuration can also include the time zone to use for \n\t\t\tthe metric.

" + "smithy.api#documentation": "

The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.

\n

The configuration can also include the time zone to use for \n\t\t\tthe metric.

" } }, "SingleMetricAnomalyDetector": { "target": "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector", "traits": { - "smithy.api#documentation": "

A single metric anomaly detector to be created.

\n\t\t

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the single metric anomaly detector attributes\n\t\t\tas part of the property SingleMetricAnomalyDetector.

" + "smithy.api#documentation": "

A single metric anomaly detector to be created.

\n

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n \n

Instead, specify the single metric anomaly detector attributes\n\t\t\tas part of the property SingleMetricAnomalyDetector.

" } }, "MetricMathAnomalyDetector": { "target": "com.amazonaws.cloudwatch#MetricMathAnomalyDetector", "traits": { - "smithy.api#documentation": "

The metric math anomaly detector to be created.

\n\t\t\n\t\t

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the metric math anomaly detector attributes\n\t\t\tas part of the property MetricMathAnomalyDetector.

" + "smithy.api#documentation": "

The metric math anomaly detector to be created.

\n

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

\n \n

Instead, specify the metric math anomaly detector attributes\n\t\t\tas part of the property MetricMathAnomalyDetector.

" } } } @@ -6446,7 +6460,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.

\n\t\t

The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. \n\t\t\tAny single alarm can be included in the rule expressions of as many as 150 composite alarms.

\n\t\t

Using composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.

\n\t\t

Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.

\n\t\t \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n\t\t\t

To get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to false.

\n\t\t\t

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t

\n \n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.

\n\t\t\n\t\t

To use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

\n\t\t\n\t\t

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.

" + "smithy.api#documentation": "

Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.

\n

The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. \n\t\t\tAny single alarm can be included in the rule expressions of as many as 150 composite alarms.

\n

Using composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.

\n

Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.

\n \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n

To get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to false.

\n

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t

\n \n

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.

\n

When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.

\n

To use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

\n

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.

" } }, "com.amazonaws.cloudwatch#PutCompositeAlarmInput": { @@ -6461,7 +6475,7 @@ "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n

" } }, "AlarmDescription": { @@ -6480,26 +6494,26 @@ "AlarmRule": { "target": "com.amazonaws.cloudwatch#AlarmRule", "traits": { - "smithy.api#documentation": "

An expression that specifies which other alarms are to be evaluated to determine this\n\t\t\tcomposite alarm's state. For each alarm that you reference, you\n\t\t\tdesignate a function that\n\t\t\tspecifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You\n\t\t\tcan use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the \n\t\t\tfunctions in your expression.

\n\t\t

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

\n\t\t

Functions can include the following:

\n\t\t \n\t\t

TRUE and FALSE are useful for testing a complex AlarmRule structure, and \n\t\tfor testing your alarm actions.

\n\t\t

Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.

\n\t\t

The following\n\t\t\tare some examples of AlarmRule:

\n\t\t \n\t\t

The AlarmRule can specify as many as 100\n\t\t\t\"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements\n\t\t\tare child alarms, TRUE or FALSE statements, and\n\t\t\tparentheses.

", + "smithy.api#documentation": "

An expression that specifies which other alarms are to be evaluated to determine this\n\t\t\tcomposite alarm's state. For each alarm that you reference, you\n\t\t\tdesignate a function that\n\t\t\tspecifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You\n\t\t\tcan use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the \n\t\t\tfunctions in your expression.

\n

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

\n

Functions can include the following:

\n \n

TRUE and FALSE are useful for testing a complex AlarmRule structure, and \n\t\tfor testing your alarm actions.

\n

Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.

\n

The following\n\t\t\tare some examples of AlarmRule:

\n \n

The AlarmRule can specify as many as 100\n\t\t\t\"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements\n\t\t\tare child alarms, TRUE or FALSE statements, and\n\t\t\tparentheses.

", "smithy.api#required": {} } }, "InsufficientDataActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" } }, "OKActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n\t\t\n\t\t\n\t\t

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:sns:region:account-id:sns-topic-name\n \n

" } }, "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

\n\t\t

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with\n\t\t\tcertain tag values.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

\n

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with\n\t\t\tcertain tag values.

" } }, "ActionsSuppressor": { @@ -6511,13 +6525,13 @@ "ActionsSuppressorWaitPeriod": { "target": "com.amazonaws.cloudwatch#SuppressorPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n\t\t \n\t\t\t

\n\t\t\t\t WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n \n

\n WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n " } }, "ActionsSuppressorExtensionPeriod": { "target": "com.amazonaws.cloudwatch#SuppressorPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n\t\t \n\t\t\t

\n\t\t\t\t ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n\t\t " + "smithy.api#documentation": "

\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t

\n \n

\n ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t

\n " } } } @@ -6539,7 +6553,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,\n\t\tthe entire contents are replaced with what you specify here.

\n\t\t

All dashboards in your account are global, not region-specific.

\n\t\t

A simple way to create a dashboard using PutDashboard is to copy an \n\t\t\texisting dashboard. To copy an existing dashboard using the console, you can load the dashboard\n\t\t\tand then use the View/edit source command in the Actions menu to display the JSON block\n\t\t\tfor that dashboard. Another way to copy a dashboard is to \n\t\t\tuse GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard.

\n\t\t

When you create a dashboard with PutDashboard, a good practice is to \n\t\t\tadd a text widget at the top of the dashboard with a message that the dashboard was created by script and should\n\t\tnot be changed in the console. This message could also point console users to the location \n\t\tof the DashboardBody script or the CloudFormation template used to create the\n\t\tdashboard.

" + "smithy.api#documentation": "

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,\n\t\tthe entire contents are replaced with what you specify here.

\n

All dashboards in your account are global, not region-specific.

\n

A simple way to create a dashboard using PutDashboard is to copy an \n\t\t\texisting dashboard. To copy an existing dashboard using the console, you can load the dashboard\n\t\t\tand then use the View/edit source command in the Actions menu to display the JSON block\n\t\t\tfor that dashboard. Another way to copy a dashboard is to \n\t\t\tuse GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard.

\n

When you create a dashboard with PutDashboard, a good practice is to \n\t\t\tadd a text widget at the top of the dashboard with a message that the dashboard was created by script and should\n\t\tnot be changed in the console. This message could also point console users to the location \n\t\tof the DashboardBody script or the CloudFormation template used to create the\n\t\tdashboard.

" } }, "com.amazonaws.cloudwatch#PutDashboardInput": { @@ -6555,7 +6569,7 @@ "DashboardBody": { "target": "com.amazonaws.cloudwatch#DashboardBody", "traits": { - "smithy.api#documentation": "

The detailed information about the dashboard in JSON format, including the widgets to include and their location\n\t\t\ton the dashboard. This parameter is required.

\n\t\t

For more information about the syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.

", + "smithy.api#documentation": "

The detailed information about the dashboard in JSON format, including the widgets to include and their location\n\t\t\ton the dashboard. This parameter is required.

\n

For more information about the syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.

", "smithy.api#required": {} } } @@ -6567,7 +6581,7 @@ "DashboardValidationMessages": { "target": "com.amazonaws.cloudwatch#DashboardValidationMessages", "traits": { - "smithy.api#documentation": "

If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.

\n\t\t\t

If this result includes only warning messages, then the input was valid enough for the dashboard to be\n\t\t\tcreated or modified, but some elements of the dashboard\n\t\t\tmight not render.

\n\t\t\t\t

If this result includes error messages, the input was not valid and the operation failed.

" + "smithy.api#documentation": "

If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.

\n

If this result includes only warning messages, then the input was valid enough for the dashboard to be\n\t\t\tcreated or modified, but some elements of the dashboard\n\t\t\tmight not render.

\n

If this result includes error messages, the input was not valid and the operation failed.

" } } } @@ -6592,7 +6606,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Contributor Insights rule. Rules evaluate log events in a\n\t\tCloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, \n\t\tsee Using Contributor Insights to Analyze High-Cardinality Data.

\n\t\t

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might not be available.

" + "smithy.api#documentation": "

Creates a Contributor Insights rule. Rules evaluate log events in a\n\t\tCloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, \n\t\tsee Using Contributor Insights to Analyze High-Cardinality Data.

\n

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might not be available.

" } }, "com.amazonaws.cloudwatch#PutInsightRuleInput": { @@ -6621,7 +6635,7 @@ "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the Contributor Insights rule. \n\t\t\tYou can associate as many as 50 tags with a rule.

\n\t\t

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by \n\t\t\tgranting a user permission to access or change only the resources that have\n\t\t\tcertain tag values.

\n\t\t

To be able to associate tags with a rule, you must have the cloudwatch:TagResource\n\t\tpermission in addition to the cloudwatch:PutInsightRule permission.

\n\t\t

If you are using this operation to update an existing Contributor Insights rule, any tags\n\t\tyou specify in this parameter are ignored. To change the tags of an existing rule, use\n\t\t\tTagResource.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the Contributor Insights rule. \n\t\t\tYou can associate as many as 50 tags with a rule.

\n

Tags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by \n\t\t\tgranting a user permission to access or change only the resources that have\n\t\t\tcertain tag values.

\n

To be able to associate tags with a rule, you must have the cloudwatch:TagResource\n\t\tpermission in addition to the cloudwatch:PutInsightRule permission.

\n

If you are using this operation to update an existing Contributor Insights rule, any tags\n\t\tyou specify in this parameter are ignored. To change the tags of an existing rule, use\n\t\t\tTagResource.

" } } } @@ -6687,7 +6701,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tor anomaly detection model.

\n\t\t\n\t\t\n\t\t

Alarms based on anomaly detection models cannot have Auto Scaling actions.

\n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.

\n\n\t\t

If you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:

\n\t\t \n\t\t\n\t\t\n\t\t\n\n\t\t\n\t\t\n\t\t

The first time you create an alarm in the \n\t\t\tAmazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.

\n\t\t\t\n\t\t

\n Cross-account alarms\n

\n\t\t\n\t\t

You can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:

\n\t\t " + "smithy.api#documentation": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tanomaly detection model, or Metrics Insights query. For more information about using \n\t\t\ta Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.

\n

Alarms based on anomaly detection models cannot have Auto Scaling actions.

\n

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.

\n

When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.

\n

If you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:

\n \n

The first time you create an alarm in the \n\t\t\tAmazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.

\n

\n Cross-account alarms\n

\n

You can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:

\n " } }, "com.amazonaws.cloudwatch#PutMetricAlarmInput": { @@ -6715,25 +6729,25 @@ "OKActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\t arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\t arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

" } }, "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n\t\t\t| arn:aws:ssm-incidents::account-id:response-plan:response-plan-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n\t\t\t| arn:aws:ssm:region:account-id:opsitem:severity\n \n\t\t\t| arn:aws:ssm-incidents::account-id:response-plan:response-plan-name\n \n

\n

Valid Values (for use with IAM roles):\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 |\n\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

" } }, "InsufficientDataActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n\n\t\t

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n\n\t\t

Valid Values (for use with IAM roles):\n\t\t\t>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).

\n

Valid Values: arn:aws:automate:region:ec2:stop | \n\t\t\tarn:aws:automate:region:ec2:terminate | \n\t\t\tarn:aws:automate:region:ec2:recover |\n\t\t\tarn:aws:automate:region:ec2:reboot |\n\t\t\tarn:aws:sns:region:account-id:sns-topic-name\n |\n\t\t\tarn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

\n

Valid Values (for use with IAM roles):\n\t\t\t>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |\n\t\t\t\tarn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "

The name for the metric associated with the alarm. For each PutMetricAlarm\n\t\toperation, you must specify either MetricName or a Metrics array.

\n\t\t

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the \n\t\t\tDimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters. Instead, you specify \n\t\tall this information in the Metrics array.

" + "smithy.api#documentation": "

The name for the metric associated with the alarm. For each PutMetricAlarm\n\t\toperation, you must specify either MetricName or a Metrics array.

\n

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the \n\t\t\tDimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters. Instead, you specify \n\t\tall this information in the Metrics array.

" } }, "Namespace": { @@ -6763,19 +6777,19 @@ "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The length, in seconds, used each time the metric specified in MetricName is\n\t\t\tevaluated. Valid values are 10, 30, and any multiple of 60.

\n\t\t

\n Period is required for alarms based on static thresholds. If \n\t\tyou are creating an alarm based on a metric math expression, you specify the \n\t\tperiod for each metric within the objects in the Metrics array.

\n\t\t

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a\n\t\t\t\tStorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have\n\t\t\tsub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,\n\t\t\tit does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm\n\t\t\tmight often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,\n\t\t\twhich has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

\n\t\t

An alarm's total current evaluation period can\n\t\tbe no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

" + "smithy.api#documentation": "

The length, in seconds, used each time the metric specified in MetricName is\n\t\t\tevaluated. Valid values are 10, 30, and any multiple of 60.

\n

\n Period is required for alarms based on static thresholds. If \n\t\tyou are creating an alarm based on a metric math expression, you specify the \n\t\tperiod for each metric within the objects in the Metrics array.

\n

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a\n\t\t\t\tStorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have\n\t\t\tsub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,\n\t\t\tit does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm\n\t\t\tmight often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,\n\t\t\twhich has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

\n

An alarm's total current evaluation period can\n\t\tbe no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

" } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "

The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.

\n\t\t

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.

\n\t\t\t

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves unpredictably.

\n\t\t

We recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.

" + "smithy.api#documentation": "

The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.

\n

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.

\n

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves unpredictably.

\n

We recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.

" } }, "EvaluationPeriods": { "target": "com.amazonaws.cloudwatch#EvaluationPeriods", "traits": { - "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold. If you are\n\t\t\tsetting an alarm that requires that a number of consecutive data points be breaching to\n\t\t\ttrigger the alarm, this value specifies that number. If you are setting an \"M out of N\"\n\t\t\talarm, this value is the N.

\n\t\t

An alarm's total current evaluation period can\n\t\t\tbe no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

", + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold. If you are\n\t\t\tsetting an alarm that requires that a number of consecutive data points be breaching to\n\t\t\ttrigger the alarm, this value specifies that number. If you are setting an \"M out of N\"\n\t\t\talarm, this value is the N.

\n

An alarm's total current evaluation period can\n\t\t\tbe no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

", "smithy.api#required": {} } }, @@ -6788,44 +6802,44 @@ "Threshold": { "target": "com.amazonaws.cloudwatch#Threshold", "traits": { - "smithy.api#documentation": "

The value against which the specified statistic is compared.

\n\t\t

This parameter is required for alarms based on static thresholds, but should\n\t\tnot be used for alarms based on anomaly detection models.

" + "smithy.api#documentation": "

The value against which the specified statistic is compared.

\n

This parameter is required for alarms based on static thresholds, but should\n\t\tnot be used for alarms based on anomaly detection models.

" } }, "ComparisonOperator": { "target": "com.amazonaws.cloudwatch#ComparisonOperator", "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic and\n\t\t\tthreshold. The specified statistic value is used as the first operand.

\n\t\t

The values LessThanLowerOrGreaterThanUpperThreshold, \n\t\t\tLessThanLowerThreshold, and GreaterThanUpperThreshold\n\t\tare used only for alarms based on anomaly detection models.

", + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic and\n\t\t\tthreshold. The specified statistic value is used as the first operand.

\n

The values LessThanLowerOrGreaterThanUpperThreshold, \n\t\t\tLessThanLowerThreshold, and GreaterThanUpperThreshold\n\t\tare used only for alarms based on anomaly detection models.

", "smithy.api#required": {} } }, "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n\t\t

Valid Values: breaching | notBreaching | ignore | missing\n

\n\t\t \n

Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\n\t\t\tmissing data even if you choose a different option for TreatMissingData. When an \n\t\t\tAWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

\n\t\t " + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n

Valid Values: breaching | notBreaching | ignore | missing\n

\n \n

Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\n\t\t\tmissing data even if you choose a different option for TreatMissingData. When an \n\t\t\tAWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

\n " } }, "EvaluateLowSampleCountPercentile": { "target": "com.amazonaws.cloudwatch#EvaluateLowSampleCountPercentile", "traits": { - "smithy.api#documentation": "

Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be \n\t\t\tstatistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state\n\t\t\tno matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

\n\t\t

Valid Values: evaluate | ignore\n

" + "smithy.api#documentation": "

Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be \n\t\t\tstatistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state\n\t\t\tno matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

\n

Valid Values: evaluate | ignore\n

" } }, "Metrics": { "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a \n\t\t\tmetric math expression. For each PutMetricAlarm\n\t\t\toperation, you must specify either MetricName or a Metrics array.

\n\t\t

Each item in the Metrics array either retrieves a metric or performs a math expression.

\n\t\t

One item in the Metrics array is the expression that the alarm watches. You designate this expression \n\t\t\tby setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.

\n\t\t

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. \n\t\t\tInstead, you retrieve\n\t\tthe metrics you are using in your math expression as part of the Metrics array.

" + "smithy.api#documentation": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a \n\t\t\tmetric math expression. For each PutMetricAlarm\n\t\t\toperation, you must specify either MetricName or a Metrics array.

\n

Each item in the Metrics array either retrieves a metric or performs a math expression.

\n

One item in the Metrics array is the expression that the alarm watches. You designate this expression \n\t\t\tby setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.

\n

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period,\n\t\t\tNamespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. \n\t\t\tInstead, you retrieve\n\t\tthe metrics you are using in your math expression as part of the Metrics array.

" } }, "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n\t\t

If you are using this operation to update an existing alarm, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing alarm, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n

If you are using this operation to update an existing alarm, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing alarm, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" } }, "ThresholdMetricId": { "target": "com.amazonaws.cloudwatch#MetricId", "traits": { - "smithy.api#documentation": "

If this is an alarm based on an anomaly detection model, make this value match\n\t\t\tthe ID of\n\t\t\tthe ANOMALY_DETECTION_BAND function.

\n\t\t

For an example of how to use this parameter, see the \n\t\t\tAnomaly Detection\n\t\tModel Alarm example on this page.

\n\t\t

If your alarm uses this parameter, it cannot have Auto Scaling actions.

" + "smithy.api#documentation": "

If this is an alarm based on an anomaly detection model, make this value match\n\t\t\tthe ID of\n\t\t\tthe ANOMALY_DETECTION_BAND function.

\n

For an example of how to use this parameter, see the \n\t\t\tAnomaly Detection\n\t\tModel Alarm example on this page.

\n

If your alarm uses this parameter, it cannot have Auto Scaling actions.

" } } } @@ -6853,7 +6867,7 @@ } ], "traits": { - "smithy.api#documentation": "

Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.

\n\n\t\t

You can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.

\n\t\t

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 1000 different metrics.

\n\t\t

Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

\n\t\t

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

\n\n\t\t

You specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.

\n\t\t

Data points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.

\n\t\t

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n\t\t\t " + "smithy.api#documentation": "

Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.

\n

You can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.

\n

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 1000 different metrics.

\n

Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

\n

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

\n

You specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.

\n

Data points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.

\n

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n " } }, "com.amazonaws.cloudwatch#PutMetricDataInput": { @@ -6862,7 +6876,7 @@ "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The namespace for the metric data.

\n\t\t

To avoid conflicts\n\t\t\twith Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/\n

", + "smithy.api#documentation": "

The namespace for the metric data.

\n

To avoid conflicts\n\t\t\twith Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/\n

", "smithy.api#required": {} } }, @@ -6901,7 +6915,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch\n\t\t\tmetrics to Amazon Web Services destinations, including Amazon S3, and to many third-party\n\t\t\tsolutions.

\n\t\t

For more information, see \n\t\tUsing Metric Streams.

\n\t\t

To create a metric stream, you must be signed in to an account that has the\n\t\t\t\tiam:PassRole permission and either the\n\t\t\t\tCloudWatchFullAccess policy or the\n\t\t\t\tcloudwatch:PutMetricStream permission.

\n\t\t

When you create or update a metric stream, you choose one of the following:

\n\t\t \n\t\t\n\t\t

By default, a metric stream always sends the MAX, MIN,\n\t\t\t\tSUM, and SAMPLECOUNT statistics for each metric that is\n\t\t\tstreamed. You can use the StatisticsConfigurations parameter to have the\n\t\t\tmetric stream send additional statistics in the stream. Streaming additional statistics\n\t\t\tincurs additional costs. For more information, see Amazon CloudWatch Pricing.

\n\t\t\n\t\t

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" + "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch\n\t\t\tmetrics to Amazon Web Services destinations, including Amazon S3, and to many third-party\n\t\t\tsolutions.

\n

For more information, see \n\t\tUsing Metric Streams.

\n

To create a metric stream, you must be signed in to an account that has the\n\t\t\t\tiam:PassRole permission and either the\n\t\t\t\tCloudWatchFullAccess policy or the\n\t\t\t\tcloudwatch:PutMetricStream permission.

\n

When you create or update a metric stream, you choose one of the following:

\n \n

By default, a metric stream always sends the MAX, MIN,\n\t\t\t\tSUM, and SAMPLECOUNT statistics for each metric that is\n\t\t\tstreamed. You can use the StatisticsConfigurations parameter to have the\n\t\t\tmetric stream send additional statistics in the stream. Streaming additional statistics\n\t\t\tincurs additional costs. For more information, see Amazon CloudWatch Pricing.

\n

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" } }, "com.amazonaws.cloudwatch#PutMetricStreamInput": { @@ -6910,20 +6924,20 @@ "Name": { "target": "com.amazonaws.cloudwatch#MetricStreamName", "traits": { - "smithy.api#documentation": "

If you are creating a new metric stream, this is the name for the new stream. The name\n\t\tmust be different than the names of other metric streams in this account and Region.

\n\t\t

If you are updating a metric stream, specify the name of that stream here.

\n\t\t

Valid characters are A-Z, a-z, 0-9, \"-\" and \"_\".

", + "smithy.api#documentation": "

If you are creating a new metric stream, this is the name for the new stream. The name\n\t\tmust be different than the names of other metric streams in this account and Region.

\n

If you are updating a metric stream, specify the name of that stream here.

\n

Valid characters are A-Z, a-z, 0-9, \"-\" and \"_\".

", "smithy.api#required": {} } }, "IncludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { - "smithy.api#documentation": "

If you specify this parameter, the stream sends only the \n\t\tmetrics from the metric namespaces that you specify here.

\n\t\t

You cannot include IncludeFilters and ExcludeFilters\n\t\tin the same operation.

" + "smithy.api#documentation": "

If you specify this parameter, the stream sends only the \n\t\tmetrics from the metric namespaces that you specify here.

\n

You cannot include IncludeFilters and ExcludeFilters\n\t\tin the same operation.

" } }, "ExcludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { - "smithy.api#documentation": "

If you specify this parameter, the stream sends metrics from all\n\t\t\tmetric namespaces except for the namespaces that you specify here.

\n\t\t

You cannot include ExcludeFilters and IncludeFilters in \n\t\t\tthe same operation.

" + "smithy.api#documentation": "

If you specify this parameter, the stream sends metrics from all\n\t\t\tmetric namespaces except for the namespaces that you specify here.

\n

You cannot include ExcludeFilters and IncludeFilters in \n\t\t\tthe same operation.

" } }, "FirehoseArn": { @@ -6936,7 +6950,7 @@ "RoleArn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data\n\t\t\tFirehose resources. This IAM role must already exist and must be in the same account as\n\t\t\tthe metric stream. This IAM role must include the following permissions:

\n\t\t ", + "smithy.api#documentation": "

The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data\n\t\t\tFirehose resources. This IAM role must already exist and must be in the same account as\n\t\t\tthe metric stream. This IAM role must include the following permissions:

\n ", "smithy.api#required": {} } }, @@ -6950,13 +6964,13 @@ "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the metric stream. You can associate as \n\t\t\tmany as 50 tags with a metric stream.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n\t\t

You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing metric stream, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the metric stream. You can associate as \n\t\t\tmany as 50 tags with a metric stream.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n

You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing metric stream, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" } }, "StatisticsConfigurations": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations", "traits": { - "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. This \n\t\t\tarray can have up to 100 members.

\n\t\t

For each entry in this array, you specify one or more metrics and the list of additional\n\t\t\tstatistics to stream for those metrics. The additional statistics that you can stream\n\t\t\tdepend on the stream's OutputFormat. If the OutputFormat is\n\t\t\t\tjson, you can stream any additional statistic that is supported by\n\t\t\t\tCloudWatch, listed in \n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat\n\t\t\tis opentelemetry0.7, you can stream percentile statistics such as p95,\n\t\t\tp99.9, and so on.

" + "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. This \n\t\t\tarray can have up to 100 members.

\n

For each entry in this array, you specify one or more metrics and the list of additional\n\t\t\tstatistics to stream for those metrics. The additional statistics that you can stream\n\t\t\tdepend on the stream's OutputFormat. If the OutputFormat is\n\t\t\t\tjson, you can stream any additional statistic that is supported by\n\t\t\t\tCloudWatch, listed in \n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat\n\t\t\tis opentelemetry0.7, you can stream percentile statistics such as p95,\n\t\t\tp99.9, and so on.

" } } } @@ -7112,7 +7126,7 @@ } ], "traits": { - "smithy.api#documentation": "

Temporarily sets the state of an alarm for testing purposes. When the updated\n\t\t\tstate differs from the previous value, the action configured for\n\t\t\tthe appropriate state is invoked. For example, if your alarm is configured to send an\n\t\t\tAmazon SNS message when an alarm is triggered, temporarily changing the alarm state to\n\t\t\tALARM sends an SNS message.

\n\t\t

Metric alarms\n\t\t\treturns to their actual state quickly, often within seconds. Because the metric alarm state change\n\t\t\thappens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through\n\t\t\tDescribeAlarmHistory.

\n\t\t

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return\n\t\t\tto its actual state. It\n\t\t\treturns to its actual state only once any of its children alarms change state. It is also\n\t\t\treevaluated if you update its\n\t\t\tconfiguration.

\n\t\t

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include\n\t\tinformation in the StateReasonData parameter to enable the policy to take the correct action.

" + "smithy.api#documentation": "

Temporarily sets the state of an alarm for testing purposes. When the updated\n\t\t\tstate differs from the previous value, the action configured for\n\t\t\tthe appropriate state is invoked. For example, if your alarm is configured to send an\n\t\t\tAmazon SNS message when an alarm is triggered, temporarily changing the alarm state to\n\t\t\tALARM sends an SNS message.

\n

Metric alarms\n\t\t\treturns to their actual state quickly, often within seconds. Because the metric alarm state change\n\t\t\thappens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through\n\t\t\tDescribeAlarmHistory.

\n

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return\n\t\t\tto its actual state. It\n\t\t\treturns to its actual state only once any of its children alarms change state. It is also\n\t\t\treevaluated if you update its\n\t\t\tconfiguration.

\n

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include\n\t\tinformation in the StateReasonData parameter to enable the policy to take the correct action.

" } }, "com.amazonaws.cloudwatch#SetAlarmStateInput": { @@ -7142,7 +7156,7 @@ "StateReasonData": { "target": "com.amazonaws.cloudwatch#StateReasonData", "traits": { - "smithy.api#documentation": "

The reason that this alarm is set to this specific state, in JSON format.

\n\t\t

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling\n\t\talarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

" + "smithy.api#documentation": "

The reason that this alarm is set to this specific state, in JSON format.

\n

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling\n\t\talarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

" } } } @@ -7381,7 +7395,7 @@ "Names": { "target": "com.amazonaws.cloudwatch#MetricStreamNames", "traits": { - "smithy.api#documentation": "

The array of the names of metric streams to start streaming.

\n\t\t

This is an \"all or nothing\" operation. If you do not have \n\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\tin the operation will start streaming.

", + "smithy.api#documentation": "

The array of the names of metric streams to start streaming.

\n

This is an \"all or nothing\" operation. If you do not have \n\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\tin the operation will start streaming.

", "smithy.api#required": {} } } @@ -7576,7 +7590,7 @@ "Names": { "target": "com.amazonaws.cloudwatch#MetricStreamNames", "traits": { - "smithy.api#documentation": "

The array of the names of metric streams to stop streaming.

\n\t\t

This is an \"all or nothing\" operation. If you do not have \n\t\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\t\tin the operation will stop streaming.

", + "smithy.api#documentation": "

The array of the names of metric streams to stop streaming.

\n

This is an \"all or nothing\" operation. If you do not have \n\t\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\t\tin the operation will stop streaming.

", "smithy.api#required": {} } } @@ -7663,7 +7677,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that \n\t\t\tcan be tagged are alarms and Contributor Insights rules.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n\t\t

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

\n\t\t

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, \n\t\t\tthis tag is appended to the list of tags associated\n\t\t\twith the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n\t\t\tthe previous value for that tag.

\n\t\t

You can associate as many as 50 tags with a CloudWatch resource.

" + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that \n\t\t\tcan be tagged are alarms and Contributor Insights rules.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

\n

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, \n\t\t\tthis tag is appended to the list of tags associated\n\t\t\twith the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n\t\t\tthe previous value for that tag.

\n

You can associate as many as 50 tags with a CloudWatch resource.

" } }, "com.amazonaws.cloudwatch#TagResourceInput": { @@ -7672,7 +7686,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're adding tags to.

\n\t\t

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n\t\t

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n\t\t

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're adding tags to.

\n

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", "smithy.api#required": {} } }, @@ -7761,7 +7775,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're removing tags from.

\n\t\t

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n\t\t

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n\t

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#documentation": "

The ARN of the CloudWatch resource that you're removing tags from.

\n

The ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n

\n

The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n

\n

For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/cost-explorer.json b/codegen/sdk-codegen/aws-models/cost-explorer.json index 228c8e3f88d..69e16371a73 100644 --- a/codegen/sdk-codegen/aws-models/cost-explorer.json +++ b/codegen/sdk-codegen/aws-models/cost-explorer.json @@ -1363,8 +1363,10 @@ "Threshold": { "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", "traits": { - "smithy.api#documentation": "

The dollar value that triggers a notification if the threshold is exceeded.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Threshold has been deprecated in favor of ThresholdExpression" + }, + "smithy.api#documentation": "

(deprecated)

\n

The dollar value that triggers a notification if the threshold is exceeded.

\n

This field has been deprecated. To specify a threshold, use ThresholdExpression.\n Continued use of Threshold will be treated as shorthand syntax for a\n ThresholdExpression.

\n

One of Threshold or ThresholdExpression is required for this resource.

" } }, "Frequency": { @@ -1380,6 +1382,12 @@ "smithy.api#documentation": "

The name for the subscription.

", "smithy.api#required": {} } + }, + "ThresholdExpression": { + "target": "com.amazonaws.costexplorer#Expression", + "traits": { + "smithy.api#documentation": "

An Expression\n object used to specify the anomalies that you want to generate alerts for. This supports\n dimensions and nested expressions. The supported dimensions are\n ANOMALY_TOTAL_IMPACT_ABSOLUTE and\n ANOMALY_TOTAL_IMPACT_PERCENTAGE. The supported nested expression types\n are AND and OR. The match option\n GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and\n 10,000,000,000.

\n

One of Threshold or ThresholdExpression is required for this resource.

\n

The following are examples of valid ThresholdExpressions:

\n " + } } }, "traits": { @@ -2300,7 +2308,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a subscription to a cost anomaly detection monitor. You can use each subscription to\n define subscribers with email or SNS notifications. Email subscribers can set a dollar\n threshold and a time frequency for receiving notifications.

" + "smithy.api#documentation": "

Adds an alert subscription to a cost anomaly detection monitor. You can use each\n subscription to define subscribers with email or SNS notifications. Email subscribers can set\n an absolute or percentage threshold and a time frequency for receiving notifications.

" } }, "com.amazonaws.costexplorer#CreateAnomalySubscriptionRequest": { @@ -2884,6 +2892,18 @@ "traits": { "smithy.api#enumValue": "INVOICING_ENTITY" } + }, + "ANOMALY_TOTAL_IMPACT_ABSOLUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALY_TOTAL_IMPACT_ABSOLUTE" + } + }, + "ANOMALY_TOTAL_IMPACT_PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALY_TOTAL_IMPACT_PERCENTAGE" + } } } }, @@ -2893,7 +2913,7 @@ "Key": { "target": "com.amazonaws.costexplorer#Dimension", "traits": { - "smithy.api#documentation": "

The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones.\n LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in\n CostCategoryRule.

" + "smithy.api#documentation": "

The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones.

\n

Not all dimensions are supported in each API. Refer to the documentation for each\n specific API to see what is supported.

\n

\n LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in\n CostCategoryRule.

\n

\n ANOMALY_TOTAL_IMPACT_ABSOLUTE and\n ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

" } }, "Values": { @@ -2905,7 +2925,7 @@ "MatchOptions": { "target": "com.amazonaws.costexplorer#MatchOptions", "traits": { - "smithy.api#documentation": "

The match options that you can use to filter your results. MatchOptions\n is only applicable for actions related to Cost Category. The default values for\n MatchOptions are EQUALS and\n CASE_SENSITIVE.

" + "smithy.api#documentation": "

The match options that you can use to filter your results.

\n

\n MatchOptions is only applicable for actions related to Cost Category and\n Anomaly Subscriptions. Refer to the documentation for each specific API to see what is\n supported.

\n

The default values for MatchOptions are EQUALS and\n CASE_SENSITIVE.

" } } }, @@ -3320,7 +3340,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use Expression to filter by cost or by usage. There are two patterns:

\n \n \n

For the GetRightsizingRecommendation action, a combination of OR and\n NOT isn't supported. OR isn't supported between different dimensions, or dimensions\n and tags. NOT operators aren't supported. Dimensions are also limited to\n LINKED_ACCOUNT, REGION, or\n RIGHTSIZING_TYPE.

\n

For the GetReservationPurchaseRecommendation action, only NOT is\n supported. AND and OR aren't supported. Dimensions are limited to\n LINKED_ACCOUNT.

\n " + "smithy.api#documentation": "

Use Expression to filter in various Cost Explorer APIs.

\n

Not all Expression types are supported in each API. Refer to the\n documentation for each specific API to see what is supported.

\n

There are two patterns:

\n \n \n

For the GetRightsizingRecommendation action, a combination of OR and\n NOT isn't supported. OR isn't supported between different dimensions, or dimensions\n and tags. NOT operators aren't supported. Dimensions are also limited to\n LINKED_ACCOUNT, REGION, or\n RIGHTSIZING_TYPE.

\n

For the GetReservationPurchaseRecommendation action, only NOT is\n supported. AND and OR aren't supported. Dimensions are limited to\n LINKED_ACCOUNT.

\n " } }, "com.amazonaws.costexplorer#Expressions": { @@ -3593,7 +3613,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account during the time period that's\n specified by the DateInterval object.

" + "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account during the time period that's\n specified by the DateInterval object. Anomalies are available for up to 90\n days.

" } }, "com.amazonaws.costexplorer#GetAnomaliesRequest": { @@ -5362,7 +5382,7 @@ "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum dollar value that's observed for an anomaly.

", + "smithy.api#documentation": "

The maximum dollar value that's observed for an anomaly.

", "smithy.api#required": {} } }, @@ -5370,7 +5390,25 @@ "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The cumulative dollar value that's observed for an anomaly.

" + "smithy.api#documentation": "

The cumulative dollar difference between the total actual spend and total expected\n spend. It is calculated as TotalActualSpend - TotalExpectedSpend.

" + } + }, + "TotalActualSpend": { + "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The cumulative dollar amount that was actually spent during the anomaly.

" + } + }, + "TotalExpectedSpend": { + "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The cumulative dollar amount that was expected to be spent during the anomaly. It is\n calculated using advanced machine learning models to determine the typical spending\n pattern based on historical data for a customer.

" + } + }, + "TotalImpactPercentage": { + "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", + "traits": { + "smithy.api#documentation": "

The cumulative percentage difference between the total actual spend and total expected\n spend. It is calculated as (TotalImpact / TotalExpectedSpend) * 100. When\n TotalExpectedSpend is zero, this field is omitted. Expected spend can\n be zero in situations such as when you start to use a service for the first time.

" } } }, @@ -5767,6 +5805,12 @@ "traits": { "smithy.api#enumValue": "CASE_INSENSITIVE" } + }, + "GREATER_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUAL" + } } } }, @@ -8370,7 +8414,10 @@ "Threshold": { "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", "traits": { - "smithy.api#documentation": "

The update to the threshold value for receiving notifications.

" + "smithy.api#deprecated": { + "message": "Threshold has been deprecated in favor of ThresholdExpression" + }, + "smithy.api#documentation": "

(deprecated)

\n

The update to the threshold value for receiving notifications.

\n

This field has been deprecated. To update a threshold, use ThresholdExpression. Continued\n use of Threshold will be treated as shorthand syntax for a ThresholdExpression.

" } }, "Frequency": { @@ -8396,6 +8443,12 @@ "traits": { "smithy.api#documentation": "

The new name of the subscription.

" } + }, + "ThresholdExpression": { + "target": "com.amazonaws.costexplorer#Expression", + "traits": { + "smithy.api#documentation": "

The update to the Expression object\n used to specify the anomalies that you want to generate alerts for. This supports dimensions\n and nested expressions. The supported dimensions are\n ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE.\n The supported nested expression types are AND and OR. The match\n option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and\n 10,000,000,000.

\n

The following are examples of valid ThresholdExpressions:

\n " + } } } }, diff --git a/codegen/sdk-codegen/aws-models/networkmanager.json b/codegen/sdk-codegen/aws-models/networkmanager.json index 71dbc49159a..8d5363c2412 100644 --- a/codegen/sdk-codegen/aws-models/networkmanager.json +++ b/codegen/sdk-codegen/aws-models/networkmanager.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -619,69 +619,91 @@ } }, "com.amazonaws.networkmanager#AttachmentState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REJECTED", - "name": "REJECTED" - }, - { - "value": "PENDING_ATTACHMENT_ACCEPTANCE", - "name": "PENDING_ATTACHMENT_ACCEPTANCE" - }, - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "PENDING_NETWORK_UPDATE", - "name": "PENDING_NETWORK_UPDATE" - }, - { - "value": "PENDING_TAG_ACCEPTANCE", - "name": "PENDING_TAG_ACCEPTANCE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + }, + "PENDING_ATTACHMENT_ACCEPTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ATTACHMENT_ACCEPTANCE" } - ] + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "PENDING_NETWORK_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_NETWORK_UPDATE" + } + }, + "PENDING_TAG_ACCEPTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_TAG_ACCEPTANCE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } } }, "com.amazonaws.networkmanager#AttachmentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONNECT", - "name": "CONNECT" - }, - { - "value": "SITE_TO_SITE_VPN", - "name": "SITE_TO_SITE_VPN" - }, - { - "value": "VPC", - "name": "VPC" - }, - { - "value": "TRANSIT_GATEWAY_ROUTE_TABLE", - "name": "TRANSIT_GATEWAY_ROUTE_TABLE" + "type": "enum", + "members": { + "CONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECT" } - ] + }, + "SITE_TO_SITE_VPN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SITE_TO_SITE_VPN" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } + }, + "TRANSIT_GATEWAY_ROUTE_TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ROUTE_TABLE" + } + } } }, "com.amazonaws.networkmanager#Bandwidth": { @@ -719,122 +741,161 @@ } }, "com.amazonaws.networkmanager#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.networkmanager#ChangeAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ADD", - "name": "ADD" - }, - { - "value": "MODIFY", - "name": "MODIFY" - }, - { - "value": "REMOVE", - "name": "REMOVE" + "type": "enum", + "members": { + "ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD" + } + }, + "MODIFY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFY" + } + }, + "REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE" } - ] + } } }, "com.amazonaws.networkmanager#ChangeSetState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_GENERATION", - "name": "PENDING_GENERATION" - }, - { - "value": "FAILED_GENERATION", - "name": "FAILED_GENERATION" - }, - { - "value": "READY_TO_EXECUTE", - "name": "READY_TO_EXECUTE" - }, - { - "value": "EXECUTING", - "name": "EXECUTING" - }, - { - "value": "EXECUTION_SUCCEEDED", - "name": "EXECUTION_SUCCEEDED" - }, - { - "value": "OUT_OF_DATE", - "name": "OUT_OF_DATE" + "type": "enum", + "members": { + "PENDING_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_GENERATION" + } + }, + "FAILED_GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_GENERATION" + } + }, + "READY_TO_EXECUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY_TO_EXECUTE" + } + }, + "EXECUTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTING" } - ] + }, + "EXECUTION_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTION_SUCCEEDED" + } + }, + "OUT_OF_DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUT_OF_DATE" + } + } } }, "com.amazonaws.networkmanager#ChangeStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NOT_STARTED", - "name": "NOT_STARTED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "COMPLETE", - "name": "COMPLETE" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STARTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.networkmanager#ChangeType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CORE_NETWORK_SEGMENT", - "name": "CORE_NETWORK_SEGMENT" - }, - { - "value": "CORE_NETWORK_EDGE", - "name": "CORE_NETWORK_EDGE" - }, - { - "value": "ATTACHMENT_MAPPING", - "name": "ATTACHMENT_MAPPING" - }, - { - "value": "ATTACHMENT_ROUTE_PROPAGATION", - "name": "ATTACHMENT_ROUTE_PROPAGATION" - }, - { - "value": "ATTACHMENT_ROUTE_STATIC", - "name": "ATTACHMENT_ROUTE_STATIC" - }, - { - "value": "CORE_NETWORK_CONFIGURATION", - "name": "CORE_NETWORK_CONFIGURATION" - }, - { - "value": "SEGMENTS_CONFIGURATION", - "name": "SEGMENTS_CONFIGURATION" - }, - { - "value": "SEGMENT_ACTIONS_CONFIGURATION", - "name": "SEGMENT_ACTIONS_CONFIGURATION" - }, - { - "value": "ATTACHMENT_POLICIES_CONFIGURATION", - "name": "ATTACHMENT_POLICIES_CONFIGURATION" + "type": "enum", + "members": { + "CORE_NETWORK_SEGMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORE_NETWORK_SEGMENT" + } + }, + "CORE_NETWORK_EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORE_NETWORK_EDGE" + } + }, + "ATTACHMENT_MAPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_MAPPING" + } + }, + "ATTACHMENT_ROUTE_PROPAGATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_ROUTE_PROPAGATION" + } + }, + "ATTACHMENT_ROUTE_STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_ROUTE_STATIC" } - ] + }, + "CORE_NETWORK_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORE_NETWORK_CONFIGURATION" + } + }, + "SEGMENTS_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEGMENTS_CONFIGURATION" + } + }, + "SEGMENT_ACTIONS_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEGMENT_ACTIONS_CONFIGURATION" + } + }, + "ATTACHMENT_POLICIES_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_POLICIES_CONFIGURATION" + } + } } }, "com.amazonaws.networkmanager#ClientToken": { @@ -1018,26 +1079,32 @@ } }, "com.amazonaws.networkmanager#ConnectPeerAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" } - ] + } } }, "com.amazonaws.networkmanager#ConnectPeerBgpConfiguration": { @@ -1133,26 +1200,32 @@ } }, "com.amazonaws.networkmanager#ConnectPeerState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } } }, "com.amazonaws.networkmanager#ConnectPeerSummary": { @@ -1344,56 +1417,66 @@ } }, "com.amazonaws.networkmanager#ConnectionState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#ConnectionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UP", - "name": "UP" - }, - { - "value": "DOWN", - "name": "DOWN" + "type": "enum", + "members": { + "UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UP" } - ] + }, + "DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOWN" + } + } } }, "com.amazonaws.networkmanager#ConnectionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BGP", - "name": "BGP" - }, - { - "value": "IPSEC", - "name": "IPSEC" + "type": "enum", + "members": { + "BGP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BGP" } - ] + }, + "IPSEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPSEC" + } + } } }, "com.amazonaws.networkmanager#ConstrainedString": { @@ -1765,18 +1848,20 @@ } }, "com.amazonaws.networkmanager#CoreNetworkPolicyAlias": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LIVE", - "name": "LIVE" - }, - { - "value": "LATEST", - "name": "LATEST" + "type": "enum", + "members": { + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" } - ] + }, + "LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST" + } + } } }, "com.amazonaws.networkmanager#CoreNetworkPolicyDocument": { @@ -1954,26 +2039,32 @@ } }, "com.amazonaws.networkmanager#CoreNetworkState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + } } }, "com.amazonaws.networkmanager#CoreNetworkSummary": { @@ -3173,26 +3264,32 @@ } }, "com.amazonaws.networkmanager#CustomerGatewayAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } } }, "com.amazonaws.networkmanager#DateTime": { @@ -4176,26 +4273,32 @@ } }, "com.amazonaws.networkmanager#DeviceState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" } - ] + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#DisassociateConnectPeer": { @@ -6943,26 +7046,32 @@ } }, "com.amazonaws.networkmanager#GlobalNetworkState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#IPAddress": { @@ -6976,10 +7085,7 @@ } }, "com.amazonaws.networkmanager#Integer": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.networkmanager#InternalServerException": { "type": "structure", @@ -7127,26 +7233,32 @@ } }, "com.amazonaws.networkmanager#LinkAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" } - ] + } } }, "com.amazonaws.networkmanager#LinkId": { @@ -7172,26 +7284,32 @@ } }, "com.amazonaws.networkmanager#LinkState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" } - ] + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#ListAttachments": { @@ -7779,15 +7897,11 @@ } }, "com.amazonaws.networkmanager#Long": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.networkmanager#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 @@ -7796,21 +7910,6 @@ }, "com.amazonaws.networkmanager#NetworkManager": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "NetworkManager", - "arnNamespace": "networkmanager", - "cloudFormationName": "NetworkManager", - "cloudTrailEventSource": "networkmanager.amazonaws.com", - "endpointPrefix": "networkmanager" - }, - "aws.auth#sigv4": { - "name": "networkmanager" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

", - "smithy.api#title": "AWS Network Manager" - }, "version": "2019-07-05", "operations": [ { @@ -8068,7 +8167,970 @@ { "target": "com.amazonaws.networkmanager#UpdateVpcAttachment" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "NetworkManager", + "arnNamespace": "networkmanager", + "cloudFormationName": "NetworkManager", + "cloudTrailEventSource": "networkmanager.amazonaws.com", + "endpointPrefix": "networkmanager" + }, + "aws.auth#sigv4": { + "name": "networkmanager" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

", + "smithy.api#title": "AWS Network Manager", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager-fips.{Region}.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-west-2", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager-fips.{Region}.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-west-2", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager.{Region}.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-west-2", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager.us-west-2.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-west-2", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager-fips.{Region}.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager-fips.{Region}.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager.{Region}.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager.us-gov-west-1.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://networkmanager.us-west-2.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-west-2", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-us-gov-global" + ] + } + ], + "endpoint": { + "url": "https://networkmanager.us-gov-west-1.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://networkmanager.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-west-2", + "signingName": "networkmanager", + "name": "sigv4" + } + ] + }, + "url": "https://networkmanager.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "aws-global", + "UseDualStack": false + } + }, + { + "documentation": "For region aws-us-gov-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "signingRegion": "us-gov-west-1", + "signingName": "networkmanager", + "name": "sigv4" + } + ] + }, + "url": "https://networkmanager.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "aws-us-gov-global", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } }, "com.amazonaws.networkmanager#NetworkResource": { "type": "structure", @@ -8221,6 +9283,7 @@ "IsMiddlebox": { "target": "com.amazonaws.networkmanager#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether this is a middlebox appliance.

" } } @@ -8570,37 +9633,43 @@ } }, "com.amazonaws.networkmanager#PeeringState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + } } }, "com.amazonaws.networkmanager#PeeringType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSIT_GATEWAY", - "name": "TRANSIT_GATEWAY" + "type": "enum", + "members": { + "TRANSIT_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY" } - ] + } } }, "com.amazonaws.networkmanager#ProposedSegmentChange": { @@ -9080,10 +10149,7 @@ } }, "com.amazonaws.networkmanager#RetryAfterSeconds": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.networkmanager#RouteAnalysis": { "type": "structure", @@ -9133,12 +10199,14 @@ "IncludeReturnPath": { "target": "com.amazonaws.networkmanager#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether to analyze the return path. The return path is not analyzed if the forward path\n analysis does not succeed.

" } }, "UseMiddleboxes": { "target": "com.amazonaws.networkmanager#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether to include the location of middlebox appliances in the route analysis.

" } }, @@ -9186,69 +10254,91 @@ } }, "com.amazonaws.networkmanager#RouteAnalysisCompletionReasonCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND", - "name": "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND" - }, - { - "value": "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY", - "name": "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY" - }, - { - "value": "CYCLIC_PATH_DETECTED", - "name": "CYCLIC_PATH_DETECTED" - }, - { - "value": "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND", - "name": "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND" - }, - { - "value": "ROUTE_NOT_FOUND", - "name": "ROUTE_NOT_FOUND" - }, - { - "value": "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND", - "name": "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND" - }, - { - "value": "INACTIVE_ROUTE_FOR_DESTINATION_FOUND", - "name": "INACTIVE_ROUTE_FOR_DESTINATION_FOUND" - }, - { - "value": "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH", - "name": "TRANSIT_GATEWAY_ATTACHMENT" - }, - { - "value": "MAX_HOPS_EXCEEDED", - "name": "MAX_HOPS_EXCEEDED" - }, - { - "value": "POSSIBLE_MIDDLEBOX", - "name": "POSSIBLE_MIDDLEBOX" - }, - { - "value": "NO_DESTINATION_ARN_PROVIDED", - "name": "NO_DESTINATION_ARN_PROVIDED" + "type": "enum", + "members": { + "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND" + } + }, + "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY" + } + }, + "CYCLIC_PATH_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CYCLIC_PATH_DETECTED" + } + }, + "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND" + } + }, + "ROUTE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUTE_NOT_FOUND" + } + }, + "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND" + } + }, + "INACTIVE_ROUTE_FOR_DESTINATION_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE_ROUTE_FOR_DESTINATION_FOUND" + } + }, + "TRANSIT_GATEWAY_ATTACHMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH" + } + }, + "MAX_HOPS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_HOPS_EXCEEDED" + } + }, + "POSSIBLE_MIDDLEBOX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSSIBLE_MIDDLEBOX" + } + }, + "NO_DESTINATION_ARN_PROVIDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_DESTINATION_ARN_PROVIDED" } - ] + } } }, "com.amazonaws.networkmanager#RouteAnalysisCompletionResultCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONNECTED", - "name": "CONNECTED" - }, - { - "value": "NOT_CONNECTED", - "name": "NOT_CONNECTED" + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED" + } + }, + "NOT_CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONNECTED" } - ] + } } }, "com.amazonaws.networkmanager#RouteAnalysisEndpointOptions": { @@ -9318,37 +10408,43 @@ } }, "com.amazonaws.networkmanager#RouteAnalysisStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RUNNING", - "name": "running" - }, - { - "value": "COMPLETED", - "name": "completed" - }, - { - "value": "FAILED", - "name": "failed" + "type": "enum", + "members": { + "running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" } - ] + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.networkmanager#RouteState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "BLACKHOLE", - "name": "BLACKHOLE" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "BLACKHOLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLACKHOLE" } - ] + } } }, "com.amazonaws.networkmanager#RouteStateList": { @@ -9378,33 +10474,37 @@ } }, "com.amazonaws.networkmanager#RouteTableType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSIT_GATEWAY_ROUTE_TABLE", - "name": "TRANSIT_GATEWAY_ROUTE_TABLE" - }, - { - "value": "CORE_NETWORK_SEGMENT", - "name": "CORE_NETWORK_SEGMENT" + "type": "enum", + "members": { + "TRANSIT_GATEWAY_ROUTE_TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_ROUTE_TABLE" + } + }, + "CORE_NETWORK_SEGMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORE_NETWORK_SEGMENT" } - ] + } } }, "com.amazonaws.networkmanager#RouteType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROPAGATED", - "name": "PROPAGATED" - }, - { - "value": "STATIC", - "name": "STATIC" + "type": "enum", + "members": { + "PROPAGATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROPAGATED" + } + }, + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" } - ] + } } }, "com.amazonaws.networkmanager#RouteTypeList": { @@ -9564,26 +10664,32 @@ } }, "com.amazonaws.networkmanager#SiteState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "UPDATING", - "name": "updating" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" } - ] + }, + "updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } } }, "com.amazonaws.networkmanager#SiteToSiteVpnAttachment": { @@ -9635,7 +10741,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables for the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

", + "smithy.api#documentation": "

Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

", "smithy.api#http": { "method": "POST", "uri": "/organizations/service-access", @@ -9731,12 +10837,14 @@ "IncludeReturnPath": { "target": "com.amazonaws.networkmanager#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether to analyze the return path. The default is false.

" } }, "UseMiddleboxes": { "target": "com.amazonaws.networkmanager#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether to include the location of middlebox appliances in the route analysis.\n The default is false.

" } } @@ -10027,26 +11135,32 @@ } }, "com.amazonaws.networkmanager#TransitGatewayConnectPeerAssociationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" } - ] + } } }, "com.amazonaws.networkmanager#TransitGatewayPeering": { @@ -10118,30 +11232,38 @@ } }, "com.amazonaws.networkmanager#TransitGatewayRegistrationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "pending" - }, - { - "value": "AVAILABLE", - "name": "available" - }, - { - "value": "DELETING", - "name": "deleting" - }, - { - "value": "DELETED", - "name": "deleted" - }, - { - "value": "FAILED", - "name": "failed" + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.networkmanager#TransitGatewayRegistrationStateReason": { @@ -10198,14 +11320,14 @@ } }, "com.amazonaws.networkmanager#TunnelProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GRE", - "name": "GRE" + "type": "enum", + "members": { + "GRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRE" } - ] + } } }, "com.amazonaws.networkmanager#UntagResource": { @@ -11000,26 +12122,32 @@ } }, "com.amazonaws.networkmanager#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UnknownOperation", - "name": "UNKNOWN_OPERATION" - }, - { - "value": "CannotParse", - "name": "CANNOT_PARSE" - }, - { - "value": "FieldValidationFailed", - "name": "FIELD_VALIDATION_FAILED" - }, - { - "value": "Other", - "name": "OTHER" + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FieldValidationFailed" } - ] + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Other" + } + } } }, "com.amazonaws.networkmanager#VpcArn": { @@ -11064,8 +12192,16 @@ "Ipv6Support": { "target": "com.amazonaws.networkmanager#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether IPv6 is supported.

" } + }, + "ApplianceModeSupport": { + "target": "com.amazonaws.networkmanager#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/redshift-data.json b/codegen/sdk-codegen/aws-models/redshift-data.json index 69735362b8e..4f75db88322 100644 --- a/codegen/sdk-codegen/aws-models/redshift-data.json +++ b/codegen/sdk-codegen/aws-models/redshift-data.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "shapes": { "com.amazonaws.redshiftdata#ActiveStatementsExceededException": { "type": "structure", @@ -34,7 +34,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n " + "smithy.api#documentation": "

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n \n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

" } }, "com.amazonaws.redshiftdata#BatchExecuteStatementException": { @@ -66,7 +66,7 @@ "Sqls": { "target": "com.amazonaws.redshiftdata#SqlList", "traits": { - "smithy.api#documentation": "

One or more SQL statements to run.

", + "smithy.api#documentation": "

One or more SQL statements to run. \n \n The SQL statements are run as a single transaction. They run serially in the order of the array. \n Subsequent SQL statements don't start until the previous statement in the array completes. \n If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

", "smithy.api#required": {} } }, @@ -112,6 +112,13 @@ "traits": { "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" } + }, + "ClientToken": { + "target": "com.amazonaws.redshiftdata#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } } } }, @@ -166,22 +173,13 @@ "type": "blob" }, "com.amazonaws.redshiftdata#BoxedBoolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.redshiftdata#BoxedDouble": { - "type": "double", - "traits": { - "smithy.api#box": {} - } + "type": "double" }, "com.amazonaws.redshiftdata#BoxedLong": { - "type": "long", - "traits": { - "smithy.api#box": {} - } + "type": "long" }, "com.amazonaws.redshiftdata#CancelStatement": { "type": "operation", @@ -206,7 +204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a running query. To be canceled, a query must be running.

" + "smithy.api#documentation": "

Cancels a running query. To be canceled, a query must be running.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

" } }, "com.amazonaws.redshiftdata#CancelStatementRequest": { @@ -232,6 +230,15 @@ } } }, + "com.amazonaws.redshiftdata#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.redshiftdata#ColumnList": { "type": "list", "member": { @@ -244,18 +251,21 @@ "isCaseSensitive": { "target": "com.amazonaws.redshiftdata#bool", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

A value that indicates whether the column is case-sensitive.

" } }, "isCurrency": { "target": "com.amazonaws.redshiftdata#bool", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

A value that indicates whether the column contains currency values.

" } }, "isSigned": { "target": "com.amazonaws.redshiftdata#bool", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "

A value that indicates whether an integer column is signed.

" } }, @@ -274,18 +284,21 @@ "nullable": { "target": "com.amazonaws.redshiftdata#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

A value that indicates whether the column is nullable.

" } }, "precision": { "target": "com.amazonaws.redshiftdata#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The precision value of a decimal number column.

" } }, "scale": { "target": "com.amazonaws.redshiftdata#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The scale value of a decimal number column.

" } }, @@ -310,6 +323,7 @@ "length": { "target": "com.amazonaws.redshiftdata#Integer", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The length of the column.

" } }, @@ -372,7 +386,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information\n includes when the query started, when it finished, the query status, the number of rows returned, and the SQL\n statement.

", + "smithy.api#documentation": "

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information\n includes when the query started, when it finished, the query status, the number of rows returned, and the SQL\n statement.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#readonly": {} } }, @@ -425,6 +439,7 @@ "Duration": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The amount of time in nanoseconds that the statement ran.

" } }, @@ -455,6 +470,7 @@ "RedshiftPid": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The process identifier from Amazon Redshift.

" } }, @@ -473,18 +489,21 @@ "ResultRows": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

Either the number of rows returned from the SQL statement or the number of rows affected.\n If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. \n A -1 indicates the value is null.

" } }, "ResultSize": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The size in bytes of the returned results. A -1 indicates the value is null.

" } }, "RedshiftQueryId": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The identifier of the query generated by Amazon Redshift. \n These identifiers are also available in the query column of the STL_QUERY system view.

" } }, @@ -528,12 +547,12 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n ", + "smithy.api#documentation": "

Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n \n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "ColumnList", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "ColumnList" }, "smithy.api#readonly": {} } @@ -593,6 +612,7 @@ "MaxResults": { "target": "com.amazonaws.redshiftdata#PageSize", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of tables to return in the response. \n If more tables exist than fit in one response, then NextToken is returned to page through the results.

" } }, @@ -647,7 +667,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n " + "smithy.api#documentation": "

Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n \n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

" } }, "com.amazonaws.redshiftdata#ExecuteStatementException": { @@ -732,6 +752,13 @@ "traits": { "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" } + }, + "ClientToken": { + "target": "com.amazonaws.redshiftdata#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "smithy.api#idempotencyToken": {} + } } } }, @@ -852,7 +879,7 @@ } ], "traits": { - "smithy.api#documentation": "

Fetches the temporarily cached result of an SQL statement. \n A token is returned to page through the statement results.

", + "smithy.api#documentation": "

Fetches the temporarily cached result of an SQL statement. \n A token is returned to page through the statement results.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -898,6 +925,7 @@ "TotalNumRows": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The total number of rows in the result set returned from a query. \n You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.

" } }, @@ -910,7 +938,10 @@ } }, "com.amazonaws.redshiftdata#Integer": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.redshiftdata#InternalServerException": { "type": "structure", @@ -949,12 +980,12 @@ } ], "traits": { - "smithy.api#documentation": "

List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n ", + "smithy.api#documentation": "

List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n \n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Databases", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Databases" }, "smithy.api#readonly": {} } @@ -996,6 +1027,7 @@ "MaxResults": { "target": "com.amazonaws.redshiftdata#PageSize", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of databases to return in the response. \n If more databases exist than fit in one response, then NextToken is returned to page through the results.

" } }, @@ -1044,12 +1076,12 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n ", + "smithy.api#documentation": "

Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n \n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Schemas", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Schemas" }, "smithy.api#readonly": {} } @@ -1103,6 +1135,7 @@ "MaxResults": { "target": "com.amazonaws.redshiftdata#PageSize", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of schemas to return in the response. \n If more schemas exist than fit in one response, then NextToken is returned to page through the results.

" } }, @@ -1148,12 +1181,12 @@ } ], "traits": { - "smithy.api#documentation": "

List of SQL statements. By default, only finished statements are shown. \n A token is returned to page through the statement list.

", + "smithy.api#documentation": "

List of SQL statements. By default, only finished statements are shown. \n A token is returned to page through the statement list.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Statements", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Statements" }, "smithy.api#readonly": {} } @@ -1161,6 +1194,7 @@ "com.amazonaws.redshiftdata#ListStatementsLimit": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 100 @@ -1179,6 +1213,7 @@ "MaxResults": { "target": "com.amazonaws.redshiftdata#ListStatementsLimit", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of SQL statements to return in the response. \n If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.

" } }, @@ -1240,12 +1275,12 @@ } ], "traits": { - "smithy.api#documentation": "

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n ", + "smithy.api#documentation": "

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n \n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Tables", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "Tables" }, "smithy.api#readonly": {} } @@ -1305,6 +1340,7 @@ "MaxResults": { "target": "com.amazonaws.redshiftdata#PageSize", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of tables to return in the response. \n If more tables exist than fit in one response, then NextToken is returned to page through the results.

" } }, @@ -1337,11 +1373,15 @@ "type": "string" }, "com.amazonaws.redshiftdata#Long": { - "type": "long" + "type": "long", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.redshiftdata#PageSize": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 1000 @@ -1364,22 +1404,6 @@ }, "com.amazonaws.redshiftdata#RedshiftData": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Redshift Data", - "arnNamespace": "redshift-data", - "cloudFormationName": "RedshiftData", - "cloudTrailEventSource": "redshift-data.amazonaws.com", - "endpointPrefix": "redshift-data" - }, - "aws.auth#sigv4": { - "name": "redshift-data" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#cors": {}, - "smithy.api#documentation": "

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run SQL statements, which are committed if the statement succeeds.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Cluster Management Guide.

", - "smithy.api#title": "Redshift Data API Service" - }, "version": "2019-12-20", "operations": [ { @@ -1412,7 +1436,372 @@ { "target": "com.amazonaws.redshiftdata#ListTables" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Redshift Data", + "arnNamespace": "redshift-data" + }, + "aws.auth#sigv4": { + "name": "redshift-data" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run SQL statements, which are committed if the statement succeeds.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Management Guide.

", + "smithy.api#title": "Redshift Data API Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://redshift-data-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://redshift-data-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://redshift-data.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://redshift-data.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } }, "com.amazonaws.redshiftdata#ResourceNotFoundException": { "type": "structure", @@ -1472,7 +1861,7 @@ "value": { "target": "com.amazonaws.redshiftdata#ParameterValue", "traits": { - "smithy.api#documentation": "

The value of the parameter. \n Amazon Redshift implicitly converts to the proper data type. For more inforation, see \n Data types in the \n Amazon Redshift Database Developer Guide.

", + "smithy.api#documentation": "

The value of the parameter. \n Amazon Redshift implicitly converts to the proper data type. For more information, see \n Data types in the \n Amazon Redshift Database Developer Guide.

", "smithy.api#required": {} } } @@ -1592,28 +1981,28 @@ "traits": { "smithy.api#enum": [ { - "value": "SUBMITTED", - "name": "SUBMITTED" + "name": "SUBMITTED", + "value": "SUBMITTED" }, { - "value": "PICKED", - "name": "PICKED" + "name": "PICKED", + "value": "PICKED" }, { - "value": "STARTED", - "name": "STARTED" + "name": "STARTED", + "value": "STARTED" }, { - "value": "FINISHED", - "name": "FINISHED" + "name": "FINISHED", + "value": "FINISHED" }, { - "value": "ABORTED", - "name": "ABORTED" + "name": "ABORTED", + "value": "ABORTED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" } ] } @@ -1632,32 +2021,32 @@ "traits": { "smithy.api#enum": [ { - "value": "SUBMITTED", - "name": "SUBMITTED" + "name": "SUBMITTED", + "value": "SUBMITTED" }, { - "value": "PICKED", - "name": "PICKED" + "name": "PICKED", + "value": "PICKED" }, { - "value": "STARTED", - "name": "STARTED" + "name": "STARTED", + "value": "STARTED" }, { - "value": "FINISHED", - "name": "FINISHED" + "name": "FINISHED", + "value": "FINISHED" }, { - "value": "ABORTED", - "name": "ABORTED" + "name": "ABORTED", + "value": "ABORTED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" }, { - "value": "ALL", - "name": "ALL" + "name": "ALL", + "value": "ALL" } ] } @@ -1678,6 +2067,7 @@ "Duration": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The amount of time in nanoseconds that the statement ran.

" } }, @@ -1714,18 +2104,21 @@ "ResultRows": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

Either the number of rows returned from the SQL statement or the number of rows affected. \n If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others.\n A -1 indicates the value is null.

" } }, "ResultSize": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The size in bytes of the returned results. A -1 indicates the value is null.

" } }, "RedshiftQueryId": { "target": "com.amazonaws.redshiftdata#Long", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

" } }, @@ -1805,7 +2198,10 @@ } }, "com.amazonaws.redshiftdata#bool": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } } } } \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/sagemaker-metrics.json b/codegen/sdk-codegen/aws-models/sagemaker-metrics.json index 02a78ddc1ba..b9df50f7926 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker-metrics.json +++ b/codegen/sdk-codegen/aws-models/sagemaker-metrics.json @@ -38,7 +38,7 @@ "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsResponse" }, "traits": { - "smithy.api#documentation": "

Used to ingest training metrics into SageMaker which can be visualized in SageMaker Studio and\n retrieved with the GetMetrics API.\n

", + "smithy.api#documentation": "

Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and\n retrieved with the GetMetrics API.\n

", "smithy.api#http": { "method": "PUT", "uri": "/BatchPutMetrics", @@ -52,7 +52,7 @@ "Code": { "target": "com.amazonaws.sagemakermetrics#PutMetricsErrorCode", "traits": { - "smithy.api#documentation": "

The error code of an error that occured when attempting to put metrics.

\n " + "smithy.api#documentation": "

The error code of an error that occured when attempting to put metrics.

\n " } }, "MetricIndex": { @@ -85,7 +85,7 @@ "TrialComponentName": { "target": "com.amazonaws.sagemakermetrics#ExperimentEntityName", "traits": { - "smithy.api#documentation": "

The name of Trial Component to associate the metrics with.

", + "smithy.api#documentation": "

The name of the Trial Component to associate with the metrics.

", "smithy.api#required": {} } }, @@ -104,7 +104,7 @@ "Errors": { "target": "com.amazonaws.sagemakermetrics#BatchPutMetricsErrorList", "traits": { - "smithy.api#documentation": "

Any errors that occur when inserting metric data will appear in this.

" + "smithy.api#documentation": "

Lists any errors that occur when inserting metric data.

" } } } @@ -183,14 +183,14 @@ "Timestamp": { "target": "com.amazonaws.sagemakermetrics#Timestamp", "traits": { - "smithy.api#documentation": "

The time when the metric was recorded.

", + "smithy.api#documentation": "

The time that the metric was recorded.

", "smithy.api#required": {} } }, "Step": { "target": "com.amazonaws.sagemakermetrics#Step", "traits": { - "smithy.api#documentation": "

Metric step (aka Epoch).\n

" + "smithy.api#documentation": "

The metric step (epoch).\n

" } }, "Value": { @@ -551,8 +551,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -564,8 +564,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -577,8 +577,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -590,8 +590,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -603,8 +603,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -616,8 +616,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -629,8 +629,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -642,8 +642,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -653,8 +653,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -666,8 +666,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -677,8 +677,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -690,8 +690,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -703,8 +703,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -716,8 +716,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -729,8 +729,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -742,8 +742,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -753,8 +753,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -766,8 +766,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -777,8 +777,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -790,8 +790,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -803,8 +803,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -815,8 +815,8 @@ }, "params": { "UseFIPS": true, - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -827,8 +827,8 @@ }, "params": { "UseFIPS": false, - "UseDualStack": true, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } }