aws-sdk-batch 1.34.0 → 1.39.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-batch.rb +3 -2
- data/lib/aws-sdk-batch/client.rb +423 -10
- data/lib/aws-sdk-batch/client_api.rb +113 -0
- data/lib/aws-sdk-batch/types.rb +862 -38
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c9d1f3bee1c2ae962471ae5e36621c438f97c3a01ae72f26c14fff3cd417e633
|
4
|
+
data.tar.gz: 6842de9983e5c5eaab81d6ab6fb0d59e047a8f877fd7cfd2760358ecada98f06
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0de77874e7ebef2a58f72ea4f8b46d6805e1ec1f8ce0f2a9da6f994be42120ba96e6ac6bdea7c2bfb180e5918079185c7c5160aeae50b984e47fa15e3fa2a1a7
|
7
|
+
data.tar.gz: 4227fd39f6413d8959116688ba515720df881e21e512b64ca1bd78602f5cebcbc71a12c03d12e209a9de2b7ee98f881779f553adeee51dbc3b557b7f98766d5a
|
data/lib/aws-sdk-batch.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-batch/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::Batch
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.39.0'
|
51
52
|
|
52
53
|
end
|
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -85,13 +85,28 @@ module Aws::Batch
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::Batch
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -455,6 +470,22 @@ module Aws::Batch
|
|
455
470
|
#
|
456
471
|
# </note>
|
457
472
|
#
|
473
|
+
# @option params [Hash<String,String>] :tags
|
474
|
+
# The tags that you apply to the compute environment to help you
|
475
|
+
# categorize and organize your resources. Each tag consists of a key and
|
476
|
+
# an optional value. For more information, see [Tagging AWS
|
477
|
+
# Resources][1] in *AWS General Reference*.
|
478
|
+
#
|
479
|
+
# These tags can be updated or removed using the [TagResource][2] and
|
480
|
+
# [UntagResource][3] API operations. These tags do not propagate to the
|
481
|
+
# underlying compute resources.
|
482
|
+
#
|
483
|
+
#
|
484
|
+
#
|
485
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
486
|
+
# [2]: https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html
|
487
|
+
# [3]: https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html
|
488
|
+
#
|
458
489
|
# @return [Types::CreateComputeEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
459
490
|
#
|
460
491
|
# * {Types::CreateComputeEnvironmentResponse#compute_environment_name #compute_environment_name} => String
|
@@ -578,6 +609,9 @@ module Aws::Batch
|
|
578
609
|
# },
|
579
610
|
# },
|
580
611
|
# service_role: "String", # required
|
612
|
+
# tags: {
|
613
|
+
# "TagKey" => "TagValue",
|
614
|
+
# },
|
581
615
|
# })
|
582
616
|
#
|
583
617
|
# @example Response structure
|
@@ -609,7 +643,9 @@ module Aws::Batch
|
|
609
643
|
#
|
610
644
|
# @option params [String] :state
|
611
645
|
# The state of the job queue. If the job queue state is `ENABLED`, it is
|
612
|
-
# able to accept jobs.
|
646
|
+
# able to accept jobs. If the job queue state is `DISABLED`, new jobs
|
647
|
+
# cannot be added to the queue, but jobs already in the queue can
|
648
|
+
# finish.
|
613
649
|
#
|
614
650
|
# @option params [required, Integer] :priority
|
615
651
|
# The priority of the job queue. Job queues with a higher priority (or a
|
@@ -627,6 +663,16 @@ module Aws::Batch
|
|
627
663
|
# associate them with a job queue. You can associate up to three compute
|
628
664
|
# environments with a job queue.
|
629
665
|
#
|
666
|
+
# @option params [Hash<String,String>] :tags
|
667
|
+
# The tags that you apply to the job queue to help you categorize and
|
668
|
+
# organize your resources. Each tag consists of a key and an optional
|
669
|
+
# value. For more information, see [Tagging AWS Resources][1] in *AWS
|
670
|
+
# General Reference*.
|
671
|
+
#
|
672
|
+
#
|
673
|
+
#
|
674
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
675
|
+
#
|
630
676
|
# @return [Types::CreateJobQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
631
677
|
#
|
632
678
|
# * {Types::CreateJobQueueResponse#job_queue_name #job_queue_name} => String
|
@@ -694,6 +740,9 @@ module Aws::Batch
|
|
694
740
|
# compute_environment: "String", # required
|
695
741
|
# },
|
696
742
|
# ],
|
743
|
+
# tags: {
|
744
|
+
# "TagKey" => "TagValue",
|
745
|
+
# },
|
697
746
|
# })
|
698
747
|
#
|
699
748
|
# @example Response structure
|
@@ -934,6 +983,8 @@ module Aws::Batch
|
|
934
983
|
# resp.compute_environments[0].compute_environment_name #=> String
|
935
984
|
# resp.compute_environments[0].compute_environment_arn #=> String
|
936
985
|
# resp.compute_environments[0].ecs_cluster_arn #=> String
|
986
|
+
# resp.compute_environments[0].tags #=> Hash
|
987
|
+
# resp.compute_environments[0].tags["TagKey"] #=> String
|
937
988
|
# resp.compute_environments[0].type #=> String, one of "MANAGED", "UNMANAGED"
|
938
989
|
# resp.compute_environments[0].state #=> String, one of "ENABLED", "DISABLED"
|
939
990
|
# resp.compute_environments[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID"
|
@@ -1082,6 +1133,7 @@ module Aws::Batch
|
|
1082
1133
|
# resp.job_definitions[0].container_properties.command #=> Array
|
1083
1134
|
# resp.job_definitions[0].container_properties.command[0] #=> String
|
1084
1135
|
# resp.job_definitions[0].container_properties.job_role_arn #=> String
|
1136
|
+
# resp.job_definitions[0].container_properties.execution_role_arn #=> String
|
1085
1137
|
# resp.job_definitions[0].container_properties.volumes #=> Array
|
1086
1138
|
# resp.job_definitions[0].container_properties.volumes[0].host.source_path #=> String
|
1087
1139
|
# resp.job_definitions[0].container_properties.volumes[0].name #=> String
|
@@ -1108,6 +1160,24 @@ module Aws::Batch
|
|
1108
1160
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].container_path #=> String
|
1109
1161
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].permissions #=> Array
|
1110
1162
|
# resp.job_definitions[0].container_properties.linux_parameters.devices[0].permissions[0] #=> String, one of "READ", "WRITE", "MKNOD"
|
1163
|
+
# resp.job_definitions[0].container_properties.linux_parameters.init_process_enabled #=> Boolean
|
1164
|
+
# resp.job_definitions[0].container_properties.linux_parameters.shared_memory_size #=> Integer
|
1165
|
+
# resp.job_definitions[0].container_properties.linux_parameters.tmpfs #=> Array
|
1166
|
+
# resp.job_definitions[0].container_properties.linux_parameters.tmpfs[0].container_path #=> String
|
1167
|
+
# resp.job_definitions[0].container_properties.linux_parameters.tmpfs[0].size #=> Integer
|
1168
|
+
# resp.job_definitions[0].container_properties.linux_parameters.tmpfs[0].mount_options #=> Array
|
1169
|
+
# resp.job_definitions[0].container_properties.linux_parameters.tmpfs[0].mount_options[0] #=> String
|
1170
|
+
# resp.job_definitions[0].container_properties.linux_parameters.max_swap #=> Integer
|
1171
|
+
# resp.job_definitions[0].container_properties.linux_parameters.swappiness #=> Integer
|
1172
|
+
# resp.job_definitions[0].container_properties.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
1173
|
+
# resp.job_definitions[0].container_properties.log_configuration.options #=> Hash
|
1174
|
+
# resp.job_definitions[0].container_properties.log_configuration.options["String"] #=> String
|
1175
|
+
# resp.job_definitions[0].container_properties.log_configuration.secret_options #=> Array
|
1176
|
+
# resp.job_definitions[0].container_properties.log_configuration.secret_options[0].name #=> String
|
1177
|
+
# resp.job_definitions[0].container_properties.log_configuration.secret_options[0].value_from #=> String
|
1178
|
+
# resp.job_definitions[0].container_properties.secrets #=> Array
|
1179
|
+
# resp.job_definitions[0].container_properties.secrets[0].name #=> String
|
1180
|
+
# resp.job_definitions[0].container_properties.secrets[0].value_from #=> String
|
1111
1181
|
# resp.job_definitions[0].timeout.attempt_duration_seconds #=> Integer
|
1112
1182
|
# resp.job_definitions[0].node_properties.num_nodes #=> Integer
|
1113
1183
|
# resp.job_definitions[0].node_properties.main_node #=> Integer
|
@@ -1119,6 +1189,7 @@ module Aws::Batch
|
|
1119
1189
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.command #=> Array
|
1120
1190
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.command[0] #=> String
|
1121
1191
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.job_role_arn #=> String
|
1192
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.execution_role_arn #=> String
|
1122
1193
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes #=> Array
|
1123
1194
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].host.source_path #=> String
|
1124
1195
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.volumes[0].name #=> String
|
@@ -1145,6 +1216,26 @@ module Aws::Batch
|
|
1145
1216
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
|
1146
1217
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].permissions #=> Array
|
1147
1218
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].permissions[0] #=> String, one of "READ", "WRITE", "MKNOD"
|
1219
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.init_process_enabled #=> Boolean
|
1220
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.shared_memory_size #=> Integer
|
1221
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs #=> Array
|
1222
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].container_path #=> String
|
1223
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].size #=> Integer
|
1224
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].mount_options #=> Array
|
1225
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].mount_options[0] #=> String
|
1226
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.max_swap #=> Integer
|
1227
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.swappiness #=> Integer
|
1228
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
1229
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.options #=> Hash
|
1230
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.options["String"] #=> String
|
1231
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.secret_options #=> Array
|
1232
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.secret_options[0].name #=> String
|
1233
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.secret_options[0].value_from #=> String
|
1234
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets #=> Array
|
1235
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
|
1236
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
1237
|
+
# resp.job_definitions[0].tags #=> Hash
|
1238
|
+
# resp.job_definitions[0].tags["TagKey"] #=> String
|
1148
1239
|
# resp.next_token #=> String
|
1149
1240
|
#
|
1150
1241
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
|
@@ -1243,6 +1334,8 @@ module Aws::Batch
|
|
1243
1334
|
# resp.job_queues[0].compute_environment_order #=> Array
|
1244
1335
|
# resp.job_queues[0].compute_environment_order[0].order #=> Integer
|
1245
1336
|
# resp.job_queues[0].compute_environment_order[0].compute_environment #=> String
|
1337
|
+
# resp.job_queues[0].tags #=> Hash
|
1338
|
+
# resp.job_queues[0].tags["TagKey"] #=> String
|
1246
1339
|
# resp.next_token #=> String
|
1247
1340
|
#
|
1248
1341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueues AWS API Documentation
|
@@ -1322,6 +1415,7 @@ module Aws::Batch
|
|
1322
1415
|
# @example Response structure
|
1323
1416
|
#
|
1324
1417
|
# resp.jobs #=> Array
|
1418
|
+
# resp.jobs[0].job_arn #=> String
|
1325
1419
|
# resp.jobs[0].job_name #=> String
|
1326
1420
|
# resp.jobs[0].job_id #=> String
|
1327
1421
|
# resp.jobs[0].job_queue #=> String
|
@@ -1356,6 +1450,7 @@ module Aws::Batch
|
|
1356
1450
|
# resp.jobs[0].container.command #=> Array
|
1357
1451
|
# resp.jobs[0].container.command[0] #=> String
|
1358
1452
|
# resp.jobs[0].container.job_role_arn #=> String
|
1453
|
+
# resp.jobs[0].container.execution_role_arn #=> String
|
1359
1454
|
# resp.jobs[0].container.volumes #=> Array
|
1360
1455
|
# resp.jobs[0].container.volumes[0].host.source_path #=> String
|
1361
1456
|
# resp.jobs[0].container.volumes[0].name #=> String
|
@@ -1391,6 +1486,24 @@ module Aws::Batch
|
|
1391
1486
|
# resp.jobs[0].container.linux_parameters.devices[0].container_path #=> String
|
1392
1487
|
# resp.jobs[0].container.linux_parameters.devices[0].permissions #=> Array
|
1393
1488
|
# resp.jobs[0].container.linux_parameters.devices[0].permissions[0] #=> String, one of "READ", "WRITE", "MKNOD"
|
1489
|
+
# resp.jobs[0].container.linux_parameters.init_process_enabled #=> Boolean
|
1490
|
+
# resp.jobs[0].container.linux_parameters.shared_memory_size #=> Integer
|
1491
|
+
# resp.jobs[0].container.linux_parameters.tmpfs #=> Array
|
1492
|
+
# resp.jobs[0].container.linux_parameters.tmpfs[0].container_path #=> String
|
1493
|
+
# resp.jobs[0].container.linux_parameters.tmpfs[0].size #=> Integer
|
1494
|
+
# resp.jobs[0].container.linux_parameters.tmpfs[0].mount_options #=> Array
|
1495
|
+
# resp.jobs[0].container.linux_parameters.tmpfs[0].mount_options[0] #=> String
|
1496
|
+
# resp.jobs[0].container.linux_parameters.max_swap #=> Integer
|
1497
|
+
# resp.jobs[0].container.linux_parameters.swappiness #=> Integer
|
1498
|
+
# resp.jobs[0].container.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
1499
|
+
# resp.jobs[0].container.log_configuration.options #=> Hash
|
1500
|
+
# resp.jobs[0].container.log_configuration.options["String"] #=> String
|
1501
|
+
# resp.jobs[0].container.log_configuration.secret_options #=> Array
|
1502
|
+
# resp.jobs[0].container.log_configuration.secret_options[0].name #=> String
|
1503
|
+
# resp.jobs[0].container.log_configuration.secret_options[0].value_from #=> String
|
1504
|
+
# resp.jobs[0].container.secrets #=> Array
|
1505
|
+
# resp.jobs[0].container.secrets[0].name #=> String
|
1506
|
+
# resp.jobs[0].container.secrets[0].value_from #=> String
|
1394
1507
|
# resp.jobs[0].node_details.node_index #=> Integer
|
1395
1508
|
# resp.jobs[0].node_details.is_main_node #=> Boolean
|
1396
1509
|
# resp.jobs[0].node_properties.num_nodes #=> Integer
|
@@ -1403,6 +1516,7 @@ module Aws::Batch
|
|
1403
1516
|
# resp.jobs[0].node_properties.node_range_properties[0].container.command #=> Array
|
1404
1517
|
# resp.jobs[0].node_properties.node_range_properties[0].container.command[0] #=> String
|
1405
1518
|
# resp.jobs[0].node_properties.node_range_properties[0].container.job_role_arn #=> String
|
1519
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.execution_role_arn #=> String
|
1406
1520
|
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes #=> Array
|
1407
1521
|
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].host.source_path #=> String
|
1408
1522
|
# resp.jobs[0].node_properties.node_range_properties[0].container.volumes[0].name #=> String
|
@@ -1429,11 +1543,31 @@ module Aws::Batch
|
|
1429
1543
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].container_path #=> String
|
1430
1544
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].permissions #=> Array
|
1431
1545
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.devices[0].permissions[0] #=> String, one of "READ", "WRITE", "MKNOD"
|
1546
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.init_process_enabled #=> Boolean
|
1547
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.shared_memory_size #=> Integer
|
1548
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs #=> Array
|
1549
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].container_path #=> String
|
1550
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].size #=> Integer
|
1551
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].mount_options #=> Array
|
1552
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].mount_options[0] #=> String
|
1553
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.max_swap #=> Integer
|
1554
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.swappiness #=> Integer
|
1555
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
1556
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.options #=> Hash
|
1557
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.options["String"] #=> String
|
1558
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.secret_options #=> Array
|
1559
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.secret_options[0].name #=> String
|
1560
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.secret_options[0].value_from #=> String
|
1561
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets #=> Array
|
1562
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].name #=> String
|
1563
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
1432
1564
|
# resp.jobs[0].array_properties.status_summary #=> Hash
|
1433
1565
|
# resp.jobs[0].array_properties.status_summary["String"] #=> Integer
|
1434
1566
|
# resp.jobs[0].array_properties.size #=> Integer
|
1435
1567
|
# resp.jobs[0].array_properties.index #=> Integer
|
1436
1568
|
# resp.jobs[0].timeout.attempt_duration_seconds #=> Integer
|
1569
|
+
# resp.jobs[0].tags #=> Hash
|
1570
|
+
# resp.jobs[0].tags["TagKey"] #=> String
|
1437
1571
|
#
|
1438
1572
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
1439
1573
|
#
|
@@ -1557,6 +1691,7 @@ module Aws::Batch
|
|
1557
1691
|
# @example Response structure
|
1558
1692
|
#
|
1559
1693
|
# resp.job_summary_list #=> Array
|
1694
|
+
# resp.job_summary_list[0].job_arn #=> String
|
1560
1695
|
# resp.job_summary_list[0].job_id #=> String
|
1561
1696
|
# resp.job_summary_list[0].job_name #=> String
|
1562
1697
|
# resp.job_summary_list[0].created_at #=> Integer
|
@@ -1582,6 +1717,59 @@ module Aws::Batch
|
|
1582
1717
|
req.send_request(options)
|
1583
1718
|
end
|
1584
1719
|
|
1720
|
+
# List the tags for an AWS Batch resource. AWS Batch resources that
|
1721
|
+
# support tags are compute environments, jobs, job definitions, and job
|
1722
|
+
# queues. ARNs for child jobs of array and multi-node parallel (MNP)
|
1723
|
+
# jobs are not supported.
|
1724
|
+
#
|
1725
|
+
# @option params [required, String] :resource_arn
|
1726
|
+
# The Amazon Resource Name (ARN) that identifies the resource for which
|
1727
|
+
# to list the tags. AWS Batch resources that support tags are compute
|
1728
|
+
# environments, jobs, job definitions, and job queues. ARNs for child
|
1729
|
+
# jobs of array and multi-node parallel (MNP) jobs are not supported.
|
1730
|
+
#
|
1731
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1732
|
+
#
|
1733
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
1734
|
+
#
|
1735
|
+
#
|
1736
|
+
# @example Example: ListTagsForResource Example
|
1737
|
+
#
|
1738
|
+
# # This demonstrates calling the ListTagsForResource action.
|
1739
|
+
#
|
1740
|
+
# resp = client.list_tags_for_resource({
|
1741
|
+
# resource_arn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
|
1742
|
+
# })
|
1743
|
+
#
|
1744
|
+
# resp.to_h outputs the following:
|
1745
|
+
# {
|
1746
|
+
# tags: {
|
1747
|
+
# "Department" => "Engineering",
|
1748
|
+
# "Stage" => "Alpha",
|
1749
|
+
# "User" => "JaneDoe",
|
1750
|
+
# },
|
1751
|
+
# }
|
1752
|
+
#
|
1753
|
+
# @example Request syntax with placeholder values
|
1754
|
+
#
|
1755
|
+
# resp = client.list_tags_for_resource({
|
1756
|
+
# resource_arn: "String", # required
|
1757
|
+
# })
|
1758
|
+
#
|
1759
|
+
# @example Response structure
|
1760
|
+
#
|
1761
|
+
# resp.tags #=> Hash
|
1762
|
+
# resp.tags["TagKey"] #=> String
|
1763
|
+
#
|
1764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListTagsForResource AWS API Documentation
|
1765
|
+
#
|
1766
|
+
# @overload list_tags_for_resource(params = {})
|
1767
|
+
# @param [Hash] params ({})
|
1768
|
+
def list_tags_for_resource(params = {}, options = {})
|
1769
|
+
req = build_request(:list_tags_for_resource, params)
|
1770
|
+
req.send_request(options)
|
1771
|
+
end
|
1772
|
+
|
1585
1773
|
# Registers an AWS Batch job definition.
|
1586
1774
|
#
|
1587
1775
|
# @option params [required, String] :job_definition_name
|
@@ -1636,6 +1824,16 @@ module Aws::Batch
|
|
1636
1824
|
#
|
1637
1825
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html
|
1638
1826
|
#
|
1827
|
+
# @option params [Hash<String,String>] :tags
|
1828
|
+
# The tags that you apply to the job definition to help you categorize
|
1829
|
+
# and organize your resources. Each tag consists of a key and an
|
1830
|
+
# optional value. For more information, see [Tagging AWS Resources][1]
|
1831
|
+
# in *AWS General Reference*.
|
1832
|
+
#
|
1833
|
+
#
|
1834
|
+
#
|
1835
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1836
|
+
#
|
1639
1837
|
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1640
1838
|
#
|
1641
1839
|
# * {Types::RegisterJobDefinitionResponse#job_definition_name #job_definition_name} => String
|
@@ -1668,6 +1866,35 @@ module Aws::Batch
|
|
1668
1866
|
# revision: 1,
|
1669
1867
|
# }
|
1670
1868
|
#
|
1869
|
+
# @example Example: RegisterJobDefinition with tags
|
1870
|
+
#
|
1871
|
+
# # This demonstrates calling the RegisterJobDefinition action, including tags.
|
1872
|
+
#
|
1873
|
+
# resp = client.register_job_definition({
|
1874
|
+
# type: "container",
|
1875
|
+
# container_properties: {
|
1876
|
+
# command: [
|
1877
|
+
# "sleep",
|
1878
|
+
# "30",
|
1879
|
+
# ],
|
1880
|
+
# image: "busybox",
|
1881
|
+
# memory: 128,
|
1882
|
+
# vcpus: 1,
|
1883
|
+
# },
|
1884
|
+
# job_definition_name: "sleep30",
|
1885
|
+
# tags: {
|
1886
|
+
# "Department" => "Engineering",
|
1887
|
+
# "User" => "JaneDoe",
|
1888
|
+
# },
|
1889
|
+
# })
|
1890
|
+
#
|
1891
|
+
# resp.to_h outputs the following:
|
1892
|
+
# {
|
1893
|
+
# job_definition_arn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1",
|
1894
|
+
# job_definition_name: "sleep30",
|
1895
|
+
# revision: 1,
|
1896
|
+
# }
|
1897
|
+
#
|
1671
1898
|
# @example Request syntax with placeholder values
|
1672
1899
|
#
|
1673
1900
|
# resp = client.register_job_definition({
|
@@ -1682,6 +1909,7 @@ module Aws::Batch
|
|
1682
1909
|
# memory: 1,
|
1683
1910
|
# command: ["String"],
|
1684
1911
|
# job_role_arn: "String",
|
1912
|
+
# execution_role_arn: "String",
|
1685
1913
|
# volumes: [
|
1686
1914
|
# {
|
1687
1915
|
# host: {
|
@@ -1728,7 +1956,36 @@ module Aws::Batch
|
|
1728
1956
|
# permissions: ["READ"], # accepts READ, WRITE, MKNOD
|
1729
1957
|
# },
|
1730
1958
|
# ],
|
1959
|
+
# init_process_enabled: false,
|
1960
|
+
# shared_memory_size: 1,
|
1961
|
+
# tmpfs: [
|
1962
|
+
# {
|
1963
|
+
# container_path: "String", # required
|
1964
|
+
# size: 1, # required
|
1965
|
+
# mount_options: ["String"],
|
1966
|
+
# },
|
1967
|
+
# ],
|
1968
|
+
# max_swap: 1,
|
1969
|
+
# swappiness: 1,
|
1970
|
+
# },
|
1971
|
+
# log_configuration: {
|
1972
|
+
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
|
1973
|
+
# options: {
|
1974
|
+
# "String" => "String",
|
1975
|
+
# },
|
1976
|
+
# secret_options: [
|
1977
|
+
# {
|
1978
|
+
# name: "String", # required
|
1979
|
+
# value_from: "String", # required
|
1980
|
+
# },
|
1981
|
+
# ],
|
1731
1982
|
# },
|
1983
|
+
# secrets: [
|
1984
|
+
# {
|
1985
|
+
# name: "String", # required
|
1986
|
+
# value_from: "String", # required
|
1987
|
+
# },
|
1988
|
+
# ],
|
1732
1989
|
# },
|
1733
1990
|
# node_properties: {
|
1734
1991
|
# num_nodes: 1, # required
|
@@ -1742,6 +1999,7 @@ module Aws::Batch
|
|
1742
1999
|
# memory: 1,
|
1743
2000
|
# command: ["String"],
|
1744
2001
|
# job_role_arn: "String",
|
2002
|
+
# execution_role_arn: "String",
|
1745
2003
|
# volumes: [
|
1746
2004
|
# {
|
1747
2005
|
# host: {
|
@@ -1788,7 +2046,36 @@ module Aws::Batch
|
|
1788
2046
|
# permissions: ["READ"], # accepts READ, WRITE, MKNOD
|
1789
2047
|
# },
|
1790
2048
|
# ],
|
2049
|
+
# init_process_enabled: false,
|
2050
|
+
# shared_memory_size: 1,
|
2051
|
+
# tmpfs: [
|
2052
|
+
# {
|
2053
|
+
# container_path: "String", # required
|
2054
|
+
# size: 1, # required
|
2055
|
+
# mount_options: ["String"],
|
2056
|
+
# },
|
2057
|
+
# ],
|
2058
|
+
# max_swap: 1,
|
2059
|
+
# swappiness: 1,
|
1791
2060
|
# },
|
2061
|
+
# log_configuration: {
|
2062
|
+
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
|
2063
|
+
# options: {
|
2064
|
+
# "String" => "String",
|
2065
|
+
# },
|
2066
|
+
# secret_options: [
|
2067
|
+
# {
|
2068
|
+
# name: "String", # required
|
2069
|
+
# value_from: "String", # required
|
2070
|
+
# },
|
2071
|
+
# ],
|
2072
|
+
# },
|
2073
|
+
# secrets: [
|
2074
|
+
# {
|
2075
|
+
# name: "String", # required
|
2076
|
+
# value_from: "String", # required
|
2077
|
+
# },
|
2078
|
+
# ],
|
1792
2079
|
# },
|
1793
2080
|
# },
|
1794
2081
|
# ],
|
@@ -1799,6 +2086,9 @@ module Aws::Batch
|
|
1799
2086
|
# timeout: {
|
1800
2087
|
# attempt_duration_seconds: 1,
|
1801
2088
|
# },
|
2089
|
+
# tags: {
|
2090
|
+
# "TagKey" => "TagValue",
|
2091
|
+
# },
|
1802
2092
|
# })
|
1803
2093
|
#
|
1804
2094
|
# @example Response structure
|
@@ -1894,8 +2184,19 @@ module Aws::Batch
|
|
1894
2184
|
#
|
1895
2185
|
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html
|
1896
2186
|
#
|
2187
|
+
# @option params [Hash<String,String>] :tags
|
2188
|
+
# The tags that you apply to the job request to help you categorize and
|
2189
|
+
# organize your resources. Each tag consists of a key and an optional
|
2190
|
+
# value. For more information, see [Tagging AWS Resources][1] in *AWS
|
2191
|
+
# General Reference*.
|
2192
|
+
#
|
2193
|
+
#
|
2194
|
+
#
|
2195
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
2196
|
+
#
|
1897
2197
|
# @return [Types::SubmitJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1898
2198
|
#
|
2199
|
+
# * {Types::SubmitJobResponse#job_arn #job_arn} => String
|
1899
2200
|
# * {Types::SubmitJobResponse#job_name #job_name} => String
|
1900
2201
|
# * {Types::SubmitJobResponse#job_id #job_id} => String
|
1901
2202
|
#
|
@@ -1984,10 +2285,14 @@ module Aws::Batch
|
|
1984
2285
|
# timeout: {
|
1985
2286
|
# attempt_duration_seconds: 1,
|
1986
2287
|
# },
|
2288
|
+
# tags: {
|
2289
|
+
# "TagKey" => "TagValue",
|
2290
|
+
# },
|
1987
2291
|
# })
|
1988
2292
|
#
|
1989
2293
|
# @example Response structure
|
1990
2294
|
#
|
2295
|
+
# resp.job_arn #=> String
|
1991
2296
|
# resp.job_name #=> String
|
1992
2297
|
# resp.job_id #=> String
|
1993
2298
|
#
|
@@ -2000,6 +2305,66 @@ module Aws::Batch
|
|
2000
2305
|
req.send_request(options)
|
2001
2306
|
end
|
2002
2307
|
|
2308
|
+
# Associates the specified tags to a resource with the specified
|
2309
|
+
# `resourceArn`. If existing tags on a resource are not specified in the
|
2310
|
+
# request parameters, they are not changed. When a resource is deleted,
|
2311
|
+
# the tags associated with that resource are deleted as well. AWS Batch
|
2312
|
+
# resources that support tags are compute environments, jobs, job
|
2313
|
+
# definitions, and job queues. ARNs for child jobs of array and
|
2314
|
+
# multi-node parallel (MNP) jobs are not supported.
|
2315
|
+
#
|
2316
|
+
# @option params [required, String] :resource_arn
|
2317
|
+
# The Amazon Resource Name (ARN) of the resource to which to add tags.
|
2318
|
+
# AWS Batch resources that support tags are compute environments, jobs,
|
2319
|
+
# job definitions, and job queues. ARNs for child jobs of array and
|
2320
|
+
# multi-node parallel (MNP) jobs are not supported.
|
2321
|
+
#
|
2322
|
+
# @option params [required, Hash<String,String>] :tags
|
2323
|
+
# The tags that you apply to the resource to help you categorize and
|
2324
|
+
# organize your resources. Each tag consists of a key and an optional
|
2325
|
+
# value. For more information, see [Tagging AWS Resources][1] in *AWS
|
2326
|
+
# General Reference*.
|
2327
|
+
#
|
2328
|
+
#
|
2329
|
+
#
|
2330
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
2331
|
+
#
|
2332
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2333
|
+
#
|
2334
|
+
#
|
2335
|
+
# @example Example: TagResource Example
|
2336
|
+
#
|
2337
|
+
# # This demonstrates calling the TagResource action.
|
2338
|
+
#
|
2339
|
+
# resp = client.tag_resource({
|
2340
|
+
# resource_arn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
|
2341
|
+
# tags: {
|
2342
|
+
# "Stage" => "Alpha",
|
2343
|
+
# },
|
2344
|
+
# })
|
2345
|
+
#
|
2346
|
+
# resp.to_h outputs the following:
|
2347
|
+
# {
|
2348
|
+
# }
|
2349
|
+
#
|
2350
|
+
# @example Request syntax with placeholder values
|
2351
|
+
#
|
2352
|
+
# resp = client.tag_resource({
|
2353
|
+
# resource_arn: "String", # required
|
2354
|
+
# tags: { # required
|
2355
|
+
# "TagKey" => "TagValue",
|
2356
|
+
# },
|
2357
|
+
# })
|
2358
|
+
#
|
2359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/TagResource AWS API Documentation
|
2360
|
+
#
|
2361
|
+
# @overload tag_resource(params = {})
|
2362
|
+
# @param [Hash] params ({})
|
2363
|
+
def tag_resource(params = {}, options = {})
|
2364
|
+
req = build_request(:tag_resource, params)
|
2365
|
+
req.send_request(options)
|
2366
|
+
end
|
2367
|
+
|
2003
2368
|
# Terminates a job in a job queue. Jobs that are in the `STARTING` or
|
2004
2369
|
# `RUNNING` state are terminated, which causes them to transition to
|
2005
2370
|
# `FAILED`. Jobs that have not progressed to the `STARTING` state are
|
@@ -2045,6 +2410,51 @@ module Aws::Batch
|
|
2045
2410
|
req.send_request(options)
|
2046
2411
|
end
|
2047
2412
|
|
2413
|
+
# Deletes specified tags from an AWS Batch resource.
|
2414
|
+
#
|
2415
|
+
# @option params [required, String] :resource_arn
|
2416
|
+
# The Amazon Resource Name (ARN) of the resource from which to delete
|
2417
|
+
# tags. AWS Batch resources that support tags are compute environments,
|
2418
|
+
# jobs, job definitions, and job queues. ARNs for child jobs of array
|
2419
|
+
# and multi-node parallel (MNP) jobs are not supported.
|
2420
|
+
#
|
2421
|
+
# @option params [required, Array<String>] :tag_keys
|
2422
|
+
# The keys of the tags to be removed.
|
2423
|
+
#
|
2424
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2425
|
+
#
|
2426
|
+
#
|
2427
|
+
# @example Example: UntagResource Example
|
2428
|
+
#
|
2429
|
+
# # This demonstrates calling the UntagResource action.
|
2430
|
+
#
|
2431
|
+
# resp = client.untag_resource({
|
2432
|
+
# resource_arn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
|
2433
|
+
# tag_keys: [
|
2434
|
+
# "Stage",
|
2435
|
+
# ],
|
2436
|
+
# })
|
2437
|
+
#
|
2438
|
+
# resp.to_h outputs the following:
|
2439
|
+
# {
|
2440
|
+
# }
|
2441
|
+
#
|
2442
|
+
# @example Request syntax with placeholder values
|
2443
|
+
#
|
2444
|
+
# resp = client.untag_resource({
|
2445
|
+
# resource_arn: "String", # required
|
2446
|
+
# tag_keys: ["TagKey"], # required
|
2447
|
+
# })
|
2448
|
+
#
|
2449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UntagResource AWS API Documentation
|
2450
|
+
#
|
2451
|
+
# @overload untag_resource(params = {})
|
2452
|
+
# @param [Hash] params ({})
|
2453
|
+
def untag_resource(params = {}, options = {})
|
2454
|
+
req = build_request(:untag_resource, params)
|
2455
|
+
req.send_request(options)
|
2456
|
+
end
|
2457
|
+
|
2048
2458
|
# Updates an AWS Batch compute environment.
|
2049
2459
|
#
|
2050
2460
|
# @option params [required, String] :compute_environment
|
@@ -2131,7 +2541,10 @@ module Aws::Batch
|
|
2131
2541
|
# The name or the Amazon Resource Name (ARN) of the job queue.
|
2132
2542
|
#
|
2133
2543
|
# @option params [String] :state
|
2134
|
-
# Describes the queue's ability to accept new jobs.
|
2544
|
+
# Describes the queue's ability to accept new jobs. If the job queue
|
2545
|
+
# state is `ENABLED`, it is able to accept jobs. If the job queue state
|
2546
|
+
# is `DISABLED`, new jobs cannot be added to the queue, but jobs already
|
2547
|
+
# in the queue can finish.
|
2135
2548
|
#
|
2136
2549
|
# @option params [Integer] :priority
|
2137
2550
|
# The priority of the job queue. Job queues with a higher priority (or a
|
@@ -2209,7 +2622,7 @@ module Aws::Batch
|
|
2209
2622
|
params: params,
|
2210
2623
|
config: config)
|
2211
2624
|
context[:gem_name] = 'aws-sdk-batch'
|
2212
|
-
context[:gem_version] = '1.
|
2625
|
+
context[:gem_version] = '1.39.0'
|
2213
2626
|
Seahorse::Client::Request.new(handlers, context)
|
2214
2627
|
end
|
2215
2628
|
|