aws-sdk-batch 1.65.0 → 1.67.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.
@@ -12,13 +12,6 @@ module Aws::Batch
12
12
 
13
13
  # An object that represents an Batch array job.
14
14
  #
15
- # @note When making an API call, you may pass ArrayProperties
16
- # data as a hash:
17
- #
18
- # {
19
- # size: 1,
20
- # }
21
- #
22
15
  # @!attribute [rw] size
23
16
  # The size of the array job.
24
17
  # @return [Integer]
@@ -163,14 +156,6 @@ module Aws::Batch
163
156
 
164
157
  # Contains the parameters for `CancelJob`.
165
158
  #
166
- # @note When making an API call, you may pass CancelJobRequest
167
- # data as a hash:
168
- #
169
- # {
170
- # job_id: "String", # required
171
- # reason: "String", # required
172
- # }
173
- #
174
159
  # @!attribute [rw] job_id
175
160
  # The Batch job ID of the job to cancel.
176
161
  # @return [String]
@@ -358,14 +343,6 @@ module Aws::Batch
358
343
  #
359
344
  # </note>
360
345
  #
361
- # @note When making an API call, you may pass ComputeEnvironmentOrder
362
- # data as a hash:
363
- #
364
- # {
365
- # order: 1, # required
366
- # compute_environment: "String", # required
367
- # }
368
- #
369
346
  # @!attribute [rw] order
370
347
  # The order of the compute environment. Compute environments are tried
371
348
  # in ascending order. For example, if two compute environments are
@@ -393,41 +370,6 @@ module Aws::Batch
393
370
  #
394
371
  # [1]: https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html
395
372
  #
396
- # @note When making an API call, you may pass ComputeResource
397
- # data as a hash:
398
- #
399
- # {
400
- # type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
401
- # allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
402
- # minv_cpus: 1,
403
- # maxv_cpus: 1, # required
404
- # desiredv_cpus: 1,
405
- # instance_types: ["String"],
406
- # image_id: "String",
407
- # subnets: ["String"], # required
408
- # security_group_ids: ["String"],
409
- # ec2_key_pair: "String",
410
- # instance_role: "String",
411
- # tags: {
412
- # "String" => "String",
413
- # },
414
- # placement_group: "String",
415
- # bid_percentage: 1,
416
- # spot_iam_fleet_role: "String",
417
- # launch_template: {
418
- # launch_template_id: "String",
419
- # launch_template_name: "String",
420
- # version: "String",
421
- # },
422
- # ec2_configuration: [
423
- # {
424
- # image_type: "ImageType", # required
425
- # image_id_override: "ImageIdOverride",
426
- # image_kubernetes_version: "KubernetesVersion",
427
- # },
428
- # ],
429
- # }
430
- #
431
373
  # @!attribute [rw] type
432
374
  # The type of compute environment: `EC2`, `SPOT`, `FARGATE`, or
433
375
  # `FARGATE_SPOT`. For more information, see [Compute environments][1]
@@ -596,9 +538,23 @@ module Aws::Batch
596
538
  # contain up to 16 subnets. For more information, see [VPCs and
597
539
  # subnets][1] in the *Amazon VPC User Guide*.
598
540
  #
541
+ # <note markdown="1"> Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For
542
+ # more information, see [ Local Zones][2] in the *Amazon EC2 User
543
+ # Guide for Linux Instances*, [Amazon EKS and Amazon Web Services
544
+ # Local Zones][3] in the *Amazon EKS User Guide* and [ Amazon ECS
545
+ # clusters in Local Zones, Wavelength Zones, and Amazon Web Services
546
+ # Outposts][4] in the *Amazon ECS Developer Guide*.
547
+ #
548
+ # Batch on Fargate doesn't currently support Local Zones.
549
+ #
550
+ # </note>
551
+ #
599
552
  #
600
553
  #
601
554
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
555
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones
556
+ # [3]: https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html
557
+ # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones
602
558
  # @return [Array<String>]
603
559
  #
604
560
  # @!attribute [rw] security_group_ids
@@ -692,7 +648,8 @@ module Aws::Batch
692
648
  # On-Demand price for that Amazon EC2 instance. You always pay the
693
649
  # lowest (market) price and never more than your maximum percentage.
694
650
  # If you leave this field empty, the default value is 100% of the
695
- # On-Demand price.
651
+ # On-Demand price. For most use cases, we recommend leaving this field
652
+ # empty.
696
653
  #
697
654
  # <note markdown="1"> This parameter isn't applicable to jobs that are running on Fargate
698
655
  # resources. Don't specify it.
@@ -789,41 +746,6 @@ module Aws::Batch
789
746
  #
790
747
  # [1]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
791
748
  #
792
- # @note When making an API call, you may pass ComputeResourceUpdate
793
- # data as a hash:
794
- #
795
- # {
796
- # minv_cpus: 1,
797
- # maxv_cpus: 1,
798
- # desiredv_cpus: 1,
799
- # subnets: ["String"],
800
- # security_group_ids: ["String"],
801
- # allocation_strategy: "BEST_FIT_PROGRESSIVE", # accepts BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
802
- # instance_types: ["String"],
803
- # ec2_key_pair: "String",
804
- # instance_role: "String",
805
- # tags: {
806
- # "String" => "String",
807
- # },
808
- # placement_group: "String",
809
- # bid_percentage: 1,
810
- # launch_template: {
811
- # launch_template_id: "String",
812
- # launch_template_name: "String",
813
- # version: "String",
814
- # },
815
- # ec2_configuration: [
816
- # {
817
- # image_type: "ImageType", # required
818
- # image_id_override: "ImageIdOverride",
819
- # image_kubernetes_version: "KubernetesVersion",
820
- # },
821
- # ],
822
- # update_to_latest_image_version: false,
823
- # type: "EC2", # accepts EC2, SPOT, FARGATE, FARGATE_SPOT
824
- # image_id: "String",
825
- # }
826
- #
827
749
  # @!attribute [rw] minv_cpus
828
750
  # The minimum number of Amazon EC2 vCPUs that an environment should
829
751
  # maintain (even if the compute environment is `DISABLED`).
@@ -880,10 +802,24 @@ module Aws::Batch
880
802
  # more information, see [Updating compute environments][2] in the
881
803
  # *Batch User Guide*.
882
804
  #
805
+ # <note markdown="1"> Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For
806
+ # more information, see [ Local Zones][3] in the *Amazon EC2 User
807
+ # Guide for Linux Instances*, [Amazon EKS and Amazon Web Services
808
+ # Local Zones][4] in the *Amazon EKS User Guide* and [ Amazon ECS
809
+ # clusters in Local Zones, Wavelength Zones, and Amazon Web Services
810
+ # Outposts][5] in the *Amazon ECS Developer Guide*.
811
+ #
812
+ # Batch on Fargate doesn't currently support Local Zones.
813
+ #
814
+ # </note>
815
+ #
883
816
  #
884
817
  #
885
818
  # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html
886
819
  # [2]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
820
+ # [3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-local-zones
821
+ # [4]: https://docs.aws.amazon.com/eks/latest/userguide/local-zones.html
822
+ # [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-regions-zones.html#clusters-local-zones
887
823
  # @return [Array<String>]
888
824
  #
889
825
  # @!attribute [rw] security_group_ids
@@ -1092,7 +1028,8 @@ module Aws::Batch
1092
1028
  # instances are launched. For example, if your maximum percentage is
1093
1029
  # 20%, the Spot price must be less than 20% of the current On-Demand
1094
1030
  # price for that Amazon EC2 instance. You always pay the lowest
1095
- # (market) price and never more than your maximum percentage.
1031
+ # (market) price and never more than your maximum percentage. For most
1032
+ # use cases, we recommend leaving this field empty.
1096
1033
  #
1097
1034
  # When updating a compute environment, changing the bid percentage
1098
1035
  # requires an infrastructure update of the compute environment. For
@@ -1548,28 +1485,6 @@ module Aws::Batch
1548
1485
 
1549
1486
  # The overrides that should be sent to a container.
1550
1487
  #
1551
- # @note When making an API call, you may pass ContainerOverrides
1552
- # data as a hash:
1553
- #
1554
- # {
1555
- # vcpus: 1,
1556
- # memory: 1,
1557
- # command: ["String"],
1558
- # instance_type: "String",
1559
- # environment: [
1560
- # {
1561
- # name: "String",
1562
- # value: "String",
1563
- # },
1564
- # ],
1565
- # resource_requirements: [
1566
- # {
1567
- # value: "String", # required
1568
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
1569
- # },
1570
- # ],
1571
- # }
1572
- #
1573
1488
  # @!attribute [rw] vcpus
1574
1489
  # This parameter is deprecated, use `resourceRequirements` to override
1575
1490
  # the `vcpus` parameter that's set in the job definition. It's not
@@ -1657,110 +1572,6 @@ module Aws::Batch
1657
1572
  # These properties to describe the container that's launched as part of
1658
1573
  # a job.
1659
1574
  #
1660
- # @note When making an API call, you may pass ContainerProperties
1661
- # data as a hash:
1662
- #
1663
- # {
1664
- # image: "String",
1665
- # vcpus: 1,
1666
- # memory: 1,
1667
- # command: ["String"],
1668
- # job_role_arn: "String",
1669
- # execution_role_arn: "String",
1670
- # volumes: [
1671
- # {
1672
- # host: {
1673
- # source_path: "String",
1674
- # },
1675
- # name: "String",
1676
- # efs_volume_configuration: {
1677
- # file_system_id: "String", # required
1678
- # root_directory: "String",
1679
- # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
1680
- # transit_encryption_port: 1,
1681
- # authorization_config: {
1682
- # access_point_id: "String",
1683
- # iam: "ENABLED", # accepts ENABLED, DISABLED
1684
- # },
1685
- # },
1686
- # },
1687
- # ],
1688
- # environment: [
1689
- # {
1690
- # name: "String",
1691
- # value: "String",
1692
- # },
1693
- # ],
1694
- # mount_points: [
1695
- # {
1696
- # container_path: "String",
1697
- # read_only: false,
1698
- # source_volume: "String",
1699
- # },
1700
- # ],
1701
- # readonly_root_filesystem: false,
1702
- # privileged: false,
1703
- # ulimits: [
1704
- # {
1705
- # hard_limit: 1, # required
1706
- # name: "String", # required
1707
- # soft_limit: 1, # required
1708
- # },
1709
- # ],
1710
- # user: "String",
1711
- # instance_type: "String",
1712
- # resource_requirements: [
1713
- # {
1714
- # value: "String", # required
1715
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
1716
- # },
1717
- # ],
1718
- # linux_parameters: {
1719
- # devices: [
1720
- # {
1721
- # host_path: "String", # required
1722
- # container_path: "String",
1723
- # permissions: ["READ"], # accepts READ, WRITE, MKNOD
1724
- # },
1725
- # ],
1726
- # init_process_enabled: false,
1727
- # shared_memory_size: 1,
1728
- # tmpfs: [
1729
- # {
1730
- # container_path: "String", # required
1731
- # size: 1, # required
1732
- # mount_options: ["String"],
1733
- # },
1734
- # ],
1735
- # max_swap: 1,
1736
- # swappiness: 1,
1737
- # },
1738
- # log_configuration: {
1739
- # log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
1740
- # options: {
1741
- # "String" => "String",
1742
- # },
1743
- # secret_options: [
1744
- # {
1745
- # name: "String", # required
1746
- # value_from: "String", # required
1747
- # },
1748
- # ],
1749
- # },
1750
- # secrets: [
1751
- # {
1752
- # name: "String", # required
1753
- # value_from: "String", # required
1754
- # },
1755
- # ],
1756
- # network_configuration: {
1757
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
1758
- # },
1759
- # fargate_platform_configuration: {
1760
- # platform_version: "String",
1761
- # },
1762
- # }
1763
- #
1764
1575
  # @!attribute [rw] image
1765
1576
  # The image used to start a container. This string is passed directly
1766
1577
  # to the Docker daemon. Images in the Docker Hub registry are
@@ -2103,55 +1914,6 @@ module Aws::Batch
2103
1914
 
2104
1915
  # Contains the parameters for `CreateComputeEnvironment`.
2105
1916
  #
2106
- # @note When making an API call, you may pass CreateComputeEnvironmentRequest
2107
- # data as a hash:
2108
- #
2109
- # {
2110
- # compute_environment_name: "String", # required
2111
- # type: "MANAGED", # required, accepts MANAGED, UNMANAGED
2112
- # state: "ENABLED", # accepts ENABLED, DISABLED
2113
- # unmanagedv_cpus: 1,
2114
- # compute_resources: {
2115
- # type: "EC2", # required, accepts EC2, SPOT, FARGATE, FARGATE_SPOT
2116
- # allocation_strategy: "BEST_FIT", # accepts BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
2117
- # minv_cpus: 1,
2118
- # maxv_cpus: 1, # required
2119
- # desiredv_cpus: 1,
2120
- # instance_types: ["String"],
2121
- # image_id: "String",
2122
- # subnets: ["String"], # required
2123
- # security_group_ids: ["String"],
2124
- # ec2_key_pair: "String",
2125
- # instance_role: "String",
2126
- # tags: {
2127
- # "String" => "String",
2128
- # },
2129
- # placement_group: "String",
2130
- # bid_percentage: 1,
2131
- # spot_iam_fleet_role: "String",
2132
- # launch_template: {
2133
- # launch_template_id: "String",
2134
- # launch_template_name: "String",
2135
- # version: "String",
2136
- # },
2137
- # ec2_configuration: [
2138
- # {
2139
- # image_type: "ImageType", # required
2140
- # image_id_override: "ImageIdOverride",
2141
- # image_kubernetes_version: "KubernetesVersion",
2142
- # },
2143
- # ],
2144
- # },
2145
- # service_role: "String",
2146
- # tags: {
2147
- # "TagKey" => "TagValue",
2148
- # },
2149
- # eks_configuration: {
2150
- # eks_cluster_arn: "String", # required
2151
- # kubernetes_namespace: "String", # required
2152
- # },
2153
- # }
2154
- #
2155
1917
  # @!attribute [rw] compute_environment_name
2156
1918
  # The name for your compute environment. It can be up to 128
2157
1919
  # characters long. It can contain uppercase and lowercase letters,
@@ -2302,25 +2064,6 @@ module Aws::Batch
2302
2064
 
2303
2065
  # Contains the parameters for `CreateJobQueue`.
2304
2066
  #
2305
- # @note When making an API call, you may pass CreateJobQueueRequest
2306
- # data as a hash:
2307
- #
2308
- # {
2309
- # job_queue_name: "String", # required
2310
- # state: "ENABLED", # accepts ENABLED, DISABLED
2311
- # scheduling_policy_arn: "String",
2312
- # priority: 1, # required
2313
- # compute_environment_order: [ # required
2314
- # {
2315
- # order: 1, # required
2316
- # compute_environment: "String", # required
2317
- # },
2318
- # ],
2319
- # tags: {
2320
- # "TagKey" => "TagValue",
2321
- # },
2322
- # }
2323
- #
2324
2067
  # @!attribute [rw] job_queue_name
2325
2068
  # The name of the job queue. It can be up to 128 letters long. It can
2326
2069
  # contain uppercase and lowercase letters, numbers, hyphens (-), and
@@ -2419,26 +2162,6 @@ module Aws::Batch
2419
2162
 
2420
2163
  # Contains the parameters for `CreateSchedulingPolicy`.
2421
2164
  #
2422
- # @note When making an API call, you may pass CreateSchedulingPolicyRequest
2423
- # data as a hash:
2424
- #
2425
- # {
2426
- # name: "String", # required
2427
- # fairshare_policy: {
2428
- # share_decay_seconds: 1,
2429
- # compute_reservation: 1,
2430
- # share_distribution: [
2431
- # {
2432
- # share_identifier: "String", # required
2433
- # weight_factor: 1.0,
2434
- # },
2435
- # ],
2436
- # },
2437
- # tags: {
2438
- # "TagKey" => "TagValue",
2439
- # },
2440
- # }
2441
- #
2442
2165
  # @!attribute [rw] name
2443
2166
  # The name of the scheduling policy. It can be up to 128 letters long.
2444
2167
  # It can contain uppercase and lowercase letters, numbers, hyphens
@@ -2497,13 +2220,6 @@ module Aws::Batch
2497
2220
 
2498
2221
  # Contains the parameters for `DeleteComputeEnvironment`.
2499
2222
  #
2500
- # @note When making an API call, you may pass DeleteComputeEnvironmentRequest
2501
- # data as a hash:
2502
- #
2503
- # {
2504
- # compute_environment: "String", # required
2505
- # }
2506
- #
2507
2223
  # @!attribute [rw] compute_environment
2508
2224
  # The name or Amazon Resource Name (ARN) of the compute environment to
2509
2225
  # delete.
@@ -2523,13 +2239,6 @@ module Aws::Batch
2523
2239
 
2524
2240
  # Contains the parameters for `DeleteJobQueue`.
2525
2241
  #
2526
- # @note When making an API call, you may pass DeleteJobQueueRequest
2527
- # data as a hash:
2528
- #
2529
- # {
2530
- # job_queue: "String", # required
2531
- # }
2532
- #
2533
2242
  # @!attribute [rw] job_queue
2534
2243
  # The short name or full Amazon Resource Name (ARN) of the queue to
2535
2244
  # delete.
@@ -2549,13 +2258,6 @@ module Aws::Batch
2549
2258
 
2550
2259
  # Contains the parameters for `DeleteSchedulingPolicy`.
2551
2260
  #
2552
- # @note When making an API call, you may pass DeleteSchedulingPolicyRequest
2553
- # data as a hash:
2554
- #
2555
- # {
2556
- # arn: "String", # required
2557
- # }
2558
- #
2559
2261
  # @!attribute [rw] arn
2560
2262
  # The Amazon Resource Name (ARN) of the scheduling policy to delete.
2561
2263
  # @return [String]
@@ -2572,13 +2274,6 @@ module Aws::Batch
2572
2274
  #
2573
2275
  class DeleteSchedulingPolicyResponse < Aws::EmptyStructure; end
2574
2276
 
2575
- # @note When making an API call, you may pass DeregisterJobDefinitionRequest
2576
- # data as a hash:
2577
- #
2578
- # {
2579
- # job_definition: "String", # required
2580
- # }
2581
- #
2582
2277
  # @!attribute [rw] job_definition
2583
2278
  # The name and revision (`name:revision`) or full Amazon Resource Name
2584
2279
  # (ARN) of the job definition to deregister.
@@ -2598,15 +2293,6 @@ module Aws::Batch
2598
2293
 
2599
2294
  # Contains the parameters for `DescribeComputeEnvironments`.
2600
2295
  #
2601
- # @note When making an API call, you may pass DescribeComputeEnvironmentsRequest
2602
- # data as a hash:
2603
- #
2604
- # {
2605
- # compute_environments: ["String"],
2606
- # max_results: 1,
2607
- # next_token: "String",
2608
- # }
2609
- #
2610
2296
  # @!attribute [rw] compute_environments
2611
2297
  # A list of up to 100 compute environment names or full Amazon
2612
2298
  # Resource Name (ARN) entries.
@@ -2673,17 +2359,6 @@ module Aws::Batch
2673
2359
 
2674
2360
  # Contains the parameters for `DescribeJobDefinitions`.
2675
2361
  #
2676
- # @note When making an API call, you may pass DescribeJobDefinitionsRequest
2677
- # data as a hash:
2678
- #
2679
- # {
2680
- # job_definitions: ["String"],
2681
- # max_results: 1,
2682
- # job_definition_name: "String",
2683
- # status: "String",
2684
- # next_token: "String",
2685
- # }
2686
- #
2687
2362
  # @!attribute [rw] job_definitions
2688
2363
  # A list of up to 100 job definitions. Each entry in the list can
2689
2364
  # either be an ARN in the format
@@ -2762,15 +2437,6 @@ module Aws::Batch
2762
2437
 
2763
2438
  # Contains the parameters for `DescribeJobQueues`.
2764
2439
  #
2765
- # @note When making an API call, you may pass DescribeJobQueuesRequest
2766
- # data as a hash:
2767
- #
2768
- # {
2769
- # job_queues: ["String"],
2770
- # max_results: 1,
2771
- # next_token: "String",
2772
- # }
2773
- #
2774
2440
  # @!attribute [rw] job_queues
2775
2441
  # A list of up to 100 queue names or full queue Amazon Resource Name
2776
2442
  # (ARN) entries.
@@ -2835,13 +2501,6 @@ module Aws::Batch
2835
2501
 
2836
2502
  # Contains the parameters for `DescribeJobs`.
