AWSAutoScalingTargetTrackingMetricDataQuery

Objective-C

@interface AWSAutoScalingTargetTrackingMetricDataQuery

Swift

class AWSAutoScalingTargetTrackingMetricDataQuery

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.

Required parameters: [Id]

  • The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable expression;

    Swift

    var expression: String? { get set }

  • A short name that identifies the object’s results in the response. This name must be unique among all TargetTrackingMetricDataQuery 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable identifier;

    Swift

    var identifier: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable label;

    Swift

    var label: String? { get set }

  • Information about the metric data to return.

    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingTargetTrackingMetricStat *_Nullable metricStat;

    Swift

    var metricStat: AWSAutoScalingTargetTrackingMetricStat? { get set }

  • Indicates whether to return the timestamps and raw data values of this metric.

    If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable returnData;

    Swift

    var returnData: NSNumber? { get set }