feat(client-application-auto-scaling): Application Auto Scaling customers can now use mathematical functions to customize the metric used with Target Tracking policies within the policy configuration itself, saving the cost and effort of publishing the customizations as a separate metric.

awstools · awstools · commit e92a7689f36e · 2023-03-14T18:20:44.000Z
diff --git a/clients/client-application-auto-scaling/README.md b/clients/client-application-auto-scaling/README.md
@@ -55,6 +55,8 @@ resources:</p>
 <p>Custom resources provided by your own applications or services</p>
 </li>
 </ul>
+<p>To learn more about Application Auto Scaling, see the <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html">Application Auto Scaling User
+Guide</a>.</p>
 <p>
 <b>API Summary</b>
 </p>
@@ -78,9 +80,6 @@ triggered by a scaling policy, scale-in activities that are triggered by a scali
 and scheduled scaling.</p>
 </li>
 </ul>
-<p>To learn more about Application Auto Scaling, including information about granting IAM users required
-permissions for Application Auto Scaling actions, see the <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html">Application Auto Scaling User
-Guide</a>.</p>
 
 ## Installing
 
diff --git a/clients/client-application-auto-scaling/src/ApplicationAutoScaling.ts b/clients/client-application-auto-scaling/src/ApplicationAutoScaling.ts
@@ -100,6 +100,8 @@ import {
  *                <p>Custom resources provided by your own applications or services</p>
  *             </li>
  *          </ul>
+ *          <p>To learn more about Application Auto Scaling, see the <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html">Application Auto Scaling User
+ *       Guide</a>.</p>
  *          <p>
  *             <b>API Summary</b>
  *          </p>
@@ -123,9 +125,6 @@ import {
  *           and scheduled scaling.</p>
  *             </li>
  *          </ul>
- *          <p>To learn more about Application Auto Scaling, including information about granting IAM users required
- *       permissions for Application Auto Scaling actions, see the <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html">Application Auto Scaling User
- *         Guide</a>.</p>
  */
 export class ApplicationAutoScaling extends ApplicationAutoScalingClient {
   /**
diff --git a/clients/client-application-auto-scaling/src/ApplicationAutoScalingClient.ts b/clients/client-application-auto-scaling/src/ApplicationAutoScalingClient.ts
@@ -311,6 +311,8 @@ export interface ApplicationAutoScalingClientResolvedConfig extends ApplicationA
  *                <p>Custom resources provided by your own applications or services</p>
  *             </li>
  *          </ul>
+ *          <p>To learn more about Application Auto Scaling, see the <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html">Application Auto Scaling User
+ *       Guide</a>.</p>
  *          <p>
  *             <b>API Summary</b>
  *          </p>
@@ -334,9 +336,6 @@ export interface ApplicationAutoScalingClientResolvedConfig extends ApplicationA
  *           and scheduled scaling.</p>
  *             </li>
  *          </ul>
- *          <p>To learn more about Application Auto Scaling, including information about granting IAM users required
- *       permissions for Application Auto Scaling actions, see the <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html">Application Auto Scaling User
- *         Guide</a>.</p>
  */
 export class ApplicationAutoScalingClient extends __Client<
   __HttpHandlerOptions,
diff --git a/clients/client-application-auto-scaling/src/endpoint/EndpointParameters.ts b/clients/client-application-auto-scaling/src/endpoint/EndpointParameters.ts
@@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
 };
 
 export interface EndpointParameters extends __EndpointParameters {
-  Region: string;
+  Region?: string;
   UseDualStack?: boolean;
   UseFIPS?: boolean;
   Endpoint?: string;
diff --git a/clients/client-application-auto-scaling/src/endpoint/ruleset.ts b/clients/client-application-auto-scaling/src/endpoint/ruleset.ts
@@ -6,26 +6,27 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
    or see "smithy.rules#endpointRuleSet"
    in codegen/sdk-codegen/aws-models/application-auto-scaling.json */
 
-const s="fn",
-t="argv",
-u="ref";
-const a=true,
-b=false,
-c="String",
-d="PartitionResult",
-e="tree",
-f="error",
-g="endpoint",
-h="getAttr",
-i={"required":true,"default":false,"type":"Boolean"},
-j={[u]:"Endpoint"},
-k={[s]:"booleanEquals",[t]:[{[u]:"UseFIPS"},true]},
-l={[s]:"booleanEquals",[t]:[{[u]:"UseDualStack"},true]},
-m={},
-n={[s]:"booleanEquals",[t]:[true,{[s]:h,[t]:[{[u]:d},"supportsFIPS"]}]},
-o={[u]:d},
-p={[s]:"booleanEquals",[t]:[true,{[s]:h,[t]:[o,"supportsDualStack"]}]},
+const s="required",
+t="fn",
+u="argv",
+v="ref";
+const a="isSet",
+b="tree",
+c="error",
+d="endpoint",
+e="PartitionResult",
+f="getAttr",
+g={[s]:false,"type":"String"},
+h={[s]:true,"default":false,"type":"Boolean"},
+i={[v]:"Endpoint"},
+j={[t]:"booleanEquals",[u]:[{[v]:"UseFIPS"},true]},
+k={[t]:"booleanEquals",[u]:[{[v]:"UseDualStack"},true]},
+l={},
+m={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[{[v]:e},"supportsFIPS"]}]},
+n={[v]:e},
+o={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[n,"supportsDualStack"]}]},
+p=[j],
 q=[k],