2837
2503
  #
2838
- # @note When making an API call, you may pass DescribeJobsRequest
2839
- # data as a hash:
2840
- #
2841
- # {
2842
- # jobs: ["String"], # required
2843
- # }
2844
- #
2845
2504
  # @!attribute [rw] jobs
2846
2505
  # A list of up to 100 job IDs.
2847
2506
  # @return [Array<String>]
@@ -2868,13 +2527,6 @@ module Aws::Batch
2868
2527
 
2869
2528
  # Contains the parameters for `DescribeSchedulingPolicies`.
2870
2529
  #
2871
- # @note When making an API call, you may pass DescribeSchedulingPoliciesRequest
2872
- # data as a hash:
2873
- #
2874
- # {
2875
- # arns: ["String"], # required
2876
- # }
2877
- #
2878
2530
  # @!attribute [rw] arns
2879
2531
  # A list of up to 100 scheduling policy Amazon Resource Name (ARN)
2880
2532
  # entries.
@@ -2907,15 +2559,6 @@ module Aws::Batch
2907
2559
  #
2908
2560
  # </note>
2909
2561
  #
2910
- # @note When making an API call, you may pass Device
2911
- # data as a hash:
2912
- #
2913
- # {
2914
- # host_path: "String", # required
2915
- # container_path: "String",
2916
- # permissions: ["READ"], # accepts READ, WRITE, MKNOD
2917
- # }
2918
- #
2919
2562
  # @!attribute [rw] host_path
2920
2563
  # The path for the device on the host container instance.
2921
2564
  # @return [String]
@@ -2944,14 +2587,6 @@ module Aws::Batch
2944
2587
  # The authorization configuration details for the Amazon EFS file
2945
2588
  # system.
2946
2589
  #
2947
- # @note When making an API call, you may pass EFSAuthorizationConfig
2948
- # data as a hash:
2949
- #
2950
- # {
2951
- # access_point_id: "String",
2952
- # iam: "ENABLED", # accepts ENABLED, DISABLED
2953
- # }
2954
- #
2955
2590
  # @!attribute [rw] access_point_id
2956
2591
  # The Amazon EFS access point ID to use. If an access point is
2957
2592
  # specified, the root directory value specified in the
@@ -2999,20 +2634,6 @@ module Aws::Batch
2999
2634
  #
3000
2635
  # [1]: https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html
3001
2636
  #
3002
- # @note When making an API call, you may pass EFSVolumeConfiguration
3003
- # data as a hash:
3004
- #
3005
- # {
3006
- # file_system_id: "String", # required
3007
- # root_directory: "String",
3008
- # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
3009
- # transit_encryption_port: 1,
3010
- # authorization_config: {
3011
- # access_point_id: "String",
3012
- # iam: "ENABLED", # accepts ENABLED, DISABLED
3013
- # },
3014
- # }
3015
- #
3016
2637
  # @!attribute [rw] file_system_id
3017
2638
  # The Amazon EFS file system ID to use.
3018
2639
  # @return [String]
@@ -3085,15 +2706,6 @@ module Aws::Batch
3085
2706
  #
3086
2707
  # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami
3087
2708
  #
3088
- # @note When making an API call, you may pass Ec2Configuration
3089
- # data as a hash:
3090
- #
3091
- # {
3092
- # image_type: "ImageType", # required
3093
- # image_id_override: "ImageIdOverride",
3094
- # image_kubernetes_version: "KubernetesVersion",
3095
- # }
3096
- #
3097
2709
  # @!attribute [rw] image_type
3098
2710
  # The image type to match with the instance type to select an AMI. The
3099
2711
  # supported values are different for `ECS` and `EKS` resources.
@@ -3260,14 +2872,6 @@ module Aws::Batch
3260
2872
  # compute environment. The cluster must exist before the compute
3261
2873
  # environment can be created.
3262
2874
  #
3263
- # @note When making an API call, you may pass EksConfiguration
3264
- # data as a hash:
3265
- #
3266
- # {
3267
- # eks_cluster_arn: "String", # required
3268
- # kubernetes_namespace: "String", # required
3269
- # }
3270
- #
3271
2875
  # @!attribute [rw] eks_cluster_arn
3272
2876
  # The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example
3273
2877
  # is `arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch `.
@@ -3300,45 +2904,6 @@ module Aws::Batch
3300
2904
  # in the pod that's launched as part of a job. This can't be specified
3301
2905
  # for Amazon ECS based job definitions.
3302
2906
  #
3303
- # @note When making an API call, you may pass EksContainer
3304
- # data as a hash:
3305
- #
3306
- # {
3307
- # name: "String",
3308
- # image: "String", # required
3309
- # image_pull_policy: "String",
3310
- # command: ["String"],
3311
- # args: ["String"],
3312
- # env: [
3313
- # {
3314
- # name: "String", # required
3315
- # value: "String",
3316
- # },
3317
- # ],
3318
- # resources: {
3319
- # limits: {
3320
- # "String" => "Quantity",
3321
- # },
3322
- # requests: {
3323
- # "String" => "Quantity",
3324
- # },
3325
- # },
3326
- # volume_mounts: [
3327
- # {
3328
- # name: "String",
3329
- # mount_path: "String",
3330
- # read_only: false,
3331
- # },
3332
- # ],
3333
- # security_context: {
3334
- # run_as_user: 1,
3335
- # run_as_group: 1,
3336
- # privileged: false,
3337
- # read_only_root_filesystem: false,
3338
- # run_as_non_root: false,
3339
- # },
3340
- # }
3341
- #
3342
2907
  # @!attribute [rw] name
3343
2908
  # The name of the container. If the name isn't specified, the default
3344
2909
  # name "`Default`" is used. Each container in a pod must have a
@@ -3597,14 +3162,6 @@ module Aws::Batch
3597
3162
 
3598
3163
  # An environment variable.
3599
3164
  #
3600
- # @note When making an API call, you may pass EksContainerEnvironmentVariable
3601
- # data as a hash:
3602
- #
3603
- # {
3604
- # name: "String", # required
3605
- # value: "String",
3606
- # }
3607
- #
3608
3165
  # @!attribute [rw] name
3609
3166
  # The name of the environment variable.
3610
3167
  # @return [String]
@@ -3625,29 +3182,6 @@ module Aws::Batch
3625
3182
  # Object representing any Kubernetes overrides to a job definition
3626
3183
  # that's used in a SubmitJob API operation.
3627
3184
  #
3628
- # @note When making an API call, you may pass EksContainerOverride
3629
- # data as a hash:
3630
- #
3631
- # {
3632
- # image: "String",
3633
- # command: ["String"],
3634
- # args: ["String"],
3635
- # env: [
3636
- # {
3637
- # name: "String", # required
3638
- # value: "String",
3639
- # },
3640
- # ],
3641
- # resources: {
3642
- # limits: {
3643
- # "String" => "Quantity",
3644
- # },
3645
- # requests: {
3646
- # "String" => "Quantity",
3647
- # },
3648
- # },
3649
- # }
3650
- #
3651
3185
  # @!attribute [rw] image
3652
3186
  # The override of the Docker image that's used to start the
3653
3187
  # container.
@@ -3716,18 +3250,6 @@ module Aws::Batch
3716
3250
  #
3717
3251
  # [1]: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
3718
3252
  #
3719
- # @note When making an API call, you may pass EksContainerResourceRequirements
3720
- # data as a hash:
3721
- #
3722
- # {
3723
- # limits: {
3724
- # "String" => "Quantity",
3725
- # },
3726
- # requests: {
3727
- # "String" => "Quantity",
3728
- # },
3729
- # }
3730
- #
3731
3253
  # @!attribute [rw] limits
3732
3254
  # The type and quantity of the resources to reserve for the container.
3733
3255
  # The values vary based on the `name` that's specified. Resources can
@@ -3832,17 +3354,6 @@ module Aws::Batch
3832
3354
  #
3833
3355
  # [1]: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
3834
3356
  #
3835
- # @note When making an API call, you may pass EksContainerSecurityContext
3836
- # data as a hash:
3837
- #
3838
- # {
3839
- # run_as_user: 1,
3840
- # run_as_group: 1,
3841
- # privileged: false,
3842
- # read_only_root_filesystem: false,
3843
- # run_as_non_root: false,
3844
- # }
3845
- #
3846
3357
  # @!attribute [rw] run_as_user
3847
3358
  # When this parameter is specified, the container is run as the
3848
3359
  # specified user ID (`uid`). If this parameter isn't specified, the
@@ -3926,15 +3437,6 @@ module Aws::Batch
3926
3437
  #
3927
3438
  # [1]: https://kubernetes.io/docs/concepts/storage/volumes/
3928
3439
  #
3929
- # @note When making an API call, you may pass EksContainerVolumeMount
3930
- # data as a hash:
3931
- #
3932
- # {
3933
- # name: "String",
3934
- # mount_path: "String",
3935
- # read_only: false,
3936
- # }
3937
- #
3938
3440
  # @!attribute [rw] name
3939
3441
  # The name the volume mount. This must match the name of one of the
3940
3442
  # volumes in the pod.
@@ -3974,14 +3476,6 @@ module Aws::Batch
3974
3476
  #
3975
3477
  # [1]: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
3976
3478
  #
3977
- # @note When making an API call, you may pass EksEmptyDir
3978
- # data as a hash:
3979
- #
3980
- # {
3981
- # medium: "String",
3982
- # size_limit: "Quantity",
3983
- # }
3984
- #
3985
3479
  # @!attribute [rw] medium
3986
3480
  # The medium to store the volume. The default value is an empty
3987
3481
  # string, which uses the storage of the node.
@@ -4021,13 +3515,6 @@ module Aws::Batch
4021
3515
  #
4022
3516
  # [1]: https://kubernetes.io/docs/concepts/storage/volumes/#hostpath
4023
3517
  #
4024
- # @note When making an API call, you may pass EksHostPath
4025
- # data as a hash:
4026
- #
4027
- # {
4028
- # path: "String",
4029
- # }
4030
- #
4031
3518
  # @!attribute [rw] path
4032
3519
  # The path of the file or directory on the host to mount into
4033
3520
  # containers on the pod.
@@ -4043,68 +3530,6 @@ module Aws::Batch
4043
3530
 
4044
3531
  # The properties for the pod.
4045
3532
  #
