| Column Name | Column Data Type |
|---|
service_namespace Required Input Column
The namespace of the Amazon Web Services service that provides the resource, or a custom-resource. | VARCHAR |
policy_names Input Column
The names of the scaling policies to describe. | VARCHAR[] |
Show child fields- policy_names[]
|
resource_id Input Column
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. -
ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service. -
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. -
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0. -
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet. -
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table. -
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. -
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. -
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE. -
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE. -
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1. -
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable. -
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5. -
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster. -
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster. -
SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering. -
SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component. -
Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456. | VARCHAR |
scalable_dimension Input Column
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. -
ecs:service:DesiredCount - The task count of an ECS service. -
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group. -
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet. -
appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet. -
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. -
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table. -
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index. -
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index. -
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. -
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant. -
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service. -
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint. -
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint. -
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function. -
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table. -
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table. -
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. -
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group. -
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group. -
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster. -
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint. -
sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component. -
workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
alarms
The CloudWatch alarms associated with the scaling policy. | STRUCT(
"alarm_name" VARCHAR,
"alarm_arn" VARCHAR
)[] |
Show child fields- alarms[]
Show child fields- alarms[].alarm_arn
The Amazon Resource Name (ARN) of the alarm. - alarms[].alarm_name
The name of the alarm.
|
creation_time
The Unix timestamp for when the scaling policy was created. | TIMESTAMP_S |
policy_arn
The Amazon Resource Name (ARN) of the scaling policy. | VARCHAR |
policy_name
The name of the scaling policy. | VARCHAR |
policy_type
The scaling policy type. The following policy types are supported: TargetTrackingScaling—Not supported for Amazon EMR StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. | VARCHAR |
step_scaling_policy_configuration
A step scaling policy. | STRUCT(
"adjustment_type" VARCHAR,
"step_adjustments" STRUCT(
"metric_interval_lower_bound" DOUBLE,
"metric_interval_upper_bound" DOUBLE,
"scaling_adjustment" BIGINT
)[],
"min_adjustment_magnitude" BIGINT,
"cooldown" BIGINT,
"metric_aggregation_type" VARCHAR
) |
Show child fields- step_scaling_policy_configuration.adjustment_type
Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. AdjustmentType is required if you are adding a new step scaling policy configuration. - step_scaling_policy_configuration.cooldown
The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide. - step_scaling_policy_configuration.metric_aggregation_type
The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. - step_scaling_policy_configuration.min_adjustment_magnitude
The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks. - step_scaling_policy_configuration.step_adjustments[]
Show child fields- step_scaling_policy_configuration.step_adjustments[].metric_interval_lower_bound
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it's exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. - step_scaling_policy_configuration.step_adjustments[].metric_interval_upper_bound
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound. - step_scaling_policy_configuration.step_adjustments[].scaling_adjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.
|
target_tracking_scaling_policy_configuration
A target tracking scaling policy. | STRUCT(
"target_value" DOUBLE,
"predefined_metric_specification" STRUCT(
"predefined_metric_type" VARCHAR,
"resource_label" VARCHAR
),
"customized_metric_specification" STRUCT(
"metric_name" VARCHAR,
"namespace" VARCHAR,
"dimensions" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[],
"statistic" VARCHAR,
"unit" VARCHAR,
"metrics" STRUCT(
"expression" VARCHAR,
"id" VARCHAR,
"label" VARCHAR,
"metric_stat" STRUCT(
"metric" STRUCT(
"dimensions" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[],
"metric_name" VARCHAR,
"namespace" VARCHAR
),
"stat" VARCHAR,
"unit" VARCHAR
),
"return_data" BOOLEAN
)[]
),
"scale_out_cooldown" BIGINT,
"scale_in_cooldown" BIGINT,
"disable_scale_in" BOOLEAN
) |
Show child fields- target_tracking_scaling_policy_configuration.customized_metric_specification
A customized metric. You can specify either a predefined metric or a customized metric. Show child fields- target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions[]
Show child fields- target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions[].name
The name of the dimension. - target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions[].value
The value of the dimension.
- target_tracking_scaling_policy_configuration.customized_metric_specification.metric_name
The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics. - target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[]
Show child fields- target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].expression
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. - target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].id
A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery 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. - target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].label
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. - target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat
Information about the metric data to return. Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both. Show child fields- target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat.metric
The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics. Show child fields- target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat.metric.dimensions[]
Show child fields- target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat.metric.dimensions[].name
The name of the dimension. - target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat.metric.dimensions[].value
The value of the dimension.
- target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat.metric.metric_name
The name of the metric. - target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat.metric.namespace
The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
- target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat.stat
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average. - target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].metric_stat.unit
The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
- target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[].return_data
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).
- target_tracking_scaling_policy_configuration.customized_metric_specification.namespace
The namespace of the metric. - target_tracking_scaling_policy_configuration.customized_metric_specification.statistic
The statistic of the metric. - target_tracking_scaling_policy_configuration.customized_metric_specification.unit
The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
- target_tracking_scaling_policy_configuration.disable_scale_in
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false. - target_tracking_scaling_policy_configuration.predefined_metric_specification
A predefined metric. You can specify either a predefined metric or a customized metric. Show child fields- target_tracking_scaling_policy_configuration.predefined_metric_specification.predefined_metric_type
The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services. - target_tracking_scaling_policy_configuration.predefined_metric_specification.resource_label
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where: To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
- target_tracking_scaling_policy_configuration.scale_in_cooldown
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide. - target_tracking_scaling_policy_configuration.scale_out_cooldown
The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide. - target_tracking_scaling_policy_configuration.target_value
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.
|