aws-sdk-ecs 1.59.0 → 1.65.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ecs.rb +1 -1
- data/lib/aws-sdk-ecs/client.rb +237 -44
- data/lib/aws-sdk-ecs/client_api.rb +44 -0
- data/lib/aws-sdk-ecs/resource.rb +1 -7
- data/lib/aws-sdk-ecs/types.rb +415 -75
- data/lib/aws-sdk-ecs/waiters.rb +64 -0
- metadata +6 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b40e7e2bb608b1b80b3f55506f8fd2864b9978492aa63563d9b7663f8bc012cd
|
|
4
|
+
data.tar.gz: b6b4af2d1ce82fa56fe41a9535ee6b8bc5830b589d57664060e44db32fce0e6d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5824d1945bdb0c00d34a20991d05ffe752e3d35cca5157ff8655c1438680adc13193a72f44020bbd1b546a91b0417272ace3c94b36403c9b484052fc01b9fe89
|
|
7
|
+
data.tar.gz: f861f386d4db1d98c0c64504ea245bedc0acae1b8f48451760128f2a70f2f856d89aeb36cdaf674e5dfff221ade117cb8647bd1929d49901217a777ea67fbc3d
|
data/lib/aws-sdk-ecs.rb
CHANGED
data/lib/aws-sdk-ecs/client.rb
CHANGED
|
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
28
29
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
29
30
|
|
|
@@ -69,6 +70,7 @@ module Aws::ECS
|
|
|
69
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
|
70
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
71
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
|
72
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
73
75
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
74
76
|
|
|
@@ -105,7 +107,7 @@ module Aws::ECS
|
|
|
105
107
|
# @option options [required, String] :region
|
|
106
108
|
# The AWS region to connect to. The configured `:region` is
|
|
107
109
|
# used to determine the service `:endpoint`. When not passed,
|
|
108
|
-
# a default `:region` is
|
|
110
|
+
# a default `:region` is searched for in the following locations:
|
|
109
111
|
#
|
|
110
112
|
# * `Aws.config[:region]`
|
|
111
113
|
# * `ENV['AWS_REGION']`
|
|
@@ -161,7 +163,7 @@ module Aws::ECS
|
|
|
161
163
|
# @option options [String] :endpoint
|
|
162
164
|
# The client endpoint is normally constructed from the `:region`
|
|
163
165
|
# option. You should only configure an `:endpoint` when connecting
|
|
164
|
-
# to test endpoints. This should be
|
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
|
165
167
|
#
|
|
166
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
167
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
@@ -176,7 +178,7 @@ module Aws::ECS
|
|
|
176
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
|
177
179
|
#
|
|
178
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
180
182
|
#
|
|
181
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
182
184
|
# The log formatter.
|
|
@@ -279,8 +281,7 @@ module Aws::ECS
|
|
|
279
281
|
#
|
|
280
282
|
# @option options [Integer] :http_read_timeout (60) The default
|
|
281
283
|
# number of seconds to wait for response data. This value can
|
|
282
|
-
# safely be set
|
|
283
|
-
# per-request on the session yielded by {#session_for}.
|
|
284
|
+
# safely be set per-request on the session.
|
|
284
285
|
#
|
|
285
286
|
# @option options [Float] :http_idle_timeout (5) The number of
|
|
286
287
|
# seconds a connection is allowed to sit idle before it is
|
|
@@ -292,7 +293,7 @@ module Aws::ECS
|
|
|
292
293
|
# request body. This option has no effect unless the request has
|
|
293
294
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
|
294
295
|
# disables this behaviour. This value can safely be set per
|
|
295
|
-
# request on the session
|
|
296
|
+
# request on the session.
|
|
296
297
|
#
|
|
297
298
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
|
298
299
|
# HTTP debug output will be sent to the `:logger`.
|
|
@@ -397,13 +398,15 @@ module Aws::ECS
|
|
|
397
398
|
#
|
|
398
399
|
# resp.capacity_provider.capacity_provider_arn #=> String
|
|
399
400
|
# resp.capacity_provider.name #=> String
|
|
400
|
-
# resp.capacity_provider.status #=> String, one of "ACTIVE"
|
|
401
|
+
# resp.capacity_provider.status #=> String, one of "ACTIVE", "INACTIVE"
|
|
401
402
|
# resp.capacity_provider.auto_scaling_group_provider.auto_scaling_group_arn #=> String
|
|
402
403
|
# resp.capacity_provider.auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
|
|
403
404
|
# resp.capacity_provider.auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
|
|
404
405
|
# resp.capacity_provider.auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
|
|
405
406
|
# resp.capacity_provider.auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
|
|
406
407
|
# resp.capacity_provider.auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
|
|
408
|
+
# resp.capacity_provider.update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
|
|
409
|
+
# resp.capacity_provider.update_status_reason #=> String
|
|
407
410
|
# resp.capacity_provider.tags #=> Array
|
|
408
411
|
# resp.capacity_provider.tags[0].key #=> String
|
|
409
412
|
# resp.capacity_provider.tags[0].value #=> String
|
|
@@ -478,8 +481,8 @@ module Aws::ECS
|
|
|
478
481
|
# PutAccountSetting or PutAccountSettingDefault.
|
|
479
482
|
#
|
|
480
483
|
# @option params [Array<String>] :capacity_providers
|
|
481
|
-
# The short name
|
|
482
|
-
#
|
|
484
|
+
# The short name of one or more capacity providers to associate with the
|
|
485
|
+
# cluster.
|
|
483
486
|
#
|
|
484
487
|
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
485
488
|
# capacity provider must already be created and not already associated
|
|
@@ -646,11 +649,14 @@ module Aws::ECS
|
|
|
646
649
|
#
|
|
647
650
|
# * `DAEMON` - The daemon scheduling strategy deploys exactly one task
|
|
648
651
|
# on each active container instance that meets all of the task
|
|
649
|
-
# placement constraints that you specify in your cluster.
|
|
650
|
-
#
|
|
651
|
-
#
|
|
652
|
-
#
|
|
653
|
-
#
|
|
652
|
+
# placement constraints that you specify in your cluster. The service
|
|
653
|
+
# scheduler also evaluates the task placement constraints for running
|
|
654
|
+
# tasks and will stop tasks that do not meet the placement
|
|
655
|
+
# constraints. When using this strategy, you don't need to specify a
|
|
656
|
+
# desired number of tasks, a task placement strategy, or use Service
|
|
657
|
+
# Auto Scaling policies. For more information, see [Service Scheduler
|
|
658
|
+
# Concepts][2] in the *Amazon Elastic Container Service Developer
|
|
659
|
+
# Guide*.
|
|
654
660
|
#
|
|
655
661
|
# You can optionally specify a deployment configuration for your
|
|
656
662
|
# service. The deployment is triggered by changing properties, such as
|
|
@@ -976,9 +982,12 @@ module Aws::ECS
|
|
|
976
982
|
#
|
|
977
983
|
# * `DAEMON`-The daemon scheduling strategy deploys exactly one task on
|
|
978
984
|
# each active container instance that meets all of the task placement
|
|
979
|
-
# constraints that you specify in your cluster.
|
|
980
|
-
#
|
|
981
|
-
#
|
|
985
|
+
# constraints that you specify in your cluster. The service scheduler
|
|
986
|
+
# also evaluates the task placement constraints for running tasks and
|
|
987
|
+
# will stop tasks that do not meet the placement constraints. When
|
|
988
|
+
# you're using this strategy, you don't need to specify a desired
|
|
989
|
+
# number of tasks, a task placement strategy, or use Service Auto
|
|
990
|
+
# Scaling policies.
|
|
982
991
|
#
|
|
983
992
|
# <note markdown="1"> Tasks using the Fargate launch type or the `CODE_DEPLOY` or
|
|
984
993
|
# `EXTERNAL` deployment controller types don't support the `DAEMON`
|
|
@@ -1731,6 +1740,65 @@ module Aws::ECS
|
|
|
1731
1740
|
req.send_request(options)
|
|
1732
1741
|
end
|
|
1733
1742
|
|
|
1743
|
+
# Deletes the specified capacity provider.
|
|
1744
|
+
#
|
|
1745
|
+
# <note markdown="1"> The `FARGATE` and `FARGATE_SPOT` capacity providers are reserved and
|
|
1746
|
+
# cannot be deleted. You can disassociate them from a cluster using
|
|
1747
|
+
# either the PutClusterCapacityProviders API or by deleting the cluster.
|
|
1748
|
+
#
|
|
1749
|
+
# </note>
|
|
1750
|
+
#
|
|
1751
|
+
# Prior to a capacity provider being deleted, the capacity provider must
|
|
1752
|
+
# be removed from the capacity provider strategy from all services. The
|
|
1753
|
+
# UpdateService API can be used to remove a capacity provider from a
|
|
1754
|
+
# service's capacity provider strategy. When updating a service, the
|
|
1755
|
+
# `forceNewDeployment` option can be used to ensure that any tasks using
|
|
1756
|
+
# the Amazon EC2 instance capacity provided by the capacity provider are
|
|
1757
|
+
# transitioned to use the capacity from the remaining capacity
|
|
1758
|
+
# providers. Only capacity providers that are not associated with a
|
|
1759
|
+
# cluster can be deleted. To remove a capacity provider from a cluster,
|
|
1760
|
+
# you can either use PutClusterCapacityProviders or delete the cluster.
|
|
1761
|
+
#
|
|
1762
|
+
# @option params [required, String] :capacity_provider
|
|
1763
|
+
# The short name or full Amazon Resource Name (ARN) of the capacity
|
|
1764
|
+
# provider to delete.
|
|
1765
|
+
#
|
|
1766
|
+
# @return [Types::DeleteCapacityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1767
|
+
#
|
|
1768
|
+
# * {Types::DeleteCapacityProviderResponse#capacity_provider #capacity_provider} => Types::CapacityProvider
|
|
1769
|
+
#
|
|
1770
|
+
# @example Request syntax with placeholder values
|
|
1771
|
+
#
|
|
1772
|
+
# resp = client.delete_capacity_provider({
|
|
1773
|
+
# capacity_provider: "String", # required
|
|
1774
|
+
# })
|
|
1775
|
+
#
|
|
1776
|
+
# @example Response structure
|
|
1777
|
+
#
|
|
1778
|
+
# resp.capacity_provider.capacity_provider_arn #=> String
|
|
1779
|
+
# resp.capacity_provider.name #=> String
|
|
1780
|
+
# resp.capacity_provider.status #=> String, one of "ACTIVE", "INACTIVE"
|
|
1781
|
+
# resp.capacity_provider.auto_scaling_group_provider.auto_scaling_group_arn #=> String
|
|
1782
|
+
# resp.capacity_provider.auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
|
|
1783
|
+
# resp.capacity_provider.auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
|
|
1784
|
+
# resp.capacity_provider.auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
|
|
1785
|
+
# resp.capacity_provider.auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
|
|
1786
|
+
# resp.capacity_provider.auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
|
|
1787
|
+
# resp.capacity_provider.update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
|
|
1788
|
+
# resp.capacity_provider.update_status_reason #=> String
|
|
1789
|
+
# resp.capacity_provider.tags #=> Array
|
|
1790
|
+
# resp.capacity_provider.tags[0].key #=> String
|
|
1791
|
+
# resp.capacity_provider.tags[0].value #=> String
|
|
1792
|
+
#
|
|
1793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteCapacityProvider AWS API Documentation
|
|
1794
|
+
#
|
|
1795
|
+
# @overload delete_capacity_provider(params = {})
|
|
1796
|
+
# @param [Hash] params ({})
|
|
1797
|
+
def delete_capacity_provider(params = {}, options = {})
|
|
1798
|
+
req = build_request(:delete_capacity_provider, params)
|
|
1799
|
+
req.send_request(options)
|
|
1800
|
+
end
|
|
1801
|
+
|
|
1734
1802
|
# Deletes the specified cluster. The cluster will transition to the
|
|
1735
1803
|
# `INACTIVE` state. Clusters with an `INACTIVE` status may remain
|
|
1736
1804
|
# discoverable in your account for a period of time. However, this
|
|
@@ -2291,6 +2359,9 @@ module Aws::ECS
|
|
|
2291
2359
|
# resp.task_definition.container_definitions[0].environment #=> Array
|
|
2292
2360
|
# resp.task_definition.container_definitions[0].environment[0].name #=> String
|
|
2293
2361
|
# resp.task_definition.container_definitions[0].environment[0].value #=> String
|
|
2362
|
+
# resp.task_definition.container_definitions[0].environment_files #=> Array
|
|
2363
|
+
# resp.task_definition.container_definitions[0].environment_files[0].value #=> String
|
|
2364
|
+
# resp.task_definition.container_definitions[0].environment_files[0].type #=> String, one of "s3"
|
|
2294
2365
|
# resp.task_definition.container_definitions[0].mount_points #=> Array
|
|
2295
2366
|
# resp.task_definition.container_definitions[0].mount_points[0].source_volume #=> String
|
|
2296
2367
|
# resp.task_definition.container_definitions[0].mount_points[0].container_path #=> String
|
|
@@ -2385,6 +2456,10 @@ module Aws::ECS
|
|
|
2385
2456
|
# resp.task_definition.volumes[0].docker_volume_configuration.labels["String"] #=> String
|
|
2386
2457
|
# resp.task_definition.volumes[0].efs_volume_configuration.file_system_id #=> String
|
|
2387
2458
|
# resp.task_definition.volumes[0].efs_volume_configuration.root_directory #=> String
|
|
2459
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
|
|
2460
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
|
2461
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
|
2462
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
|
2388
2463
|
# resp.task_definition.status #=> String, one of "ACTIVE", "INACTIVE"
|
|
2389
2464
|
# resp.task_definition.requires_attributes #=> Array
|
|
2390
2465
|
# resp.task_definition.requires_attributes[0].name #=> String
|
|
@@ -2477,13 +2552,15 @@ module Aws::ECS
|
|
|
2477
2552
|
# resp.capacity_providers #=> Array
|
|
2478
2553
|
# resp.capacity_providers[0].capacity_provider_arn #=> String
|
|
2479
2554
|
# resp.capacity_providers[0].name #=> String
|
|
2480
|
-
# resp.capacity_providers[0].status #=> String, one of "ACTIVE"
|
|
2555
|
+
# resp.capacity_providers[0].status #=> String, one of "ACTIVE", "INACTIVE"
|
|
2481
2556
|
# resp.capacity_providers[0].auto_scaling_group_provider.auto_scaling_group_arn #=> String
|
|
2482
2557
|
# resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
|
|
2483
2558
|
# resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
|
|
2484
2559
|
# resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
|
|
2485
2560
|
# resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
|
|
2486
2561
|
# resp.capacity_providers[0].auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
|
|
2562
|
+
# resp.capacity_providers[0].update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
|
|
2563
|
+
# resp.capacity_providers[0].update_status_reason #=> String
|
|
2487
2564
|
# resp.capacity_providers[0].tags #=> Array
|
|
2488
2565
|
# resp.capacity_providers[0].tags[0].key #=> String
|
|
2489
2566
|
# resp.capacity_providers[0].tags[0].value #=> String
|
|
@@ -3016,6 +3093,12 @@ module Aws::ECS
|
|
|
3016
3093
|
# resp.failures[0].reason #=> String
|
|
3017
3094
|
# resp.failures[0].detail #=> String
|
|
3018
3095
|
#
|
|
3096
|
+
#
|
|
3097
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
3098
|
+
#
|
|
3099
|
+
# * services_inactive
|
|
3100
|
+
# * services_stable
|
|
3101
|
+
#
|
|
3019
3102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServices AWS API Documentation
|
|
3020
3103
|
#
|
|
3021
3104
|
# @overload describe_services(params = {})
|
|
@@ -3144,6 +3227,9 @@ module Aws::ECS
|
|
|
3144
3227
|
# resp.task_definition.container_definitions[0].environment #=> Array
|
|
3145
3228
|
# resp.task_definition.container_definitions[0].environment[0].name #=> String
|
|
3146
3229
|
# resp.task_definition.container_definitions[0].environment[0].value #=> String
|
|
3230
|
+
# resp.task_definition.container_definitions[0].environment_files #=> Array
|
|
3231
|
+
# resp.task_definition.container_definitions[0].environment_files[0].value #=> String
|
|
3232
|
+
# resp.task_definition.container_definitions[0].environment_files[0].type #=> String, one of "s3"
|
|
3147
3233
|
# resp.task_definition.container_definitions[0].mount_points #=> Array
|
|
3148
3234
|
# resp.task_definition.container_definitions[0].mount_points[0].source_volume #=> String
|
|
3149
3235
|
# resp.task_definition.container_definitions[0].mount_points[0].container_path #=> String
|
|
@@ -3238,6 +3324,10 @@ module Aws::ECS
|
|
|
3238
3324
|
# resp.task_definition.volumes[0].docker_volume_configuration.labels["String"] #=> String
|
|
3239
3325
|
# resp.task_definition.volumes[0].efs_volume_configuration.file_system_id #=> String
|
|
3240
3326
|
# resp.task_definition.volumes[0].efs_volume_configuration.root_directory #=> String
|
|
3327
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
|
|
3328
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
|
3329
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
|
3330
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
|
3241
3331
|
# resp.task_definition.status #=> String, one of "ACTIVE", "INACTIVE"
|
|
3242
3332
|
# resp.task_definition.requires_attributes #=> Array
|
|
3243
3333
|
# resp.task_definition.requires_attributes[0].name #=> String
|
|
@@ -3518,6 +3608,9 @@ module Aws::ECS
|
|
|
3518
3608
|
# resp.tasks[0].overrides.container_overrides[0].environment #=> Array
|
|
3519
3609
|
# resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
|
|
3520
3610
|
# resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
|
|
3611
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files #=> Array
|
|
3612
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files[0].value #=> String
|
|
3613
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
|
|
3521
3614
|
# resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
|
|
3522
3615
|
# resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
|
|
3523
3616
|
# resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
|
|
@@ -3551,6 +3644,12 @@ module Aws::ECS
|
|
|
3551
3644
|
# resp.failures[0].reason #=> String
|
|
3552
3645
|
# resp.failures[0].detail #=> String
|
|
3553
3646
|
#
|
|
3647
|
+
#
|
|
3648
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
|
3649
|
+
#
|
|
3650
|
+
# * tasks_running
|
|
3651
|
+
# * tasks_stopped
|
|
3652
|
+
#
|
|
3554
3653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasks AWS API Documentation
|
|
3555
3654
|
#
|
|
3556
3655
|
# @overload describe_tasks(params = {})
|
|
@@ -3608,7 +3707,7 @@ module Aws::ECS
|
|
|
3608
3707
|
# Lists the account settings for a specified principal.
|
|
3609
3708
|
#
|
|
3610
3709
|
# @option params [String] :name
|
|
3611
|
-
# The
|
|
3710
|
+
# The name of the account setting you want to list the settings for.
|
|
3612
3711
|
#
|
|
3613
3712
|
# @option params [String] :value
|
|
3614
3713
|
# The value of the account settings with which to filter results. You
|
|
@@ -3654,6 +3753,8 @@ module Aws::ECS
|
|
|
3654
3753
|
# * {Types::ListAccountSettingsResponse#settings #settings} => Array<Types::Setting>
|
|
3655
3754
|
# * {Types::ListAccountSettingsResponse#next_token #next_token} => String
|
|
3656
3755
|
#
|
|
3756
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3757
|
+
#
|
|
3657
3758
|
#
|
|
3658
3759
|
# @example Example: To view your effective account settings
|
|
3659
3760
|
#
|
|
@@ -3793,6 +3894,8 @@ module Aws::ECS
|
|
|
3793
3894
|
# * {Types::ListAttributesResponse#attributes #attributes} => Array<Types::Attribute>
|
|
3794
3895
|
# * {Types::ListAttributesResponse#next_token #next_token} => String
|
|
3795
3896
|
#
|
|
3897
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3898
|
+
#
|
|
3796
3899
|
# @example Request syntax with placeholder values
|
|
3797
3900
|
#
|
|
3798
3901
|
# resp = client.list_attributes({
|
|
@@ -3851,6 +3954,8 @@ module Aws::ECS
|
|
|
3851
3954
|
# * {Types::ListClustersResponse#cluster_arns #cluster_arns} => Array<String>
|
|
3852
3955
|
# * {Types::ListClustersResponse#next_token #next_token} => String
|
|
3853
3956
|
#
|
|
3957
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3958
|
+
#
|
|
3854
3959
|
#
|
|
3855
3960
|
# @example Example: To list your available clusters
|
|
3856
3961
|
#
|
|
@@ -3949,6 +4054,8 @@ module Aws::ECS
|
|
|
3949
4054
|
# * {Types::ListContainerInstancesResponse#container_instance_arns #container_instance_arns} => Array<String>
|
|
3950
4055
|
# * {Types::ListContainerInstancesResponse#next_token #next_token} => String
|
|
3951
4056
|
#
|
|
4057
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4058
|
+
#
|
|
3952
4059
|
#
|
|
3953
4060
|
# @example Example: To list your available container instances in a cluster
|
|
3954
4061
|
#
|
|
@@ -4031,6 +4138,8 @@ module Aws::ECS
|
|
|
4031
4138
|
# * {Types::ListServicesResponse#service_arns #service_arns} => Array<String>
|
|
4032
4139
|
# * {Types::ListServicesResponse#next_token #next_token} => String
|
|
4033
4140
|
#
|
|
4141
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4142
|
+
#
|
|
4034
4143
|
#
|
|
4035
4144
|
# @example Example: To list the services in a cluster
|
|
4036
4145
|
#
|
|
@@ -4177,6 +4286,8 @@ module Aws::ECS
|
|
|
4177
4286
|
# * {Types::ListTaskDefinitionFamiliesResponse#families #families} => Array<String>
|
|
4178
4287
|
# * {Types::ListTaskDefinitionFamiliesResponse#next_token #next_token} => String
|
|
4179
4288
|
#
|
|
4289
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4290
|
+
#
|
|
4180
4291
|
#
|
|
4181
4292
|
# @example Example: To list your registered task definition families
|
|
4182
4293
|
#
|
|
@@ -4290,6 +4401,8 @@ module Aws::ECS
|
|
|
4290
4401
|
# * {Types::ListTaskDefinitionsResponse#task_definition_arns #task_definition_arns} => Array<String>
|
|
4291
4402
|
# * {Types::ListTaskDefinitionsResponse#next_token #next_token} => String
|
|
4292
4403
|
#
|
|
4404
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4405
|
+
#
|
|
4293
4406
|
#
|
|
4294
4407
|
# @example Example: To list your registered task definitions
|
|
4295
4408
|
#
|
|
@@ -4433,6 +4546,8 @@ module Aws::ECS
|
|
|
4433
4546
|
# * {Types::ListTasksResponse#task_arns #task_arns} => Array<String>
|
|
4434
4547
|
# * {Types::ListTasksResponse#next_token #next_token} => String
|
|
4435
4548
|
#
|
|
4549
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4550
|
+
#
|
|
4436
4551
|
#
|
|
4437
4552
|
# @example Example: To list the tasks in a cluster
|
|
4438
4553
|
#
|
|
@@ -5099,8 +5214,16 @@ module Aws::ECS
|
|
|
5099
5214
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html
|
|
5100
5215
|
#
|
|
5101
5216
|
# @option params [String] :execution_role_arn
|
|
5102
|
-
# The Amazon Resource Name (ARN) of the task execution role that
|
|
5103
|
-
# Amazon ECS container agent
|
|
5217
|
+
# The Amazon Resource Name (ARN) of the task execution role that grants
|
|
5218
|
+
# the Amazon ECS container agent permission to make AWS API calls on
|
|
5219
|
+
# your behalf. The task execution IAM role is required depending on the
|
|
5220
|
+
# requirements of your task. For more information, see [Amazon ECS task
|
|
5221
|
+
# execution IAM role][1] in the *Amazon Elastic Container Service
|
|
5222
|
+
# Developer Guide*.
|
|
5223
|
+
#
|
|
5224
|
+
#
|
|
5225
|
+
#
|
|
5226
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html
|
|
5104
5227
|
#
|
|
5105
5228
|
# @option params [String] :network_mode
|
|
5106
5229
|
# The Docker networking mode to use for the containers in the task. The
|
|
@@ -5451,6 +5574,12 @@ module Aws::ECS
|
|
|
5451
5574
|
# value: "String",
|
|
5452
5575
|
# },
|
|
5453
5576
|
# ],
|
|
5577
|
+
# environment_files: [
|
|
5578
|
+
# {
|
|
5579
|
+
# value: "String", # required
|
|
5580
|
+
# type: "s3", # required, accepts s3
|
|
5581
|
+
# },
|
|
5582
|
+
# ],
|
|
5454
5583
|
# mount_points: [
|
|
5455
5584
|
# {
|
|
5456
5585
|
# source_volume: "String",
|
|
@@ -5588,6 +5717,12 @@ module Aws::ECS
|
|
|
5588
5717
|
# efs_volume_configuration: {
|
|
5589
5718
|
# file_system_id: "String", # required
|
|
5590
5719
|
# root_directory: "String",
|
|
5720
|
+
# transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
|
|
5721
|
+
# transit_encryption_port: 1,
|
|
5722
|
+
# authorization_config: {
|
|
5723
|
+
# access_point_id: "String",
|
|
5724
|
+
# iam: "ENABLED", # accepts ENABLED, DISABLED
|
|
5725
|
+
# },
|
|
5591
5726
|
# },
|
|
5592
5727
|
# },
|
|
5593
5728
|
# ],
|
|
@@ -5650,6 +5785,9 @@ module Aws::ECS
|
|
|
5650
5785
|
# resp.task_definition.container_definitions[0].environment #=> Array
|
|
5651
5786
|
# resp.task_definition.container_definitions[0].environment[0].name #=> String
|
|
5652
5787
|
# resp.task_definition.container_definitions[0].environment[0].value #=> String
|
|
5788
|
+
# resp.task_definition.container_definitions[0].environment_files #=> Array
|
|
5789
|
+
# resp.task_definition.container_definitions[0].environment_files[0].value #=> String
|
|
5790
|
+
# resp.task_definition.container_definitions[0].environment_files[0].type #=> String, one of "s3"
|
|
5653
5791
|
# resp.task_definition.container_definitions[0].mount_points #=> Array
|
|
5654
5792
|
# resp.task_definition.container_definitions[0].mount_points[0].source_volume #=> String
|
|
5655
5793
|
# resp.task_definition.container_definitions[0].mount_points[0].container_path #=> String
|
|
@@ -5744,6 +5882,10 @@ module Aws::ECS
|
|
|
5744
5882
|
# resp.task_definition.volumes[0].docker_volume_configuration.labels["String"] #=> String
|
|
5745
5883
|
# resp.task_definition.volumes[0].efs_volume_configuration.file_system_id #=> String
|
|
5746
5884
|
# resp.task_definition.volumes[0].efs_volume_configuration.root_directory #=> String
|
|
5885
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
|
|
5886
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
|
5887
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
|
5888
|
+
# resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
|
5747
5889
|
# resp.task_definition.status #=> String, one of "ACTIVE", "INACTIVE"
|
|
5748
5890
|
# resp.task_definition.requires_attributes #=> Array
|
|
5749
5891
|
# resp.task_definition.requires_attributes[0].name #=> String
|
|
@@ -6064,6 +6206,12 @@ module Aws::ECS
|
|
|
6064
6206
|
# value: "String",
|
|
6065
6207
|
# },
|
|
6066
6208
|
# ],
|
|
6209
|
+
# environment_files: [
|
|
6210
|
+
# {
|
|
6211
|
+
# value: "String", # required
|
|
6212
|
+
# type: "s3", # required, accepts s3
|
|
6213
|
+
# },
|
|
6214
|
+
# ],
|
|
6067
6215
|
# cpu: 1,
|
|
6068
6216
|
# memory: 1,
|
|
6069
6217
|
# memory_reservation: 1,
|
|
@@ -6176,6 +6324,9 @@ module Aws::ECS
|
|
|
6176
6324
|
# resp.tasks[0].overrides.container_overrides[0].environment #=> Array
|
|
6177
6325
|
# resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
|
|
6178
6326
|
# resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
|
|
6327
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files #=> Array
|
|
6328
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files[0].value #=> String
|
|
6329
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
|
|
6179
6330
|
# resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
|
|
6180
6331
|
# resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
|
|
6181
6332
|
# resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
|
|
@@ -6358,6 +6509,12 @@ module Aws::ECS
|
|
|
6358
6509
|
# value: "String",
|
|
6359
6510
|
# },
|
|
6360
6511
|
# ],
|
|
6512
|
+
# environment_files: [
|
|
6513
|
+
# {
|
|
6514
|
+
# value: "String", # required
|
|
6515
|
+
# type: "s3", # required, accepts s3
|
|
6516
|
+
# },
|
|
6517
|
+
# ],
|
|
6361
6518
|
# cpu: 1,
|
|
6362
6519
|
# memory: 1,
|
|
6363
6520
|
# memory_reservation: 1,
|
|
@@ -6457,6 +6614,9 @@ module Aws::ECS
|
|
|
6457
6614
|
# resp.tasks[0].overrides.container_overrides[0].environment #=> Array
|
|
6458
6615
|
# resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
|
|
6459
6616
|
# resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
|
|
6617
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files #=> Array
|
|
6618
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files[0].value #=> String
|
|
6619
|
+
# resp.tasks[0].overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
|
|
6460
6620
|
# resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
|
|
6461
6621
|
# resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
|
|
6462
6622
|
# resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
|
|
@@ -6611,6 +6771,9 @@ module Aws::ECS
|
|
|
6611
6771
|
# resp.task.overrides.container_overrides[0].environment #=> Array
|
|
6612
6772
|
# resp.task.overrides.container_overrides[0].environment[0].name #=> String
|
|
6613
6773
|
# resp.task.overrides.container_overrides[0].environment[0].value #=> String
|
|
6774
|
+
# resp.task.overrides.container_overrides[0].environment_files #=> Array
|
|
6775
|
+
# resp.task.overrides.container_overrides[0].environment_files[0].value #=> String
|
|
6776
|
+
# resp.task.overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
|
|
6614
6777
|
# resp.task.overrides.container_overrides[0].cpu #=> Integer
|
|
6615
6778
|
# resp.task.overrides.container_overrides[0].memory #=> Integer
|
|
6616
6779
|
# resp.task.overrides.container_overrides[0].memory_reservation #=> Integer
|
|
@@ -7285,25 +7448,33 @@ module Aws::ECS
|
|
|
7285
7448
|
req.send_request(options)
|
|
7286
7449
|
end
|
|
7287
7450
|
|
|
7451
|
+
# Updating the task placement strategies and constraints on an Amazon
|
|
7452
|
+
# ECS service remains in preview and is a Beta Service as defined by and
|
|
7453
|
+
# subject to the Beta Service Participation Service Terms located at
|
|
7454
|
+
# [https://aws.amazon.com/service-terms][1] ("Beta Terms"). These Beta
|
|
7455
|
+
# Terms apply to your participation in this preview.
|
|
7456
|
+
#
|
|
7288
7457
|
# Modifies the parameters of a service.
|
|
7289
7458
|
#
|
|
7290
7459
|
# For services using the rolling update (`ECS`) deployment controller,
|
|
7291
|
-
# the desired count, deployment configuration, network configuration,
|
|
7292
|
-
# task definition used can
|
|
7460
|
+
# the desired count, deployment configuration, network configuration,
|
|
7461
|
+
# task placement constraints and strategies, or task definition used can
|
|
7462
|
+
# be updated.
|
|
7293
7463
|
#
|
|
7294
7464
|
# For services using the blue/green (`CODE_DEPLOY`) deployment
|
|
7295
|
-
# controller, only the desired count, deployment configuration,
|
|
7296
|
-
#
|
|
7297
|
-
#
|
|
7298
|
-
#
|
|
7299
|
-
#
|
|
7300
|
-
# Reference*.
|
|
7465
|
+
# controller, only the desired count, deployment configuration, task
|
|
7466
|
+
# placement constraints and strategies, and health check grace period
|
|
7467
|
+
# can be updated using this API. If the network configuration, platform
|
|
7468
|
+
# version, or task definition need to be updated, a new AWS CodeDeploy
|
|
7469
|
+
# deployment should be created. For more information, see
|
|
7470
|
+
# [CreateDeployment][2] in the *AWS CodeDeploy API Reference*.
|
|
7301
7471
|
#
|
|
7302
7472
|
# For services using an external deployment controller, you can update
|
|
7303
|
-
# only the desired count
|
|
7304
|
-
# If the launch type, load
|
|
7305
|
-
#
|
|
7306
|
-
# new task set. For more
|
|
7473
|
+
# only the desired count, task placement constraints and strategies, and
|
|
7474
|
+
# health check grace period using this API. If the launch type, load
|
|
7475
|
+
# balancer, network configuration, platform version, or task definition
|
|
7476
|
+
# need to be updated, you should create a new task set. For more
|
|
7477
|
+
# information, see CreateTaskSet.
|
|
7307
7478
|
#
|
|
7308
7479
|
# You can add to or subtract from the number of instantiations of a task
|
|
7309
7480
|
# definition in a service by specifying the cluster that the service is
|
|
@@ -7393,7 +7564,8 @@ module Aws::ECS
|
|
|
7393
7564
|
#
|
|
7394
7565
|
#
|
|
7395
7566
|
#
|
|
7396
|
-
# [1]: https://
|
|
7567
|
+
# [1]: https://aws.amazon.com/service-terms
|
|
7568
|
+
# [2]: https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html
|
|
7397
7569
|
#
|
|
7398
7570
|
# @option params [String] :cluster
|
|
7399
7571
|
# The short name or full Amazon Resource Name (ARN) of the cluster that
|
|
@@ -7420,9 +7592,30 @@ module Aws::ECS
|
|
|
7420
7592
|
#
|
|
7421
7593
|
# If the service is using the default capacity provider strategy for the
|
|
7422
7594
|
# cluster, the service can be updated to use one or more capacity
|
|
7423
|
-
# providers
|
|
7424
|
-
#
|
|
7425
|
-
# default capacity provider strategy
|
|
7595
|
+
# providers as opposed to the default capacity provider strategy.
|
|
7596
|
+
# However, when a service is using a capacity provider strategy that is
|
|
7597
|
+
# not the default capacity provider strategy, the service cannot be
|
|
7598
|
+
# updated to use the cluster's default capacity provider strategy.
|
|
7599
|
+
#
|
|
7600
|
+
# A capacity provider strategy consists of one or more capacity
|
|
7601
|
+
# providers along with the `base` and `weight` to assign to them. A
|
|
7602
|
+
# capacity provider must be associated with the cluster to be used in a
|
|
7603
|
+
# capacity provider strategy. The PutClusterCapacityProviders API is
|
|
7604
|
+
# used to associate a capacity provider with a cluster. Only capacity
|
|
7605
|
+
# providers with an `ACTIVE` or `UPDATING` status can be used.
|
|
7606
|
+
#
|
|
7607
|
+
# If specifying a capacity provider that uses an Auto Scaling group, the
|
|
7608
|
+
# capacity provider must already be created. New capacity providers can
|
|
7609
|
+
# be created with the CreateCapacityProvider API operation.
|
|
7610
|
+
#
|
|
7611
|
+
# To use a AWS Fargate capacity provider, specify either the `FARGATE`
|
|
7612
|
+
# or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity
|
|
7613
|
+
# providers are available to all accounts and only need to be associated
|
|
7614
|
+
# with a cluster to be used.
|
|
7615
|
+
#
|
|
7616
|
+
# The PutClusterCapacityProviders API operation is used to update the
|
|
7617
|
+
# list of available capacity providers for a cluster after the cluster
|
|
7618
|
+
# is created.
|
|
7426
7619
|
#
|
|
7427
7620
|
# @option params [Types::DeploymentConfiguration] :deployment_configuration
|
|
7428
7621
|
# Optional deployment parameters that control how many tasks run during
|
|
@@ -7878,7 +8071,7 @@ module Aws::ECS
|
|
|
7878
8071
|
params: params,
|
|
7879
8072
|
config: config)
|
|
7880
8073
|
context[:gem_name] = 'aws-sdk-ecs'
|
|
7881
|
-
context[:gem_version] = '1.
|
|
8074
|
+
context[:gem_version] = '1.65.0'
|
|
7882
8075
|
Seahorse::Client::Request.new(handlers, context)
|
|
7883
8076
|
end
|
|
7884
8077
|
|
|
@@ -7944,12 +8137,12 @@ module Aws::ECS
|
|
|
7944
8137
|
# The following table lists the valid waiter names, the operations they call,
|
|
7945
8138
|
# and the default `:delay` and `:max_attempts` values.
|
|
7946
8139
|
#
|
|
7947
|
-
# | waiter_name | params
|
|
7948
|
-
# | ----------------- |
|
|
7949
|
-
# | services_inactive | {#describe_services} | 15 | 40 |
|
|
7950
|
-
# | services_stable | {#describe_services} | 15 | 40 |
|
|
7951
|
-
# | tasks_running | {#describe_tasks} | 6 | 100 |
|
|
7952
|
-
# | tasks_stopped | {#describe_tasks} | 6 | 100 |
|
|
8140
|
+
# | waiter_name | params | :delay | :max_attempts |
|
|
8141
|
+
# | ----------------- | -------------------------- | -------- | ------------- |
|
|
8142
|
+
# | services_inactive | {Client#describe_services} | 15 | 40 |
|
|
8143
|
+
# | services_stable | {Client#describe_services} | 15 | 40 |
|
|
8144
|
+
# | tasks_running | {Client#describe_tasks} | 6 | 100 |
|
|
8145
|
+
# | tasks_stopped | {Client#describe_tasks} | 6 | 100 |
|
|
7953
8146
|
#
|
|
7954
8147
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
|
7955
8148
|
# because the waiter has entered a state that it will not transition
|