4046
- # @note When making an API call, you may pass EksPodProperties
4047
- # data as a hash:
4048
- #
4049
- # {
4050
- # service_account_name: "String",
4051
- # host_network: false,
4052
- # dns_policy: "String",
4053
- # containers: [
4054
- # {
4055
- # name: "String",
4056
- # image: "String", # required
4057
- # image_pull_policy: "String",
4058
- # command: ["String"],
4059
- # args: ["String"],
4060
- # env: [
4061
- # {
4062
- # name: "String", # required
4063
- # value: "String",
4064
- # },
4065
- # ],
4066
- # resources: {
4067
- # limits: {
4068
- # "String" => "Quantity",
4069
- # },
4070
- # requests: {
4071
- # "String" => "Quantity",
4072
- # },
4073
- # },
4074
- # volume_mounts: [
4075
- # {
4076
- # name: "String",
4077
- # mount_path: "String",
4078
- # read_only: false,
4079
- # },
4080
- # ],
4081
- # security_context: {
4082
- # run_as_user: 1,
4083
- # run_as_group: 1,
4084
- # privileged: false,
4085
- # read_only_root_filesystem: false,
4086
- # run_as_non_root: false,
4087
- # },
4088
- # },
4089
- # ],
4090
- # volumes: [
4091
- # {
4092
- # name: "String", # required
4093
- # host_path: {
4094
- # path: "String",
4095
- # },
4096
- # empty_dir: {
4097
- # medium: "String",
4098
- # size_limit: "Quantity",
4099
- # },
4100
- # secret: {
4101
- # secret_name: "String", # required
4102
- # optional: false,
4103
- # },
4104
- # },
4105
- # ],
4106
- # }
4107
- #
4108
3533
  # @!attribute [rw] service_account_name
4109
3534
  # The name of the service account that's used to run the pod. For
4110
3535
  # more information, see [Kubernetes service accounts][1] and
@@ -4262,33 +3687,6 @@ module Aws::Batch
4262
3687
  # An object that contains overrides for the Kubernetes pod properties of
4263
3688
  # a job.
4264
3689
  #
4265
- # @note When making an API call, you may pass EksPodPropertiesOverride
4266
- # data as a hash:
4267
- #
4268
- # {
4269
- # containers: [
4270
- # {
4271
- # image: "String",
4272
- # command: ["String"],
4273
- # args: ["String"],
4274
- # env: [
4275
- # {
4276
- # name: "String", # required
4277
- # value: "String",
4278
- # },
4279
- # ],
4280
- # resources: {
4281
- # limits: {
4282
- # "String" => "Quantity",
4283
- # },
4284
- # requests: {
4285
- # "String" => "Quantity",
4286
- # },
4287
- # },
4288
- # },
4289
- # ],
4290
- # }
4291
- #
4292
3690
  # @!attribute [rw] containers
4293
3691
  # The overrides for the container that's used on the Amazon EKS pod.
4294
3692
  # @return [Array<Types::EksContainerOverride>]
@@ -4304,70 +3702,6 @@ module Aws::Batch
4304
3702
  # An object that contains the properties for the Kubernetes resources of
4305
3703
  # a job.
4306
3704
  #
4307
- # @note When making an API call, you may pass EksProperties
4308
- # data as a hash:
4309
- #
4310
- # {
4311
- # pod_properties: {
4312
- # service_account_name: "String",
4313
- # host_network: false,
4314
- # dns_policy: "String",
4315
- # containers: [
4316
- # {
4317
- # name: "String",
4318
- # image: "String", # required
4319
- # image_pull_policy: "String",
4320
- # command: ["String"],
4321
- # args: ["String"],
4322
- # env: [
4323
- # {
4324
- # name: "String", # required
4325
- # value: "String",
4326
- # },
4327
- # ],
4328
- # resources: {
4329
- # limits: {
4330
- # "String" => "Quantity",
4331
- # },
4332
- # requests: {
4333
- # "String" => "Quantity",
4334
- # },
4335
- # },
4336
- # volume_mounts: [
4337
- # {
4338
- # name: "String",
4339
- # mount_path: "String",
4340
- # read_only: false,
4341
- # },
4342
- # ],
4343
- # security_context: {
4344
- # run_as_user: 1,
4345
- # run_as_group: 1,
4346
- # privileged: false,
4347
- # read_only_root_filesystem: false,
4348
- # run_as_non_root: false,
4349
- # },
4350
- # },
4351
- # ],
4352
- # volumes: [
4353
- # {
4354
- # name: "String", # required
4355
- # host_path: {
4356
- # path: "String",
4357
- # },
4358
- # empty_dir: {
4359
- # medium: "String",
4360
- # size_limit: "Quantity",
4361
- # },
4362
- # secret: {
4363
- # secret_name: "String", # required
4364
- # optional: false,
4365
- # },
4366
- # },
4367
- # ],
4368
- # },
4369
- # }
4370
- #
4371
3705
  # @!attribute [rw] pod_properties
4372
3706
  # The properties for the Kubernetes pod resources of a job.
4373
3707
  # @return [Types::EksPodProperties]
@@ -4398,35 +3732,6 @@ module Aws::Batch
4398
3732
  # An object that contains overrides for the Kubernetes resources of a
4399
3733
  # job.
4400
3734
  #
4401
- # @note When making an API call, you may pass EksPropertiesOverride
4402
- # data as a hash:
4403
- #
4404
- # {
4405
- # pod_properties: {
4406
- # containers: [
4407
- # {
4408
- # image: "String",
4409
- # command: ["String"],
4410
- # args: ["String"],
4411
- # env: [
4412
- # {
4413
- # name: "String", # required
4414
- # value: "String",
4415
- # },
4416
- # ],
4417
- # resources: {
4418
- # limits: {
4419
- # "String" => "Quantity",
4420
- # },
4421
- # requests: {
4422
- # "String" => "Quantity",
4423
- # },
4424
- # },
4425
- # },
4426
- # ],
4427
- # },
4428
- # }
4429
- #
4430
3735
  # @!attribute [rw] pod_properties
4431
3736
  # The overrides for the Kubernetes pod resources of a job.
4432
3737
  # @return [Types::EksPodPropertiesOverride]
@@ -4446,14 +3751,6 @@ module Aws::Batch
4446
3751
  #
4447
3752
  # [1]: https://kubernetes.io/docs/concepts/storage/volumes/#secret
4448
3753
  #
4449
- # @note When making an API call, you may pass EksSecret
4450
- # data as a hash:
4451
- #
4452
- # {
4453
- # secret_name: "String", # required
4454
- # optional: false,
4455
- # }
4456
- #
4457
3754
  # @!attribute [rw] secret_name
4458
3755
  # The name of the secret. The name must be allowed as a DNS subdomain
4459
3756
  # name. For more information, see [DNS subdomain names][1] in the
@@ -4479,24 +3776,6 @@ module Aws::Batch
4479
3776
 
4480
3777
  # Specifies an Amazon EKS volume for a job definition.
4481
3778
  #
4482
- # @note When making an API call, you may pass EksVolume
4483
- # data as a hash:
4484
- #
4485
- # {
4486
- # name: "String", # required
4487
- # host_path: {
4488
- # path: "String",
4489
- # },
4490
- # empty_dir: {
4491
- # medium: "String",
4492
- # size_limit: "Quantity",
4493
- # },
4494
- # secret: {
4495
- # secret_name: "String", # required
4496
- # optional: false,
4497
- # },
4498
- # }
4499
- #
4500
3779
  # @!attribute [rw] name
4501
3780
  # The name of the volume. The name must be allowed as a DNS subdomain
4502
3781
  # name. For more information, see [DNS subdomain names][1] in the
@@ -4552,16 +3831,6 @@ module Aws::Batch
4552
3831
  # `EvaluateOnExit` conditions in a `RetryStrategy` match, then the job
4553
3832
  # is retried.
4554
3833
  #
4555
- # @note When making an API call, you may pass EvaluateOnExit
4556
- # data as a hash:
4557
- #
4558
- # {
4559
- # on_status_reason: "String",
4560
- # on_reason: "String",
4561
- # on_exit_code: "String",
4562
- # action: "RETRY", # required, accepts RETRY, EXIT
4563
- # }
4564
- #
4565
3834
  # @!attribute [rw] on_status_reason
4566
3835
  # Contains a glob pattern to match against the `StatusReason` returned
4567
3836
  # for a job. The pattern can contain up to 512 characters. It can
@@ -4609,20 +3878,6 @@ module Aws::Batch
4609
3878
 
4610
3879
  # The fair share policy for a scheduling policy.
4611
3880
  #
4612
- # @note When making an API call, you may pass FairsharePolicy
4613
- # data as a hash:
4614
- #
4615
- # {
4616
- # share_decay_seconds: 1,
4617
- # compute_reservation: 1,
4618
- # share_distribution: [
4619
- # {
4620
- # share_identifier: "String", # required
4621
- # weight_factor: 1.0,
4622
- # },
4623
- # ],
4624
- # }
4625
- #
4626
3881
  # @!attribute [rw] share_decay_seconds
4627
3882
  # The amount of time (in seconds) to use to calculate a fair share
4628
3883
  # percentage for each fair share identifier in use. A value of zero
@@ -4671,13 +3926,6 @@ module Aws::Batch
4671
3926
  # resources. Jobs that run on EC2 resources must not specify this
4672
3927
  # parameter.
4673
3928
  #
4674
- # @note When making an API call, you may pass FargatePlatformConfiguration
4675
- # data as a hash:
4676
- #
4677
- # {
4678
- # platform_version: "String",
4679
- # }
4680
- #
4681
3929
  # @!attribute [rw] platform_version
4682
3930
  # The Fargate platform version where the jobs are running. A platform
4683
3931
  # version is specified only for jobs that are running on Fargate
@@ -4706,13 +3954,6 @@ module Aws::Batch
4706
3954
  # data isn't guaranteed to persist after the containers that are
4707
3955
  # associated with it stop running.
4708
3956
  #
4709
- # @note When making an API call, you may pass Host
4710
- # data as a hash:
4711
- #
4712
- # {
4713
- # source_path: "String",
4714
- # }
4715
- #
4716
3957
  # @!attribute [rw] source_path
4717
3958
  # The path on the host container instance that's presented to the
4718
3959
  # container. If this parameter is empty, then the Docker daemon has
@@ -4871,14 +4112,6 @@ module Aws::Batch
4871
4112
 
4872
4113
  # An object that represents an Batch job dependency.
4873
4114
  #
