lib/aws-sdk-applicationautoscaling/client.rb in aws-sdk-applicationautoscaling-1.49.0 vs lib/aws-sdk-applicationautoscaling/client.rb in aws-sdk-applicationautoscaling-1.50.0
- old
+ new
@@ -342,12 +342,12 @@
#
# Deleting a step scaling policy deletes the underlying alarm action,
# but does not delete the CloudWatch alarm associated with the scaling
# policy, even if it no longer has an associated action.
#
- # For more information, see [Delete a Step Scaling Policy][1] and
- # [Delete a Target Tracking Scaling Policy][2] in the *Application Auto
+ # For more information, see [Delete a step scaling policy][1] and
+ # [Delete a target tracking scaling policy][2] in the *Application Auto
# Scaling User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html#delete-step-scaling-policy
@@ -522,16 +522,16 @@
end
# Deletes the specified scheduled action for an Application Auto Scaling
# scalable target.
#
- # For more information, see [Delete a Scheduled Action][1] in the
+ # For more information, see [Delete a scheduled action][1] in the
# *Application Auto Scaling User Guide*.
#
#
#
- # [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html#delete-scheduled-action
+ # [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html#delete-scheduled-action
#
# @option params [required, String] :service_namespace
# The namespace of the AWS service that provides the resource. For a
# resource provided by your own application or service, use
# `custom-resource` instead.
@@ -870,12 +870,11 @@
# resource provided by your own application or service, use
# `custom-resource` instead.
#
# @option params [Array<String>] :resource_ids
# The identifier of the resource associated with the scalable target.
- # This string consists of the resource type and unique identifier. If
- # you specify a scalable dimension, you must also specify a resource ID.
+ # 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/default/sample-webapp`.
#
@@ -1089,12 +1088,11 @@
# resource provided by your own application or service, use
# `custom-resource` instead.
#
# @option params [String] :resource_id
# The identifier of the resource associated with the scaling activity.
- # This string consists of the resource type and unique identifier. If
- # you specify a scalable dimension, you must also specify a resource ID.
+ # 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/default/sample-webapp`.
#
@@ -1303,12 +1301,12 @@
# specified service namespace.
#
# You can filter the results using `ResourceId`, `ScalableDimension`,
# and `PolicyNames`.
#
- # For more information, see [Target Tracking Scaling Policies][1] and
- # [Step Scaling Policies][2] in the *Application Auto Scaling User
+ # For more information, see [Target tracking scaling policies][1] and
+ # [Step scaling policies][2] in the *Application Auto Scaling User
# Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html
@@ -1322,12 +1320,11 @@
# resource provided by your own application or service, use
# `custom-resource` instead.
#
# @option params [String] :resource_id
# The identifier of the resource associated with the scaling policy.
- # This string consists of the resource type and unique identifier. If
- # you specify a scalable dimension, you must also specify a resource ID.
+ # 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/default/sample-webapp`.
#
@@ -1568,16 +1565,17 @@
# specified service namespace.
#
# You can filter the results using the `ResourceId`,
# `ScalableDimension`, and `ScheduledActionNames` parameters.
#
- # For more information, see [Scheduled Scaling][1] in the *Application
- # Auto Scaling User Guide*.
+ # For more information, see [Scheduled scaling][1] and [Managing
+ # scheduled scaling][2] in the *Application Auto Scaling User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html
+ # [2]: https://docs.aws.amazon.com/autoscaling/application/userguide/scheduled-scaling-additional-cli-commands.html
#
# @option params [Array<String>] :scheduled_action_names
# The names of the scheduled actions to describe.
#
# @option params [required, String] :service_namespace
@@ -1585,12 +1583,11 @@
# resource provided by your own application or service, use
# `custom-resource` instead.
#
# @option params [String] :resource_id
# The identifier of the resource associated with the scheduled action.
- # This string consists of the resource type and unique identifier. If
- # you specify a scalable dimension, you must also specify a resource ID.
+ # 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/default/sample-webapp`.
#
@@ -1746,10 +1743,11 @@
# resp.scheduled_actions #=> Array
# resp.scheduled_actions[0].scheduled_action_name #=> String
# resp.scheduled_actions[0].scheduled_action_arn #=> String
# resp.scheduled_actions[0].service_namespace #=> String, one of "ecs", "elasticmapreduce", "ec2", "appstream", "dynamodb", "rds", "sagemaker", "custom-resource", "comprehend", "lambda", "cassandra", "kafka"
# resp.scheduled_actions[0].schedule #=> String
+ # resp.scheduled_actions[0].timezone #=> String
# resp.scheduled_actions[0].resource_id #=> String
# resp.scheduled_actions[0].scalable_dimension #=> String, one of "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "elasticmapreduce:instancegroup:InstanceCount", "appstream:fleet:DesiredCapacity", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits", "rds:cluster:ReadReplicaCount", "sagemaker:variant:DesiredInstanceCount", "custom-resource:ResourceType:Property", "comprehend:document-classifier-endpoint:DesiredInferenceUnits", "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits", "lambda:function:ProvisionedConcurrency", "cassandra:table:ReadCapacityUnits", "cassandra:table:WriteCapacityUnits", "kafka:broker-storage:VolumeSize"
# resp.scheduled_actions[0].start_time #=> Time
# resp.scheduled_actions[0].end_time #=> Time
# resp.scheduled_actions[0].scalable_target_action.min_capacity #=> Integer
@@ -1793,12 +1791,12 @@
# scaling policy initiates a scale-in activity before the target
# tracking policy is ready to scale in, the scale-in activity will not
# be blocked. After the scale-in activity completes, the target tracking
# policy could instruct the scalable target to scale out again.
#
- # For more information, see [Target Tracking Scaling Policies][1] and
- # [Step Scaling Policies][2] in the *Application Auto Scaling User
+ # For more information, see [Target tracking scaling policies][1] and
+ # [Step scaling policies][2] in the *Application Auto Scaling User
# Guide*.
#
# <note markdown="1"> If a scalable target is deregistered, the scalable target is no longer
# available to execute scaling policies. Any scaling policies that were
# specified for the scalable target are deleted.
@@ -1950,12 +1948,12 @@
# `TargetTrackingScaling`—Not supported for Amazon EMR
#
# `StepScaling`—Not supported for DynamoDB, Amazon Comprehend, Lambda,
# Amazon Keyspaces (for Apache Cassandra), or Amazon MSK.
#
- # For more information, see [Target Tracking Scaling Policies][1] and
- # [Step Scaling Policies][2] in the *Application Auto Scaling User
+ # For more information, see [Target tracking scaling policies][1] and
+ # [Step scaling policies][2] in the *Application Auto Scaling User
# Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html
@@ -2086,18 +2084,18 @@
# target identified by those three attributes. You cannot create a
# scheduled action until you have registered the resource as a scalable
# target.
#
# When start and end times are specified with a recurring schedule using
- # a cron expression or rates, they form the boundaries of when the
+ # a cron expression or rates, they form the boundaries for when the
# recurring action starts and stops.
#
# To update a scheduled action, specify the parameters that you want to
# change. If you don't specify start and end times, the old values are
# deleted.
#
- # For more information, see [Scheduled Scaling][1] in the *Application
+ # For more information, see [Scheduled scaling][1] in the *Application
# Auto Scaling User Guide*.
#
# <note markdown="1"> If a scalable target is deregistered, the scalable target is no longer
# available to run scheduled actions. Any scheduled actions that were
# specified for the scalable target are deleted.
@@ -2120,28 +2118,46 @@
#
# * Rate expressions - "`rate(value unit)`"
#
# * Cron expressions - "`cron(fields)`"
#
- # At expressions are useful for one-time schedules. Specify the time in
- # UTC.
+ # At expressions are useful for one-time schedules. Cron expressions are
+ # useful for scheduled actions that run periodically at a specified date
+ # and time, and rate expressions are useful for scheduled actions that
+ # run at a regular interval.
#
- # For rate expressions, *value* is a positive integer and *unit* is
- # `minute` \| `minutes` \| `hour` \| `hours` \| `day` \| `days`.
+ # At and cron expressions use Universal Coordinated Time (UTC) by
+ # default.
#
- # For cron expressions, *fields* is a cron expression. The supported
- # cron format consists of six fields separated by white spaces:
+ # The cron format consists of six fields separated by white spaces:
# \[Minutes\] \[Hours\] \[Day\_of\_Month\] \[Month\] \[Day\_of\_Week\]
# \[Year\].
#
- # For more information and examples, see [Scheduled Scaling][1] in the
- # *Application Auto Scaling User Guide*.
+ # For rate expressions, *value* is a positive integer and *unit* is
+ # `minute` \| `minutes` \| `hour` \| `hours` \| `day` \| `days`.
#
+ # For more information and examples, see [Example scheduled actions for
+ # Application Auto Scaling][1] in the *Application Auto Scaling User
+ # Guide*.
#
#
- # [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html
#
+ # [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html
+ #
+ # @option params [String] :timezone
+ # Specifies the time zone used when setting a scheduled action by using
+ # an at or cron expression. If a time zone is not provided, UTC is used
+ # by default.
+ #
+ # Valid values are the canonical names of the IANA time zones supported
+ # by Joda-Time (such as `Etc/GMT+9` or `Pacific/Tahiti`). For more
+ # information, see [https://www.joda.org/joda-time/timezones.html][1].
+ #
+ #
+ #
+ # [1]: https://www.joda.org/joda-time/timezones.html
+ #
# @option params [required, String] :scheduled_action_name
# The name of the scheduled action. This name must be unique among all
# other scheduled actions on the specified scalable target.
#
# @option params [required, String] :resource_id
@@ -2266,14 +2282,14 @@
#
# * `kafka:broker-storage:VolumeSize` - The provisioned volume size (in
# GiB) for brokers in an Amazon MSK cluster.
#
# @option params [Time,DateTime,Date,Integer,String] :start_time
- # The date and time for this scheduled action to start.
+ # The date and time for this scheduled action to start, in UTC.
#
# @option params [Time,DateTime,Date,Integer,String] :end_time
- # The date and time for the recurring schedule to end.
+ # The date and time for the recurring schedule to end, in UTC.
#
# @option params [Types::ScalableTargetAction] :scalable_target_action
# The new minimum and maximum capacity. You can set both values or just
# one. At the scheduled time, if the current capacity is below the
# minimum capacity, Application Auto Scaling scales out to the minimum
@@ -2285,10 +2301,11 @@
# @example Request syntax with placeholder values
#
# resp = client.put_scheduled_action({
# service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb, rds, sagemaker, custom-resource, comprehend, lambda, cassandra, kafka
# schedule: "ResourceIdMaxLen1600",
+ # timezone: "ResourceIdMaxLen1600",
# scheduled_action_name: "ScheduledActionName", # required
# resource_id: "ResourceIdMaxLen1600", # required
# scalable_dimension: "ecs:service:DesiredCount", # required, accepts ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, elasticmapreduce:instancegroup:InstanceCount, appstream:fleet:DesiredCapacity, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits, rds:cluster:ReadReplicaCount, sagemaker:variant:DesiredInstanceCount, custom-resource:ResourceType:Property, comprehend:document-classifier-endpoint:DesiredInferenceUnits, comprehend:entity-recognizer-endpoint:DesiredInferenceUnits, lambda:function:ProvisionedConcurrency, cassandra:table:ReadCapacityUnits, cassandra:table:WriteCapacityUnits, kafka:broker-storage:VolumeSize
# start_time: Time.now,
# end_time: Time.now,
@@ -2502,11 +2519,11 @@
# of an IAM role that allows Application Auto Scaling to modify the
# scalable target on your behalf.
#
# If the service supports service-linked roles, Application Auto Scaling
# uses a service-linked role, which it creates if it does not yet exist.
- # For more information, see [Application Auto Scaling IAM Roles][1].
+ # For more information, see [Application Auto Scaling IAM roles][1].
#
#
#
# [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles
#
@@ -2528,11 +2545,11 @@
# suspended.
#
# * For `ScheduledScalingSuspended`, while a suspension is in effect,
# all scaling activities that involve scheduled actions are suspended.
#
- # For more information, see [Suspending and Resuming Scaling][1] in the
+ # For more information, see [Suspending and resuming scaling][1] in the
# *Application Auto Scaling User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html
@@ -2589,10 +2606,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-applicationautoscaling'
- context[:gem_version] = '1.49.0'
+ context[:gem_version] = '1.50.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated