aws-sdk-ecs 1.52.0 → 1.53.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-ecs.rb +1 -1
- data/lib/aws-sdk-ecs/client.rb +404 -346
- data/lib/aws-sdk-ecs/client_api.rb +42 -34
- data/lib/aws-sdk-ecs/types.rb +398 -359
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 498b05fc960032ad070c525aa840299cdc288f34
|
4
|
+
data.tar.gz: c8b59661027add4aec8d3da1af2ebeff455f5514
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b42c3e3201745ade23fb7cc5b4597bd0cd3a20699026a6ca3ac1c711441566ef446e9c6c1ff74f89962711fdc9bdd7d44029eeb1a78817c738b833575b6ec664
|
7
|
+
data.tar.gz: 3d505c12ec92df62c3b67c78288814d3c2594e08158a898afd7bfcd0a00ebc6b037fec19d9de14db88de074dd46ecd7c8b895250f526020810148045dc013acf
|
data/lib/aws-sdk-ecs.rb
CHANGED
data/lib/aws-sdk-ecs/client.rb
CHANGED
@@ -1996,6 +1996,9 @@ module Aws::ECS
|
|
1996
1996
|
# resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE"
|
1997
1997
|
# resp.task_definition.cpu #=> String
|
1998
1998
|
# resp.task_definition.memory #=> String
|
1999
|
+
# resp.task_definition.inference_accelerators #=> Array
|
2000
|
+
# resp.task_definition.inference_accelerators[0].device_name #=> String
|
2001
|
+
# resp.task_definition.inference_accelerators[0].device_type #=> String
|
1999
2002
|
# resp.task_definition.pid_mode #=> String, one of "host", "task"
|
2000
2003
|
# resp.task_definition.ipc_mode #=> String, one of "host", "task", "none"
|
2001
2004
|
# resp.task_definition.proxy_configuration.type #=> String, one of "APPMESH"
|
@@ -2098,6 +2101,7 @@ module Aws::ECS
|
|
2098
2101
|
# resp.failures #=> Array
|
2099
2102
|
# resp.failures[0].arn #=> String
|
2100
2103
|
# resp.failures[0].reason #=> String
|
2104
|
+
# resp.failures[0].detail #=> String
|
2101
2105
|
#
|
2102
2106
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeClusters AWS API Documentation
|
2103
2107
|
#
|
@@ -2280,6 +2284,7 @@ module Aws::ECS
|
|
2280
2284
|
# resp.failures #=> Array
|
2281
2285
|
# resp.failures[0].arn #=> String
|
2282
2286
|
# resp.failures[0].reason #=> String
|
2287
|
+
# resp.failures[0].detail #=> String
|
2283
2288
|
#
|
2284
2289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstances AWS API Documentation
|
2285
2290
|
#
|
@@ -2481,6 +2486,7 @@ module Aws::ECS
|
|
2481
2486
|
# resp.failures #=> Array
|
2482
2487
|
# resp.failures[0].arn #=> String
|
2483
2488
|
# resp.failures[0].reason #=> String
|
2489
|
+
# resp.failures[0].detail #=> String
|
2484
2490
|
#
|
2485
2491
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServices AWS API Documentation
|
2486
2492
|
#
|
@@ -2717,6 +2723,9 @@ module Aws::ECS
|
|
2717
2723
|
# resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE"
|
2718
2724
|
# resp.task_definition.cpu #=> String
|
2719
2725
|
# resp.task_definition.memory #=> String
|
2726
|
+
# resp.task_definition.inference_accelerators #=> Array
|
2727
|
+
# resp.task_definition.inference_accelerators[0].device_name #=> String
|
2728
|
+
# resp.task_definition.inference_accelerators[0].device_type #=> String
|
2720
2729
|
# resp.task_definition.pid_mode #=> String, one of "host", "task"
|
2721
2730
|
# resp.task_definition.ipc_mode #=> String, one of "host", "task", "none"
|
2722
2731
|
# resp.task_definition.proxy_configuration.type #=> String, one of "APPMESH"
|
@@ -2810,6 +2819,7 @@ module Aws::ECS
|
|
2810
2819
|
# resp.failures #=> Array
|
2811
2820
|
# resp.failures[0].arn #=> String
|
2812
2821
|
# resp.failures[0].reason #=> String
|
2822
|
+
# resp.failures[0].detail #=> String
|
2813
2823
|
#
|
2814
2824
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskSets AWS API Documentation
|
2815
2825
|
#
|
@@ -2903,32 +2913,23 @@ module Aws::ECS
|
|
2903
2913
|
# @example Response structure
|
2904
2914
|
#
|
2905
2915
|
# resp.tasks #=> Array
|
2906
|
-
# resp.tasks[0].
|
2916
|
+
# resp.tasks[0].attachments #=> Array
|
2917
|
+
# resp.tasks[0].attachments[0].id #=> String
|
2918
|
+
# resp.tasks[0].attachments[0].type #=> String
|
2919
|
+
# resp.tasks[0].attachments[0].status #=> String
|
2920
|
+
# resp.tasks[0].attachments[0].details #=> Array
|
2921
|
+
# resp.tasks[0].attachments[0].details[0].name #=> String
|
2922
|
+
# resp.tasks[0].attachments[0].details[0].value #=> String
|
2923
|
+
# resp.tasks[0].attributes #=> Array
|
2924
|
+
# resp.tasks[0].attributes[0].name #=> String
|
2925
|
+
# resp.tasks[0].attributes[0].value #=> String
|
2926
|
+
# resp.tasks[0].attributes[0].target_type #=> String, one of "container-instance"
|
2927
|
+
# resp.tasks[0].attributes[0].target_id #=> String
|
2928
|
+
# resp.tasks[0].availability_zone #=> String
|
2907
2929
|
# resp.tasks[0].cluster_arn #=> String
|
2908
|
-
# resp.tasks[0].
|
2930
|
+
# resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
|
2931
|
+
# resp.tasks[0].connectivity_at #=> Time
|
2909
2932
|
# resp.tasks[0].container_instance_arn #=> String
|
2910
|
-
# resp.tasks[0].overrides.container_overrides #=> Array
|
2911
|
-
# resp.tasks[0].overrides.container_overrides[0].name #=> String
|
2912
|
-
# resp.tasks[0].overrides.container_overrides[0].command #=> Array
|
2913
|
-
# resp.tasks[0].overrides.container_overrides[0].command[0] #=> String
|
2914
|
-
# resp.tasks[0].overrides.container_overrides[0].environment #=> Array
|
2915
|
-
# resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
|
2916
|
-
# resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
|
2917
|
-
# resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
|
2918
|
-
# resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
|
2919
|
-
# resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
|
2920
|
-
# resp.tasks[0].overrides.container_overrides[0].resource_requirements #=> Array
|
2921
|
-
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].value #=> String
|
2922
|
-
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
|
2923
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
|
2924
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
|
2925
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
|
2926
|
-
# resp.tasks[0].overrides.task_role_arn #=> String
|
2927
|
-
# resp.tasks[0].overrides.execution_role_arn #=> String
|
2928
|
-
# resp.tasks[0].last_status #=> String
|
2929
|
-
# resp.tasks[0].desired_status #=> String
|
2930
|
-
# resp.tasks[0].cpu #=> String
|
2931
|
-
# resp.tasks[0].memory #=> String
|
2932
2933
|
# resp.tasks[0].containers #=> Array
|
2933
2934
|
# resp.tasks[0].containers[0].container_arn #=> String
|
2934
2935
|
# resp.tasks[0].containers[0].task_arn #=> String
|
@@ -2954,39 +2955,57 @@ module Aws::ECS
|
|
2954
2955
|
# resp.tasks[0].containers[0].memory_reservation #=> String
|
2955
2956
|
# resp.tasks[0].containers[0].gpu_ids #=> Array
|
2956
2957
|
# resp.tasks[0].containers[0].gpu_ids[0] #=> String
|
2957
|
-
# resp.tasks[0].
|
2958
|
-
# resp.tasks[0].version #=> Integer
|
2959
|
-
# resp.tasks[0].stopped_reason #=> String
|
2960
|
-
# resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated"
|
2961
|
-
# resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
|
2962
|
-
# resp.tasks[0].connectivity_at #=> Time
|
2963
|
-
# resp.tasks[0].pull_started_at #=> Time
|
2964
|
-
# resp.tasks[0].pull_stopped_at #=> Time
|
2965
|
-
# resp.tasks[0].execution_stopped_at #=> Time
|
2958
|
+
# resp.tasks[0].cpu #=> String
|
2966
2959
|
# resp.tasks[0].created_at #=> Time
|
2967
|
-
# resp.tasks[0].
|
2968
|
-
# resp.tasks[0].
|
2969
|
-
# resp.tasks[0].stopped_at #=> Time
|
2960
|
+
# resp.tasks[0].desired_status #=> String
|
2961
|
+
# resp.tasks[0].execution_stopped_at #=> Time
|
2970
2962
|
# resp.tasks[0].group #=> String
|
2963
|
+
# resp.tasks[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
|
2964
|
+
# resp.tasks[0].inference_accelerators #=> Array
|
2965
|
+
# resp.tasks[0].inference_accelerators[0].device_name #=> String
|
2966
|
+
# resp.tasks[0].inference_accelerators[0].device_type #=> String
|
2967
|
+
# resp.tasks[0].last_status #=> String
|
2971
2968
|
# resp.tasks[0].launch_type #=> String, one of "EC2", "FARGATE"
|
2969
|
+
# resp.tasks[0].memory #=> String
|
2970
|
+
# resp.tasks[0].overrides.container_overrides #=> Array
|
2971
|
+
# resp.tasks[0].overrides.container_overrides[0].name #=> String
|
2972
|
+
# resp.tasks[0].overrides.container_overrides[0].command #=> Array
|
2973
|
+
# resp.tasks[0].overrides.container_overrides[0].command[0] #=> String
|
2974
|
+
# resp.tasks[0].overrides.container_overrides[0].environment #=> Array
|
2975
|
+
# resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
|
2976
|
+
# resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
|
2977
|
+
# resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
|
2978
|
+
# resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
|
2979
|
+
# resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
|
2980
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements #=> Array
|
2981
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].value #=> String
|
2982
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
|
2983
|
+
# resp.tasks[0].overrides.cpu #=> String
|
2984
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
|
2985
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
|
2986
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
|
2987
|
+
# resp.tasks[0].overrides.execution_role_arn #=> String
|
2988
|
+
# resp.tasks[0].overrides.memory #=> String
|
2989
|
+
# resp.tasks[0].overrides.task_role_arn #=> String
|
2972
2990
|
# resp.tasks[0].platform_version #=> String
|
2973
|
-
# resp.tasks[0].
|
2974
|
-
# resp.tasks[0].
|
2975
|
-
# resp.tasks[0].
|
2976
|
-
# resp.tasks[0].
|
2977
|
-
# resp.tasks[0].
|
2978
|
-
# resp.tasks[0].
|
2979
|
-
# resp.tasks[0].
|
2980
|
-
# resp.tasks[0].
|
2991
|
+
# resp.tasks[0].pull_started_at #=> Time
|
2992
|
+
# resp.tasks[0].pull_stopped_at #=> Time
|
2993
|
+
# resp.tasks[0].started_at #=> Time
|
2994
|
+
# resp.tasks[0].started_by #=> String
|
2995
|
+
# resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated"
|
2996
|
+
# resp.tasks[0].stopped_at #=> Time
|
2997
|
+
# resp.tasks[0].stopped_reason #=> String
|
2998
|
+
# resp.tasks[0].stopping_at #=> Time
|
2981
2999
|
# resp.tasks[0].tags #=> Array
|
2982
3000
|
# resp.tasks[0].tags[0].key #=> String
|
2983
3001
|
# resp.tasks[0].tags[0].value #=> String
|
2984
|
-
# resp.tasks[0].
|
2985
|
-
# resp.tasks[0].
|
2986
|
-
# resp.tasks[0].
|
3002
|
+
# resp.tasks[0].task_arn #=> String
|
3003
|
+
# resp.tasks[0].task_definition_arn #=> String
|
3004
|
+
# resp.tasks[0].version #=> Integer
|
2987
3005
|
# resp.failures #=> Array
|
2988
3006
|
# resp.failures[0].arn #=> String
|
2989
3007
|
# resp.failures[0].reason #=> String
|
3008
|
+
# resp.failures[0].detail #=> String
|
2990
3009
|
#
|
2991
3010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasks AWS API Documentation
|
2992
3011
|
#
|
@@ -3064,11 +3083,10 @@ module Aws::ECS
|
|
3064
3083
|
# settings are returned.
|
3065
3084
|
#
|
3066
3085
|
# @option params [String] :next_token
|
3067
|
-
# The `nextToken` value returned from a
|
3068
|
-
#
|
3069
|
-
#
|
3070
|
-
#
|
3071
|
-
# value.
|
3086
|
+
# The `nextToken` value returned from a `ListAccountSettings` request
|
3087
|
+
# indicating that more results are available to fulfill the request and
|
3088
|
+
# further calls will be needed. If `maxResults` was provided, it is
|
3089
|
+
# possible the number of results to be fewer than `maxResults`.
|
3072
3090
|
#
|
3073
3091
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
3074
3092
|
# to retrieve the next items in a list and not for other programmatic
|
@@ -3205,10 +3223,10 @@ module Aws::ECS
|
|
3205
3223
|
# specify an attribute name to use this parameter.
|
3206
3224
|
#
|
3207
3225
|
# @option params [String] :next_token
|
3208
|
-
# The `nextToken` value returned from a
|
3209
|
-
#
|
3210
|
-
#
|
3211
|
-
#
|
3226
|
+
# The `nextToken` value returned from a `ListAttributes` request
|
3227
|
+
# indicating that more results are available to fulfill the request and
|
3228
|
+
# further calls will be needed. If `maxResults` was provided, it is
|
3229
|
+
# possible the number of results to be fewer than `maxResults`.
|
3212
3230
|
#
|
3213
3231
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
3214
3232
|
# to retrieve the next items in a list and not for other programmatic
|
@@ -3263,10 +3281,10 @@ module Aws::ECS
|
|
3263
3281
|
# Returns a list of existing clusters.
|
3264
3282
|
#
|
3265
3283
|
# @option params [String] :next_token
|
3266
|
-
# The `nextToken` value returned from a
|
3267
|
-
#
|
3268
|
-
#
|
3269
|
-
#
|
3284
|
+
# The `nextToken` value returned from a `ListClusters` request
|
3285
|
+
# indicating that more results are available to fulfill the request and
|
3286
|
+
# further calls will be needed. If `maxResults` was provided, it is
|
3287
|
+
# possible the number of results to be fewer than `maxResults`.
|
3270
3288
|
#
|
3271
3289
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
3272
3290
|
# to retrieve the next items in a list and not for other programmatic
|
@@ -3353,11 +3371,10 @@ module Aws::ECS
|
|
3353
3371
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html
|
3354
3372
|
#
|
3355
3373
|
# @option params [String] :next_token
|
3356
|
-
# The `nextToken` value returned from a
|
3357
|
-
#
|
3358
|
-
#
|
3359
|
-
#
|
3360
|
-
# value.
|
3374
|
+
# The `nextToken` value returned from a `ListContainerInstances` request
|
3375
|
+
# indicating that more results are available to fulfill the request and
|
3376
|
+
# further calls will be needed. If `maxResults` was provided, it is
|
3377
|
+
# possible the number of results to be fewer than `maxResults`.
|
3361
3378
|
#
|
3362
3379
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
3363
3380
|
# to retrieve the next items in a list and not for other programmatic
|
@@ -3438,10 +3455,10 @@ module Aws::ECS
|
|
3438
3455
|
# default cluster is assumed.
|
3439
3456
|
#
|
3440
3457
|
# @option params [String] :next_token
|
3441
|
-
# The `nextToken` value returned from a
|
3442
|
-
#
|
3443
|
-
#
|
3444
|
-
#
|
3458
|
+
# The `nextToken` value returned from a `ListServices` request
|
3459
|
+
# indicating that more results are available to fulfill the request and
|
3460
|
+
# further calls will be needed. If `maxResults` was provided, it is
|
3461
|
+
# possible the number of results to be fewer than `maxResults`.
|
3445
3462
|
#
|
3446
3463
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
3447
3464
|
# to retrieve the next items in a list and not for other programmatic
|
@@ -3588,11 +3605,11 @@ module Aws::ECS
|
|
3588
3605
|
# subsequent request.
|
3589
3606
|
#
|
3590
3607
|
# @option params [String] :next_token
|
3591
|
-
# The `nextToken` value returned from a
|
3592
|
-
#
|
3593
|
-
#
|
3594
|
-
#
|
3595
|
-
#
|
3608
|
+
# The `nextToken` value returned from a `ListTaskDefinitionFamilies`
|
3609
|
+
# request indicating that more results are available to fulfill the
|
3610
|
+
# request and further calls will be needed. If `maxResults` was
|
3611
|
+
# provided, it is possible the number of results to be fewer than
|
3612
|
+
# `maxResults`.
|
3596
3613
|
#
|
3597
3614
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
3598
3615
|
# to retrieve the next items in a list and not for other programmatic
|
@@ -3702,11 +3719,10 @@ module Aws::ECS
|
|
3702
3719
|
# family are listed first.
|
3703
3720
|
#
|
3704
3721
|
# @option params [String] :next_token
|
3705
|
-
# The `nextToken` value returned from a
|
3706
|
-
#
|
3707
|
-
#
|
3708
|
-
#
|
3709
|
-
# value.
|
3722
|
+
# The `nextToken` value returned from a `ListTaskDefinitions` request
|
3723
|
+
# indicating that more results are available to fulfill the request and
|
3724
|
+
# further calls will be needed. If `maxResults` was provided, it is
|
3725
|
+
# possible the number of results to be fewer than `maxResults`.
|
3710
3726
|
#
|
3711
3727
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
3712
3728
|
# to retrieve the next items in a list and not for other programmatic
|
@@ -3819,10 +3835,10 @@ module Aws::ECS
|
|
3819
3835
|
# family.
|
3820
3836
|
#
|
3821
3837
|
# @option params [String] :next_token
|
3822
|
-
# The `nextToken` value returned from a
|
3823
|
-
#
|
3824
|
-
#
|
3825
|
-
# results
|
3838
|
+
# The `nextToken` value returned from a `ListTasks` request indicating
|
3839
|
+
# that more results are available to fulfill the request and further
|
3840
|
+
# calls will be needed. If `maxResults` was provided, it is possible the
|
3841
|
+
# number of results to be fewer than `maxResults`.
|
3826
3842
|
#
|
3827
3843
|
# <note markdown="1"> This token should be treated as an opaque identifier that is only used
|
3828
3844
|
# to retrieve the next items in a list and not for other programmatic
|
@@ -5072,6 +5088,9 @@ module Aws::ECS
|
|
5072
5088
|
# resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE"
|
5073
5089
|
# resp.task_definition.cpu #=> String
|
5074
5090
|
# resp.task_definition.memory #=> String
|
5091
|
+
# resp.task_definition.inference_accelerators #=> Array
|
5092
|
+
# resp.task_definition.inference_accelerators[0].device_name #=> String
|
5093
|
+
# resp.task_definition.inference_accelerators[0].device_type #=> String
|
5075
5094
|
# resp.task_definition.pid_mode #=> String, one of "host", "task"
|
5076
5095
|
# resp.task_definition.ipc_mode #=> String, one of "host", "task", "none"
|
5077
5096
|
# resp.task_definition.proxy_configuration.type #=> String, one of "APPMESH"
|
@@ -5133,10 +5152,43 @@ module Aws::ECS
|
|
5133
5152
|
# which to run your task. If you do not specify a cluster, the default
|
5134
5153
|
# cluster is assumed.
|
5135
5154
|
#
|
5136
|
-
# @option params [
|
5137
|
-
# The
|
5138
|
-
#
|
5139
|
-
#
|
5155
|
+
# @option params [Integer] :count
|
5156
|
+
# The number of instantiations of the specified task to place on your
|
5157
|
+
# cluster. You can specify up to 10 tasks per call.
|
5158
|
+
#
|
5159
|
+
# @option params [Boolean] :enable_ecs_managed_tags
|
5160
|
+
# Specifies whether to enable Amazon ECS managed tags for the task. For
|
5161
|
+
# more information, see [Tagging Your Amazon ECS Resources][1] in the
|
5162
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
5163
|
+
#
|
5164
|
+
#
|
5165
|
+
#
|
5166
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
5167
|
+
#
|
5168
|
+
# @option params [String] :group
|
5169
|
+
# The name of the task group to associate with the task. The default
|
5170
|
+
# value is the family name of the task definition (for example,
|
5171
|
+
# family:my-family-name).
|
5172
|
+
#
|
5173
|
+
# @option params [String] :launch_type
|
5174
|
+
# The launch type on which to run your task. For more information, see
|
5175
|
+
# [Amazon ECS Launch Types][1] in the *Amazon Elastic Container Service
|
5176
|
+
# Developer Guide*.
|
5177
|
+
#
|
5178
|
+
#
|
5179
|
+
#
|
5180
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
5181
|
+
#
|
5182
|
+
# @option params [Types::NetworkConfiguration] :network_configuration
|
5183
|
+
# The network configuration for the task. This parameter is required for
|
5184
|
+
# task definitions that use the `awsvpc` network mode to receive their
|
5185
|
+
# own elastic network interface, and it is not supported for other
|
5186
|
+
# network modes. For more information, see [Task Networking][1] in the
|
5187
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
5188
|
+
#
|
5189
|
+
#
|
5190
|
+
#
|
5191
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
|
5140
5192
|
#
|
5141
5193
|
# @option params [Types::TaskOverride] :overrides
|
5142
5194
|
# A list of container overrides in JSON format that specify the name of
|
@@ -5153,27 +5205,6 @@ module Aws::ECS
|
|
5153
5205
|
#
|
5154
5206
|
# </note>
|
5155
5207
|
#
|
5156
|
-
# @option params [Integer] :count
|
5157
|
-
# The number of instantiations of the specified task to place on your
|
5158
|
-
# cluster. You can specify up to 10 tasks per call.
|
5159
|
-
#
|
5160
|
-
# @option params [String] :started_by
|
5161
|
-
# An optional tag specified when a task is started. For example, if you
|
5162
|
-
# automatically trigger a task to run a batch process job, you could
|
5163
|
-
# apply a unique identifier for that job to your task with the
|
5164
|
-
# `startedBy` parameter. You can then identify which tasks belong to
|
5165
|
-
# that job by filtering the results of a ListTasks call with the
|
5166
|
-
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
5167
|
-
# numbers, hyphens, and underscores are allowed.
|
5168
|
-
#
|
5169
|
-
# If a task is started by an Amazon ECS service, then the `startedBy`
|
5170
|
-
# parameter contains the deployment ID of the service that starts it.
|
5171
|
-
#
|
5172
|
-
# @option params [String] :group
|
5173
|
-
# The name of the task group to associate with the task. The default
|
5174
|
-
# value is the family name of the task definition (for example,
|
5175
|
-
# family:my-family-name).
|
5176
|
-
#
|
5177
5208
|
# @option params [Array<Types::PlacementConstraint>] :placement_constraints
|
5178
5209
|
# An array of placement constraint objects to use for the task. You can
|
5179
5210
|
# specify up to 10 constraints per task (including constraints in the
|
@@ -5183,15 +5214,6 @@ module Aws::ECS
|
|
5183
5214
|
# The placement strategy objects to use for the task. You can specify a
|
5184
5215
|
# maximum of five strategy rules per task.
|
5185
5216
|
#
|
5186
|
-
# @option params [String] :launch_type
|
5187
|
-
# The launch type on which to run your task. For more information, see
|
5188
|
-
# [Amazon ECS Launch Types][1] in the *Amazon Elastic Container Service
|
5189
|
-
# Developer Guide*.
|
5190
|
-
#
|
5191
|
-
#
|
5192
|
-
#
|
5193
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
|
5194
|
-
#
|
5195
5217
|
# @option params [String] :platform_version
|
5196
5218
|
# The platform version the task should run. A platform version is only
|
5197
5219
|
# specified for tasks using the Fargate launch type. If one is not
|
@@ -5203,16 +5225,31 @@ module Aws::ECS
|
|
5203
5225
|
#
|
5204
5226
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
|
5205
5227
|
#
|
5206
|
-
# @option params [
|
5207
|
-
#
|
5208
|
-
# task
|
5209
|
-
#
|
5210
|
-
#
|
5211
|
-
# *Amazon Elastic Container Service Developer Guide*.
|
5228
|
+
# @option params [String] :propagate_tags
|
5229
|
+
# Specifies whether to propagate the tags from the task definition to
|
5230
|
+
# the task. If no value is specified, the tags are not propagated. Tags
|
5231
|
+
# can only be propagated to the task during task creation. To add tags
|
5232
|
+
# to a task after task creation, use the TagResource API action.
|
5212
5233
|
#
|
5234
|
+
# <note markdown="1"> An error will be received if you specify the `SERVICE` option when
|
5235
|
+
# running a task.
|
5213
5236
|
#
|
5237
|
+
# </note>
|
5214
5238
|
#
|
5215
|
-
#
|
5239
|
+
# @option params [String] :reference_id
|
5240
|
+
# The reference ID to use for the task.
|
5241
|
+
#
|
5242
|
+
# @option params [String] :started_by
|
5243
|
+
# An optional tag specified when a task is started. For example, if you
|
5244
|
+
# automatically trigger a task to run a batch process job, you could
|
5245
|
+
# apply a unique identifier for that job to your task with the
|
5246
|
+
# `startedBy` parameter. You can then identify which tasks belong to
|
5247
|
+
# that job by filtering the results of a ListTasks call with the
|
5248
|
+
# `startedBy` value. Up to 36 letters (uppercase and lowercase),
|
5249
|
+
# numbers, hyphens, and underscores are allowed.
|
5250
|
+
#
|
5251
|
+
# If a task is started by an Amazon ECS service, then the `startedBy`
|
5252
|
+
# parameter contains the deployment ID of the service that starts it.
|
5216
5253
|
#
|
5217
5254
|
# @option params [Array<Types::Tag>] :tags
|
5218
5255
|
# The metadata that you apply to the task to help you categorize and
|
@@ -5244,25 +5281,10 @@ module Aws::ECS
|
|
5244
5281
|
# Tags with this prefix do not count against your tags per resource
|
5245
5282
|
# limit.
|
5246
5283
|
#
|
5247
|
-
# @option params [
|
5248
|
-
#
|
5249
|
-
#
|
5250
|
-
#
|
5251
|
-
#
|
5252
|
-
#
|
5253
|
-
#
|
5254
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
5255
|
-
#
|
5256
|
-
# @option params [String] :propagate_tags
|
5257
|
-
# Specifies whether to propagate the tags from the task definition to
|
5258
|
-
# the task. If no value is specified, the tags are not propagated. Tags
|
5259
|
-
# can only be propagated to the task during task creation. To add tags
|
5260
|
-
# to a task after task creation, use the TagResource API action.
|
5261
|
-
#
|
5262
|
-
# <note markdown="1"> An error will be received if you specify the `SERVICE` option when
|
5263
|
-
# running a task.
|
5264
|
-
#
|
5265
|
-
# </note>
|
5284
|
+
# @option params [required, String] :task_definition
|
5285
|
+
# The `family` and `revision` (`family:revision`) or full ARN of the
|
5286
|
+
# task definition to run. If a `revision` is not specified, the latest
|
5287
|
+
# `ACTIVE` revision is used.
|
5266
5288
|
#
|
5267
5289
|
# @return [Types::RunTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5268
5290
|
#
|
@@ -5311,7 +5333,17 @@ module Aws::ECS
|
|
5311
5333
|
#
|
5312
5334
|
# resp = client.run_task({
|
5313
5335
|
# cluster: "String",
|
5314
|
-
#
|
5336
|
+
# count: 1,
|
5337
|
+
# enable_ecs_managed_tags: false,
|
5338
|
+
# group: "String",
|
5339
|
+
# launch_type: "EC2", # accepts EC2, FARGATE
|
5340
|
+
# network_configuration: {
|
5341
|
+
# awsvpc_configuration: {
|
5342
|
+
# subnets: ["String"], # required
|
5343
|
+
# security_groups: ["String"],
|
5344
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
5345
|
+
# },
|
5346
|
+
# },
|
5315
5347
|
# overrides: {
|
5316
5348
|
# container_overrides: [
|
5317
5349
|
# {
|
@@ -5334,18 +5366,17 @@ module Aws::ECS
|
|
5334
5366
|
# ],
|
5335
5367
|
# },
|
5336
5368
|
# ],
|
5369
|
+
# cpu: "String",
|
5337
5370
|
# inference_accelerator_overrides: [
|
5338
5371
|
# {
|
5339
5372
|
# device_name: "String",
|
5340
5373
|
# device_type: "String",
|
5341
5374
|
# },
|
5342
5375
|
# ],
|
5343
|
-
# task_role_arn: "String",
|
5344
5376
|
# execution_role_arn: "String",
|
5377
|
+
# memory: "String",
|
5378
|
+
# task_role_arn: "String",
|
5345
5379
|
# },
|
5346
|
-
# count: 1,
|
5347
|
-
# started_by: "String",
|
5348
|
-
# group: "String",
|
5349
5380
|
# placement_constraints: [
|
5350
5381
|
# {
|
5351
5382
|
# type: "distinctInstance", # accepts distinctInstance, memberOf
|
@@ -5358,54 +5389,39 @@ module Aws::ECS
|
|
5358
5389
|
# field: "String",
|
5359
5390
|
# },
|
5360
5391
|
# ],
|
5361
|
-
# launch_type: "EC2", # accepts EC2, FARGATE
|
5362
5392
|
# platform_version: "String",
|
5363
|
-
#
|
5364
|
-
#
|
5365
|
-
#
|
5366
|
-
# security_groups: ["String"],
|
5367
|
-
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
5368
|
-
# },
|
5369
|
-
# },
|
5393
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
5394
|
+
# reference_id: "String",
|
5395
|
+
# started_by: "String",
|
5370
5396
|
# tags: [
|
5371
5397
|
# {
|
5372
5398
|
# key: "TagKey",
|
5373
5399
|
# value: "TagValue",
|
5374
5400
|
# },
|
5375
5401
|
# ],
|
5376
|
-
#
|
5377
|
-
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
5402
|
+
# task_definition: "String", # required
|
5378
5403
|
# })
|
5379
5404
|
#
|
5380
5405
|
# @example Response structure
|
5381
5406
|
#
|
5382
5407
|
# resp.tasks #=> Array
|
5383
|
-
# resp.tasks[0].
|
5384
|
-
# resp.tasks[0].
|
5385
|
-
# resp.tasks[0].
|
5386
|
-
# resp.tasks[0].
|
5387
|
-
# resp.tasks[0].
|
5388
|
-
# resp.tasks[0].
|
5389
|
-
# resp.tasks[0].
|
5390
|
-
# resp.tasks[0].
|
5391
|
-
# resp.tasks[0].
|
5392
|
-
# resp.tasks[0].
|
5393
|
-
# resp.tasks[0].
|
5394
|
-
# resp.tasks[0].
|
5395
|
-
# resp.tasks[0].
|
5396
|
-
# resp.tasks[0].
|
5397
|
-
# resp.tasks[0].
|
5398
|
-
# resp.tasks[0].
|
5399
|
-
# resp.tasks[0].
|
5400
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
|
5401
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
|
5402
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
|
5403
|
-
# resp.tasks[0].overrides.task_role_arn #=> String
|
5404
|
-
# resp.tasks[0].overrides.execution_role_arn #=> String
|
5405
|
-
# resp.tasks[0].last_status #=> String
|
5406
|
-
# resp.tasks[0].desired_status #=> String
|
5407
|
-
# resp.tasks[0].cpu #=> String
|
5408
|
-
# resp.tasks[0].memory #=> String
|
5408
|
+
# resp.tasks[0].attachments #=> Array
|
5409
|
+
# resp.tasks[0].attachments[0].id #=> String
|
5410
|
+
# resp.tasks[0].attachments[0].type #=> String
|
5411
|
+
# resp.tasks[0].attachments[0].status #=> String
|
5412
|
+
# resp.tasks[0].attachments[0].details #=> Array
|
5413
|
+
# resp.tasks[0].attachments[0].details[0].name #=> String
|
5414
|
+
# resp.tasks[0].attachments[0].details[0].value #=> String
|
5415
|
+
# resp.tasks[0].attributes #=> Array
|
5416
|
+
# resp.tasks[0].attributes[0].name #=> String
|
5417
|
+
# resp.tasks[0].attributes[0].value #=> String
|
5418
|
+
# resp.tasks[0].attributes[0].target_type #=> String, one of "container-instance"
|
5419
|
+
# resp.tasks[0].attributes[0].target_id #=> String
|
5420
|
+
# resp.tasks[0].availability_zone #=> String
|
5421
|
+
# resp.tasks[0].cluster_arn #=> String
|
5422
|
+
# resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
|
5423
|
+
# resp.tasks[0].connectivity_at #=> Time
|
5424
|
+
# resp.tasks[0].container_instance_arn #=> String
|
5409
5425
|
# resp.tasks[0].containers #=> Array
|
5410
5426
|
# resp.tasks[0].containers[0].container_arn #=> String
|
5411
5427
|
# resp.tasks[0].containers[0].task_arn #=> String
|
@@ -5431,39 +5447,57 @@ module Aws::ECS
|
|
5431
5447
|
# resp.tasks[0].containers[0].memory_reservation #=> String
|
5432
5448
|
# resp.tasks[0].containers[0].gpu_ids #=> Array
|
5433
5449
|
# resp.tasks[0].containers[0].gpu_ids[0] #=> String
|
5434
|
-
# resp.tasks[0].
|
5435
|
-
# resp.tasks[0].version #=> Integer
|
5436
|
-
# resp.tasks[0].stopped_reason #=> String
|
5437
|
-
# resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated"
|
5438
|
-
# resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
|
5439
|
-
# resp.tasks[0].connectivity_at #=> Time
|
5440
|
-
# resp.tasks[0].pull_started_at #=> Time
|
5441
|
-
# resp.tasks[0].pull_stopped_at #=> Time
|
5442
|
-
# resp.tasks[0].execution_stopped_at #=> Time
|
5450
|
+
# resp.tasks[0].cpu #=> String
|
5443
5451
|
# resp.tasks[0].created_at #=> Time
|
5444
|
-
# resp.tasks[0].
|
5445
|
-
# resp.tasks[0].
|
5446
|
-
# resp.tasks[0].stopped_at #=> Time
|
5452
|
+
# resp.tasks[0].desired_status #=> String
|
5453
|
+
# resp.tasks[0].execution_stopped_at #=> Time
|
5447
5454
|
# resp.tasks[0].group #=> String
|
5455
|
+
# resp.tasks[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
|
5456
|
+
# resp.tasks[0].inference_accelerators #=> Array
|
5457
|
+
# resp.tasks[0].inference_accelerators[0].device_name #=> String
|
5458
|
+
# resp.tasks[0].inference_accelerators[0].device_type #=> String
|
5459
|
+
# resp.tasks[0].last_status #=> String
|
5448
5460
|
# resp.tasks[0].launch_type #=> String, one of "EC2", "FARGATE"
|
5461
|
+
# resp.tasks[0].memory #=> String
|
5462
|
+
# resp.tasks[0].overrides.container_overrides #=> Array
|
5463
|
+
# resp.tasks[0].overrides.container_overrides[0].name #=> String
|
5464
|
+
# resp.tasks[0].overrides.container_overrides[0].command #=> Array
|
5465
|
+
# resp.tasks[0].overrides.container_overrides[0].command[0] #=> String
|
5466
|
+
# resp.tasks[0].overrides.container_overrides[0].environment #=> Array
|
5467
|
+
# resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
|
5468
|
+
# resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
|
5469
|
+
# resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
|
5470
|
+
# resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
|
5471
|
+
# resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
|
5472
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements #=> Array
|
5473
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].value #=> String
|
5474
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
|
5475
|
+
# resp.tasks[0].overrides.cpu #=> String
|
5476
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
|
5477
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
|
5478
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
|
5479
|
+
# resp.tasks[0].overrides.execution_role_arn #=> String
|
5480
|
+
# resp.tasks[0].overrides.memory #=> String
|
5481
|
+
# resp.tasks[0].overrides.task_role_arn #=> String
|
5449
5482
|
# resp.tasks[0].platform_version #=> String
|
5450
|
-
# resp.tasks[0].
|
5451
|
-
# resp.tasks[0].
|
5452
|
-
# resp.tasks[0].
|
5453
|
-
# resp.tasks[0].
|
5454
|
-
# resp.tasks[0].
|
5455
|
-
# resp.tasks[0].
|
5456
|
-
# resp.tasks[0].
|
5457
|
-
# resp.tasks[0].
|
5483
|
+
# resp.tasks[0].pull_started_at #=> Time
|
5484
|
+
# resp.tasks[0].pull_stopped_at #=> Time
|
5485
|
+
# resp.tasks[0].started_at #=> Time
|
5486
|
+
# resp.tasks[0].started_by #=> String
|
5487
|
+
# resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated"
|
5488
|
+
# resp.tasks[0].stopped_at #=> Time
|
5489
|
+
# resp.tasks[0].stopped_reason #=> String
|
5490
|
+
# resp.tasks[0].stopping_at #=> Time
|
5458
5491
|
# resp.tasks[0].tags #=> Array
|
5459
5492
|
# resp.tasks[0].tags[0].key #=> String
|
5460
5493
|
# resp.tasks[0].tags[0].value #=> String
|
5461
|
-
# resp.tasks[0].
|
5462
|
-
# resp.tasks[0].
|
5463
|
-
# resp.tasks[0].
|
5494
|
+
# resp.tasks[0].task_arn #=> String
|
5495
|
+
# resp.tasks[0].task_definition_arn #=> String
|
5496
|
+
# resp.tasks[0].version #=> Integer
|
5464
5497
|
# resp.failures #=> Array
|
5465
5498
|
# resp.failures[0].arn #=> String
|
5466
5499
|
# resp.failures[0].reason #=> String
|
5500
|
+
# resp.failures[0].detail #=> String
|
5467
5501
|
#
|
5468
5502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTask AWS API Documentation
|
5469
5503
|
#
|
@@ -5490,10 +5524,29 @@ module Aws::ECS
|
|
5490
5524
|
# which to start your task. If you do not specify a cluster, the default
|
5491
5525
|
# cluster is assumed.
|
5492
5526
|
#
|
5493
|
-
# @option params [required, String] :
|
5494
|
-
# The
|
5495
|
-
#
|
5496
|
-
#
|
5527
|
+
# @option params [required, Array<String>] :container_instances
|
5528
|
+
# The container instance IDs or full ARN entries for the container
|
5529
|
+
# instances on which you would like to place your task. You can specify
|
5530
|
+
# up to 10 container instances.
|
5531
|
+
#
|
5532
|
+
# @option params [Boolean] :enable_ecs_managed_tags
|
5533
|
+
# Specifies whether to enable Amazon ECS managed tags for the task. For
|
5534
|
+
# more information, see [Tagging Your Amazon ECS Resources][1] in the
|
5535
|
+
# *Amazon Elastic Container Service Developer Guide*.
|
5536
|
+
#
|
5537
|
+
#
|
5538
|
+
#
|
5539
|
+
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
5540
|
+
#
|
5541
|
+
# @option params [String] :group
|
5542
|
+
# The name of the task group to associate with the task. The default
|
5543
|
+
# value is the family name of the task definition (for example,
|
5544
|
+
# family:my-family-name).
|
5545
|
+
#
|
5546
|
+
# @option params [Types::NetworkConfiguration] :network_configuration
|
5547
|
+
# The VPC subnet and security group configuration for tasks that receive
|
5548
|
+
# their own elastic network interface by using the `awsvpc` networking
|
5549
|
+
# mode.
|
5497
5550
|
#
|
5498
5551
|
# @option params [Types::TaskOverride] :overrides
|
5499
5552
|
# A list of container overrides in JSON format that specify the name of
|
@@ -5510,10 +5563,13 @@ module Aws::ECS
|
|
5510
5563
|
#
|
5511
5564
|
# </note>
|
5512
5565
|
#
|
5513
|
-
# @option params [
|
5514
|
-
#
|
5515
|
-
#
|
5516
|
-
#
|
5566
|
+
# @option params [String] :propagate_tags
|
5567
|
+
# Specifies whether to propagate the tags from the task definition or
|
5568
|
+
# the service to the task. If no value is specified, the tags are not
|
5569
|
+
# propagated.
|
5570
|
+
#
|
5571
|
+
# @option params [String] :reference_id
|
5572
|
+
# The reference ID to use for the task.
|
5517
5573
|
#
|
5518
5574
|
# @option params [String] :started_by
|
5519
5575
|
# An optional tag specified when a task is started. For example, if you
|
@@ -5527,16 +5583,6 @@ module Aws::ECS
|
|
5527
5583
|
# If a task is started by an Amazon ECS service, then the `startedBy`
|
5528
5584
|
# parameter contains the deployment ID of the service that starts it.
|
5529
5585
|
#
|
5530
|
-
# @option params [String] :group
|
5531
|
-
# The name of the task group to associate with the task. The default
|
5532
|
-
# value is the family name of the task definition (for example,
|
5533
|
-
# family:my-family-name).
|
5534
|
-
#
|
5535
|
-
# @option params [Types::NetworkConfiguration] :network_configuration
|
5536
|
-
# The VPC subnet and security group configuration for tasks that receive
|
5537
|
-
# their own elastic network interface by using the `awsvpc` networking
|
5538
|
-
# mode.
|
5539
|
-
#
|
5540
5586
|
# @option params [Array<Types::Tag>] :tags
|
5541
5587
|
# The metadata that you apply to the task to help you categorize and
|
5542
5588
|
# organize them. Each tag consists of a key and an optional value, both
|
@@ -5567,19 +5613,10 @@ module Aws::ECS
|
|
5567
5613
|
# Tags with this prefix do not count against your tags per resource
|
5568
5614
|
# limit.
|
5569
5615
|
#
|
5570
|
-
# @option params [
|
5571
|
-
#
|
5572
|
-
#
|
5573
|
-
#
|
5574
|
-
#
|
5575
|
-
#
|
5576
|
-
#
|
5577
|
-
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html
|
5578
|
-
#
|
5579
|
-
# @option params [String] :propagate_tags
|
5580
|
-
# Specifies whether to propagate the tags from the task definition or
|
5581
|
-
# the service to the task. If no value is specified, the tags are not
|
5582
|
-
# propagated.
|
5616
|
+
# @option params [required, String] :task_definition
|
5617
|
+
# The `family` and `revision` (`family:revision`) or full ARN of the
|
5618
|
+
# task definition to start. If a `revision` is not specified, the latest
|
5619
|
+
# `ACTIVE` revision is used.
|
5583
5620
|
#
|
5584
5621
|
# @return [Types::StartTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5585
5622
|
#
|
@@ -5590,7 +5627,16 @@ module Aws::ECS
|
|
5590
5627
|
#
|
5591
5628
|
# resp = client.start_task({
|
5592
5629
|
# cluster: "String",
|
5593
|
-
#
|
5630
|
+
# container_instances: ["String"], # required
|
5631
|
+
# enable_ecs_managed_tags: false,
|
5632
|
+
# group: "String",
|
5633
|
+
# network_configuration: {
|
5634
|
+
# awsvpc_configuration: {
|
5635
|
+
# subnets: ["String"], # required
|
5636
|
+
# security_groups: ["String"],
|
5637
|
+
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
5638
|
+
# },
|
5639
|
+
# },
|
5594
5640
|
# overrides: {
|
5595
5641
|
# container_overrides: [
|
5596
5642
|
# {
|
@@ -5613,64 +5659,49 @@ module Aws::ECS
|
|
5613
5659
|
# ],
|
5614
5660
|
# },
|
5615
5661
|
# ],
|
5662
|
+
# cpu: "String",
|
5616
5663
|
# inference_accelerator_overrides: [
|
5617
5664
|
# {
|
5618
5665
|
# device_name: "String",
|
5619
5666
|
# device_type: "String",
|
5620
5667
|
# },
|
5621
5668
|
# ],
|
5622
|
-
# task_role_arn: "String",
|
5623
5669
|
# execution_role_arn: "String",
|
5670
|
+
# memory: "String",
|
5671
|
+
# task_role_arn: "String",
|
5624
5672
|
# },
|
5625
|
-
#
|
5673
|
+
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
5674
|
+
# reference_id: "String",
|
5626
5675
|
# started_by: "String",
|
5627
|
-
# group: "String",
|
5628
|
-
# network_configuration: {
|
5629
|
-
# awsvpc_configuration: {
|
5630
|
-
# subnets: ["String"], # required
|
5631
|
-
# security_groups: ["String"],
|
5632
|
-
# assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
|
5633
|
-
# },
|
5634
|
-
# },
|
5635
5676
|
# tags: [
|
5636
5677
|
# {
|
5637
5678
|
# key: "TagKey",
|
5638
5679
|
# value: "TagValue",
|
5639
5680
|
# },
|
5640
5681
|
# ],
|
5641
|
-
#
|
5642
|
-
# propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE
|
5682
|
+
# task_definition: "String", # required
|
5643
5683
|
# })
|
5644
5684
|
#
|
5645
5685
|
# @example Response structure
|
5646
5686
|
#
|
5647
5687
|
# resp.tasks #=> Array
|
5648
|
-
# resp.tasks[0].
|
5688
|
+
# resp.tasks[0].attachments #=> Array
|
5689
|
+
# resp.tasks[0].attachments[0].id #=> String
|
5690
|
+
# resp.tasks[0].attachments[0].type #=> String
|
5691
|
+
# resp.tasks[0].attachments[0].status #=> String
|
5692
|
+
# resp.tasks[0].attachments[0].details #=> Array
|
5693
|
+
# resp.tasks[0].attachments[0].details[0].name #=> String
|
5694
|
+
# resp.tasks[0].attachments[0].details[0].value #=> String
|
5695
|
+
# resp.tasks[0].attributes #=> Array
|
5696
|
+
# resp.tasks[0].attributes[0].name #=> String
|
5697
|
+
# resp.tasks[0].attributes[0].value #=> String
|
5698
|
+
# resp.tasks[0].attributes[0].target_type #=> String, one of "container-instance"
|
5699
|
+
# resp.tasks[0].attributes[0].target_id #=> String
|
5700
|
+
# resp.tasks[0].availability_zone #=> String
|
5649
5701
|
# resp.tasks[0].cluster_arn #=> String
|
5650
|
-
# resp.tasks[0].
|
5702
|
+
# resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
|
5703
|
+
# resp.tasks[0].connectivity_at #=> Time
|
5651
5704
|
# resp.tasks[0].container_instance_arn #=> String
|
5652
|
-
# resp.tasks[0].overrides.container_overrides #=> Array
|
5653
|
-
# resp.tasks[0].overrides.container_overrides[0].name #=> String
|
5654
|
-
# resp.tasks[0].overrides.container_overrides[0].command #=> Array
|
5655
|
-
# resp.tasks[0].overrides.container_overrides[0].command[0] #=> String
|
5656
|
-
# resp.tasks[0].overrides.container_overrides[0].environment #=> Array
|
5657
|
-
# resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
|
5658
|
-
# resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
|
5659
|
-
# resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
|
5660
|
-
# resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
|
5661
|
-
# resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
|
5662
|
-
# resp.tasks[0].overrides.container_overrides[0].resource_requirements #=> Array
|
5663
|
-
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].value #=> String
|
5664
|
-
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
|
5665
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
|
5666
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
|
5667
|
-
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
|
5668
|
-
# resp.tasks[0].overrides.task_role_arn #=> String
|
5669
|
-
# resp.tasks[0].overrides.execution_role_arn #=> String
|
5670
|
-
# resp.tasks[0].last_status #=> String
|
5671
|
-
# resp.tasks[0].desired_status #=> String
|
5672
|
-
# resp.tasks[0].cpu #=> String
|
5673
|
-
# resp.tasks[0].memory #=> String
|
5674
5705
|
# resp.tasks[0].containers #=> Array
|
5675
5706
|
# resp.tasks[0].containers[0].container_arn #=> String
|
5676
5707
|
# resp.tasks[0].containers[0].task_arn #=> String
|
@@ -5696,39 +5727,57 @@ module Aws::ECS
|
|
5696
5727
|
# resp.tasks[0].containers[0].memory_reservation #=> String
|
5697
5728
|
# resp.tasks[0].containers[0].gpu_ids #=> Array
|
5698
5729
|
# resp.tasks[0].containers[0].gpu_ids[0] #=> String
|
5699
|
-
# resp.tasks[0].
|
5700
|
-
# resp.tasks[0].version #=> Integer
|
5701
|
-
# resp.tasks[0].stopped_reason #=> String
|
5702
|
-
# resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated"
|
5703
|
-
# resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
|
5704
|
-
# resp.tasks[0].connectivity_at #=> Time
|
5705
|
-
# resp.tasks[0].pull_started_at #=> Time
|
5706
|
-
# resp.tasks[0].pull_stopped_at #=> Time
|
5707
|
-
# resp.tasks[0].execution_stopped_at #=> Time
|
5730
|
+
# resp.tasks[0].cpu #=> String
|
5708
5731
|
# resp.tasks[0].created_at #=> Time
|
5709
|
-
# resp.tasks[0].
|
5710
|
-
# resp.tasks[0].
|
5711
|
-
# resp.tasks[0].stopped_at #=> Time
|
5732
|
+
# resp.tasks[0].desired_status #=> String
|
5733
|
+
# resp.tasks[0].execution_stopped_at #=> Time
|
5712
5734
|
# resp.tasks[0].group #=> String
|
5735
|
+
# resp.tasks[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
|
5736
|
+
# resp.tasks[0].inference_accelerators #=> Array
|
5737
|
+
# resp.tasks[0].inference_accelerators[0].device_name #=> String
|
5738
|
+
# resp.tasks[0].inference_accelerators[0].device_type #=> String
|
5739
|
+
# resp.tasks[0].last_status #=> String
|
5713
5740
|
# resp.tasks[0].launch_type #=> String, one of "EC2", "FARGATE"
|
5741
|
+
# resp.tasks[0].memory #=> String
|
5742
|
+
# resp.tasks[0].overrides.container_overrides #=> Array
|
5743
|
+
# resp.tasks[0].overrides.container_overrides[0].name #=> String
|
5744
|
+
# resp.tasks[0].overrides.container_overrides[0].command #=> Array
|
5745
|
+
# resp.tasks[0].overrides.container_overrides[0].command[0] #=> String
|
5746
|
+
# resp.tasks[0].overrides.container_overrides[0].environment #=> Array
|
5747
|
+
# resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
|
5748
|
+
# resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
|
5749
|
+
# resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
|
5750
|
+
# resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
|
5751
|
+
# resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
|
5752
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements #=> Array
|
5753
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].value #=> String
|
5754
|
+
# resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
|
5755
|
+
# resp.tasks[0].overrides.cpu #=> String
|
5756
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
|
5757
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
|
5758
|
+
# resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
|
5759
|
+
# resp.tasks[0].overrides.execution_role_arn #=> String
|
5760
|
+
# resp.tasks[0].overrides.memory #=> String
|
5761
|
+
# resp.tasks[0].overrides.task_role_arn #=> String
|
5714
5762
|
# resp.tasks[0].platform_version #=> String
|
5715
|
-
# resp.tasks[0].
|
5716
|
-
# resp.tasks[0].
|
5717
|
-
# resp.tasks[0].
|
5718
|
-
# resp.tasks[0].
|
5719
|
-
# resp.tasks[0].
|
5720
|
-
# resp.tasks[0].
|
5721
|
-
# resp.tasks[0].
|
5722
|
-
# resp.tasks[0].
|
5763
|
+
# resp.tasks[0].pull_started_at #=> Time
|
5764
|
+
# resp.tasks[0].pull_stopped_at #=> Time
|
5765
|
+
# resp.tasks[0].started_at #=> Time
|
5766
|
+
# resp.tasks[0].started_by #=> String
|
5767
|
+
# resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated"
|
5768
|
+
# resp.tasks[0].stopped_at #=> Time
|
5769
|
+
# resp.tasks[0].stopped_reason #=> String
|
5770
|
+
# resp.tasks[0].stopping_at #=> Time
|
5723
5771
|
# resp.tasks[0].tags #=> Array
|
5724
5772
|
# resp.tasks[0].tags[0].key #=> String
|
5725
5773
|
# resp.tasks[0].tags[0].value #=> String
|
5726
|
-
# resp.tasks[0].
|
5727
|
-
# resp.tasks[0].
|
5728
|
-
# resp.tasks[0].
|
5774
|
+
# resp.tasks[0].task_arn #=> String
|
5775
|
+
# resp.tasks[0].task_definition_arn #=> String
|
5776
|
+
# resp.tasks[0].version #=> Integer
|
5729
5777
|
# resp.failures #=> Array
|
5730
5778
|
# resp.failures[0].arn #=> String
|
5731
5779
|
# resp.failures[0].reason #=> String
|
5780
|
+
# resp.failures[0].detail #=> String
|
5732
5781
|
#
|
5733
5782
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTask AWS API Documentation
|
5734
5783
|
#
|
@@ -5789,32 +5838,23 @@ module Aws::ECS
|
|
5789
5838
|
#
|
5790
5839
|
# @example Response structure
|
5791
5840
|
#
|
5792
|
-
# resp.task.
|
5841
|
+
# resp.task.attachments #=> Array
|
5842
|
+
# resp.task.attachments[0].id #=> String
|
5843
|
+
# resp.task.attachments[0].type #=> String
|
5844
|
+
# resp.task.attachments[0].status #=> String
|
5845
|
+
# resp.task.attachments[0].details #=> Array
|
5846
|
+
# resp.task.attachments[0].details[0].name #=> String
|
5847
|
+
# resp.task.attachments[0].details[0].value #=> String
|
5848
|
+
# resp.task.attributes #=> Array
|
5849
|
+
# resp.task.attributes[0].name #=> String
|
5850
|
+
# resp.task.attributes[0].value #=> String
|
5851
|
+
# resp.task.attributes[0].target_type #=> String, one of "container-instance"
|
5852
|
+
# resp.task.attributes[0].target_id #=> String
|
5853
|
+
# resp.task.availability_zone #=> String
|
5793
5854
|
# resp.task.cluster_arn #=> String
|
5794
|
-
# resp.task.
|
5855
|
+
# resp.task.connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
|
5856
|
+
# resp.task.connectivity_at #=> Time
|
5795
5857
|
# resp.task.container_instance_arn #=> String
|
5796
|
-
# resp.task.overrides.container_overrides #=> Array
|
5797
|
-
# resp.task.overrides.container_overrides[0].name #=> String
|
5798
|
-
# resp.task.overrides.container_overrides[0].command #=> Array
|
5799
|
-
# resp.task.overrides.container_overrides[0].command[0] #=> String
|
5800
|
-
# resp.task.overrides.container_overrides[0].environment #=> Array
|
5801
|
-
# resp.task.overrides.container_overrides[0].environment[0].name #=> String
|
5802
|
-
# resp.task.overrides.container_overrides[0].environment[0].value #=> String
|
5803
|
-
# resp.task.overrides.container_overrides[0].cpu #=> Integer
|
5804
|
-
# resp.task.overrides.container_overrides[0].memory #=> Integer
|
5805
|
-
# resp.task.overrides.container_overrides[0].memory_reservation #=> Integer
|
5806
|
-
# resp.task.overrides.container_overrides[0].resource_requirements #=> Array
|
5807
|
-
# resp.task.overrides.container_overrides[0].resource_requirements[0].value #=> String
|
5808
|
-
# resp.task.overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
|
5809
|
-
# resp.task.overrides.inference_accelerator_overrides #=> Array
|
5810
|
-
# resp.task.overrides.inference_accelerator_overrides[0].device_name #=> String
|
5811
|
-
# resp.task.overrides.inference_accelerator_overrides[0].device_type #=> String
|
5812
|
-
# resp.task.overrides.task_role_arn #=> String
|
5813
|
-
# resp.task.overrides.execution_role_arn #=> String
|
5814
|
-
# resp.task.last_status #=> String
|
5815
|
-
# resp.task.desired_status #=> String
|
5816
|
-
# resp.task.cpu #=> String
|
5817
|
-
# resp.task.memory #=> String
|
5818
5858
|
# resp.task.containers #=> Array
|
5819
5859
|
# resp.task.containers[0].container_arn #=> String
|
5820
5860
|
# resp.task.containers[0].task_arn #=> String
|
@@ -5840,36 +5880,53 @@ module Aws::ECS
|
|
5840
5880
|
# resp.task.containers[0].memory_reservation #=> String
|
5841
5881
|
# resp.task.containers[0].gpu_ids #=> Array
|
5842
5882
|
# resp.task.containers[0].gpu_ids[0] #=> String
|
5843
|
-
# resp.task.
|
5844
|
-
# resp.task.version #=> Integer
|
5845
|
-
# resp.task.stopped_reason #=> String
|
5846
|
-
# resp.task.stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated"
|
5847
|
-
# resp.task.connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
|
5848
|
-
# resp.task.connectivity_at #=> Time
|
5849
|
-
# resp.task.pull_started_at #=> Time
|
5850
|
-
# resp.task.pull_stopped_at #=> Time
|
5851
|
-
# resp.task.execution_stopped_at #=> Time
|
5883
|
+
# resp.task.cpu #=> String
|
5852
5884
|
# resp.task.created_at #=> Time
|
5853
|
-
# resp.task.
|
5854
|
-
# resp.task.
|
5855
|
-
# resp.task.stopped_at #=> Time
|
5885
|
+
# resp.task.desired_status #=> String
|
5886
|
+
# resp.task.execution_stopped_at #=> Time
|
5856
5887
|
# resp.task.group #=> String
|
5888
|
+
# resp.task.health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
|
5889
|
+
# resp.task.inference_accelerators #=> Array
|
5890
|
+
# resp.task.inference_accelerators[0].device_name #=> String
|
5891
|
+
# resp.task.inference_accelerators[0].device_type #=> String
|
5892
|
+
# resp.task.last_status #=> String
|
5857
5893
|
# resp.task.launch_type #=> String, one of "EC2", "FARGATE"
|
5894
|
+
# resp.task.memory #=> String
|
5895
|
+
# resp.task.overrides.container_overrides #=> Array
|
5896
|
+
# resp.task.overrides.container_overrides[0].name #=> String
|
5897
|
+
# resp.task.overrides.container_overrides[0].command #=> Array
|
5898
|
+
# resp.task.overrides.container_overrides[0].command[0] #=> String
|
5899
|
+
# resp.task.overrides.container_overrides[0].environment #=> Array
|
5900
|
+
# resp.task.overrides.container_overrides[0].environment[0].name #=> String
|
5901
|
+
# resp.task.overrides.container_overrides[0].environment[0].value #=> String
|
5902
|
+
# resp.task.overrides.container_overrides[0].cpu #=> Integer
|
5903
|
+
# resp.task.overrides.container_overrides[0].memory #=> Integer
|
5904
|
+
# resp.task.overrides.container_overrides[0].memory_reservation #=> Integer
|
5905
|
+
# resp.task.overrides.container_overrides[0].resource_requirements #=> Array
|
5906
|
+
# resp.task.overrides.container_overrides[0].resource_requirements[0].value #=> String
|
5907
|
+
# resp.task.overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
|
5908
|
+
# resp.task.overrides.cpu #=> String
|
5909
|
+
# resp.task.overrides.inference_accelerator_overrides #=> Array
|
5910
|
+
# resp.task.overrides.inference_accelerator_overrides[0].device_name #=> String
|
5911
|
+
# resp.task.overrides.inference_accelerator_overrides[0].device_type #=> String
|
5912
|
+
# resp.task.overrides.execution_role_arn #=> String
|
5913
|
+
# resp.task.overrides.memory #=> String
|
5914
|
+
# resp.task.overrides.task_role_arn #=> String
|
5858
5915
|
# resp.task.platform_version #=> String
|
5859
|
-
# resp.task.
|
5860
|
-
# resp.task.
|
5861
|
-
# resp.task.
|
5862
|
-
# resp.task.
|
5863
|
-
# resp.task.
|
5864
|
-
# resp.task.
|
5865
|
-
# resp.task.
|
5866
|
-
# resp.task.
|
5916
|
+
# resp.task.pull_started_at #=> Time
|
5917
|
+
# resp.task.pull_stopped_at #=> Time
|
5918
|
+
# resp.task.started_at #=> Time
|
5919
|
+
# resp.task.started_by #=> String
|
5920
|
+
# resp.task.stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated"
|
5921
|
+
# resp.task.stopped_at #=> Time
|
5922
|
+
# resp.task.stopped_reason #=> String
|
5923
|
+
# resp.task.stopping_at #=> Time
|
5867
5924
|
# resp.task.tags #=> Array
|
5868
5925
|
# resp.task.tags[0].key #=> String
|
5869
5926
|
# resp.task.tags[0].value #=> String
|
5870
|
-
# resp.task.
|
5871
|
-
# resp.task.
|
5872
|
-
# resp.task.
|
5927
|
+
# resp.task.task_arn #=> String
|
5928
|
+
# resp.task.task_definition_arn #=> String
|
5929
|
+
# resp.task.version #=> Integer
|
5873
5930
|
#
|
5874
5931
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTask AWS API Documentation
|
5875
5932
|
#
|
@@ -6488,6 +6545,7 @@ module Aws::ECS
|
|
6488
6545
|
# resp.failures #=> Array
|
6489
6546
|
# resp.failures[0].arn #=> String
|
6490
6547
|
# resp.failures[0].reason #=> String
|
6548
|
+
# resp.failures[0].detail #=> String
|
6491
6549
|
#
|
6492
6550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesState AWS API Documentation
|
6493
6551
|
#
|
@@ -7029,7 +7087,7 @@ module Aws::ECS
|
|
7029
7087
|
params: params,
|
7030
7088
|
config: config)
|
7031
7089
|
context[:gem_name] = 'aws-sdk-ecs'
|
7032
|
-
context[:gem_version] = '1.
|
7090
|
+
context[:gem_version] = '1.53.0'
|
7033
7091
|
Seahorse::Client::Request.new(handlers, context)
|
7034
7092
|
end
|
7035
7093
|
|