4874
- # @note When making an API call, you may pass JobDependency
4875
- # data as a hash:
4876
- #
4877
- # {
4878
- # job_id: "String",
4879
- # type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
4880
- # }
4881
- #
4882
4115
  # @!attribute [rw] job_id
4883
4116
  # The job ID of the Batch job that's associated with this dependency.
4884
4117
  # @return [String]
@@ -5048,6 +4281,14 @@ module Aws::Batch
5048
4281
  # A list of job attempts that are associated with this job.
5049
4282
  # @return [Array<Types::EksAttemptDetail>]
5050
4283
  #
4284
+ # @!attribute [rw] is_cancelled
4285
+ # Indicates whether the job is canceled.
4286
+ # @return [Boolean]
4287
+ #
4288
+ # @!attribute [rw] is_terminated
4289
+ # Indicates whether the job is terminated.
4290
+ # @return [Boolean]
4291
+ #
5051
4292
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobDetail AWS API Documentation
5052
4293
  #
5053
4294
  class JobDetail < Struct.new(
@@ -5076,7 +4317,9 @@ module Aws::Batch
5076
4317
  :propagate_tags,
5077
4318
  :platform_capabilities,
5078
4319
  :eks_properties,
5079
- :eks_attempts)
4320
+ :eks_attempts,
4321
+ :is_cancelled,
4322
+ :is_terminated)
5080
4323
  SENSITIVE = []
5081
4324
  include Aws::Structure
5082
4325
  end
@@ -5243,18 +4486,17 @@ module Aws::Batch
5243
4486
 
5244
4487
  # An object that represents a job timeout configuration.
5245
4488
  #
5246
- # @note When making an API call, you may pass JobTimeout
5247
- # data as a hash:
5248
- #
5249
- # {
5250
- # attempt_duration_seconds: 1,
5251
- # }
5252
- #
5253
4489
  # @!attribute [rw] attempt_duration_seconds
5254
4490
  # The job timeout time (in seconds) that's measured from the job
5255
4491
  # attempt's `startedAt` timestamp. After this time passes, Batch
5256
4492
  # terminates your jobs if they aren't finished. The minimum value for
5257
4493
  # the timeout is 60 seconds.
4494
+ #
4495
+ # For array jobs, the timeout applies to the child jobs, not to the
4496
+ # parent array job.
4497
+ #
4498
+ # For multi-node parallel (MNP) jobs, the timeout applies to the whole
4499
+ # job, not to the individual nodes.
5258
4500
  # @return [Integer]
5259
4501
  #
5260
4502
  # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/JobTimeout AWS API Documentation
@@ -5267,14 +4509,6 @@ module Aws::Batch
5267
4509
 
5268
4510
  # A key-value pair object.
5269
4511
  #
5270
- # @note When making an API call, you may pass KeyValuePair
5271
- # data as a hash:
5272
- #
5273
- # {
5274
- # name: "String",
5275
- # value: "String",
5276
- # }
5277
- #
5278
4512
  # @!attribute [rw] name
5279
4513
  # The name of the key-value pair. For environment variables, this is
5280
4514
  # the name of the environment variable.
@@ -5297,14 +4531,6 @@ module Aws::Batch
5297
4531
  # A filter name and value pair that's used to return a more specific
5298
4532
  # list of results from a `ListJobs` API operation.
5299
4533
  #
5300
- # @note When making an API call, you may pass KeyValuesPair
5301
- # data as a hash:
5302
- #
5303
- # {
5304
- # name: "String",
5305
- # values: ["String"],
5306
- # }
5307
- #
5308
4534
  # @!attribute [rw] name
5309
4535
  # The name of the filter. Filter names are case sensitive.
5310
4536
  # @return [String]
@@ -5336,15 +4562,6 @@ module Aws::Batch
5336
4562
  #
5337
4563
  # </note>
5338
4564
  #
5339
- # @note When making an API call, you may pass LaunchTemplateSpecification
5340
- # data as a hash:
5341
- #
5342
- # {
5343
- # launch_template_id: "String",
5344
- # launch_template_name: "String",
5345
- # version: "String",
5346
- # }
5347
- #
5348
4565
  # @!attribute [rw] launch_template_id
5349
4566
  # The ID of the launch template.
5350
4567
  # @return [String]
@@ -5393,30 +4610,6 @@ module Aws::Batch
5393
4610
  # Linux-specific modifications that are applied to the container, such
5394
4611
  # as details for device mappings.
5395
4612
  #
5396
- # @note When making an API call, you may pass LinuxParameters
5397
- # data as a hash:
5398
- #
5399
- # {
5400
- # devices: [
5401
- # {
5402
- # host_path: "String", # required
5403
- # container_path: "String",
5404
- # permissions: ["READ"], # accepts READ, WRITE, MKNOD
5405
- # },
5406
- # ],
5407
- # init_process_enabled: false,
5408
- # shared_memory_size: 1,
5409
- # tmpfs: [
5410
- # {
5411
- # container_path: "String", # required
5412
- # size: 1, # required
5413
- # mount_options: ["String"],
5414
- # },
5415
- # ],
5416
- # max_swap: 1,
5417
- # swappiness: 1,
5418
- # }
5419
- #
5420
4613
  # @!attribute [rw] devices
5421
4614
  # Any of the host devices to expose to the container. This parameter
5422
4615
  # maps to `Devices` in the [Create a container][1] section of the
@@ -5564,24 +4757,6 @@ module Aws::Batch
5564
4757
 
5565
4758
  # Contains the parameters for `ListJobs`.
5566
4759
  #
5567
- # @note When making an API call, you may pass ListJobsRequest
5568
- # data as a hash:
5569
- #
5570
- # {
5571
- # job_queue: "String",
5572
- # array_job_id: "String",
5573
- # multi_node_job_id: "String",
5574
- # job_status: "SUBMITTED", # accepts SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING, SUCCEEDED, FAILED
5575
- # max_results: 1,
5576
- # next_token: "String",
5577
- # filters: [
5578
- # {
5579
- # name: "String",
5580
- # values: ["String"],
5581
- # },
5582
- # ],
5583
- # }
5584
- #
5585
4760
  # @!attribute [rw] job_queue
5586
4761
  # The name or full Amazon Resource Name (ARN) of the job queue used to
5587
4762
  # list jobs.
@@ -5716,14 +4891,6 @@ module Aws::Batch
5716
4891
 
5717
4892
  # Contains the parameters for `ListSchedulingPolicies`.
5718
4893
  #
5719
- # @note When making an API call, you may pass ListSchedulingPoliciesRequest
5720
- # data as a hash:
5721
- #
5722
- # {
5723
- # max_results: 1,
5724
- # next_token: "String",
5725
- # }
5726
- #
5727
4894
  # @!attribute [rw] max_results
5728
4895
  # The maximum number of results that's returned by
5729
4896
  # `ListSchedulingPolicies` in paginated output. When this parameter is
@@ -5783,13 +4950,6 @@ module Aws::Batch
5783
4950
 
5784
4951
  # Contains the parameters for `ListTagsForResource`.
5785
4952
  #
5786
- # @note When making an API call, you may pass ListTagsForResourceRequest
5787
- # data as a hash:
5788
- #
5789
- # {
5790
- # resource_arn: "String", # required
5791
- # }
5792
- #
5793
4953
  # @!attribute [rw] resource_arn
5794
4954
  # The Amazon Resource Name (ARN) that identifies the resource that
5795
4955
  # tags are listed for. Batch resources that support tags are compute
@@ -5821,22 +4981,6 @@ module Aws::Batch
5821
4981
  # Log configuration options to send to a custom log driver for the
5822
4982
  # container.
5823
4983
  #
5824
- # @note When making an API call, you may pass LogConfiguration
5825
- # data as a hash:
5826
- #
5827
- # {
5828
- # log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
5829
- # options: {
5830
- # "String" => "String",
5831
- # },
5832
- # secret_options: [
5833
- # {
5834
- # name: "String", # required
5835
- # value_from: "String", # required
5836
- # },
5837
- # ],
5838
- # }
5839
- #
5840
4984
  # @!attribute [rw] log_driver
5841
4985
  # The log driver to use for the container. The valid values that are
5842
4986
  # listed for this parameter are log drivers that the Amazon ECS
@@ -5958,15 +5102,6 @@ module Aws::Batch
5958
5102
  #
5959
5103
  # [1]: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container
5960
5104
  #
5961
- # @note When making an API call, you may pass MountPoint
5962
- # data as a hash:
5963
- #
5964
- # {
5965
- # container_path: "String",
5966
- # read_only: false,
5967
- # source_volume: "String",
5968
- # }
5969
- #
5970
5105
  # @!attribute [rw] container_path
5971
5106
  # The path on the container where the host volume is mounted.
5972
5107
  # @return [String]
@@ -5995,13 +5130,6 @@ module Aws::Batch
5995
5130
  # resources. Jobs that are running on EC2 resources must not specify
5996
5131
  # this parameter.
5997
5132
  #
5998
- # @note When making an API call, you may pass NetworkConfiguration
5999
- # data as a hash:
6000
- #
6001
- # {
6002
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
6003
- # }
6004
- #
6005
5133
  # @!attribute [rw] assign_public_ip
6006
5134
  # Indicates whether the job has a public IP address. For a job that's
6007
5135
  # running on Fargate resources in a private subnet to send outbound
@@ -6081,36 +5209,6 @@ module Aws::Batch
6081
5209
  #
6082
5210
  # </note>
6083
5211
  #
6084
- # @note When making an API call, you may pass NodeOverrides
6085
- # data as a hash:
6086
- #
6087
- # {
6088
- # num_nodes: 1,
6089
- # node_property_overrides: [
6090
- # {
6091
- # target_nodes: "String", # required
6092
- # container_overrides: {
6093
- # vcpus: 1,
6094
- # memory: 1,
6095
- # command: ["String"],
6096
- # instance_type: "String",
6097
- # environment: [
6098
- # {
6099
- # name: "String",
6100
- # value: "String",
6101
- # },
6102
- # ],
6103
- # resource_requirements: [
6104
- # {
6105
- # value: "String", # required
6106
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
6107
- # },
6108
- # ],
6109
- # },
6110
- # },
6111
- # ],
6112
- # }
6113
- #
6114
5212
  # @!attribute [rw] num_nodes
6115
5213
  # The number of nodes to use with a multi-node parallel job. This
6116
5214
  # value overrides the number of nodes that are specified in the job
@@ -6149,119 +5247,6 @@ module Aws::Batch
6149
5247
  #
6150
5248
  # </note>
6151
5249
  #
6152
- # @note When making an API call, you may pass NodeProperties
6153
- # data as a hash:
6154
- #
6155
- # {
6156
- # num_nodes: 1, # required
6157
- # main_node: 1, # required
6158
- # node_range_properties: [ # required
6159
- # {
6160
- # target_nodes: "String", # required
6161
- # container: {
6162
- # image: "String",
6163
- # vcpus: 1,
6164
- # memory: 1,
6165
- # command: ["String"],
6166
- # job_role_arn: "String",
6167
- # execution_role_arn: "String",
6168
- # volumes: [
6169
- # {
6170
- # host: {
6171
- # source_path: "String",
6172
- # },
6173
- # name: "String",
6174
- # efs_volume_configuration: {
6175
- # file_system_id: "String", # required
6176
- # root_directory: "String",
6177
- # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
6178
- # transit_encryption_port: 1,
6179
- # authorization_config: {
6180
- # access_point_id: "String",
6181
- # iam: "ENABLED", # accepts ENABLED, DISABLED
6182
- # },
6183
- # },
6184
- # },
6185
- # ],
6186
- # environment: [
6187
- # {
6188
- # name: "String",
6189
- # value: "String",
6190
- # },
6191
- # ],
6192
- # mount_points: [
6193
- # {
6194
- # container_path: "String",
6195
- # read_only: false,
6196
- # source_volume: "String",
6197
- # },
6198
- # ],
6199
- # readonly_root_filesystem: false,
6200
- # privileged: false,
6201
- # ulimits: [
6202
- # {
6203
- # hard_limit: 1, # required
6204
- # name: "String", # required
6205
- # soft_limit: 1, # required
6206
- # },
6207
- # ],
6208
- # user: "String",
6209
- # instance_type: "String",
6210
- # resource_requirements: [
6211
- # {
6212
- # value: "String", # required
6213
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
6214
- # },
6215
- # ],
6216
- # linux_parameters: {
6217
- # devices: [
6218
- # {
6219
- # host_path: "String", # required
6220
- # container_path: "String",
6221
- # permissions: ["READ"], # accepts READ, WRITE, MKNOD
6222
- # },
6223
- # ],
6224
- # init_process_enabled: false,
6225
- # shared_memory_size: 1,
6226
- # tmpfs: [
6227
- # {
6228
- # container_path: "String", # required
6229
- # size: 1, # required
6230
- # mount_options: ["String"],
6231
- # },
6232
- # ],
6233
- # max_swap: 1,
6234
- # swappiness: 1,
6235
- # },
6236
- # log_configuration: {
6237
- # log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
6238
- # options: {
6239
- # "String" => "String",
6240
- # },
6241
- # secret_options: [
6242
- # {
6243
- # name: "String", # required
6244
- # value_from: "String", # required
6245
- # },
6246
- # ],
6247
- # },
6248
- # secrets: [
6249
- # {
6250
- # name: "String", # required
6251
- # value_from: "String", # required
6252
- # },
6253
- # ],
6254
- # network_configuration: {
6255
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
6256
- # },
6257
- # fargate_platform_configuration: {
6258
- # platform_version: "String",
6259
- # },
6260
- # },
6261
- # },
6262
- # ],
6263
- # }
6264
- #
6265
5250
  # @!attribute [rw] num_nodes
6266
5251
  # The number of nodes that are associated with a multi-node parallel
6267
5252
  # job.
@@ -6319,31 +5304,6 @@ module Aws::Batch
6319
5304
  # The object that represents any node overrides to a job definition
6320
5305
  # that's used in a SubmitJob API operation.
6321
5306
  #
6322
- # @note When making an API call, you may pass NodePropertyOverride
6323
- # data as a hash:
6324
- #
6325
- # {
6326
- # target_nodes: "String", # required
6327
- # container_overrides: {
6328
- # vcpus: 1,
6329
- # memory: 1,
6330
- # command: ["String"],
6331
- # instance_type: "String",
6332
- # environment: [
6333
- # {
6334
- # name: "String",
6335
- # value: "String",
6336
- # },
6337
- # ],
6338
- # resource_requirements: [
6339
- # {
6340
- # value: "String", # required
6341
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
6342
- # },
6343
- # ],
6344
- # },
6345
- # }
6346
- #
6347
5307
  # @!attribute [rw] target_nodes
6348
5308
  # The range of nodes, using node index values, that's used to
6349
5309
  # override. A range of `0:3` indicates nodes with index values of `0`
@@ -6369,113 +5329,6 @@ module Aws::Batch
6369
5329
  # An object that represents the properties of the node range for a
6370
5330
  # multi-node parallel job.
6371
5331
  #
6372
- # @note When making an API call, you may pass NodeRangeProperty
6373
- # data as a hash:
6374
- #
6375
- # {
6376
- # target_nodes: "String", # required
6377
- # container: {
6378
- # image: "String",
6379
- # vcpus: 1,
6380
- # memory: 1,
6381
- # command: ["String"],
6382
- # job_role_arn: "String",
6383
- # execution_role_arn: "String",
6384
- # volumes: [
6385
- # {
6386
- # host: {
6387
- # source_path: "String",
6388
- # },
6389
- # name: "String",
6390
- # efs_volume_configuration: {
6391
- # file_system_id: "String", # required
6392
- # root_directory: "String",
6393
- # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
6394
- # transit_encryption_port: 1,
6395
- # authorization_config: {
6396
- # access_point_id: "String",
6397
- # iam: "ENABLED", # accepts ENABLED, DISABLED
6398
- # },
6399
- # },
6400
- # },
6401
- # ],
6402
- # environment: [
6403
- # {
6404
- # name: "String",
6405
- # value: "String",
6406
- # },
6407
- # ],
6408
- # mount_points: [
6409
- # {
6410
- # container_path: "String",
6411
- # read_only: false,
6412
- # source_volume: "String",
6413
- # },
6414
- # ],
6415
- # readonly_root_filesystem: false,
6416
- # privileged: false,
6417
- # ulimits: [
6418
- # {
6419
- # hard_limit: 1, # required
6420
- # name: "String", # required
6421
- # soft_limit: 1, # required
6422
- # },
6423
- # ],
6424
- # user: "String",
6425
- # instance_type: "String",
6426
- # resource_requirements: [
6427
- # {
6428
- # value: "String", # required
6429
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
6430
- # },
6431
- # ],
6432
- # linux_parameters: {
6433
- # devices: [
6434
- # {
6435
- # host_path: "String", # required
6436
- # container_path: "String",
6437
- # permissions: ["READ"], # accepts READ, WRITE, MKNOD
6438
- # },
6439
- # ],
6440
- # init_process_enabled: false,
6441
- # shared_memory_size: 1,
6442
- # tmpfs: [
6443
- # {
6444
- # container_path: "String", # required
6445
- # size: 1, # required
6446
- # mount_options: ["String"],
6447
- # },
6448
- # ],
6449
- # max_swap: 1,
6450
- # swappiness: 1,
6451
- # },
6452
- # log_configuration: {
6453
- # log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
6454
- # options: {
6455
- # "String" => "String",
6456
- # },
6457
- # secret_options: [
6458
- # {
6459
- # name: "String", # required
6460
- # value_from: "String", # required
6461
- # },
6462
- # ],
6463
- # },
6464
- # secrets: [
6465
- # {
6466
- # name: "String", # required
6467
- # value_from: "String", # required
6468
- # },
6469
- # ],
6470
- # network_configuration: {
6471
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
6472
- # },
6473
- # fargate_platform_configuration: {
6474
- # platform_version: "String",
6475
- # },
6476
- # },
6477
- # }
6478
- #
6479
5332
  # @!attribute [rw] target_nodes
6480
5333
  # The range of nodes, using node index values. A range of `0:3`
6481
5334
  # indicates nodes with index values of `0` through `3`. If the
@@ -6502,306 +5355,6 @@ module Aws::Batch
6502
5355
 
6503
5356
  # Contains the parameters for `RegisterJobDefinition`.
6504
5357
  #
6505
- # @note When making an API call, you may pass RegisterJobDefinitionRequest
6506
- # data as a hash:
6507
- #
6508
- # {
6509
- # job_definition_name: "String", # required
6510
- # type: "container", # required, accepts container, multinode
6511
- # parameters: {
6512
- # "String" => "String",
6513
- # },
6514
- # scheduling_priority: 1,
6515
- # container_properties: {
6516
- # image: "String",
6517
- # vcpus: 1,
6518
- # memory: 1,
6519
- # command: ["String"],
6520
- # job_role_arn: "String",
6521
- # execution_role_arn: "String",
6522
- # volumes: [
6523
- # {
6524
- # host: {
6525
- # source_path: "String",
6526
- # },
6527
- # name: "String",
6528
- # efs_volume_configuration: {
6529
- # file_system_id: "String", # required
6530
- # root_directory: "String",
6531
- # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
6532
- # transit_encryption_port: 1,
6533
- # authorization_config: {
6534
- # access_point_id: "String",
6535
- # iam: "ENABLED", # accepts ENABLED, DISABLED
6536
- # },
6537
- # },
6538
- # },
6539
- # ],
6540
- # environment: [
6541
- # {
6542
- # name: "String",
6543
- # value: "String",
6544
- # },
6545
- # ],
6546
- # mount_points: [
6547
- # {
6548
- # container_path: "String",
6549
- # read_only: false,
6550
- # source_volume: "String",
6551
- # },
6552
- # ],
6553
- # readonly_root_filesystem: false,
6554
- # privileged: false,
6555
- # ulimits: [
6556
- # {
6557
- # hard_limit: 1, # required
6558
- # name: "String", # required
6559
- # soft_limit: 1, # required
6560
- # },
6561
- # ],
6562
- # user: "String",
6563
- # instance_type: "String",
6564
- # resource_requirements: [
6565
- # {
6566
- # value: "String", # required
6567
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
6568
- # },
6569
- # ],
6570
- # linux_parameters: {
6571
- # devices: [
6572
- # {
6573
- # host_path: "String", # required
6574
- # container_path: "String",
6575
- # permissions: ["READ"], # accepts READ, WRITE, MKNOD
6576
- # },
6577
- # ],
6578
- # init_process_enabled: false,
6579
- # shared_memory_size: 1,
6580
- # tmpfs: [
6581
- # {
6582
- # container_path: "String", # required
6583
- # size: 1, # required
6584
- # mount_options: ["String"],
6585
- # },
6586
- # ],
6587
- # max_swap: 1,
6588
- # swappiness: 1,
6589
- # },
6590
- # log_configuration: {
6591
- # log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
6592
- # options: {
6593
- # "String" => "String",
6594
- # },
6595
- # secret_options: [
6596
- # {
6597
- # name: "String", # required
6598
- # value_from: "String", # required
6599
- # },
6600
- # ],
6601
- # },
6602
- # secrets: [
6603
- # {
6604
- # name: "String", # required
6605
- # value_from: "String", # required
6606
- # },
6607
- # ],
6608
- # network_configuration: {
6609
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
6610
- # },
6611
- # fargate_platform_configuration: {
6612
- # platform_version: "String",
6613
- # },
6614
- # },
6615
- # node_properties: {
6616
- # num_nodes: 1, # required
6617
- # main_node: 1, # required
6618
- # node_range_properties: [ # required
6619
- # {
6620
- # target_nodes: "String", # required
6621
- # container: {
6622
- # image: "String",
6623
- # vcpus: 1,
6624
- # memory: 1,
6625
- # command: ["String"],
6626
- # job_role_arn: "String",
6627
- # execution_role_arn: "String",
6628
- # volumes: [
6629
- # {
6630
- # host: {
6631
- # source_path: "String",
6632
- # },
6633
- # name: "String",
6634
- # efs_volume_configuration: {
6635
- # file_system_id: "String", # required
6636
- # root_directory: "String",
6637
- # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
6638
- # transit_encryption_port: 1,
6639
- # authorization_config: {
6640
- # access_point_id: "String",
6641
- # iam: "ENABLED", # accepts ENABLED, DISABLED
6642
- # },
6643
- # },
6644
- # },
6645
- # ],
6646
- # environment: [
6647
- # {
6648
- # name: "String",
6649
- # value: "String",
6650
- # },
6651
- # ],
6652
- # mount_points: [
6653
- # {
6654
- # container_path: "String",
6655
- # read_only: false,
6656
- # source_volume: "String",
6657
- # },
6658
- # ],
6659
- # readonly_root_filesystem: false,
6660
- # privileged: false,
6661
- # ulimits: [
6662
- # {
6663
- # hard_limit: 1, # required
6664
- # name: "String", # required
6665
- # soft_limit: 1, # required
6666
- # },
6667
- # ],
6668
- # user: "String",
6669
- # instance_type: "String",
6670
- # resource_requirements: [
6671
- # {
6672
- # value: "String", # required
6673
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
6674
- # },
6675
- # ],
6676
- # linux_parameters: {
6677
- # devices: [
6678
- # {
6679
- # host_path: "String", # required
6680
- # container_path: "String",
6681
- # permissions: ["READ"], # accepts READ, WRITE, MKNOD
6682
- # },
6683
- # ],
6684
- # init_process_enabled: false,
6685
- # shared_memory_size: 1,
6686
- # tmpfs: [
6687
- # {
6688
- # container_path: "String", # required
6689
- # size: 1, # required
6690
- # mount_options: ["String"],
6691
- # },
6692
- # ],
6693
- # max_swap: 1,
6694
- # swappiness: 1,
6695
- # },
6696
- # log_configuration: {
6697
- # log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk
6698
- # options: {
6699
- # "String" => "String",
6700
- # },
6701
- # secret_options: [
6702
- # {
6703
- # name: "String", # required
6704
- # value_from: "String", # required
6705
- # },
6706
- # ],
6707
- # },
6708
- # secrets: [
6709
- # {
6710
- # name: "String", # required
6711
- # value_from: "String", # required
6712
- # },
6713
- # ],
6714
- # network_configuration: {
6715
- # assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
6716
- # },
6717
- # fargate_platform_configuration: {
6718
- # platform_version: "String",
6719
- # },
6720
- # },
6721
- # },
6722
- # ],
6723
- # },
6724
- # retry_strategy: {
6725
- # attempts: 1,
6726
- # evaluate_on_exit: [
6727
- # {
6728
- # on_status_reason: "String",
6729
- # on_reason: "String",
6730
- # on_exit_code: "String",
6731
- # action: "RETRY", # required, accepts RETRY, EXIT
6732
- # },
6733
- # ],
6734
- # },
6735
- # propagate_tags: false,
6736
- # timeout: {
6737
- # attempt_duration_seconds: 1,
6738
- # },
6739
- # tags: {
6740
- # "TagKey" => "TagValue",
6741
- # },
6742
- # platform_capabilities: ["EC2"], # accepts EC2, FARGATE
6743
- # eks_properties: {
6744
- # pod_properties: {
6745
- # service_account_name: "String",
6746
- # host_network: false,
6747
- # dns_policy: "String",
6748
- # containers: [
6749
- # {
6750
- # name: "String",
6751
- # image: "String", # required
6752
- # image_pull_policy: "String",
6753
- # command: ["String"],
6754
- # args: ["String"],
6755
- # env: [
6756
- # {
6757
- # name: "String", # required
6758
- # value: "String",
6759
- # },
6760
- # ],
6761
- # resources: {
6762
- # limits: {
6763
- # "String" => "Quantity",
6764
- # },
6765
- # requests: {
6766
- # "String" => "Quantity",
6767
- # },
6768
- # },
6769
- # volume_mounts: [
6770
- # {
6771
- # name: "String",
6772
- # mount_path: "String",
6773
- # read_only: false,
6774
- # },
6775
- # ],
6776
- # security_context: {
6777
- # run_as_user: 1,
6778
- # run_as_group: 1,
6779
- # privileged: false,
6780
- # read_only_root_filesystem: false,
6781
- # run_as_non_root: false,
6782
- # },
6783
- # },
6784
- # ],
6785
- # volumes: [
6786
- # {
6787
- # name: "String", # required
6788
- # host_path: {
6789
- # path: "String",
6790
- # },
6791
- # empty_dir: {
6792
- # medium: "String",
6793
- # size_limit: "Quantity",
6794
- # },
6795
- # secret: {
6796
- # secret_name: "String", # required
6797
- # optional: false,
6798
- # },
6799
- # },
6800
- # ],
6801
- # },
6802
- # },
6803
- # }
6804
- #
6805
5358
  # @!attribute [rw] job_definition_name
6806
5359
  # The name of the job definition to register. It can be up to 128
6807
5360
  # letters long. It can contain uppercase and lowercase letters,
@@ -6984,14 +5537,6 @@ module Aws::Batch
6984
5537
  # The type and amount of a resource to assign to a container. The
6985
5538
  # supported resources include `GPU`, `MEMORY`, and `VCPU`.
6986
5539
  #
6987
- # @note When making an API call, you may pass ResourceRequirement
6988
- # data as a hash:
6989
- #
6990
- # {
6991
- # value: "String", # required
6992
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
6993
- # }
6994
- #
6995
5540
  # @!attribute [rw] value
6996
5541
  # The quantity of the specified resource to reserve for the container.
6997
5542
  # The values vary based on the `type` specified.
@@ -7172,21 +5717,6 @@ module Aws::Batch
7172
5717
  #
7173
5718
  # [1]: https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html
7174
5719
  #
7175
- # @note When making an API call, you may pass RetryStrategy
7176
- # data as a hash:
7177
- #
7178
- # {
7179
- # attempts: 1,
7180
- # evaluate_on_exit: [
7181
- # {
7182
- # on_status_reason: "String",
7183
- # on_reason: "String",
7184
- # on_exit_code: "String",
7185
- # action: "RETRY", # required, accepts RETRY, EXIT
7186
- # },
7187
- # ],
7188
- # }
7189
- #
7190
5720
  # @!attribute [rw] attempts
7191
5721
  # The number of times to move a job to the `RUNNABLE` status. You can
7192
5722
  # specify between 1 and 10 attempts. If the value of `attempts` is
@@ -7280,14 +5810,6 @@ module Aws::Batch
7280
5810
  #
7281
5811
  # [1]: https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html
7282
5812
  #
7283
- # @note When making an API call, you may pass Secret
7284
- # data as a hash:
7285
- #
7286
- # {
7287
- # name: "String", # required
7288
- # value_from: "String", # required
7289
- # }
7290
- #
7291
5813
  # @!attribute [rw] name
7292
5814
  # The name of the secret.
7293
5815
  # @return [String]
@@ -7333,14 +5855,6 @@ module Aws::Batch
7333
5855
  # share policy. Fair share identifiers that aren't included have a
7334
5856
  # default weight of `1.0`.
7335
5857
  #
7336
- # @note When making an API call, you may pass ShareAttributes
7337
- # data as a hash:
7338
- #
7339
- # {
7340
- # share_identifier: "String", # required
7341
- # weight_factor: 1.0,
7342
- # }
7343
- #
7344
5858
  # @!attribute [rw] share_identifier
7345
5859
  # A fair share identifier or fair share identifier prefix. If the
7346
5860
  # string ends with an asterisk (*), this entry specifies the weight
@@ -7379,116 +5893,6 @@ module Aws::Batch
7379
5893
 
7380
5894
  # Contains the parameters for `SubmitJob`.
7381
5895
  #
