aws-sdk-batch 1.110.0 → 1.112.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/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-batch/client.rb +610 -13
- data/lib/aws-sdk-batch/client_api.rb +211 -0
- data/lib/aws-sdk-batch/types.rb +697 -37
- data/lib/aws-sdk-batch.rb +1 -1
- data/sig/client.rbs +142 -6
- data/sig/types.rbs +135 -1
- metadata +2 -2
data/lib/aws-sdk-batch/client.rb
CHANGED
@@ -924,6 +924,84 @@ module Aws::Batch
|
|
924
924
|
req.send_request(options)
|
925
925
|
end
|
926
926
|
|
927
|
+
# Creates an Batch consumable resource.
|
928
|
+
#
|
929
|
+
# @option params [required, String] :consumable_resource_name
|
930
|
+
# The name of the consumable resource. Must be unique.
|
931
|
+
#
|
932
|
+
# @option params [Integer] :total_quantity
|
933
|
+
# The total amount of the consumable resource that is available. Must be
|
934
|
+
# non-negative.
|
935
|
+
#
|
936
|
+
# @option params [String] :resource_type
|
937
|
+
# Indicates whether the resource is available to be re-used after a job
|
938
|
+
# completes. Can be one of:
|
939
|
+
#
|
940
|
+
# * `REPLENISHABLE` (default)
|
941
|
+
#
|
942
|
+
# * `NON_REPLENISHABLE`
|
943
|
+
#
|
944
|
+
# @option params [Hash<String,String>] :tags
|
945
|
+
# The tags that you apply to the consumable resource to help you
|
946
|
+
# categorize and organize your resources. Each tag consists of a key and
|
947
|
+
# an optional value. For more information, see [Tagging your Batch
|
948
|
+
# resources][1].
|
949
|
+
#
|
950
|
+
#
|
951
|
+
#
|
952
|
+
# [1]: https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html
|
953
|
+
#
|
954
|
+
# @return [Types::CreateConsumableResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
955
|
+
#
|
956
|
+
# * {Types::CreateConsumableResourceResponse#consumable_resource_name #consumable_resource_name} => String
|
957
|
+
# * {Types::CreateConsumableResourceResponse#consumable_resource_arn #consumable_resource_arn} => String
|
958
|
+
#
|
959
|
+
#
|
960
|
+
# @example Example: To create a consumable resource
|
961
|
+
#
|
962
|
+
# # Creates a Batch consumable resource.
|
963
|
+
#
|
964
|
+
# resp = client.create_consumable_resource({
|
965
|
+
# consumable_resource_name: "myConsumableResource",
|
966
|
+
# resource_type: "REPLENISHABLE",
|
967
|
+
# tags: {
|
968
|
+
# "Department" => "Engineering",
|
969
|
+
# "User" => "JaneDoe",
|
970
|
+
# },
|
971
|
+
# total_quantity: 123,
|
972
|
+
# })
|
973
|
+
#
|
974
|
+
# resp.to_h outputs the following:
|
975
|
+
# {
|
976
|
+
# consumable_resource_arn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
977
|
+
# consumable_resource_name: "myConsumableResource",
|
978
|
+
# }
|
979
|
+
#
|
980
|
+
# @example Request syntax with placeholder values
|
981
|
+
#
|
982
|
+
# resp = client.create_consumable_resource({
|
983
|
+
# consumable_resource_name: "String", # required
|
984
|
+
# total_quantity: 1,
|
985
|
+
# resource_type: "String",
|
986
|
+
# tags: {
|
987
|
+
# "TagKey" => "TagValue",
|
988
|
+
# },
|
989
|
+
# })
|
990
|
+
#
|
991
|
+
# @example Response structure
|
992
|
+
#
|
993
|
+
# resp.consumable_resource_name #=> String
|
994
|
+
# resp.consumable_resource_arn #=> String
|
995
|
+
#
|
996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/CreateConsumableResource AWS API Documentation
|
997
|
+
#
|
998
|
+
# @overload create_consumable_resource(params = {})
|
999
|
+
# @param [Hash] params ({})
|
1000
|
+
def create_consumable_resource(params = {}, options = {})
|
1001
|
+
req = build_request(:create_consumable_resource, params)
|
1002
|
+
req.send_request(options)
|
1003
|
+
end
|
1004
|
+
|
927
1005
|
# Creates an Batch job queue. When you create a job queue, you associate
|
928
1006
|
# one or more compute environments to the queue and assign an order of
|
929
1007
|
# preference for the compute environments.
|
@@ -1209,6 +1287,41 @@ module Aws::Batch
|
|
1209
1287
|
req.send_request(options)
|
1210
1288
|
end
|
1211
1289
|
|
1290
|
+
# Deletes the specified consumable resource.
|
1291
|
+
#
|
1292
|
+
# @option params [required, String] :consumable_resource
|
1293
|
+
# The name or ARN of the consumable resource that will be deleted.
|
1294
|
+
#
|
1295
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1296
|
+
#
|
1297
|
+
#
|
1298
|
+
# @example Example: To delete a consumable resource
|
1299
|
+
#
|
1300
|
+
# # Deletes the specified consumable resource.
|
1301
|
+
#
|
1302
|
+
# resp = client.delete_consumable_resource({
|
1303
|
+
# consumable_resource: "myConsumableResource",
|
1304
|
+
# })
|
1305
|
+
#
|
1306
|
+
# resp.to_h outputs the following:
|
1307
|
+
# {
|
1308
|
+
# }
|
1309
|
+
#
|
1310
|
+
# @example Request syntax with placeholder values
|
1311
|
+
#
|
1312
|
+
# resp = client.delete_consumable_resource({
|
1313
|
+
# consumable_resource: "String", # required
|
1314
|
+
# })
|
1315
|
+
#
|
1316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DeleteConsumableResource AWS API Documentation
|
1317
|
+
#
|
1318
|
+
# @overload delete_consumable_resource(params = {})
|
1319
|
+
# @param [Hash] params ({})
|
1320
|
+
def delete_consumable_resource(params = {}, options = {})
|
1321
|
+
req = build_request(:delete_consumable_resource, params)
|
1322
|
+
req.send_request(options)
|
1323
|
+
end
|
1324
|
+
|
1212
1325
|
# Deletes the specified job queue. You must first disable submissions
|
1213
1326
|
# for a queue with the UpdateJobQueue operation. All jobs in the queue
|
1214
1327
|
# are eventually terminated when you delete a job queue. The jobs are
|
@@ -1474,6 +1587,74 @@ module Aws::Batch
|
|
1474
1587
|
req.send_request(options)
|
1475
1588
|
end
|
1476
1589
|
|
1590
|
+
# Returns a description of the specified consumable resource.
|
1591
|
+
#
|
1592
|
+
# @option params [required, String] :consumable_resource
|
1593
|
+
# The name or ARN of the consumable resource whose description will be
|
1594
|
+
# returned.
|
1595
|
+
#
|
1596
|
+
# @return [Types::DescribeConsumableResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1597
|
+
#
|
1598
|
+
# * {Types::DescribeConsumableResourceResponse#consumable_resource_name #consumable_resource_name} => String
|
1599
|
+
# * {Types::DescribeConsumableResourceResponse#consumable_resource_arn #consumable_resource_arn} => String
|
1600
|
+
# * {Types::DescribeConsumableResourceResponse#total_quantity #total_quantity} => Integer
|
1601
|
+
# * {Types::DescribeConsumableResourceResponse#in_use_quantity #in_use_quantity} => Integer
|
1602
|
+
# * {Types::DescribeConsumableResourceResponse#available_quantity #available_quantity} => Integer
|
1603
|
+
# * {Types::DescribeConsumableResourceResponse#resource_type #resource_type} => String
|
1604
|
+
# * {Types::DescribeConsumableResourceResponse#created_at #created_at} => Integer
|
1605
|
+
# * {Types::DescribeConsumableResourceResponse#tags #tags} => Hash<String,String>
|
1606
|
+
#
|
1607
|
+
#
|
1608
|
+
# @example Example: To get a description of a consumable resource
|
1609
|
+
#
|
1610
|
+
# # Returns a description of the specified consumable resource.
|
1611
|
+
#
|
1612
|
+
# resp = client.describe_consumable_resource({
|
1613
|
+
# consumable_resource: "myConsumableResource",
|
1614
|
+
# })
|
1615
|
+
#
|
1616
|
+
# resp.to_h outputs the following:
|
1617
|
+
# {
|
1618
|
+
# available_quantity: 123,
|
1619
|
+
# consumable_resource_arn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
1620
|
+
# consumable_resource_name: "myConsumableResource",
|
1621
|
+
# created_at: 123,
|
1622
|
+
# in_use_quantity: 123,
|
1623
|
+
# resource_type: "REPLENISHABLE",
|
1624
|
+
# tags: {
|
1625
|
+
# "Department" => "Engineering",
|
1626
|
+
# "User" => "JaneDoe",
|
1627
|
+
# },
|
1628
|
+
# total_quantity: 123,
|
1629
|
+
# }
|
1630
|
+
#
|
1631
|
+
# @example Request syntax with placeholder values
|
1632
|
+
#
|
1633
|
+
# resp = client.describe_consumable_resource({
|
1634
|
+
# consumable_resource: "String", # required
|
1635
|
+
# })
|
1636
|
+
#
|
1637
|
+
# @example Response structure
|
1638
|
+
#
|
1639
|
+
# resp.consumable_resource_name #=> String
|
1640
|
+
# resp.consumable_resource_arn #=> String
|
1641
|
+
# resp.total_quantity #=> Integer
|
1642
|
+
# resp.in_use_quantity #=> Integer
|
1643
|
+
# resp.available_quantity #=> Integer
|
1644
|
+
# resp.resource_type #=> String
|
1645
|
+
# resp.created_at #=> Integer
|
1646
|
+
# resp.tags #=> Hash
|
1647
|
+
# resp.tags["TagKey"] #=> String
|
1648
|
+
#
|
1649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeConsumableResource AWS API Documentation
|
1650
|
+
#
|
1651
|
+
# @overload describe_consumable_resource(params = {})
|
1652
|
+
# @param [Hash] params ({})
|
1653
|
+
def describe_consumable_resource(params = {}, options = {})
|
1654
|
+
req = build_request(:describe_consumable_resource, params)
|
1655
|
+
req.send_request(options)
|
1656
|
+
end
|
1657
|
+
|
1477
1658
|
# Describes a list of job definitions. You can specify a `status` (such
|
1478
1659
|
# as `ACTIVE`) to only return job definitions that match that status.
|
1479
1660
|
#
|
@@ -1642,7 +1823,7 @@ module Aws::Batch
|
|
1642
1823
|
# resp.job_definitions[0].container_properties.linux_parameters.tmpfs[0].mount_options[0] #=> String
|
1643
1824
|
# resp.job_definitions[0].container_properties.linux_parameters.max_swap #=> Integer
|
1644
1825
|
# resp.job_definitions[0].container_properties.linux_parameters.swappiness #=> Integer
|
1645
|
-
# resp.job_definitions[0].container_properties.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
1826
|
+
# resp.job_definitions[0].container_properties.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
|
1646
1827
|
# resp.job_definitions[0].container_properties.log_configuration.options #=> Hash
|
1647
1828
|
# resp.job_definitions[0].container_properties.log_configuration.options["String"] #=> String
|
1648
1829
|
# resp.job_definitions[0].container_properties.log_configuration.secret_options #=> Array
|
@@ -1653,6 +1834,7 @@ module Aws::Batch
|
|
1653
1834
|
# resp.job_definitions[0].container_properties.secrets[0].value_from #=> String
|
1654
1835
|
# resp.job_definitions[0].container_properties.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1655
1836
|
# resp.job_definitions[0].container_properties.fargate_platform_configuration.platform_version #=> String
|
1837
|
+
# resp.job_definitions[0].container_properties.enable_execute_command #=> Boolean
|
1656
1838
|
# resp.job_definitions[0].container_properties.ephemeral_storage.size_in_gi_b #=> Integer
|
1657
1839
|
# resp.job_definitions[0].container_properties.runtime_platform.operating_system_family #=> String
|
1658
1840
|
# resp.job_definitions[0].container_properties.runtime_platform.cpu_architecture #=> String
|
@@ -1710,7 +1892,7 @@ module Aws::Batch
|
|
1710
1892
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].mount_options[0] #=> String
|
1711
1893
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.max_swap #=> Integer
|
1712
1894
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.linux_parameters.swappiness #=> Integer
|
1713
|
-
# 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"
|
1895
|
+
# 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", "awsfirelens"
|
1714
1896
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.options #=> Hash
|
1715
1897
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.options["String"] #=> String
|
1716
1898
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.log_configuration.secret_options #=> Array
|
@@ -1721,6 +1903,7 @@ module Aws::Batch
|
|
1721
1903
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
1722
1904
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
1723
1905
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
|
1906
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].container.enable_execute_command #=> Boolean
|
1724
1907
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.ephemeral_storage.size_in_gi_b #=> Integer
|
1725
1908
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.runtime_platform.operating_system_family #=> String
|
1726
1909
|
# resp.job_definitions[0].node_properties.node_range_properties[0].container.runtime_platform.cpu_architecture #=> String
|
@@ -1738,6 +1921,9 @@ module Aws::Batch
|
|
1738
1921
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].environment[0].name #=> String
|
1739
1922
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].environment[0].value #=> String
|
1740
1923
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].essential #=> Boolean
|
1924
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
|
1925
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.options #=> Hash
|
1926
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.options["String"] #=> String
|
1741
1927
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].image #=> String
|
1742
1928
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.devices #=> Array
|
1743
1929
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.devices[0].host_path #=> String
|
@@ -1753,7 +1939,7 @@ module Aws::Batch
|
|
1753
1939
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
|
1754
1940
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.max_swap #=> Integer
|
1755
1941
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.swappiness #=> Integer
|
1756
|
-
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
1942
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
|
1757
1943
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.options #=> Hash
|
1758
1944
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.options["String"] #=> String
|
1759
1945
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.secret_options #=> Array
|
@@ -1796,6 +1982,7 @@ module Aws::Batch
|
|
1796
1982
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
1797
1983
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
1798
1984
|
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
1985
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].enable_execute_command #=> Boolean
|
1799
1986
|
# resp.job_definitions[0].node_properties.node_range_properties[0].eks_properties.pod_properties.service_account_name #=> String
|
1800
1987
|
# resp.job_definitions[0].node_properties.node_range_properties[0].eks_properties.pod_properties.host_network #=> Boolean
|
1801
1988
|
# resp.job_definitions[0].node_properties.node_range_properties[0].eks_properties.pod_properties.dns_policy #=> String
|
@@ -1868,6 +2055,9 @@ module Aws::Batch
|
|
1868
2055
|
# resp.job_definitions[0].node_properties.node_range_properties[0].eks_properties.pod_properties.metadata.annotations["String"] #=> String
|
1869
2056
|
# resp.job_definitions[0].node_properties.node_range_properties[0].eks_properties.pod_properties.metadata.namespace #=> String
|
1870
2057
|
# resp.job_definitions[0].node_properties.node_range_properties[0].eks_properties.pod_properties.share_process_namespace #=> Boolean
|
2058
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].consumable_resource_properties.consumable_resource_list #=> Array
|
2059
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].consumable_resource_properties.consumable_resource_list[0].consumable_resource #=> String
|
2060
|
+
# resp.job_definitions[0].node_properties.node_range_properties[0].consumable_resource_properties.consumable_resource_list[0].quantity #=> Integer
|
1871
2061
|
# resp.job_definitions[0].tags #=> Hash
|
1872
2062
|
# resp.job_definitions[0].tags["TagKey"] #=> String
|
1873
2063
|
# resp.job_definitions[0].propagate_tags #=> Boolean
|
@@ -1884,6 +2074,9 @@ module Aws::Batch
|
|
1884
2074
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].environment[0].name #=> String
|
1885
2075
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].environment[0].value #=> String
|
1886
2076
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].essential #=> Boolean
|
2077
|
+
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
|
2078
|
+
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.options #=> Hash
|
2079
|
+
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.options["String"] #=> String
|
1887
2080
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].image #=> String
|
1888
2081
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].linux_parameters.devices #=> Array
|
1889
2082
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].linux_parameters.devices[0].host_path #=> String
|
@@ -1899,7 +2092,7 @@ module Aws::Batch
|
|
1899
2092
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
|
1900
2093
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].linux_parameters.max_swap #=> Integer
|
1901
2094
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].linux_parameters.swappiness #=> Integer
|
1902
|
-
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
2095
|
+
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
|
1903
2096
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].log_configuration.options #=> Hash
|
1904
2097
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].log_configuration.options["String"] #=> String
|
1905
2098
|
# resp.job_definitions[0].ecs_properties.task_properties[0].containers[0].log_configuration.secret_options #=> Array
|
@@ -1942,6 +2135,7 @@ module Aws::Batch
|
|
1942
2135
|
# resp.job_definitions[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
1943
2136
|
# resp.job_definitions[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
1944
2137
|
# resp.job_definitions[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
2138
|
+
# resp.job_definitions[0].ecs_properties.task_properties[0].enable_execute_command #=> Boolean
|
1945
2139
|
# resp.job_definitions[0].eks_properties.pod_properties.service_account_name #=> String
|
1946
2140
|
# resp.job_definitions[0].eks_properties.pod_properties.host_network #=> Boolean
|
1947
2141
|
# resp.job_definitions[0].eks_properties.pod_properties.dns_policy #=> String
|
@@ -2015,6 +2209,9 @@ module Aws::Batch
|
|
2015
2209
|
# resp.job_definitions[0].eks_properties.pod_properties.metadata.namespace #=> String
|
2016
2210
|
# resp.job_definitions[0].eks_properties.pod_properties.share_process_namespace #=> Boolean
|
2017
2211
|
# resp.job_definitions[0].container_orchestration_type #=> String, one of "ECS", "EKS"
|
2212
|
+
# resp.job_definitions[0].consumable_resource_properties.consumable_resource_list #=> Array
|
2213
|
+
# resp.job_definitions[0].consumable_resource_properties.consumable_resource_list[0].consumable_resource #=> String
|
2214
|
+
# resp.job_definitions[0].consumable_resource_properties.consumable_resource_list[0].quantity #=> Integer
|
2018
2215
|
# resp.next_token #=> String
|
2019
2216
|
#
|
2020
2217
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobDefinitions AWS API Documentation
|
@@ -2304,7 +2501,7 @@ module Aws::Batch
|
|
2304
2501
|
# resp.jobs[0].container.linux_parameters.tmpfs[0].mount_options[0] #=> String
|
2305
2502
|
# resp.jobs[0].container.linux_parameters.max_swap #=> Integer
|
2306
2503
|
# resp.jobs[0].container.linux_parameters.swappiness #=> Integer
|
2307
|
-
# resp.jobs[0].container.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
2504
|
+
# resp.jobs[0].container.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
|
2308
2505
|
# resp.jobs[0].container.log_configuration.options #=> Hash
|
2309
2506
|
# resp.jobs[0].container.log_configuration.options["String"] #=> String
|
2310
2507
|
# resp.jobs[0].container.log_configuration.secret_options #=> Array
|
@@ -2319,6 +2516,7 @@ module Aws::Batch
|
|
2319
2516
|
# resp.jobs[0].container.runtime_platform.operating_system_family #=> String
|
2320
2517
|
# resp.jobs[0].container.runtime_platform.cpu_architecture #=> String
|
2321
2518
|
# resp.jobs[0].container.repository_credentials.credentials_parameter #=> String
|
2519
|
+
# resp.jobs[0].container.enable_execute_command #=> Boolean
|
2322
2520
|
# resp.jobs[0].node_details.node_index #=> Integer
|
2323
2521
|
# resp.jobs[0].node_details.is_main_node #=> Boolean
|
2324
2522
|
# resp.jobs[0].node_properties.num_nodes #=> Integer
|
@@ -2373,7 +2571,7 @@ module Aws::Batch
|
|
2373
2571
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.tmpfs[0].mount_options[0] #=> String
|
2374
2572
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.max_swap #=> Integer
|
2375
2573
|
# resp.jobs[0].node_properties.node_range_properties[0].container.linux_parameters.swappiness #=> Integer
|
2376
|
-
# 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"
|
2574
|
+
# 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", "awsfirelens"
|
2377
2575
|
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.options #=> Hash
|
2378
2576
|
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.options["String"] #=> String
|
2379
2577
|
# resp.jobs[0].node_properties.node_range_properties[0].container.log_configuration.secret_options #=> Array
|
@@ -2384,6 +2582,7 @@ module Aws::Batch
|
|
2384
2582
|
# resp.jobs[0].node_properties.node_range_properties[0].container.secrets[0].value_from #=> String
|
2385
2583
|
# resp.jobs[0].node_properties.node_range_properties[0].container.network_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
|
2386
2584
|
# resp.jobs[0].node_properties.node_range_properties[0].container.fargate_platform_configuration.platform_version #=> String
|
2585
|
+
# resp.jobs[0].node_properties.node_range_properties[0].container.enable_execute_command #=> Boolean
|
2387
2586
|
# resp.jobs[0].node_properties.node_range_properties[0].container.ephemeral_storage.size_in_gi_b #=> Integer
|
2388
2587
|
# resp.jobs[0].node_properties.node_range_properties[0].container.runtime_platform.operating_system_family #=> String
|
2389
2588
|
# resp.jobs[0].node_properties.node_range_properties[0].container.runtime_platform.cpu_architecture #=> String
|
@@ -2401,6 +2600,9 @@ module Aws::Batch
|
|
2401
2600
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].environment[0].name #=> String
|
2402
2601
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].environment[0].value #=> String
|
2403
2602
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].essential #=> Boolean
|
2603
|
+
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
|
2604
|
+
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.options #=> Hash
|
2605
|
+
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.options["String"] #=> String
|
2404
2606
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].image #=> String
|
2405
2607
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.devices #=> Array
|
2406
2608
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.devices[0].host_path #=> String
|
@@ -2416,7 +2618,7 @@ module Aws::Batch
|
|
2416
2618
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
|
2417
2619
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.max_swap #=> Integer
|
2418
2620
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].linux_parameters.swappiness #=> Integer
|
2419
|
-
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
2621
|
+
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
|
2420
2622
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.options #=> Hash
|
2421
2623
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.options["String"] #=> String
|
2422
2624
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].containers[0].log_configuration.secret_options #=> Array
|
@@ -2459,6 +2661,7 @@ module Aws::Batch
|
|
2459
2661
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
2460
2662
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
2461
2663
|
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
2664
|
+
# resp.jobs[0].node_properties.node_range_properties[0].ecs_properties.task_properties[0].enable_execute_command #=> Boolean
|
2462
2665
|
# resp.jobs[0].node_properties.node_range_properties[0].eks_properties.pod_properties.service_account_name #=> String
|
2463
2666
|
# resp.jobs[0].node_properties.node_range_properties[0].eks_properties.pod_properties.host_network #=> Boolean
|
2464
2667
|
# resp.jobs[0].node_properties.node_range_properties[0].eks_properties.pod_properties.dns_policy #=> String
|
@@ -2531,6 +2734,9 @@ module Aws::Batch
|
|
2531
2734
|
# resp.jobs[0].node_properties.node_range_properties[0].eks_properties.pod_properties.metadata.annotations["String"] #=> String
|
2532
2735
|
# resp.jobs[0].node_properties.node_range_properties[0].eks_properties.pod_properties.metadata.namespace #=> String
|
2533
2736
|
# resp.jobs[0].node_properties.node_range_properties[0].eks_properties.pod_properties.share_process_namespace #=> Boolean
|
2737
|
+
# resp.jobs[0].node_properties.node_range_properties[0].consumable_resource_properties.consumable_resource_list #=> Array
|
2738
|
+
# resp.jobs[0].node_properties.node_range_properties[0].consumable_resource_properties.consumable_resource_list[0].consumable_resource #=> String
|
2739
|
+
# resp.jobs[0].node_properties.node_range_properties[0].consumable_resource_properties.consumable_resource_list[0].quantity #=> Integer
|
2534
2740
|
# resp.jobs[0].array_properties.status_summary #=> Hash
|
2535
2741
|
# resp.jobs[0].array_properties.status_summary["String"] #=> Integer
|
2536
2742
|
# resp.jobs[0].array_properties.size #=> Integer
|
@@ -2648,6 +2854,9 @@ module Aws::Batch
|
|
2648
2854
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].environment[0].name #=> String
|
2649
2855
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].environment[0].value #=> String
|
2650
2856
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].essential #=> Boolean
|
2857
|
+
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
|
2858
|
+
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.options #=> Hash
|
2859
|
+
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].firelens_configuration.options["String"] #=> String
|
2651
2860
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].image #=> String
|
2652
2861
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].linux_parameters.devices #=> Array
|
2653
2862
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].linux_parameters.devices[0].host_path #=> String
|
@@ -2663,7 +2872,7 @@ module Aws::Batch
|
|
2663
2872
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
|
2664
2873
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].linux_parameters.max_swap #=> Integer
|
2665
2874
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].linux_parameters.swappiness #=> Integer
|
2666
|
-
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk"
|
2875
|
+
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
|
2667
2876
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].log_configuration.options #=> Hash
|
2668
2877
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].log_configuration.options["String"] #=> String
|
2669
2878
|
# resp.jobs[0].ecs_properties.task_properties[0].containers[0].log_configuration.secret_options #=> Array
|
@@ -2715,8 +2924,12 @@ module Aws::Batch
|
|
2715
2924
|
# resp.jobs[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
|
2716
2925
|
# resp.jobs[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
|
2717
2926
|
# resp.jobs[0].ecs_properties.task_properties[0].volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
|
2927
|
+
# resp.jobs[0].ecs_properties.task_properties[0].enable_execute_command #=> Boolean
|
2718
2928
|
# resp.jobs[0].is_cancelled #=> Boolean
|
2719
2929
|
# resp.jobs[0].is_terminated #=> Boolean
|
2930
|
+
# resp.jobs[0].consumable_resource_properties.consumable_resource_list #=> Array
|
2931
|
+
# resp.jobs[0].consumable_resource_properties.consumable_resource_list[0].consumable_resource #=> String
|
2932
|
+
# resp.jobs[0].consumable_resource_properties.consumable_resource_list[0].quantity #=> Integer
|
2720
2933
|
#
|
2721
2934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobs AWS API Documentation
|
2722
2935
|
#
|
@@ -2797,6 +3010,112 @@ module Aws::Batch
|
|
2797
3010
|
req.send_request(options)
|
2798
3011
|
end
|
2799
3012
|
|
3013
|
+
# Returns a list of Batch consumable resources.
|
3014
|
+
#
|
3015
|
+
# @option params [Array<Types::KeyValuesPair>] :filters
|
3016
|
+
# The filters to apply to the consumable resource list query. If used,
|
3017
|
+
# only those consumable resources that match the filter are listed.
|
3018
|
+
# Filter names and values can be:
|
3019
|
+
#
|
3020
|
+
# * name: `CONSUMABLE_RESOURCE_NAME `
|
3021
|
+
#
|
3022
|
+
# values: case-insensitive matches for the consumable resource name.
|
3023
|
+
# If a filter value ends with an asterisk (*), it matches any
|
3024
|
+
# consumable resource name that begins with the string before the
|
3025
|
+
# '*'.
|
3026
|
+
#
|
3027
|
+
# @option params [Integer] :max_results
|
3028
|
+
# The maximum number of results returned by `ListConsumableResources` in
|
3029
|
+
# paginated output. When this parameter is used,
|
3030
|
+
# `ListConsumableResources` only returns `maxResults` results in a
|
3031
|
+
# single page and a `nextToken` response element. The remaining results
|
3032
|
+
# of the initial request can be seen by sending another
|
3033
|
+
# `ListConsumableResources` request with the returned `nextToken` value.
|
3034
|
+
# This value can be between 1 and 100. If this parameter isn't used,
|
3035
|
+
# then `ListConsumableResources` returns up to 100 results and a
|
3036
|
+
# `nextToken` value if applicable.
|
3037
|
+
#
|
3038
|
+
# @option params [String] :next_token
|
3039
|
+
# The `nextToken` value returned from a previous paginated
|
3040
|
+
# `ListConsumableResources` request where `maxResults` was used and the
|
3041
|
+
# results exceeded the value of that parameter. Pagination continues
|
3042
|
+
# from the end of the previous results that returned the `nextToken`
|
3043
|
+
# value. This value is `null` when there are no more results to return.
|
3044
|
+
#
|
3045
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
3046
|
+
# the next items in a list and not for other programmatic purposes.
|
3047
|
+
#
|
3048
|
+
# </note>
|
3049
|
+
#
|
3050
|
+
# @return [Types::ListConsumableResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3051
|
+
#
|
3052
|
+
# * {Types::ListConsumableResourcesResponse#consumable_resources #consumable_resources} => Array<Types::ConsumableResourceSummary>
|
3053
|
+
# * {Types::ListConsumableResourcesResponse#next_token #next_token} => String
|
3054
|
+
#
|
3055
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3056
|
+
#
|
3057
|
+
#
|
3058
|
+
# @example Example: To get a list of a consumable resources
|
3059
|
+
#
|
3060
|
+
# # Returns a list of the consumable resources for your account.
|
3061
|
+
#
|
3062
|
+
# resp = client.list_consumable_resources({
|
3063
|
+
# filters: [
|
3064
|
+
# {
|
3065
|
+
# name: "CONSUMABLE_RESOURCE_NAME",
|
3066
|
+
# values: [
|
3067
|
+
# "my*",
|
3068
|
+
# ],
|
3069
|
+
# },
|
3070
|
+
# ],
|
3071
|
+
# max_results: 123,
|
3072
|
+
# })
|
3073
|
+
#
|
3074
|
+
# resp.to_h outputs the following:
|
3075
|
+
# {
|
3076
|
+
# consumable_resources: [
|
3077
|
+
# {
|
3078
|
+
# consumable_resource_arn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
3079
|
+
# consumable_resource_name: "myConsumableResource",
|
3080
|
+
# in_use_quantity: 12,
|
3081
|
+
# resource_type: "REPLENISHABLE",
|
3082
|
+
# total_quantity: 123,
|
3083
|
+
# },
|
3084
|
+
# ],
|
3085
|
+
# }
|
3086
|
+
#
|
3087
|
+
# @example Request syntax with placeholder values
|
3088
|
+
#
|
3089
|
+
# resp = client.list_consumable_resources({
|
3090
|
+
# filters: [
|
3091
|
+
# {
|
3092
|
+
# name: "String",
|
3093
|
+
# values: ["String"],
|
3094
|
+
# },
|
3095
|
+
# ],
|
3096
|
+
# max_results: 1,
|
3097
|
+
# next_token: "String",
|
3098
|
+
# })
|
3099
|
+
#
|
3100
|
+
# @example Response structure
|
3101
|
+
#
|
3102
|
+
# resp.consumable_resources #=> Array
|
3103
|
+
# resp.consumable_resources[0].consumable_resource_arn #=> String
|
3104
|
+
# resp.consumable_resources[0].consumable_resource_name #=> String
|
3105
|
+
# resp.consumable_resources[0].total_quantity #=> Integer
|
3106
|
+
# resp.consumable_resources[0].in_use_quantity #=> Integer
|
3107
|
+
# resp.consumable_resources[0].resource_type #=> String
|
3108
|
+
# resp.next_token #=> String
|
3109
|
+
#
|
3110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListConsumableResources AWS API Documentation
|
3111
|
+
#
|
3112
|
+
# @overload list_consumable_resources(params = {})
|
3113
|
+
# @param [Hash] params ({})
|
3114
|
+
def list_consumable_resources(params = {}, options = {})
|
3115
|
+
req = build_request(:list_consumable_resources, params)
|
3116
|
+
req.send_request(options)
|
3117
|
+
end
|
3118
|
+
|
2800
3119
|
# Returns a list of Batch jobs.
|
2801
3120
|
#
|
2802
3121
|
# You must specify only one of the following items:
|
@@ -3002,6 +3321,141 @@ module Aws::Batch
|
|
3002
3321
|
req.send_request(options)
|
3003
3322
|
end
|
3004
3323
|
|
3324
|
+
# Returns a list of Batch jobs that require a specific consumable
|
3325
|
+
# resource.
|
3326
|
+
#
|
3327
|
+
# @option params [required, String] :consumable_resource
|
3328
|
+
# The name or ARN of the consumable resource.
|
3329
|
+
#
|
3330
|
+
# @option params [Array<Types::KeyValuesPair>] :filters
|
3331
|
+
# The filters to apply to the job list query. If used, only those jobs
|
3332
|
+
# requiring the specified consumable resource (`consumableResource`) and
|
3333
|
+
# that match the value of the filters are listed. The filter names and
|
3334
|
+
# values can be:
|
3335
|
+
#
|
3336
|
+
# * name: `JOB_STATUS`
|
3337
|
+
#
|
3338
|
+
# values: `SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING |
|
3339
|
+
# SUCCEEDED | FAILED`
|
3340
|
+
#
|
3341
|
+
# * name: `JOB_NAME `
|
3342
|
+
#
|
3343
|
+
# The values are case-insensitive matches for the job name. If a
|
3344
|
+
# filter value ends with an asterisk (*), it matches any job name
|
3345
|
+
# that begins with the string before the '*'.
|
3346
|
+
#
|
3347
|
+
# @option params [Integer] :max_results
|
3348
|
+
# The maximum number of results returned by
|
3349
|
+
# `ListJobsByConsumableResource` in paginated output. When this
|
3350
|
+
# parameter is used, `ListJobsByConsumableResource` only returns
|
3351
|
+
# `maxResults` results in a single page and a `nextToken` response
|
3352
|
+
# element. The remaining results of the initial request can be seen by
|
3353
|
+
# sending another `ListJobsByConsumableResource` request with the
|
3354
|
+
# returned `nextToken` value. This value can be between 1 and 100. If
|
3355
|
+
# this parameter isn't used, then `ListJobsByConsumableResource`
|
3356
|
+
# returns up to 100 results and a `nextToken` value if applicable.
|
3357
|
+
#
|
3358
|
+
# @option params [String] :next_token
|
3359
|
+
# The `nextToken` value returned from a previous paginated
|
3360
|
+
# `ListJobsByConsumableResource` request where `maxResults` was used and
|
3361
|
+
# the results exceeded the value of that parameter. Pagination continues
|
3362
|
+
# from the end of the previous results that returned the `nextToken`
|
3363
|
+
# value. This value is `null` when there are no more results to return.
|
3364
|
+
#
|
3365
|
+
# <note markdown="1"> Treat this token as an opaque identifier that's only used to retrieve
|
3366
|
+
# the next items in a list and not for other programmatic purposes.
|
3367
|
+
#
|
3368
|
+
# </note>
|
3369
|
+
#
|
3370
|
+
# @return [Types::ListJobsByConsumableResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3371
|
+
#
|
3372
|
+
# * {Types::ListJobsByConsumableResourceResponse#jobs #jobs} => Array<Types::ListJobsByConsumableResourceSummary>
|
3373
|
+
# * {Types::ListJobsByConsumableResourceResponse#next_token #next_token} => String
|
3374
|
+
#
|
3375
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3376
|
+
#
|
3377
|
+
#
|
3378
|
+
# @example Example: To get a list of Batch jobs by consumable resource
|
3379
|
+
#
|
3380
|
+
# # Returns a list of Batch jobs that require a specific consumable resource.
|
3381
|
+
#
|
3382
|
+
# resp = client.list_jobs_by_consumable_resource({
|
3383
|
+
# consumable_resource: "myConsumableResource",
|
3384
|
+
# filters: [
|
3385
|
+
# {
|
3386
|
+
# name: "CONSUMABLE_RESOURCE_NAME",
|
3387
|
+
# values: [
|
3388
|
+
# "my*",
|
3389
|
+
# ],
|
3390
|
+
# },
|
3391
|
+
# ],
|
3392
|
+
# max_results: 123,
|
3393
|
+
# })
|
3394
|
+
#
|
3395
|
+
# resp.to_h outputs the following:
|
3396
|
+
# {
|
3397
|
+
# jobs: [
|
3398
|
+
# {
|
3399
|
+
# consumable_resource_properties: {
|
3400
|
+
# consumable_resource_list: [
|
3401
|
+
# {
|
3402
|
+
# consumable_resource: "myConsumableResource",
|
3403
|
+
# quantity: 123,
|
3404
|
+
# },
|
3405
|
+
# ],
|
3406
|
+
# },
|
3407
|
+
# created_at: 1480460782010,
|
3408
|
+
# job_arn: "arn:aws:batch:us-east-1:012345678910:job/myJob",
|
3409
|
+
# job_definition_arn: "arn:aws:batch:us-east-1:012345678910:job-definition/myJobDef",
|
3410
|
+
# job_name: "myJob",
|
3411
|
+
# job_queue_arn: "arn:aws:batch:us-east-1:012345678910:job-queue/myJobQueue",
|
3412
|
+
# job_status: "PENDING",
|
3413
|
+
# quantity: 123,
|
3414
|
+
# },
|
3415
|
+
# ],
|
3416
|
+
# }
|
3417
|
+
#
|
3418
|
+
# @example Request syntax with placeholder values
|
3419
|
+
#
|
3420
|
+
# resp = client.list_jobs_by_consumable_resource({
|
3421
|
+
# consumable_resource: "String", # required
|
3422
|
+
# filters: [
|
3423
|
+
# {
|
3424
|
+
# name: "String",
|
3425
|
+
# values: ["String"],
|
3426
|
+
# },
|
3427
|
+
# ],
|
3428
|
+
# max_results: 1,
|
3429
|
+
# next_token: "String",
|
3430
|
+
# })
|
3431
|
+
#
|
3432
|
+
# @example Response structure
|
3433
|
+
#
|
3434
|
+
# resp.jobs #=> Array
|
3435
|
+
# resp.jobs[0].job_arn #=> String
|
3436
|
+
# resp.jobs[0].job_queue_arn #=> String
|
3437
|
+
# resp.jobs[0].job_name #=> String
|
3438
|
+
# resp.jobs[0].job_definition_arn #=> String
|
3439
|
+
# resp.jobs[0].share_identifier #=> String
|
3440
|
+
# resp.jobs[0].job_status #=> String
|
3441
|
+
# resp.jobs[0].quantity #=> Integer
|
3442
|
+
# resp.jobs[0].status_reason #=> String
|
3443
|
+
# resp.jobs[0].started_at #=> Integer
|
3444
|
+
# resp.jobs[0].created_at #=> Integer
|
3445
|
+
# resp.jobs[0].consumable_resource_properties.consumable_resource_list #=> Array
|
3446
|
+
# resp.jobs[0].consumable_resource_properties.consumable_resource_list[0].consumable_resource #=> String
|
3447
|
+
# resp.jobs[0].consumable_resource_properties.consumable_resource_list[0].quantity #=> Integer
|
3448
|
+
# resp.next_token #=> String
|
3449
|
+
#
|
3450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ListJobsByConsumableResource AWS API Documentation
|
3451
|
+
#
|
3452
|
+
# @overload list_jobs_by_consumable_resource(params = {})
|
3453
|
+
# @param [Hash] params ({})
|
3454
|
+
def list_jobs_by_consumable_resource(params = {}, options = {})
|
3455
|
+
req = build_request(:list_jobs_by_consumable_resource, params)
|
3456
|
+
req.send_request(options)
|
3457
|
+
end
|
3458
|
+
|
3005
3459
|
# Returns a list of Batch scheduling policies.
|
3006
3460
|
#
|
3007
3461
|
# @option params [Integer] :max_results
|
@@ -3244,6 +3698,9 @@ module Aws::Batch
|
|
3244
3698
|
# An object with properties that are specific to Amazon ECS-based jobs.
|
3245
3699
|
# This must not be specified for Amazon EKS-based job definitions.
|
3246
3700
|
#
|
3701
|
+
# @option params [Types::ConsumableResourceProperties] :consumable_resource_properties
|
3702
|
+
# Contains a list of consumable resources required by the job.
|
3703
|
+
#
|
3247
3704
|
# @return [Types::RegisterJobDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3248
3705
|
#
|
3249
3706
|
# * {Types::RegisterJobDefinitionResponse#job_definition_name #job_definition_name} => String
|
@@ -3406,7 +3863,7 @@ module Aws::Batch
|
|
3406
3863
|
# swappiness: 1,
|
3407
3864
|
# },
|
3408
3865
|
# log_configuration: {
|
3409
|
-
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
|
3866
|
+
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens
|
3410
3867
|
# options: {
|
3411
3868
|
# "String" => "String",
|
3412
3869
|
# },
|
@@ -3429,6 +3886,7 @@ module Aws::Batch
|
|
3429
3886
|
# fargate_platform_configuration: {
|
3430
3887
|
# platform_version: "String",
|
3431
3888
|
# },
|
3889
|
+
# enable_execute_command: false,
|
3432
3890
|
# ephemeral_storage: {
|
3433
3891
|
# size_in_gi_b: 1, # required
|
3434
3892
|
# },
|
@@ -3522,7 +3980,7 @@ module Aws::Batch
|
|
3522
3980
|
# swappiness: 1,
|
3523
3981
|
# },
|
3524
3982
|
# log_configuration: {
|
3525
|
-
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
|
3983
|
+
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens
|
3526
3984
|
# options: {
|
3527
3985
|
# "String" => "String",
|
3528
3986
|
# },
|
@@ -3545,6 +4003,7 @@ module Aws::Batch
|
|
3545
4003
|
# fargate_platform_configuration: {
|
3546
4004
|
# platform_version: "String",
|
3547
4005
|
# },
|
4006
|
+
# enable_execute_command: false,
|
3548
4007
|
# ephemeral_storage: {
|
3549
4008
|
# size_in_gi_b: 1, # required
|
3550
4009
|
# },
|
@@ -3576,6 +4035,12 @@ module Aws::Batch
|
|
3576
4035
|
# },
|
3577
4036
|
# ],
|
3578
4037
|
# essential: false,
|
4038
|
+
# firelens_configuration: {
|
4039
|
+
# type: "fluentd", # required, accepts fluentd, fluentbit
|
4040
|
+
# options: {
|
4041
|
+
# "String" => "String",
|
4042
|
+
# },
|
4043
|
+
# },
|
3579
4044
|
# image: "String", # required
|
3580
4045
|
# linux_parameters: {
|
3581
4046
|
# devices: [
|
@@ -3598,7 +4063,7 @@ module Aws::Batch
|
|
3598
4063
|
# swappiness: 1,
|
3599
4064
|
# },
|
3600
4065
|
# log_configuration: {
|
3601
|
-
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
|
4066
|
+
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens
|
3602
4067
|
# options: {
|
3603
4068
|
# "String" => "String",
|
3604
4069
|
# },
|
@@ -3677,6 +4142,7 @@ module Aws::Batch
|
|
3677
4142
|
# },
|
3678
4143
|
# },
|
3679
4144
|
# ],
|
4145
|
+
# enable_execute_command: false,
|
3680
4146
|
# },
|
3681
4147
|
# ],
|
3682
4148
|
# },
|
@@ -3800,6 +4266,14 @@ module Aws::Batch
|
|
3800
4266
|
# share_process_namespace: false,
|
3801
4267
|
# },
|
3802
4268
|
# },
|
4269
|
+
# consumable_resource_properties: {
|
4270
|
+
# consumable_resource_list: [
|
4271
|
+
# {
|
4272
|
+
# consumable_resource: "String",
|
4273
|
+
# quantity: 1,
|
4274
|
+
# },
|
4275
|
+
# ],
|
4276
|
+
# },
|
3803
4277
|
# },
|
3804
4278
|
# ],
|
3805
4279
|
# },
|
@@ -3961,6 +4435,12 @@ module Aws::Batch
|
|
3961
4435
|
# },
|
3962
4436
|
# ],
|
3963
4437
|
# essential: false,
|
4438
|
+
# firelens_configuration: {
|
4439
|
+
# type: "fluentd", # required, accepts fluentd, fluentbit
|
4440
|
+
# options: {
|
4441
|
+
# "String" => "String",
|
4442
|
+
# },
|
4443
|
+
# },
|
3964
4444
|
# image: "String", # required
|
3965
4445
|
# linux_parameters: {
|
3966
4446
|
# devices: [
|
@@ -3983,7 +4463,7 @@ module Aws::Batch
|
|
3983
4463
|
# swappiness: 1,
|
3984
4464
|
# },
|
3985
4465
|
# log_configuration: {
|
3986
|
-
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
|
4466
|
+
# log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens
|
3987
4467
|
# options: {
|
3988
4468
|
# "String" => "String",
|
3989
4469
|
# },
|
@@ -4062,6 +4542,15 @@ module Aws::Batch
|
|
4062
4542
|
# },
|
4063
4543
|
# },
|
4064
4544
|
# ],
|
4545
|
+
# enable_execute_command: false,
|
4546
|
+
# },
|
4547
|
+
# ],
|
4548
|
+
# },
|
4549
|
+
# consumable_resource_properties: {
|
4550
|
+
# consumable_resource_list: [
|
4551
|
+
# {
|
4552
|
+
# consumable_resource: "String",
|
4553
|
+
# quantity: 1,
|
4065
4554
|
# },
|
4066
4555
|
# ],
|
4067
4556
|
# },
|
@@ -4232,6 +4721,10 @@ module Aws::Batch
|
|
4232
4721
|
# definition, can only be specified for jobs that are run on Amazon ECS
|
4233
4722
|
# resources.
|
4234
4723
|
#
|
4724
|
+
# @option params [Types::ConsumableResourceProperties] :consumable_resource_properties_override
|
4725
|
+
# An object that contains overrides for the consumable resources of a
|
4726
|
+
# job.
|
4727
|
+
#
|
4235
4728
|
# @return [Types::SubmitJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4236
4729
|
#
|
4237
4730
|
# * {Types::SubmitJobResponse#job_arn #job_arn} => String
|
@@ -4398,6 +4891,14 @@ module Aws::Batch
|
|
4398
4891
|
# },
|
4399
4892
|
# },
|
4400
4893
|
# },
|
4894
|
+
# consumable_resource_properties_override: {
|
4895
|
+
# consumable_resource_list: [
|
4896
|
+
# {
|
4897
|
+
# consumable_resource: "String",
|
4898
|
+
# quantity: 1,
|
4899
|
+
# },
|
4900
|
+
# ],
|
4901
|
+
# },
|
4401
4902
|
# },
|
4402
4903
|
# ],
|
4403
4904
|
# },
|
@@ -4500,6 +5001,14 @@ module Aws::Batch
|
|
4500
5001
|
# },
|
4501
5002
|
# ],
|
4502
5003
|
# },
|
5004
|
+
# consumable_resource_properties_override: {
|
5005
|
+
# consumable_resource_list: [
|
5006
|
+
# {
|
5007
|
+
# consumable_resource: "String",
|
5008
|
+
# quantity: 1,
|
5009
|
+
# },
|
5010
|
+
# ],
|
5011
|
+
# },
|
4503
5012
|
# })
|
4504
5013
|
#
|
4505
5014
|
# @example Response structure
|
@@ -4859,6 +5368,94 @@ module Aws::Batch
|
|
4859
5368
|
req.send_request(options)
|
4860
5369
|
end
|
4861
5370
|
|
5371
|
+
# Updates a consumable resource.
|
5372
|
+
#
|
5373
|
+
# @option params [required, String] :consumable_resource
|
5374
|
+
# The name or ARN of the consumable resource to be updated.
|
5375
|
+
#
|
5376
|
+
# @option params [String] :operation
|
5377
|
+
# Indicates how the quantity of the consumable resource will be updated.
|
5378
|
+
# Must be one of:
|
5379
|
+
#
|
5380
|
+
# * `SET`
|
5381
|
+
#
|
5382
|
+
# Sets the quantity of the resource to the value specified by the
|
5383
|
+
# `quantity` parameter.
|
5384
|
+
#
|
5385
|
+
# * `ADD`
|
5386
|
+
#
|
5387
|
+
# Increases the quantity of the resource by the value specified by the
|
5388
|
+
# `quantity` parameter.
|
5389
|
+
#
|
5390
|
+
# * `REMOVE`
|
5391
|
+
#
|
5392
|
+
# Reduces the quantity of the resource by the value specified by the
|
5393
|
+
# `quantity` parameter.
|
5394
|
+
#
|
5395
|
+
# @option params [Integer] :quantity
|
5396
|
+
# The change in the total quantity of the consumable resource. The
|
5397
|
+
# `operation` parameter determines whether the value specified here will
|
5398
|
+
# be the new total quantity, or the amount by which the total quantity
|
5399
|
+
# will be increased or reduced. Must be a non-negative value.
|
5400
|
+
#
|
5401
|
+
# @option params [String] :client_token
|
5402
|
+
# If this parameter is specified and two update requests with identical
|
5403
|
+
# payloads and `clientToken`s are received, these requests are
|
5404
|
+
# considered the same request and the second request is rejected. A
|
5405
|
+
# `clientToken` is valid for 8 hours or until one hour after the
|
5406
|
+
# consumable resource is deleted, whichever is less.
|
5407
|
+
#
|
5408
|
+
# **A suitable default value is auto-generated.** You should normally
|
5409
|
+
# not need to pass this option.**
|
5410
|
+
#
|
5411
|
+
# @return [Types::UpdateConsumableResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5412
|
+
#
|
5413
|
+
# * {Types::UpdateConsumableResourceResponse#consumable_resource_name #consumable_resource_name} => String
|
5414
|
+
# * {Types::UpdateConsumableResourceResponse#consumable_resource_arn #consumable_resource_arn} => String
|
5415
|
+
# * {Types::UpdateConsumableResourceResponse#total_quantity #total_quantity} => Integer
|
5416
|
+
#
|
5417
|
+
#
|
5418
|
+
# @example Example: To update a consumable resource
|
5419
|
+
#
|
5420
|
+
# # Updates a consumable resource.
|
5421
|
+
#
|
5422
|
+
# resp = client.update_consumable_resource({
|
5423
|
+
# consumable_resource: "myConsumableResource",
|
5424
|
+
# operation: "ADD",
|
5425
|
+
# quantity: 12,
|
5426
|
+
# })
|
5427
|
+
#
|
5428
|
+
# resp.to_h outputs the following:
|
5429
|
+
# {
|
5430
|
+
# consumable_resource_arn: "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
5431
|
+
# consumable_resource_name: "myConsumableResource",
|
5432
|
+
# total_quantity: 135,
|
5433
|
+
# }
|
5434
|
+
#
|
5435
|
+
# @example Request syntax with placeholder values
|
5436
|
+
#
|
5437
|
+
# resp = client.update_consumable_resource({
|
5438
|
+
# consumable_resource: "String", # required
|
5439
|
+
# operation: "String",
|
5440
|
+
# quantity: 1,
|
5441
|
+
# client_token: "ClientRequestToken",
|
5442
|
+
# })
|
5443
|
+
#
|
5444
|
+
# @example Response structure
|
5445
|
+
#
|
5446
|
+
# resp.consumable_resource_name #=> String
|
5447
|
+
# resp.consumable_resource_arn #=> String
|
5448
|
+
# resp.total_quantity #=> Integer
|
5449
|
+
#
|
5450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/UpdateConsumableResource AWS API Documentation
|
5451
|
+
#
|
5452
|
+
# @overload update_consumable_resource(params = {})
|
5453
|
+
# @param [Hash] params ({})
|
5454
|
+
def update_consumable_resource(params = {}, options = {})
|
5455
|
+
req = build_request(:update_consumable_resource, params)
|
5456
|
+
req.send_request(options)
|
5457
|
+
end
|
5458
|
+
|
4862
5459
|
# Updates a job queue.
|
4863
5460
|
#
|
4864
5461
|
# @option params [required, String] :job_queue
|
@@ -5022,7 +5619,7 @@ module Aws::Batch
|
|
5022
5619
|
tracer: tracer
|
5023
5620
|
)
|
5024
5621
|
context[:gem_name] = 'aws-sdk-batch'
|
5025
|
-
context[:gem_version] = '1.
|
5622
|
+
context[:gem_version] = '1.112.0'
|
5026
5623
|
Seahorse::Client::Request.new(handlers, context)
|
5027
5624
|
end
|
5028
5625
|
|