aws-sdk-applicationautoscaling 1.66.0 → 1.68.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-applicationautoscaling/client.rb +369 -21
- data/lib/aws-sdk-applicationautoscaling/client_api.rb +121 -3
- data/lib/aws-sdk-applicationautoscaling/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-applicationautoscaling/endpoint_provider.rb +29 -26
- data/lib/aws-sdk-applicationautoscaling/endpoints.rb +42 -0
- data/lib/aws-sdk-applicationautoscaling/errors.rb +42 -0
- data/lib/aws-sdk-applicationautoscaling/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-applicationautoscaling/types.rb +383 -25
- data/lib/aws-sdk-applicationautoscaling.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c8596d9d0cc5b32b0cd913a0afb1a0cdd86e692e43967bc29dd1351c84771c6c
|
4
|
+
data.tar.gz: 4d6715a47d97be3a2af03327a8867da963a83793d29e79f8764193f30f50e5e0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c1182016a7e7995b0d7f467e76837d7fc648ffd07307647505e998701f0aed47027f48619224a4667b4029f7605ecab0ac37859ad5c76e77218e6b0eb2982ab9
|
7
|
+
data.tar.gz: 7c0a18ba0d33f564e71b8f620dde95388405a424b3939425cb409555d462747c74d5a795fd2aa5f70325c8bc316d3b26cb98e27cc77e805d4f21720714a2b734
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.68.0 (2023-03-20)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - With this release customers can now tag their Application Auto Scaling registered targets with key-value pairs and manage IAM permissions for all the tagged resources centrally.
|
8
|
+
|
9
|
+
1.67.0 (2023-03-14)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Application Auto Scaling customers can now use mathematical functions to customize the metric used with Target Tracking policies within the policy configuration itself, saving the cost and effort of publishing the customizations as a separate metric.
|
13
|
+
|
4
14
|
1.66.0 (2023-01-27)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.68.0
|
@@ -737,6 +737,22 @@ module Aws::ApplicationAutoScaling
|
|
737
737
|
#
|
738
738
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
739
739
|
#
|
740
|
+
#
|
741
|
+
# @example Example: To delete a scheduled action
|
742
|
+
#
|
743
|
+
# # This example deletes a scheduled action for the AppStream 2.0 fleet called sample-fleet.
|
744
|
+
#
|
745
|
+
# resp = client.delete_scheduled_action({
|
746
|
+
# resource_id: "fleet/sample-fleet",
|
747
|
+
# scalable_dimension: "appstream:fleet:DesiredCapacity",
|
748
|
+
# scheduled_action_name: "my-recurring-action",
|
749
|
+
# service_namespace: "appstream",
|
750
|
+
# })
|
751
|
+
#
|
752
|
+
# resp.to_h outputs the following:
|
753
|
+
# {
|
754
|
+
# }
|
755
|
+
#
|
740
756
|
# @example Request syntax with placeholder values
|
741
757
|
#
|
742
758
|
# resp = client.delete_scheduled_action({
|
@@ -1172,6 +1188,7 @@ module Aws::ApplicationAutoScaling
|
|
1172
1188
|
# resp.scalable_targets[0].suspended_state.dynamic_scaling_in_suspended #=> Boolean
|
1173
1189
|
# resp.scalable_targets[0].suspended_state.dynamic_scaling_out_suspended #=> Boolean
|
1174
1190
|
# resp.scalable_targets[0].suspended_state.scheduled_scaling_suspended #=> Boolean
|
1191
|
+
# resp.scalable_targets[0].scalable_target_arn #=> String
|
1175
1192
|
# resp.next_token #=> String
|
1176
1193
|
#
|
1177
1194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/DescribeScalableTargets AWS API Documentation
|
@@ -1706,6 +1723,18 @@ module Aws::ApplicationAutoScaling
|
|
1706
1723
|
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions[0].value #=> String
|
1707
1724
|
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.statistic #=> String, one of "Average", "Minimum", "Maximum", "SampleCount", "Sum"
|
1708
1725
|
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.unit #=> String
|
1726
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics #=> Array
|
1727
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].expression #=> String
|
1728
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].id #=> String
|
1729
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].label #=> String
|
1730
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].metric_stat.metric.dimensions #=> Array
|
1731
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].metric_stat.metric.dimensions[0].name #=> String
|
1732
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].metric_stat.metric.dimensions[0].value #=> String
|
1733
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].metric_stat.metric.metric_name #=> String
|
1734
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].metric_stat.metric.namespace #=> String
|
1735
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].metric_stat.stat #=> String
|
1736
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].metric_stat.unit #=> String
|
1737
|
+
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.customized_metric_specification.metrics[0].return_data #=> Boolean
|
1709
1738
|
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_out_cooldown #=> Integer
|
1710
1739
|
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.scale_in_cooldown #=> Integer
|
1711
1740
|
# resp.scaling_policies[0].target_tracking_scaling_policy_configuration.disable_scale_in #=> Boolean
|
@@ -1906,6 +1935,47 @@ module Aws::ApplicationAutoScaling
|
|
1906
1935
|
#
|
1907
1936
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1908
1937
|
#
|
1938
|
+
#
|
1939
|
+
# @example Example: To describe scheduled actions
|
1940
|
+
#
|
1941
|
+
# # This example describes the scheduled actions for the dynamodb service namespace.
|
1942
|
+
#
|
1943
|
+
# resp = client.describe_scheduled_actions({
|
1944
|
+
# service_namespace: "dynamodb",
|
1945
|
+
# })
|
1946
|
+
#
|
1947
|
+
# resp.to_h outputs the following:
|
1948
|
+
# {
|
1949
|
+
# scheduled_actions: [
|
1950
|
+
# {
|
1951
|
+
# creation_time: Time.parse(1561571888.361),
|
1952
|
+
# resource_id: "table/my-table",
|
1953
|
+
# scalable_dimension: "dynamodb:table:WriteCapacityUnits",
|
1954
|
+
# scalable_target_action: {
|
1955
|
+
# max_capacity: 20,
|
1956
|
+
# min_capacity: 15,
|
1957
|
+
# },
|
1958
|
+
# schedule: "at(2019-05-20T18:35:00)",
|
1959
|
+
# scheduled_action_arn: "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action",
|
1960
|
+
# scheduled_action_name: "my-first-scheduled-action",
|
1961
|
+
# service_namespace: "dynamodb",
|
1962
|
+
# },
|
1963
|
+
# {
|
1964
|
+
# creation_time: Time.parse(1561571946.021),
|
1965
|
+
# resource_id: "table/my-table",
|
1966
|
+
# scalable_dimension: "dynamodb:table:WriteCapacityUnits",
|
1967
|
+
# scalable_target_action: {
|
1968
|
+
# max_capacity: 10,
|
1969
|
+
# min_capacity: 5,
|
1970
|
+
# },
|
1971
|
+
# schedule: "at(2019-05-20T18:40:00)",
|
1972
|
+
# scheduled_action_arn: "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action",
|
1973
|
+
# scheduled_action_name: "my-second-scheduled-action",
|
1974
|
+
# service_namespace: "dynamodb",
|
1975
|
+
# },
|
1976
|
+
# ],
|
1977
|
+
# }
|
1978
|
+
#
|
1909
1979
|
# @example Request syntax with placeholder values
|
1910
1980
|
#
|
1911
1981
|
# resp = client.describe_scheduled_actions({
|
@@ -1943,6 +2013,65 @@ module Aws::ApplicationAutoScaling
|
|
1943
2013
|
req.send_request(options)
|
1944
2014
|
end
|
1945
2015
|
|
2016
|
+
# Returns all the tags on the specified Application Auto Scaling
|
2017
|
+
# scalable target.
|
2018
|
+
#
|
2019
|
+
# For general information about tags, including the format and syntax,
|
2020
|
+
# see [Tagging Amazon Web Services resources][1] in the *Amazon Web
|
2021
|
+
# Services General Reference*.
|
2022
|
+
#
|
2023
|
+
#
|
2024
|
+
#
|
2025
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
2026
|
+
#
|
2027
|
+
# @option params [required, String] :resource_arn
|
2028
|
+
# Specify the ARN of the scalable target.
|
2029
|
+
#
|
2030
|
+
# For example:
|
2031
|
+
# `arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123`
|
2032
|
+
#
|
2033
|
+
# To get the ARN for a scalable target, use DescribeScalableTargets.
|
2034
|
+
#
|
2035
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2036
|
+
#
|
2037
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
2038
|
+
#
|
2039
|
+
#
|
2040
|
+
# @example Example: To list tags for a scalable target
|
2041
|
+
#
|
2042
|
+
# # This example lists the tag key names and values that are attached to the scalable target specified by its ARN.
|
2043
|
+
#
|
2044
|
+
# resp = client.list_tags_for_resource({
|
2045
|
+
# resource_arn: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123",
|
2046
|
+
# })
|
2047
|
+
#
|
2048
|
+
# resp.to_h outputs the following:
|
2049
|
+
# {
|
2050
|
+
# tags: {
|
2051
|
+
# "environment" => "production",
|
2052
|
+
# },
|
2053
|
+
# }
|
2054
|
+
#
|
2055
|
+
# @example Request syntax with placeholder values
|
2056
|
+
#
|
2057
|
+
# resp = client.list_tags_for_resource({
|
2058
|
+
# resource_arn: "AmazonResourceName", # required
|
2059
|
+
# })
|
2060
|
+
#
|
2061
|
+
# @example Response structure
|
2062
|
+
#
|
2063
|
+
# resp.tags #=> Hash
|
2064
|
+
# resp.tags["TagKey"] #=> String
|
2065
|
+
#
|
2066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/ListTagsForResource AWS API Documentation
|
2067
|
+
#
|
2068
|
+
# @overload list_tags_for_resource(params = {})
|
2069
|
+
# @param [Hash] params ({})
|
2070
|
+
def list_tags_for_resource(params = {}, options = {})
|
2071
|
+
req = build_request(:list_tags_for_resource, params)
|
2072
|
+
req.send_request(options)
|
2073
|
+
end
|
2074
|
+
|
1946
2075
|
# Creates or updates a scaling policy for an Application Auto Scaling
|
1947
2076
|
# scalable target.
|
1948
2077
|
#
|
@@ -1977,7 +2106,7 @@ module Aws::ApplicationAutoScaling
|
|
1977
2106
|
# Guide*.
|
1978
2107
|
#
|
1979
2108
|
# <note markdown="1"> If a scalable target is deregistered, the scalable target is no longer
|
1980
|
-
# available to
|
2109
|
+
# available to use scaling policies. Any scaling policies that were
|
1981
2110
|
# specified for the scalable target are deleted.
|
1982
2111
|
#
|
1983
2112
|
# </note>
|
@@ -2242,16 +2371,38 @@ module Aws::ApplicationAutoScaling
|
|
2242
2371
|
# resource_label: "ResourceLabel",
|
2243
2372
|
# },
|
2244
2373
|
# customized_metric_specification: {
|
2245
|
-
# metric_name: "MetricName",
|
2246
|
-
# namespace: "MetricNamespace",
|
2374
|
+
# metric_name: "MetricName",
|
2375
|
+
# namespace: "MetricNamespace",
|
2247
2376
|
# dimensions: [
|
2248
2377
|
# {
|
2249
2378
|
# name: "MetricDimensionName", # required
|
2250
2379
|
# value: "MetricDimensionValue", # required
|
2251
2380
|
# },
|
2252
2381
|
# ],
|
2253
|
-
# statistic: "Average", #
|
2382
|
+
# statistic: "Average", # accepts Average, Minimum, Maximum, SampleCount, Sum
|
2254
2383
|
# unit: "MetricUnit",
|
2384
|
+
# metrics: [
|
2385
|
+
# {
|
2386
|
+
# expression: "Expression",
|
2387
|
+
# id: "Id", # required
|
2388
|
+
# label: "XmlString",
|
2389
|
+
# metric_stat: {
|
2390
|
+
# metric: { # required
|
2391
|
+
# dimensions: [
|
2392
|
+
# {
|
2393
|
+
# name: "TargetTrackingMetricDimensionName", # required
|
2394
|
+
# value: "TargetTrackingMetricDimensionValue", # required
|
2395
|
+
# },
|
2396
|
+
# ],
|
2397
|
+
# metric_name: "TargetTrackingMetricName",
|
2398
|
+
# namespace: "TargetTrackingMetricNamespace",
|
2399
|
+
# },
|
2400
|
+
# stat: "XmlString", # required
|
2401
|
+
# unit: "TargetTrackingMetricUnit",
|
2402
|
+
# },
|
2403
|
+
# return_data: false,
|
2404
|
+
# },
|
2405
|
+
# ],
|
2255
2406
|
# },
|
2256
2407
|
# scale_out_cooldown: 1,
|
2257
2408
|
# scale_in_cooldown: 1,
|
@@ -2284,8 +2435,8 @@ module Aws::ApplicationAutoScaling
|
|
2284
2435
|
# scheduled action until you have registered the resource as a scalable
|
2285
2436
|
# target.
|
2286
2437
|
#
|
2287
|
-
# When start and end times
|
2288
|
-
#
|
2438
|
+
# When you specify start and end times with a recurring schedule using a
|
2439
|
+
# cron expression or rates, they form the boundaries for when the
|
2289
2440
|
# recurring action starts and stops.
|
2290
2441
|
#
|
2291
2442
|
# To update a scheduled action, specify the parameters that you want to
|
@@ -2513,6 +2664,28 @@ module Aws::ApplicationAutoScaling
|
|
2513
2664
|
#
|
2514
2665
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2515
2666
|
#
|
2667
|
+
#
|
2668
|
+
# @example Example: To create a recurring scheduled action
|
2669
|
+
#
|
2670
|
+
# # This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the
|
2671
|
+
# # specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity,
|
2672
|
+
# # Application Auto Scaling scales out to the value specified by MinCapacity.
|
2673
|
+
#
|
2674
|
+
# resp = client.put_scheduled_action({
|
2675
|
+
# resource_id: "table/TestTable",
|
2676
|
+
# scalable_dimension: "dynamodb:table:WriteCapacityUnits",
|
2677
|
+
# scalable_target_action: {
|
2678
|
+
# min_capacity: 6,
|
2679
|
+
# },
|
2680
|
+
# schedule: "cron(15 12 * * ? *)",
|
2681
|
+
# scheduled_action_name: "my-recurring-action",
|
2682
|
+
# service_namespace: "dynamodb",
|
2683
|
+
# })
|
2684
|
+
#
|
2685
|
+
# resp.to_h outputs the following:
|
2686
|
+
# {
|
2687
|
+
# }
|
2688
|
+
#
|
2516
2689
|
# @example Request syntax with placeholder values
|
2517
2690
|
#
|
2518
2691
|
# resp = client.put_scheduled_action({
|
@@ -2539,8 +2712,8 @@ module Aws::ApplicationAutoScaling
|
|
2539
2712
|
req.send_request(options)
|
2540
2713
|
end
|
2541
2714
|
|
2542
|
-
# Registers or updates a scalable target, the resource that you
|
2543
|
-
# scale.
|
2715
|
+
# Registers or updates a scalable target, which is the resource that you
|
2716
|
+
# want to scale.
|
2544
2717
|
#
|
2545
2718
|
# Scalable targets are uniquely identified by the combination of
|
2546
2719
|
# resource ID, scalable dimension, and namespace, which represents some
|
@@ -2552,10 +2725,10 @@ module Aws::ApplicationAutoScaling
|
|
2552
2725
|
# resource's current capacity. Otherwise, it changes the resource's
|
2553
2726
|
# current capacity to a value that is inside of this range.
|
2554
2727
|
#
|
2555
|
-
# If you
|
2556
|
-
#
|
2557
|
-
#
|
2558
|
-
#
|
2728
|
+
# If you add a scaling policy, current capacity is adjustable within the
|
2729
|
+
# specified range when scaling starts. Application Auto Scaling scaling
|
2730
|
+
# policies will not scale capacity to values that are outside of the
|
2731
|
+
# minimum and maximum range.
|
2559
2732
|
#
|
2560
2733
|
# After you register a scalable target, you do not need to register it
|
2561
2734
|
# again to use other Application Auto Scaling operations. To see which
|
@@ -2569,12 +2742,20 @@ module Aws::ApplicationAutoScaling
|
|
2569
2742
|
# resource ID, scalable dimension, and namespace. Any parameters that
|
2570
2743
|
# you don't specify are not changed by this update request.
|
2571
2744
|
#
|
2572
|
-
# <note markdown="1"> If you call the `RegisterScalableTarget` API to
|
2573
|
-
# scalable target,
|
2574
|
-
#
|
2575
|
-
#
|
2576
|
-
#
|
2577
|
-
#
|
2745
|
+
# <note markdown="1"> If you call the `RegisterScalableTarget` API operation to create a
|
2746
|
+
# scalable target, there might be a brief delay until the operation
|
2747
|
+
# achieves [eventual consistency][3]. You might become aware of this
|
2748
|
+
# brief delay if you get unexpected errors when performing sequential
|
2749
|
+
# operations. The typical strategy is to retry the request, and some
|
2750
|
+
# Amazon Web Services SDKs include automatic backoff and retry logic.
|
2751
|
+
#
|
2752
|
+
# If you call the `RegisterScalableTarget` API operation to update an
|
2753
|
+
# existing scalable target, Application Auto Scaling retrieves the
|
2754
|
+
# current capacity of the resource. If it's below the minimum capacity
|
2755
|
+
# or above the maximum capacity, Application Auto Scaling adjusts the
|
2756
|
+
# capacity of the scalable target to place it within these bounds, even
|
2757
|
+
# if you don't include the `MinCapacity` or `MaxCapacity` request
|
2758
|
+
# parameters.
|
2578
2759
|
#
|
2579
2760
|
# </note>
|
2580
2761
|
#
|
@@ -2582,6 +2763,7 @@ module Aws::ApplicationAutoScaling
|
|
2582
2763
|
#
|
2583
2764
|
# [1]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html
|
2584
2765
|
# [2]: https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DeregisterScalableTarget.html
|
2766
|
+
# [3]: https://en.wikipedia.org/wiki/Eventual_consistency
|
2585
2767
|
#
|
2586
2768
|
# @option params [required, String] :service_namespace
|
2587
2769
|
# The namespace of the Amazon Web Services service that provides the
|
@@ -2771,7 +2953,7 @@ module Aws::ApplicationAutoScaling
|
|
2771
2953
|
# This property is required when registering a new scalable target.
|
2772
2954
|
#
|
2773
2955
|
# Although you can specify a large maximum capacity, note that service
|
2774
|
-
# quotas
|
2956
|
+
# quotas might impose lower limits. Each service has its own default
|
2775
2957
|
# quotas for the maximum capacity of the resource. If you want to
|
2776
2958
|
# specify a higher limit, you can request an increase. For more
|
2777
2959
|
# information, consult the documentation for that service. For
|
@@ -2824,7 +3006,26 @@ module Aws::ApplicationAutoScaling
|
|
2824
3006
|
#
|
2825
3007
|
# [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html
|
2826
3008
|
#
|
2827
|
-
# @
|
3009
|
+
# @option params [Hash<String,String>] :tags
|
3010
|
+
# Assigns one or more tags to the scalable target. Use this parameter to
|
3011
|
+
# tag the scalable target when it is created. To tag an existing
|
3012
|
+
# scalable target, use the TagResource operation.
|
3013
|
+
#
|
3014
|
+
# Each tag consists of a tag key and a tag value. Both the tag key and
|
3015
|
+
# the tag value are required. You cannot have more than one tag on a
|
3016
|
+
# scalable target with the same tag key.
|
3017
|
+
#
|
3018
|
+
# Use tags to control access to a scalable target. For more information,
|
3019
|
+
# see [Tagging support for Application Auto Scaling][1] in the
|
3020
|
+
# *Application Auto Scaling User Guide*.
|
3021
|
+
#
|
3022
|
+
#
|
3023
|
+
#
|
3024
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html
|
3025
|
+
#
|
3026
|
+
# @return [Types::RegisterScalableTargetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3027
|
+
#
|
3028
|
+
# * {Types::RegisterScalableTargetResponse#scalable_target_arn #scalable_target_arn} => String
|
2828
3029
|
#
|
2829
3030
|
#
|
2830
3031
|
# @example Example: To register an ECS service as a scalable target
|
@@ -2854,8 +3055,15 @@ module Aws::ApplicationAutoScaling
|
|
2854
3055
|
# dynamic_scaling_out_suspended: false,
|
2855
3056
|
# scheduled_scaling_suspended: false,
|
2856
3057
|
# },
|
3058
|
+
# tags: {
|
3059
|
+
# "TagKey" => "TagValue",
|
3060
|
+
# },
|
2857
3061
|
# })
|
2858
3062
|
#
|
3063
|
+
# @example Response structure
|
3064
|
+
#
|
3065
|
+
# resp.scalable_target_arn #=> String
|
3066
|
+
#
|
2859
3067
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/RegisterScalableTarget AWS API Documentation
|
2860
3068
|
#
|
2861
3069
|
# @overload register_scalable_target(params = {})
|
@@ -2865,6 +3073,146 @@ module Aws::ApplicationAutoScaling
|
|
2865
3073
|
req.send_request(options)
|
2866
3074
|
end
|
2867
3075
|
|
3076
|
+
# Adds or edits tags on an Application Auto Scaling scalable target.
|
3077
|
+
#
|
3078
|
+
# Each tag consists of a tag key and a tag value, which are both
|
3079
|
+
# case-sensitive strings. To add a tag, specify a new tag key and a tag
|
3080
|
+
# value. To edit a tag, specify an existing tag key and a new tag value.
|
3081
|
+
#
|
3082
|
+
# You can use this operation to tag an Application Auto Scaling scalable
|
3083
|
+
# target, but you cannot tag a scaling policy or scheduled action.
|
3084
|
+
#
|
3085
|
+
# You can also add tags to an Application Auto Scaling scalable target
|
3086
|
+
# while creating it (`RegisterScalableTarget`).
|
3087
|
+
#
|
3088
|
+
# For general information about tags, including the format and syntax,
|
3089
|
+
# see [Tagging Amazon Web Services resources][1] in the *Amazon Web
|
3090
|
+
# Services General Reference*.
|
3091
|
+
#
|
3092
|
+
# Use tags to control access to a scalable target. For more information,
|
3093
|
+
# see [Tagging support for Application Auto Scaling][2] in the
|
3094
|
+
# *Application Auto Scaling User Guide*.
|
3095
|
+
#
|
3096
|
+
#
|
3097
|
+
#
|
3098
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
3099
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html
|
3100
|
+
#
|
3101
|
+
# @option params [required, String] :resource_arn
|
3102
|
+
# Identifies the Application Auto Scaling scalable target that you want
|
3103
|
+
# to apply tags to.
|
3104
|
+
#
|
3105
|
+
# For example:
|
3106
|
+
# `arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123`
|
3107
|
+
#
|
3108
|
+
# To get the ARN for a scalable target, use DescribeScalableTargets.
|
3109
|
+
#
|
3110
|
+
# @option params [required, Hash<String,String>] :tags
|
3111
|
+
# The tags assigned to the resource. A tag is a label that you assign to
|
3112
|
+
# an AWS resource.
|
3113
|
+
#
|
3114
|
+
# Each tag consists of a tag key and a tag value.
|
3115
|
+
#
|
3116
|
+
# You cannot have more than one tag on an Application Auto Scaling
|
3117
|
+
# scalable target with the same tag key. If you specify an existing tag
|
3118
|
+
# key with a different tag value, Application Auto Scaling replaces the
|
3119
|
+
# current tag value with the specified one.
|
3120
|
+
#
|
3121
|
+
# For information about the rules that apply to tag keys and tag values,
|
3122
|
+
# see [User-defined tag restrictions][1] in the *Amazon Web Services
|
3123
|
+
# Billing and Cost Management User Guide*.
|
3124
|
+
#
|
3125
|
+
#
|
3126
|
+
#
|
3127
|
+
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
3128
|
+
#
|
3129
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3130
|
+
#
|
3131
|
+
#
|
3132
|
+
# @example Example: To add a tag to a scalable target
|
3133
|
+
#
|
3134
|
+
# # This example adds a tag with the key name "environment" and the value "production" to the scalable target specified by
|
3135
|
+
# # its ARN.
|
3136
|
+
#
|
3137
|
+
# resp = client.tag_resource({
|
3138
|
+
# resource_arn: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123",
|
3139
|
+
# tags: {
|
3140
|
+
# "environment" => "production",
|
3141
|
+
# },
|
3142
|
+
# })
|
3143
|
+
#
|
3144
|
+
# resp.to_h outputs the following:
|
3145
|
+
# {
|
3146
|
+
# }
|
3147
|
+
#
|
3148
|
+
# @example Request syntax with placeholder values
|
3149
|
+
#
|
3150
|
+
# resp = client.tag_resource({
|
3151
|
+
# resource_arn: "AmazonResourceName", # required
|
3152
|
+
# tags: { # required
|
3153
|
+
# "TagKey" => "TagValue",
|
3154
|
+
# },
|
3155
|
+
# })
|
3156
|
+
#
|
3157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/TagResource AWS API Documentation
|
3158
|
+
#
|
3159
|
+
# @overload tag_resource(params = {})
|
3160
|
+
# @param [Hash] params ({})
|
3161
|
+
def tag_resource(params = {}, options = {})
|
3162
|
+
req = build_request(:tag_resource, params)
|
3163
|
+
req.send_request(options)
|
3164
|
+
end
|
3165
|
+
|
3166
|
+
# Deletes tags from an Application Auto Scaling scalable target. To
|
3167
|
+
# delete a tag, specify the tag key and the Application Auto Scaling
|
3168
|
+
# scalable target.
|
3169
|
+
#
|
3170
|
+
# @option params [required, String] :resource_arn
|
3171
|
+
# Identifies the Application Auto Scaling scalable target from which to
|
3172
|
+
# remove tags.
|
3173
|
+
#
|
3174
|
+
# For example:
|
3175
|
+
# `arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123`
|
3176
|
+
#
|
3177
|
+
# To get the ARN for a scalable target, use DescribeScalableTargets.
|
3178
|
+
#
|
3179
|
+
# @option params [required, Array<String>] :tag_keys
|
3180
|
+
# One or more tag keys. Specify only the tag keys, not the tag values.
|
3181
|
+
#
|
3182
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3183
|
+
#
|
3184
|
+
#
|
3185
|
+
# @example Example: To remove a tag from a scalable target
|
3186
|
+
#
|
3187
|
+
# # This example removes the tag pair with the key name "environment" from the scalable target specified by its ARN.
|
3188
|
+
#
|
3189
|
+
# resp = client.untag_resource({
|
3190
|
+
# resource_arn: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123",
|
3191
|
+
# tag_keys: [
|
3192
|
+
# "environment",
|
3193
|
+
# ],
|
3194
|
+
# })
|
3195
|
+
#
|
3196
|
+
# resp.to_h outputs the following:
|
3197
|
+
# {
|
3198
|
+
# }
|
3199
|
+
#
|
3200
|
+
# @example Request syntax with placeholder values
|
3201
|
+
#
|
3202
|
+
# resp = client.untag_resource({
|
3203
|
+
# resource_arn: "AmazonResourceName", # required
|
3204
|
+
# tag_keys: ["TagKey"], # required
|
3205
|
+
# })
|
3206
|
+
#
|
3207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/application-autoscaling-2016-02-06/UntagResource AWS API Documentation
|
3208
|
+
#
|
3209
|
+
# @overload untag_resource(params = {})
|
3210
|
+
# @param [Hash] params ({})
|
3211
|
+
def untag_resource(params = {}, options = {})
|
3212
|
+
req = build_request(:untag_resource, params)
|
3213
|
+
req.send_request(options)
|
3214
|
+
end
|
3215
|
+
|
2868
3216
|
# @!endgroup
|
2869
3217
|
|
2870
3218
|
# @param params ({})
|
@@ -2878,7 +3226,7 @@ module Aws::ApplicationAutoScaling
|
|
2878
3226
|
params: params,
|
2879
3227
|
config: config)
|
2880
3228
|
context[:gem_name] = 'aws-sdk-applicationautoscaling'
|
2881
|
-
context[:gem_version] = '1.
|
3229
|
+
context[:gem_version] = '1.68.0'
|
2882
3230
|
Seahorse::Client::Request.new(handlers, context)
|
2883
3231
|
end
|
2884
3232
|
|