7382
- # @note When making an API call, you may pass SubmitJobRequest
7383
- # data as a hash:
7384
- #
7385
- # {
7386
- # job_name: "String", # required
7387
- # job_queue: "String", # required
7388
- # share_identifier: "String",
7389
- # scheduling_priority_override: 1,
7390
- # array_properties: {
7391
- # size: 1,
7392
- # },
7393
- # depends_on: [
7394
- # {
7395
- # job_id: "String",
7396
- # type: "N_TO_N", # accepts N_TO_N, SEQUENTIAL
7397
- # },
7398
- # ],
7399
- # job_definition: "String", # required
7400
- # parameters: {
7401
- # "String" => "String",
7402
- # },
7403
- # container_overrides: {
7404
- # vcpus: 1,
7405
- # memory: 1,
7406
- # command: ["String"],
7407
- # instance_type: "String",
7408
- # environment: [
7409
- # {
7410
- # name: "String",
7411
- # value: "String",
7412
- # },
7413
- # ],
7414
- # resource_requirements: [
7415
- # {
7416
- # value: "String", # required
7417
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
7418
- # },
7419
- # ],
7420
- # },
7421
- # node_overrides: {
7422
- # num_nodes: 1,
7423
- # node_property_overrides: [
7424
- # {
7425
- # target_nodes: "String", # required
7426
- # container_overrides: {
7427
- # vcpus: 1,
7428
- # memory: 1,
7429
- # command: ["String"],
7430
- # instance_type: "String",
7431
- # environment: [
7432
- # {
7433
- # name: "String",
7434
- # value: "String",
7435
- # },
7436
- # ],
7437
- # resource_requirements: [
7438
- # {
7439
- # value: "String", # required
7440
- # type: "GPU", # required, accepts GPU, VCPU, MEMORY
7441
- # },
7442
- # ],
7443
- # },
7444
- # },
7445
- # ],
7446
- # },
7447
- # retry_strategy: {
7448
- # attempts: 1,
7449
- # evaluate_on_exit: [
7450
- # {
7451
- # on_status_reason: "String",
7452
- # on_reason: "String",
7453
- # on_exit_code: "String",
7454
- # action: "RETRY", # required, accepts RETRY, EXIT
7455
- # },
7456
- # ],
7457
- # },
7458
- # propagate_tags: false,
7459
- # timeout: {
7460
- # attempt_duration_seconds: 1,
7461
- # },
7462
- # tags: {
7463
- # "TagKey" => "TagValue",
7464
- # },
7465
- # eks_properties_override: {
7466
- # pod_properties: {
7467
- # containers: [
7468
- # {
7469
- # image: "String",
7470
- # command: ["String"],
7471
- # args: ["String"],
7472
- # env: [
7473
- # {
7474
- # name: "String", # required
7475
- # value: "String",
7476
- # },
7477
- # ],
7478
- # resources: {
7479
- # limits: {
7480
- # "String" => "Quantity",
7481
- # },
7482
- # requests: {
7483
- # "String" => "Quantity",
7484
- # },
7485
- # },
7486
- # },
7487
- # ],
7488
- # },
7489
- # },
7490
- # }
7491
- #
7492
5896
  # @!attribute [rw] job_name
7493
5897
  # The name of the job. It can be up to 128 letters long. The first
7494
5898
  # character must be alphanumeric, can contain uppercase and lowercase
@@ -7669,16 +6073,6 @@ module Aws::Batch
7669
6073
 
7670
6074
  # Contains the parameters for `TagResource`.
7671
6075
  #
7672
- # @note When making an API call, you may pass TagResourceRequest
7673
- # data as a hash:
7674
- #
7675
- # {
7676
- # resource_arn: "String", # required
7677
- # tags: { # required
7678
- # "TagKey" => "TagValue",
7679
- # },
7680
- # }
7681
- #
7682
6076
  # @!attribute [rw] resource_arn
7683
6077
  # The Amazon Resource Name (ARN) of the resource that tags are added
7684
6078
  # to. Batch resources that support tags are compute environments,
@@ -7713,14 +6107,6 @@ module Aws::Batch
7713
6107
 
7714
6108
  # Contains the parameters for `TerminateJob`.
7715
6109
  #
7716
- # @note When making an API call, you may pass TerminateJobRequest
7717
- # data as a hash:
7718
- #
7719
- # {
7720
- # job_id: "String", # required
7721
- # reason: "String", # required
7722
- # }
7723
- #
7724
6110
  # @!attribute [rw] job_id
7725
6111
  # The Batch job ID of the job to terminate.
7726
6112
  # @return [String]
@@ -7752,15 +6138,6 @@ module Aws::Batch
7752
6138
  #
7753
6139
  # </note>
7754
6140
  #
7755
- # @note When making an API call, you may pass Tmpfs
7756
- # data as a hash:
7757
- #
7758
- # {
7759
- # container_path: "String", # required
7760
- # size: 1, # required
7761
- # mount_options: ["String"],
7762
- # }
7763
- #
7764
6141
  # @!attribute [rw] container_path
7765
6142
  # The absolute file path in the container where the `tmpfs` volume is
7766
6143
  # mounted.
@@ -7802,15 +6179,6 @@ module Aws::Batch
7802
6179
  #
7803
6180
  # </note>
7804
6181
  #
7805
- # @note When making an API call, you may pass Ulimit
7806
- # data as a hash:
7807
- #
7808
- # {
7809
- # hard_limit: 1, # required
7810
- # name: "String", # required
7811
- # soft_limit: 1, # required
7812
- # }
7813
- #
7814
6182
  # @!attribute [rw] hard_limit
7815
6183
  # The hard limit for the `ulimit` type.
7816
6184
  # @return [Integer]
@@ -7835,14 +6203,6 @@ module Aws::Batch
7835
6203
 
7836
6204
  # Contains the parameters for `UntagResource`.
7837
6205
  #
7838
- # @note When making an API call, you may pass UntagResourceRequest
7839
- # data as a hash:
7840
- #
7841
- # {
7842
- # resource_arn: "String", # required
7843
- # tag_keys: ["TagKey"], # required
7844
- # }
7845
- #
7846
6206
  # @!attribute [rw] resource_arn
7847
6207
  # The Amazon Resource Name (ARN) of the resource from which to delete
7848
6208
  # tags. Batch resources that support tags are compute environments,
@@ -7870,51 +6230,6 @@ module Aws::Batch
7870
6230
 
7871
6231
  # Contains the parameters for `UpdateComputeEnvironment`.
7872
6232
  #
7873
- # @note When making an API call, you may pass UpdateComputeEnvironmentRequest
7874
- # data as a hash:
7875
- #
7876
- # {
7877
- # compute_environment: "String", # required
7878
- # state: "ENABLED", # accepts ENABLED, DISABLED
7879
- # unmanagedv_cpus: 1,
7880
- # compute_resources: {
7881
- # minv_cpus: 1,
7882
- # maxv_cpus: 1,
7883
- # desiredv_cpus: 1,
7884
- # subnets: ["String"],
7885
- # security_group_ids: ["String"],
7886
- # allocation_strategy: "BEST_FIT_PROGRESSIVE", # accepts BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED
7887
- # instance_types: ["String"],
7888
- # ec2_key_pair: "String",
7889
- # instance_role: "String",
7890
- # tags: {
7891
- # "String" => "String",
7892
- # },
7893
- # placement_group: "String",
7894
- # bid_percentage: 1,
7895
- # launch_template: {
7896
- # launch_template_id: "String",
7897
- # launch_template_name: "String",
7898
- # version: "String",
7899
- # },
7900
- # ec2_configuration: [
7901
- # {
7902
- # image_type: "ImageType", # required
7903
- # image_id_override: "ImageIdOverride",
7904
- # image_kubernetes_version: "KubernetesVersion",
7905
- # },
7906
- # ],
7907
- # update_to_latest_image_version: false,
7908
- # type: "EC2", # accepts EC2, SPOT, FARGATE, FARGATE_SPOT
7909
- # image_id: "String",
7910
- # },
7911
- # service_role: "String",
7912
- # update_policy: {
7913
- # terminate_jobs_on_update: false,
7914
- # job_execution_timeout_minutes: 1,
7915
- # },
7916
- # }
7917
- #
7918
6233
  # @!attribute [rw] compute_environment
7919
6234
  # The name or full Amazon Resource Name (ARN) of the compute
7920
6235
  # environment to update.
@@ -8035,22 +6350,6 @@ module Aws::Batch
8035
6350
 
8036
6351
  # Contains the parameters for `UpdateJobQueue`.
8037
6352
  #
8038
- # @note When making an API call, you may pass UpdateJobQueueRequest
8039
- # data as a hash:
8040
- #
8041
- # {
8042
- # job_queue: "String", # required
8043
- # state: "ENABLED", # accepts ENABLED, DISABLED
8044
- # scheduling_policy_arn: "String",
8045
- # priority: 1,
8046
- # compute_environment_order: [
8047
- # {
8048
- # order: 1, # required
8049
- # compute_environment: "String", # required
8050
- # },
8051
- # ],
8052
- # }
8053
- #
8054
6353
  # @!attribute [rw] job_queue
8055
6354
  # The name or the Amazon Resource Name (ARN) of the job queue.
8056
6355
  # @return [String]
@@ -8137,14 +6436,6 @@ module Aws::Batch
8137
6436
  #
8138
6437
  # [1]: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
8139
6438
  #
8140
- # @note When making an API call, you may pass UpdatePolicy
8141
- # data as a hash:
8142
- #
8143
- # {
8144
- # terminate_jobs_on_update: false,
8145
- # job_execution_timeout_minutes: 1,
8146
- # }
8147
- #
8148
6439
  # @!attribute [rw] terminate_jobs_on_update
8149
6440
  # Specifies whether jobs are automatically terminated when the
8150
6441
  # computer environment infrastructure is updated. The default value is
@@ -8167,23 +6458,6 @@ module Aws::Batch
8167
6458
 
8168
6459
  # Contains the parameters for `UpdateSchedulingPolicy`.
8169
6460
  #
8170
- # @note When making an API call, you may pass UpdateSchedulingPolicyRequest
8171
- # data as a hash:
8172
- #
8173
- # {
8174
- # arn: "String", # required
8175
- # fairshare_policy: {
8176
- # share_decay_seconds: 1,
8177
- # compute_reservation: 1,
8178
- # share_distribution: [
8179
- # {
8180
- # share_identifier: "String", # required
8181
- # weight_factor: 1.0,
8182
- # },
8183
- # ],
8184
- # },
8185
- # }
8186
- #
8187
6461
  # @!attribute [rw] arn
8188
6462
  # The Amazon Resource Name (ARN) of the scheduling policy to update.
8189
6463
  # @return [String]
@@ -8207,26 +6481,6 @@ module Aws::Batch
8207
6481
 
8208
6482
  # A data volume that's used in a job's container properties.
8209
6483
  #
8210
- # @note When making an API call, you may pass Volume
8211
- # data as a hash:
8212
- #
8213
- # {
8214
- # host: {
8215
- # source_path: "String",
8216
- # },
8217
- # name: "String",
8218
- # efs_volume_configuration: {
8219
- # file_system_id: "String", # required
8220
- # root_directory: "String",
8221
- # transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
8222
- # transit_encryption_port: 1,
8223
- # authorization_config: {
8224
- # access_point_id: "String",
8225
- # iam: "ENABLED", # accepts ENABLED, DISABLED
8226
- # },
8227
- # },
8228
- # }
8229
- #
8230
6484
  # @!attribute [rw] host
8231
6485
  # The contents of the `host` parameter determine whether your data
8232
6486
  # volume persists on the host container instance and where it's