-r=[l];
-const _data={version:"1.0",parameters:{Region:{required:a,type:c},UseDualStack:i,UseFIPS:i,Endpoint:{required:b,type:c}},rules:[{conditions:[{[s]:"aws.partition",[t]:[{[u]:"Region"}],assign:d}],type:e,rules:[{conditions:[{[s]:"isSet",[t]:[j]}],type:e,rules:[{conditions:q,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:f},{type:e,rules:[{conditions:r,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:f},{endpoint:{url:j,properties:m,headers:m},type:g}]}]},{conditions:[k,l],type:e,rules:[{conditions:[n,p],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://application-autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:g}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:f}]},{conditions:q,type:e,rules:[{conditions:[n],type:e,rules:[{type:e,rules:[{conditions:[{[s]:"stringEquals",[t]:["aws-us-gov",{[s]:h,[t]:[o,"name"]}]}],endpoint:{url:"https://application-autoscaling.{Region}.amazonaws.com",properties:m,headers:m},type:g},{endpoint:{url:"https://application-autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:g}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:f}]},{conditions:r,type:e,rules:[{conditions:[p],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://application-autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:g}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:f}]},{type:e,rules:[{endpoint:{url:"https://application-autoscaling.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:g}]}]}]};
+r=[{[v]:"Region"}];
+const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]}]},{type:b,rules:[{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[m,o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://application-autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:f,[u]:[n,"name"]}]}],endpoint:{url:"https://application-autoscaling.{Region}.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://application-autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://application-autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://application-autoscaling.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
 export const ruleSet: RuleSetObject = _data;
diff --git a/clients/client-application-auto-scaling/src/models/models_0.ts b/clients/client-application-auto-scaling/src/models/models_0.ts
@@ -1065,8 +1065,8 @@ export interface ScalableTarget {
   CreationTime: Date | undefined;
 
   /**
-   * <p>Specifies whether the scaling activities for a scalable target are in a suspended state.
-   *       </p>
+   * <p>Specifies whether the scaling activities for a scalable target are in a suspended
+   *          state.</p>
    */
   SuspendedState?: SuspendedState;
 }
@@ -1960,6 +1960,134 @@ export interface MetricDimension {
   Value: string | undefined;
 }
 
+/**
+ * <p>Describes the dimension of a metric.</p>
+ */
+export interface TargetTrackingMetricDimension {
+  /**
+   * <p>The name of the dimension.</p>
+   */
+  Name: string | undefined;
+
+  /**
+   * <p>The value of the dimension.</p>
+   */
+  Value: string | undefined;
+}
+
+/**
+ * <p>Represents a specific metric.</p>
+ *          <p>Metric is a property of the <a>TargetTrackingMetricStat</a> object.</p>
+ */
+export interface TargetTrackingMetric {
+  /**
+   * <p>The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services
+   *          documentation available from the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon Web Services
+   *             services that publish CloudWatch metrics </a> in the <i>Amazon CloudWatch User
+   *             Guide</i>. </p>
+   *          <p>Conditional: If you published your metric with dimensions, you must specify the same
+   *          dimensions in your scaling policy.</p>
+   */
+  Dimensions?: TargetTrackingMetricDimension[];
+
+  /**
+   * <p>The name of the metric.</p>
+   */
+  MetricName?: string;
+
+  /**
+   * <p>The namespace of the metric. For more information, see the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon Web Services
+   *             services that publish CloudWatch metrics </a> in the <i>Amazon CloudWatch User
+   *             Guide</i>.</p>
+   */
+  Namespace?: string;
+}
+
+/**
+ * <p>This structure defines the CloudWatch metric to return, along with the statistic, period, and
+ *          unit.</p>
+ *          <p>For more information about the CloudWatch terminology below, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html">Amazon CloudWatch
+ *             concepts</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
+ */
+export interface TargetTrackingMetricStat {
+  /**
+   * <p>The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get
+   *          the exact metric name, namespace, and dimensions, inspect the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html">Metric</a> object that is
+   *          returned by a call to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.</p>
+   */
+  Metric: TargetTrackingMetric | undefined;
+
+  /**
+   * <p>The statistic to return. It can include any CloudWatch statistic or extended statistic. For a
+   *          list of valid values, see the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
+   *          <p>The most commonly used metrics for scaling is <code>Average</code>
+   *          </p>
+   */
+  Stat: string | undefined;
+
+  /**
+   * <p>The unit to use for the returned data points. For a complete list of the units that CloudWatch
+   *          supports, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a> data
+   *          type in the <i>Amazon CloudWatch API Reference</i>.</p>
+   */
+  Unit?: string;
+}
+
+/**
+ * <p>The metric data to return. Also defines whether this call is returning data for one
+ *          metric only, or whether it is performing a math expression on the values of returned metric
+ *          statistics to create a new time series. A time series is a series of data points, each of
+ *          which is associated with a timestamp.</p>
+ *          <p>For more information and examples, see <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html">Create a target tracking scaling policy for Application Auto Scaling using metric math</a> in the
+ *          <i>Application Auto Scaling User Guide</i>.</p>
+ */
+export interface TargetTrackingMetricDataQuery {
+  /**
+   * <p>The math expression to perform on the returned data, if this object is performing a math
+   *          expression. This expression can use the <code>Id</code> of the other metrics to refer to
+   *          those metrics, and can also use the <code>Id</code> of other expressions to use the result
+   *          of those expressions. </p>
+   *          <p>Conditional: Within each <code>TargetTrackingMetricDataQuery</code> object, you must
+   *          specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>
+   */
+  Expression?: string;
+
+  /**
+   * <p>A short name that identifies the object's results in the response. This name must be
+   *          unique among all <code>MetricDataQuery</code> objects specified for a single scaling
+   *          policy. If you are performing math expressions on this set of data, this name represents
+   *          that data and can serve as a variable in the mathematical expression. The valid characters
+   *          are letters, numbers, and underscores. The first character must be a lowercase letter.
+   *       </p>
+   */
+  Id: string | undefined;
+
+  /**
+   * <p>A human-readable label for this metric or expression. This is especially useful if this
+   *          is a math expression, so that you know what the value represents.</p>
+   */
+  Label?: string;
+
+  /**
+   * <p>Information about the metric data to return.</p>
+   *          <p>Conditional: Within each <code>MetricDataQuery</code> object, you must specify either
+   *             <code>Expression</code> or <code>MetricStat</code>, but not both.</p>
+   */
+  MetricStat?: TargetTrackingMetricStat;
+
+  /**
+   * <p>Indicates whether to return the timestamps and raw data values of this metric. </p>
+   *          <p>If you use any math expressions, specify <code>true</code> for this value for only the
+   *          final math expression that the metric specification is based on. You must specify
+   *             <code>false</code> for <code>ReturnData</code> for all the other metrics and expressions
+   *          used in the metric specification.</p>
+   *          <p>If you are only retrieving metrics and not performing any math expressions, do not
+   *          specify anything for <code>ReturnData</code>. This sets it to its default
+   *             (<code>true</code>).</p>
+   */
+  ReturnData?: boolean;
+}
+
 export enum MetricStatistic {
   Average = "Average",
   Maximum = "Maximum",
@@ -1989,10 +2117,6 @@ export enum MetricStatistic {
  *                increase when capacity decreases. </p>
  *             </li>
  *          </ul>
- *          <p>For an example of how creating new metrics can be useful, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-using-sqs-queue.html">Scaling
- *             based on Amazon SQS</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. This topic
- *          mentions Auto Scaling groups, but the same scenario for Amazon SQS can apply to the target tracking
- *          scaling policies that you create for a Spot Fleet by using the Application Auto Scaling API.</p>
  *          <p>For more information about the CloudWatch terminology below, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html">Amazon CloudWatch
  *             concepts</a> in the <i>Amazon CloudWatch User Guide</i>. </p>
  */
@@ -2001,12 +2125,12 @@ export interface CustomizedMetricSpecification {
    * <p>The name of the metric. To get the exact metric name, namespace, and dimensions, inspect
    *          the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html">Metric</a> object that is returned by a call to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.</p>
    */
-  MetricName: string | undefined;
+  MetricName?: string;
 
   /**
    * <p>The namespace of the metric.</p>
    */
-  Namespace: string | undefined;
+  Namespace?: string;
 
   /**
    * <p>The dimensions of the metric. </p>
@@ -2018,14 +2142,20 @@ export interface CustomizedMetricSpecification {
   /**
    * <p>The statistic of the metric.</p>
    */
-  Statistic: MetricStatistic | string | undefined;
+  Statistic?: MetricStatistic | string;
 
   /**
    * <p>The unit of the metric. For a complete list of the units that CloudWatch supports, see the
    *             <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a> data
    *          type in the <i>Amazon CloudWatch API Reference</i>.</p>
    */
   Unit?: string;
+
+  /**
+   * <p>The metrics to include in the target tracking scaling policy, as a metric data query.
+   *          This can include both raw metric and metric math expressions.</p>
+   */
+  Metrics?: TargetTrackingMetricDataQuery[];
 }
 
 export enum MetricType {
@@ -3806,6 +3936,34 @@ export const MetricDimensionFilterSensitiveLog = (obj: MetricDimension): any =>
   ...obj,
 });
 
+/**
+ * @internal
+ */
+export const TargetTrackingMetricDimensionFilterSensitiveLog = (obj: TargetTrackingMetricDimension): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const TargetTrackingMetricFilterSensitiveLog = (obj: TargetTrackingMetric): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const TargetTrackingMetricStatFilterSensitiveLog = (obj: TargetTrackingMetricStat): any => ({
+  ...obj,
+});
+
+/**
+ * @internal
+ */
+export const TargetTrackingMetricDataQueryFilterSensitiveLog = (obj: TargetTrackingMetricDataQuery): any => ({
+  ...obj,
+});
+
 /**
  * @internal
  */
diff --git a/clients/client-application-auto-scaling/src/protocols/Aws_json1_1.ts b/clients/client-application-auto-scaling/src/protocols/Aws_json1_1.ts
diff --git a/codegen/sdk-codegen/aws-models/application-auto-scaling.json b/codegen/sdk-codegen/aws-models/application-auto-scaling.json
