lib/aws-sdk-applicationautoscaling/client.rb in aws-sdk-applicationautoscaling-1.6.0 vs lib/aws-sdk-applicationautoscaling/client.rb in aws-sdk-applicationautoscaling-1.7.0

- old
+ new

@@ -475,12 +475,12 @@ def deregister_scalable_target(params = {}, options = {}) req = build_request(:deregister_scalable_target, params) req.send_request(options) end - # Provides descriptive information about the scalable targets in the - # specified namespace. + # Gets information about the scalable targets in the specified + # namespace. # # You can filter the results using the `ResourceIds` and # `ScalableDimension` parameters. # # To create a scalable target or update an existing one, see @@ -557,12 +557,12 @@ # # * `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an # Aurora DB cluster. Available for Aurora MySQL-compatible edition. # # @option params [Integer] :max_results - # The maximum number of scalable target results. This value can be - # between 1 and 50. The default value is 50. + # The maximum number of scalable targets. This value can be between 1 + # and 50. The default value is 50. # # If this parameter is used, the operation returns up to `MaxResults` # results at a time, along with a `NextToken` value. To get the next set # of results, include the `NextToken` value in a subsequent call. If # this parameter is not used, the operation returns up to 50 results and @@ -711,12 +711,12 @@ # # * `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an # Aurora DB cluster. Available for Aurora MySQL-compatible edition. # # @option params [Integer] :max_results - # The maximum number of scalable target results. This value can be - # between 1 and 50. The default value is 50. + # The maximum number of scalable targets. This value can be between 1 + # and 50. The default value is 50. # # If this parameter is used, the operation returns up to `MaxResults` # results at a time, along with a `NextToken` value. To get the next set # of results, include the `NextToken` value in a subsequent call. If # this parameter is not used, the operation returns up to 50 results and @@ -876,12 +876,12 @@ # # * `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an # Aurora DB cluster. Available for Aurora MySQL-compatible edition. # # @option params [Integer] :max_results - # The maximum number of scalable target results. This value can be - # between 1 and 50. The default value is 50. + # The maximum number of scalable targets. This value can be between 1 + # and 50. The default value is 50. # # If this parameter is used, the operation returns up to `MaxResults` # results at a time, along with a `NextToken` value. To get the next set # of results, include the `NextToken` value in a subsequent call. If # this parameter is not used, the operation returns up to 50 results and @@ -963,11 +963,11 @@ # resp.scaling_policies[0].step_scaling_policy_configuration.step_adjustments[0].scaling_adjustment #=> Integer # resp.scaling_policies[0].step_scaling_policy_configuration.min_adjustment_magnitude #=> Integer # resp.scaling_policies[0].step_scaling_policy_configuration.cooldown #=> Integer # resp.scaling_policies[0].step_scaling_policy_configuration.metric_aggregation_type #=> String, one of "Average", "Minimum", "Maximum" # resp.scaling_policies[0].target_tracking_scaling_policy_configuration.target_value #=> Float - # resp.scaling_policies[0].target_tracking_scaling_policy_configuration.predefined_metric_specification.predefined_metric_type #=> String, one of "DynamoDBReadCapacityUtilization", "DynamoDBWriteCapacityUtilization", "ALBRequestCountPerTarget", "RDSReaderAverageCPUUtilization", "RDSReaderAverageDatabaseConnections", "EC2SpotFleetRequestAverageCPUUtilization", "EC2SpotFleetRequestAverageNetworkIn", "EC2SpotFleetRequestAverageNetworkOut" + # resp.scaling_policies[0].target_tracking_scaling_policy_configuration.predefined_metric_specification.predefined_metric_type #=> String, one of "DynamoDBReadCapacityUtilization", "DynamoDBWriteCapacityUtilization", "ALBRequestCountPerTarget", "RDSReaderAverageCPUUtilization", "RDSReaderAverageDatabaseConnections", "EC2SpotFleetRequestAverageCPUUtilization", "EC2SpotFleetRequestAverageNetworkIn", "EC2SpotFleetRequestAverageNetworkOut", "ECSServiceAverageCPUUtilization", "ECSServiceAverageMemoryUtilization" # resp.scaling_policies[0].target_tracking_scaling_policy_configuration.predefined_metric_specification.resource_label #=> String # resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metric_name #=> String # resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.namespace #=> String # resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions #=> Array # resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions[0].name #=> String @@ -1132,11 +1132,11 @@ # target. # # Each scalable target is identified by a service namespace, resource # ID, and scalable dimension. A scaling policy applies to the scalable # target identified by those three attributes. You cannot create a - # scaling policy without first registering a scalable target using + # scaling policy until you register the scalable target using # RegisterScalableTarget. # # To update a policy, specify its policy name and the parameters that # you want to change. Any parameters that you don't specify are not # changed by this update request. @@ -1215,28 +1215,29 @@ # # * `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an # Aurora DB cluster. Available for Aurora MySQL-compatible edition. # # @option params [String] :policy_type - # The policy type. If you are creating a new policy, this parameter is - # required. If you are updating a policy, this parameter is not - # required. + # The policy type. This parameter is required if you are creating a + # policy. # - # For DynamoDB, only `TargetTrackingScaling` is supported. For any other - # service, only `StepScaling` is supported. + # For DynamoDB, only `TargetTrackingScaling` is supported. For Amazon + # ECS, Spot Fleet, and Amazon RDS, both `StepScaling` and + # `TargetTrackingScaling` are supported. For any other service, only + # `StepScaling` is supported. # # @option params [Types::StepScalingPolicyConfiguration] :step_scaling_policy_configuration # A step scaling policy. # # This parameter is required if you are creating a policy and the policy # type is `StepScaling`. # # @option params [Types::TargetTrackingScalingPolicyConfiguration] :target_tracking_scaling_policy_configuration # A target tracking policy. # - # This parameter is required if you are creating a new policy and the - # policy type is `TargetTrackingScaling`. + # This parameter is required if you are creating a policy and the policy + # type is `TargetTrackingScaling`. # # @return [Types::PutScalingPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PutScalingPolicyResponse#policy_arn #policy_arn} => String # * {Types::PutScalingPolicyResponse#alarms #alarms} => Array<Types::Alarm> @@ -1320,11 +1321,11 @@ # metric_aggregation_type: "Average", # accepts Average, Minimum, Maximum # }, # target_tracking_scaling_policy_configuration: { # target_value: 1.0, # required # predefined_metric_specification: { - # predefined_metric_type: "DynamoDBReadCapacityUtilization", # required, accepts DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut + # predefined_metric_type: "DynamoDBReadCapacityUtilization", # required, accepts DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization # resource_label: "ResourceLabel", # }, # customized_metric_specification: { # metric_name: "MetricName", # required # namespace: "MetricNamespace", # required @@ -1363,11 +1364,11 @@ # scalable target. # # Each scalable target is identified by a service namespace, resource # ID, and scalable dimension. A scheduled action applies to the scalable # target identified by those three attributes. You cannot create a - # scheduled action without first registering a scalable target using + # scheduled action until you register the scalable target using # RegisterScalableTarget. # # To update an action, specify its name and the parameters that you want # to change. If you don't specify start and end times, the old values # are deleted. Any other parameters that you don't specify are not @@ -1437,11 +1438,12 @@ # # * Aurora DB cluster - The resource type is `cluster` and the unique # identifier is the cluster name. Example: `cluster:my-db-cluster`. # # @option params [String] :scalable_dimension - # The scalable dimension. This string consists of the service namespace, + # The scalable dimension. This parameter is required if you are creating + # a scheduled action. This string consists of the service namespace, # resource type, and scaling property. # # * `ecs:service:DesiredCount` - The desired task count of an ECS # service. # @@ -1510,17 +1512,17 @@ end # Registers or updates a scalable target. A scalable target is a # resource that Application Auto Scaling can scale out or scale in. # After you have registered a scalable target, you can use this - # operation to update the minimum and maximum values for your scalable + # operation to update the minimum and maximum values for its scalable # dimension. # # After you register a scalable target, you can create and apply scaling # policies using PutScalingPolicy. You can view the scaling policies for - # a service namespace using DescribeScalableTargets. If you are no - # longer using a scalable target, you can deregister it using + # a service namespace using DescribeScalableTargets. If you no longer + # need a scalable target, you can deregister it using # DeregisterScalableTarget. # # @option params [required, String] :service_namespace # The namespace of the AWS service. For more information, see [AWS # Service Namespaces][1] in the *Amazon Web Services General Reference*. @@ -1590,29 +1592,26 @@ # * `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an # Aurora DB cluster. Available for Aurora MySQL-compatible edition. # # @option params [Integer] :min_capacity # The minimum value to scale to in response to a scale in event. This - # parameter is required if you are registering a scalable target and - # optional if you are updating one. + # parameter is required if you are registering a scalable target. # # @option params [Integer] :max_capacity # The maximum value to scale to in response to a scale out event. This - # parameter is required if you are registering a scalable target and - # optional if you are updating one. + # parameter is required if you are registering a scalable target. # # @option params [String] :role_arn - # The ARN of an IAM role that allows Application Auto Scaling to modify - # the scalable target on your behalf. + # Application Auto Scaling creates a service-linked role that grants it + # permissions to modify the scalable target on your behalf. For more + # information, see [Service-Linked Roles for Application Auto + # Scaling][1]. # - # With Amazon RDS resources, permissions are granted using a - # service-linked role. For more information, see [Service-Linked Roles - # for Application Auto Scaling][1]. - # # For resources that are not supported using a service-linked role, this - # parameter is required when you register a scalable target and optional - # when you update one. + # parameter is required and must specify the ARN of an IAM role that + # allows Application Auto Scaling to modify the scalable target on your + # behalf. # # # # [1]: http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/application-autoscaling-service-linked-roles.html # @@ -1682,10 +1681,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-applicationautoscaling' - context[:gem_version] = '1.6.0' + context[:gem_version] = '1.7.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated