lib/aws-sdk-applicationautoscaling/client.rb in aws-sdk-applicationautoscaling-1.63.0 vs lib/aws-sdk-applicationautoscaling/client.rb in aws-sdk-applicationautoscaling-1.64.0
- old
+ new
@@ -505,11 +505,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -699,11 +699,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -877,11 +877,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -1064,11 +1064,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -1186,10 +1186,18 @@
# Provides descriptive information about the scaling activities in the
# specified namespace from the previous six weeks.
#
# You can filter the results using `ResourceId` and `ScalableDimension`.
#
+ # For information about viewing scaling activities using the Amazon Web
+ # Services CLI, see [Scaling activities for Application Auto
+ # Scaling][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html
+ #
# @option params [required, String] :service_namespace
# The namespace of the Amazon Web Services service that provides the
# resource. For a resource provided by your own application or service,
# use `custom-resource` instead.
#
@@ -1297,11 +1305,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -1344,10 +1352,22 @@
# a `NextToken` value, if applicable.
#
# @option params [String] :next_token
# The token for the next set of results.
#
+ # @option params [Boolean] :include_not_scaled_activities
+ # Specifies whether to include activities that aren't scaled (*not
+ # scaled activities*) in the response. Not scaled activities are
+ # activities that aren't completed or started for various reasons, such
+ # as preventing infinite scaling loops. For help interpreting the not
+ # scaled reason details in the response, see [Scaling activities for
+ # Application Auto Scaling][1].
+ #
+ #
+ #
+ # [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html
+ #
# @return [Types::DescribeScalingActivitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeScalingActivitiesResponse#scaling_activities #scaling_activities} => Array<Types::ScalingActivity>
# * {Types::DescribeScalingActivitiesResponse#next_token #next_token} => String
#
@@ -1389,10 +1409,11 @@
# service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb, rds, sagemaker, custom-resource, comprehend, lambda, cassandra, kafka, elasticache, neptune
# resource_id: "ResourceIdMaxLen1600",
# scalable_dimension: "ecs:service:DesiredCount", # 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, elasticache:replication-group:NodeGroups, elasticache:replication-group:Replicas, neptune:cluster:ReadReplicaCount
# max_results: 1,
# next_token: "XmlString",
+ # include_not_scaled_activities: false,
# })
#
# @example Response structure
#
# resp.scaling_activities #=> Array
@@ -1405,10 +1426,15 @@
# resp.scaling_activities[0].start_time #=> Time
# resp.scaling_activities[0].end_time #=> Time
# resp.scaling_activities[0].status_code #=> String, one of "Pending", "InProgress", "Successful", "Overridden", "Unfulfilled", "Failed"
# resp.scaling_activities[0].status_message #=> String
# resp.scaling_activities[0].details #=> String
+ # resp.scaling_activities[0].not_scaled_reasons #=> Array
+ # resp.scaling_activities[0].not_scaled_reasons[0].code #=> String
+ # resp.scaling_activities[0].not_scaled_reasons[0].max_capacity #=> Integer
+ # resp.scaling_activities[0].not_scaled_reasons[0].min_capacity #=> Integer
+ # resp.scaling_activities[0].not_scaled_reasons[0].current_capacity #=> Integer
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalingActivities AWS API Documentation
#
# @overload describe_scaling_activities(params = {})
@@ -1545,11 +1571,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -1824,11 +1850,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -1962,10 +1988,14 @@
# [2]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html
#
# @option params [required, String] :policy_name
# The name of the scaling policy.
#
+ # You cannot change the name of a scaling policy, but you can delete the
+ # original scaling policy and create a new scaling policy with the same
+ # settings and a different name.
+ #
# @option params [required, String] :service_namespace
# The namespace of the Amazon Web Services service that provides the
# resource. For a resource provided by your own application or service,
# use `custom-resource` instead.
#
@@ -2072,11 +2102,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -2107,12 +2137,12 @@
#
# * `neptune:cluster:ReadReplicaCount` - The count of read replicas in
# an Amazon Neptune DB cluster.
#
# @option params [String] :policy_type
- # The policy type. This parameter is required if you are creating a
- # scaling policy.
+ # The scaling policy type. This parameter is required if you are
+ # creating a scaling policy.
#
# The following policy types are supported:
#
# `TargetTrackingScaling`—Not supported for Amazon EMR
#
@@ -2432,11 +2462,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -2507,22 +2537,28 @@
def put_scheduled_action(params = {}, options = {})
req = build_request(:put_scheduled_action, params)
req.send_request(options)
end
- # Registers or updates a scalable target.
+ # Registers or updates a scalable target, the resource that you want to
+ # scale.
#
- # A scalable target is a resource that Application Auto Scaling can
- # scale out and scale in. Scalable targets are uniquely identified by
- # the combination of resource ID, scalable dimension, and namespace.
+ # Scalable targets are uniquely identified by the combination of
+ # resource ID, scalable dimension, and namespace, which represents some
+ # capacity dimension of the underlying service.
#
# When you register a new scalable target, you must specify values for
- # minimum and maximum capacity. Current capacity will be adjusted within
- # the specified range when scaling starts. Application Auto Scaling
- # scaling policies will not scale capacity to values that are outside of
- # this range.
+ # the minimum and maximum capacity. If the specified resource is not
+ # active in the target service, this operation does not change the
+ # resource's current capacity. Otherwise, it changes the resource's
+ # current capacity to a value that is inside of this range.
#
+ # If you choose to add a scaling policy, current capacity is adjustable
+ # within the specified range when scaling starts. Application Auto
+ # Scaling scaling policies will not scale capacity to values that are
+ # outside of the minimum and maximum range.
+ #
# After you register a scalable target, you do not need to register it
# again to use other Application Auto Scaling operations. To see which
# resources have been registered, use [DescribeScalableTargets][1]. You
# can also view the scaling policies for a service namespace by using
# [DescribeScalableTargets][1]. If you no longer need a scalable target,
@@ -2657,11 +2693,11 @@
# * `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 an SageMaker model endpoint variant.
+ # 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` -
@@ -2697,15 +2733,39 @@
# The minimum value that you plan to scale in to. When a scaling policy
# is in effect, Application Auto Scaling can scale in (contract) as
# needed to the minimum capacity limit in response to changing demand.
# This property is required when registering a new scalable target.
#
- # For certain resources, the minimum value allowed is 0. This includes
- # Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB
- # clusters, EMR clusters, and custom resources. For all other resources,
- # the minimum value allowed is 1.
+ # For the following resources, the minimum value allowed is 0.
#
+ # * AppStream 2.0 fleets
+ #
+ # * Aurora DB clusters
+ #
+ # * ECS services
+ #
+ # * EMR clusters
+ #
+ # * Lambda provisioned concurrency
+ #
+ # * SageMaker endpoint variants
+ #
+ # * Spot Fleets
+ #
+ # * custom resources
+ #
+ # It's strongly recommended that you specify a value greater than 0. A
+ # value greater than 0 means that data points are continuously reported
+ # to CloudWatch that scaling policies can use to scale on a metric like
+ # average CPU utilization.
+ #
+ # For all other resources, the minimum allowed value depends on the type
+ # of resource that you are using. If you provide a value that is lower
+ # than what a resource can accept, an error occurs. In which case, the
+ # error message will provide the minimum value that the resource can
+ # accept.
+ #
# @option params [Integer] :max_capacity
# The maximum value that you plan to scale out to. When a scaling policy
# is in effect, Application Auto Scaling can scale out (expand) as
# needed to the maximum capacity limit in response to changing demand.
# This property is required when registering a new scalable target.
@@ -2714,11 +2774,11 @@
# quotas may impose lower limits. Each service has its own default
# quotas for the maximum capacity of the resource. If you want to
# specify a higher limit, you can request an increase. For more
# information, consult the documentation for that service. For
# information about the default quotas for each service, see [Service
- # Endpoints and Quotas][1] in the *Amazon Web Services General
+ # endpoints and quotas][1] in the *Amazon Web Services General
# Reference*.
#
#
#
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html
@@ -2816,10 +2876,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-applicationautoscaling'
- context[:gem_version] = '1.63.0'
+ context[:gem_version] = '1.64.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated