@aws-sdk/client-batch 3.523.0 → 3.525.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.
- package/dist-cjs/index.js +96 -3
- package/dist-es/protocols/Aws_restJson1.js +105 -4
- package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +59 -45
- package/dist-types/commands/CreateJobQueueCommand.d.ts +7 -6
- package/dist-types/commands/DeleteComputeEnvironmentCommand.d.ts +6 -3
- package/dist-types/commands/DeleteJobQueueCommand.d.ts +5 -3
- package/dist-types/commands/DeregisterJobDefinitionCommand.d.ts +2 -1
- package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +121 -2
- package/dist-types/commands/DescribeJobsCommand.d.ts +133 -0
- package/dist-types/commands/ListJobsCommand.d.ts +2 -2
- package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +119 -0
- package/dist-types/commands/SubmitJobCommand.d.ts +65 -15
- package/dist-types/commands/TagResourceCommand.d.ts +4 -3
- package/dist-types/commands/TerminateJobCommand.d.ts +4 -3
- package/dist-types/models/models_0.d.ts +1394 -448
- package/dist-types/ts3.4/models/models_0.d.ts +103 -0
- package/package.json +17 -17
- package/dist-cjs/Batch.js +0 -1
- package/dist-cjs/BatchClient.js +0 -1
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +0 -1
- package/dist-cjs/commands/CancelJobCommand.js +0 -1
- package/dist-cjs/commands/CreateComputeEnvironmentCommand.js +0 -1
- package/dist-cjs/commands/CreateJobQueueCommand.js +0 -1
- package/dist-cjs/commands/CreateSchedulingPolicyCommand.js +0 -1
- package/dist-cjs/commands/DeleteComputeEnvironmentCommand.js +0 -1
- package/dist-cjs/commands/DeleteJobQueueCommand.js +0 -1
- package/dist-cjs/commands/DeleteSchedulingPolicyCommand.js +0 -1
- package/dist-cjs/commands/DeregisterJobDefinitionCommand.js +0 -1
- package/dist-cjs/commands/DescribeComputeEnvironmentsCommand.js +0 -1
- package/dist-cjs/commands/DescribeJobDefinitionsCommand.js +0 -1
- package/dist-cjs/commands/DescribeJobQueuesCommand.js +0 -1
- package/dist-cjs/commands/DescribeJobsCommand.js +0 -1
- package/dist-cjs/commands/DescribeSchedulingPoliciesCommand.js +0 -1
- package/dist-cjs/commands/ListJobsCommand.js +0 -1
- package/dist-cjs/commands/ListSchedulingPoliciesCommand.js +0 -1
- package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -1
- package/dist-cjs/commands/RegisterJobDefinitionCommand.js +0 -1
- package/dist-cjs/commands/SubmitJobCommand.js +0 -1
- package/dist-cjs/commands/TagResourceCommand.js +0 -1
- package/dist-cjs/commands/TerminateJobCommand.js +0 -1
- package/dist-cjs/commands/UntagResourceCommand.js +0 -1
- package/dist-cjs/commands/UpdateComputeEnvironmentCommand.js +0 -1
- package/dist-cjs/commands/UpdateJobQueueCommand.js +0 -1
- package/dist-cjs/commands/UpdateSchedulingPolicyCommand.js +0 -1
- package/dist-cjs/commands/index.js +0 -1
- package/dist-cjs/endpoint/EndpointParameters.js +0 -1
- package/dist-cjs/extensionConfiguration.js +0 -1
- package/dist-cjs/models/BatchServiceException.js +0 -1
- package/dist-cjs/models/index.js +0 -1
- package/dist-cjs/models/models_0.js +0 -1
- package/dist-cjs/pagination/DescribeComputeEnvironmentsPaginator.js +0 -1
- package/dist-cjs/pagination/DescribeJobDefinitionsPaginator.js +0 -1
- package/dist-cjs/pagination/DescribeJobQueuesPaginator.js +0 -1
- package/dist-cjs/pagination/Interfaces.js +0 -1
- package/dist-cjs/pagination/ListJobsPaginator.js +0 -1
- package/dist-cjs/pagination/ListSchedulingPoliciesPaginator.js +0 -1
- package/dist-cjs/pagination/index.js +0 -1
- package/dist-cjs/protocols/Aws_restJson1.js +0 -1
- package/dist-cjs/runtimeExtensions.js +0 -1
|
@@ -179,9 +179,9 @@ export interface CancelJobRequest {
|
|
|
179
179
|
jobId: string | undefined;
|
|
180
180
|
/**
|
|
181
181
|
* @public
|
|
182
|
-
* <p>A message to attach to the job that explains the reason for canceling it. This message is
|
|
183
|
-
*
|
|
184
|
-
*
|
|
182
|
+
* <p>A message to attach to the job that explains the reason for canceling it. This message is
|
|
183
|
+
* returned by future <a>DescribeJobs</a> operations on the job. This message is also
|
|
184
|
+
* recorded in the Batch activity logs.</p>
|
|
185
185
|
*/
|
|
186
186
|
reason: string | undefined;
|
|
187
187
|
}
|
|
@@ -365,7 +365,7 @@ export interface LaunchTemplateSpecification {
|
|
|
365
365
|
* isn't changed when the compute environment is updated. It's only changed if the
|
|
366
366
|
* <code>updateToLatestImageVersion</code> parameter for the compute environment is set to
|
|
367
367
|
* <code>true</code>. During an infrastructure update, if either <code>$Latest</code> or
|
|
368
|
-
*
|
|
368
|
+
* <code>$Default</code> is specified, Batch re-evaluates the launch template version, and it
|
|
369
369
|
* might use a different version of the launch template. This is the case even if the launch
|
|
370
370
|
* template isn't specified in the update. When updating a compute environment, changing the launch
|
|
371
371
|
* template requires an infrastructure update of the compute environment. For more information, see
|
|
@@ -445,18 +445,18 @@ export interface ComputeResource {
|
|
|
445
445
|
* </dd>
|
|
446
446
|
* <dt>SPOT_PRICE_CAPACITY_OPTIMIZED</dt>
|
|
447
447
|
* <dd>
|
|
448
|
-
* <p>The price and capacity optimized allocation strategy looks at both price and
|
|
448
|
+
* <p>The price and capacity optimized allocation strategy looks at both price and capacity to
|
|
449
449
|
* select the Spot Instance pools that are the least likely to be interrupted and have the lowest
|
|
450
450
|
* possible price. This allocation strategy is only available for Spot Instance compute
|
|
451
451
|
* resources.</p>
|
|
452
452
|
* </dd>
|
|
453
453
|
* </dl>
|
|
454
454
|
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
455
|
-
*
|
|
455
|
+
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
|
|
456
456
|
* (recommended) strategies using On-Demand or Spot Instances, and the
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
457
|
+
* <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
458
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
|
|
459
|
+
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
460
460
|
*/
|
|
461
461
|
allocationStrategy?: CRAllocationStrategy;
|
|
462
462
|
/**
|
|
@@ -479,11 +479,11 @@ export interface ComputeResource {
|
|
|
479
479
|
* support.</p>
|
|
480
480
|
* <note>
|
|
481
481
|
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
482
|
-
*
|
|
482
|
+
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
|
|
483
483
|
* (recommended) strategies using On-Demand or Spot Instances, and the
|
|
484
|
-
*
|
|
485
|
-
*
|
|
486
|
-
*
|
|
484
|
+
* <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
485
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
|
|
486
|
+
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
487
487
|
* </note>
|
|
488
488
|
*/
|
|
489
489
|
maxvCpus: number | undefined;
|
|
@@ -578,9 +578,9 @@ export interface ComputeResource {
|
|
|
578
578
|
ec2KeyPair?: string;
|
|
579
579
|
/**
|
|
580
580
|
* @public
|
|
581
|
-
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This
|
|
582
|
-
* for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN)
|
|
583
|
-
*
|
|
581
|
+
* <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This
|
|
582
|
+
* parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN)
|
|
583
|
+
* of an instance profile. For example, <code>
|
|
584
584
|
* <i>ecsInstanceRole</i>
|
|
585
585
|
* </code> or
|
|
586
586
|
* <code>arn:aws:iam::<i><aws_account_id></i>:instance-profile/<i>ecsInstanceRole</i>
|
|
@@ -593,13 +593,13 @@ export interface ComputeResource {
|
|
|
593
593
|
instanceRole?: string;
|
|
594
594
|
/**
|
|
595
595
|
* @public
|
|
596
|
-
* <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute
|
|
596
|
+
* <p>Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute
|
|
597
597
|
* environment. For Batch, these take the form of <code>"String1": "String2"</code>, where
|
|
598
598
|
* <code>String1</code> is the tag key and <code>String2</code> is the tag value-for example,
|
|
599
599
|
* <code>\{ "Name": "Batch Instance - C4OnDemand" \}</code>. This is helpful for recognizing your
|
|
600
600
|
* Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to
|
|
601
601
|
* the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
602
|
-
*
|
|
602
|
+
* <i>Batch User Guide</i>. These tags aren't seen when using the Batch
|
|
603
603
|
* <code>ListTagsForResource</code> API operation.</p>
|
|
604
604
|
* <note>
|
|
605
605
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
@@ -654,9 +654,9 @@ export interface ComputeResource {
|
|
|
654
654
|
/**
|
|
655
655
|
* @public
|
|
656
656
|
* <p>The launch template to use for your compute resources. Any other compute resource parameters
|
|
657
|
-
* that you specify in a <a>CreateComputeEnvironment</a> API operation override the same
|
|
658
|
-
*
|
|
659
|
-
*
|
|
657
|
+
* that you specify in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html">CreateComputeEnvironment</a> API operation override the same parameters in the launch
|
|
658
|
+
* template. You must specify either the launch template ID or launch template name in the request,
|
|
659
|
+
* but not both. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html">Launch template support</a> in the
|
|
660
660
|
* <i>Batch User Guide</i>.</p>
|
|
661
661
|
* <note>
|
|
662
662
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
|
|
@@ -665,8 +665,8 @@ export interface ComputeResource {
|
|
|
665
665
|
launchTemplate?: LaunchTemplateSpecification;
|
|
666
666
|
/**
|
|
667
667
|
* @public
|
|
668
|
-
* <p>Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances
|
|
669
|
-
* the compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
|
|
668
|
+
* <p>Provides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2 instances
|
|
669
|
+
* in the compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
|
|
670
670
|
* <code>ECS_AL2</code>.</p>
|
|
671
671
|
* <p>One or two values can be provided.</p>
|
|
672
672
|
* <note>
|
|
@@ -735,9 +735,8 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
735
735
|
computeEnvironmentName: string | undefined;
|
|
736
736
|
/**
|
|
737
737
|
* @public
|
|
738
|
-
* <p>The type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For
|
|
739
|
-
*
|
|
740
|
-
* <i>Batch User Guide</i>.</p>
|
|
738
|
+
* <p>The type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For
|
|
739
|
+
* more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute Environments</a> in the <i>Batch User Guide</i>.</p>
|
|
741
740
|
*/
|
|
742
741
|
type: CEType | undefined;
|
|
743
742
|
/**
|
|
@@ -767,50 +766,55 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
767
766
|
state?: CEState;
|
|
768
767
|
/**
|
|
769
768
|
* @public
|
|
770
|
-
* <p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only
|
|
771
|
-
*
|
|
772
|
-
*
|
|
769
|
+
* <p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only
|
|
770
|
+
* used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this
|
|
771
|
+
* parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p>
|
|
773
772
|
* <note>
|
|
774
|
-
* <p>This parameter is only supported when the <code>type</code> parameter is set to
|
|
773
|
+
* <p>This parameter is only supported when the <code>type</code> parameter is set to
|
|
774
|
+
* <code>UNMANAGED</code>.</p>
|
|
775
775
|
* </note>
|
|
776
776
|
*/
|
|
777
777
|
unmanagedvCpus?: number;
|
|
778
778
|
/**
|
|
779
779
|
* @public
|
|
780
|
-
* <p>Details about the compute resources managed by the compute environment. This parameter is
|
|
781
|
-
*
|
|
780
|
+
* <p>Details about the compute resources managed by the compute environment. This parameter is
|
|
781
|
+
* required for managed compute environments. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute Environments</a>
|
|
782
|
+
* in the <i>Batch User Guide</i>.</p>
|
|
782
783
|
*/
|
|
783
784
|
computeResources?: ComputeResource;
|
|
784
785
|
/**
|
|
785
786
|
* @public
|
|
786
|
-
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
|
|
787
|
-
*
|
|
788
|
-
*
|
|
787
|
+
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
|
|
788
|
+
* services on your behalf. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the
|
|
789
|
+
* <i>Batch User Guide</i>.</p>
|
|
789
790
|
* <important>
|
|
790
|
-
* <p>If your account already created the Batch service-linked role, that role is used by
|
|
791
|
-
*
|
|
792
|
-
*
|
|
793
|
-
*
|
|
791
|
+
* <p>If your account already created the Batch service-linked role, that role is used by
|
|
792
|
+
* default for your compute environment unless you specify a different role here. If the
|
|
793
|
+
* Batch service-linked role doesn't exist in your account, and no role is specified here,
|
|
794
|
+
* the service attempts to create the Batch service-linked role in your account.</p>
|
|
794
795
|
* </important>
|
|
795
|
-
* <p>If your specified role has a path other than <code>/</code>, then you must specify either
|
|
796
|
-
*
|
|
797
|
-
*
|
|
798
|
-
*
|
|
796
|
+
* <p>If your specified role has a path other than <code>/</code>, then you must specify either
|
|
797
|
+
* the full role ARN (recommended) or prefix the role name with the path. For example, if a
|
|
798
|
+
* role with the name <code>bar</code> has a path of <code>/foo/</code>, specify
|
|
799
|
+
* <code>/foo/bar</code> as the role name. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names">Friendly
|
|
800
|
+
* names and paths</a> in the <i>IAM User Guide</i>.</p>
|
|
799
801
|
* <note>
|
|
800
|
-
* <p>Depending on how you created your Batch service role, its ARN might contain the
|
|
801
|
-
*
|
|
802
|
-
*
|
|
803
|
-
*
|
|
802
|
+
* <p>Depending on how you created your Batch service role, its ARN might contain the
|
|
803
|
+
* <code>service-role</code> path prefix. When you only specify the name of the service role,
|
|
804
|
+
* Batch assumes that your ARN doesn't use the <code>service-role</code> path prefix. Because
|
|
805
|
+
* of this, we recommend that you specify the full ARN of your service role when you create
|
|
806
|
+
* compute environments.</p>
|
|
804
807
|
* </note>
|
|
805
808
|
*/
|
|
806
809
|
serviceRole?: string;
|
|
807
810
|
/**
|
|
808
811
|
* @public
|
|
809
|
-
* <p>The tags that you apply to the compute environment to help you categorize and organize
|
|
810
|
-
*
|
|
811
|
-
*
|
|
812
|
-
*
|
|
813
|
-
*
|
|
812
|
+
* <p>The tags that you apply to the compute environment to help you categorize and organize
|
|
813
|
+
* your resources. Each tag consists of a key and an optional value. For more information, see
|
|
814
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
815
|
+
* Resources</a> in <i>Amazon Web Services General Reference</i>.</p>
|
|
816
|
+
* <p>These tags can be updated or removed using the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html">TagResource</a> and <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html">UntagResource</a> API operations. These tags don't propagate to the underlying compute
|
|
817
|
+
* resources.</p>
|
|
814
818
|
*/
|
|
815
819
|
tags?: Record<string, string>;
|
|
816
820
|
/**
|
|
@@ -843,7 +847,7 @@ export interface CreateComputeEnvironmentResponse {
|
|
|
843
847
|
* for job placement first. Compute environments must be in the <code>VALID</code> state before you
|
|
844
848
|
* can associate them with a job queue. All of the compute environments must be either EC2
|
|
845
849
|
* (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or
|
|
846
|
-
* <code>FARGATE_SPOT</code>); EC2 and Fargate compute environments can't be mixed.</p>
|
|
850
|
+
* <code>FARGATE_SPOT</code>); Amazon EC2 and Fargate compute environments can't be mixed.</p>
|
|
847
851
|
* <note>
|
|
848
852
|
* <p>All compute environments that are associated with a job queue must share the same
|
|
849
853
|
* architecture. Batch doesn't support mixing compute environment architecture types in a single
|
|
@@ -883,57 +887,61 @@ export type JQState = (typeof JQState)[keyof typeof JQState];
|
|
|
883
887
|
export interface CreateJobQueueRequest {
|
|
884
888
|
/**
|
|
885
889
|
* @public
|
|
886
|
-
* <p>The name of the job queue. It can be up to 128 letters long. It can contain uppercase and
|
|
887
|
-
*
|
|
890
|
+
* <p>The name of the job queue. It can be up to 128 letters long. It can contain uppercase and
|
|
891
|
+
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
888
892
|
*/
|
|
889
893
|
jobQueueName: string | undefined;
|
|
890
894
|
/**
|
|
891
895
|
* @public
|
|
892
|
-
* <p>The state of the job queue. If the job queue state is <code>ENABLED</code>, it is able to
|
|
893
|
-
*
|
|
894
|
-
*
|
|
896
|
+
* <p>The state of the job queue. If the job queue state is <code>ENABLED</code>, it is able to
|
|
897
|
+
* accept jobs. If the job queue state is <code>DISABLED</code>, new jobs can't be added to the
|
|
898
|
+
* queue, but jobs already in the queue can finish.</p>
|
|
895
899
|
*/
|
|
896
900
|
state?: JQState;
|
|
897
901
|
/**
|
|
898
902
|
* @public
|
|
899
|
-
* <p>The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job
|
|
900
|
-
*
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
*
|
|
903
|
+
* <p>The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job
|
|
904
|
+
* queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue
|
|
905
|
+
* uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can
|
|
906
|
+
* replace but can't remove the fair share scheduling policy. The format is
|
|
907
|
+
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
904
908
|
* </code>.
|
|
905
|
-
*
|
|
906
|
-
*
|
|
909
|
+
* An example is
|
|
910
|
+
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
907
911
|
*/
|
|
908
912
|
schedulingPolicyArn?: string;
|
|
909
913
|
/**
|
|
910
914
|
* @public
|
|
911
|
-
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer
|
|
912
|
-
*
|
|
913
|
-
*
|
|
914
|
-
*
|
|
915
|
-
*
|
|
916
|
-
*
|
|
915
|
+
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer
|
|
916
|
+
* value for the <code>priority</code> parameter) are evaluated first when associated with the
|
|
917
|
+
* same compute environment. Priority is determined in descending order. For example, a job queue
|
|
918
|
+
* with a priority value of <code>10</code> is given scheduling preference over a job queue with
|
|
919
|
+
* a priority value of <code>1</code>. All of the compute environments must be either EC2
|
|
920
|
+
* (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or
|
|
921
|
+
* <code>FARGATE_SPOT</code>); EC2 and Fargate compute environments can't be mixed.</p>
|
|
917
922
|
*/
|
|
918
923
|
priority: number | undefined;
|
|
919
924
|
/**
|
|
920
925
|
* @public
|
|
921
|
-
* <p>The set of compute environments mapped to a job queue and their order relative to each
|
|
922
|
-
*
|
|
923
|
-
*
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
*
|
|
926
|
+
* <p>The set of compute environments mapped to a job queue and their order relative to each
|
|
927
|
+
* other. The job scheduler uses this parameter to determine which compute environment runs a
|
|
928
|
+
* specific job. Compute environments must be in the <code>VALID</code> state before you can
|
|
929
|
+
* associate them with a job queue. You can associate up to three compute environments with a job
|
|
930
|
+
* queue. All of the compute environments must be either EC2 (<code>EC2</code> or
|
|
931
|
+
* <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>); EC2 and
|
|
932
|
+
* Fargate compute environments can't be mixed.</p>
|
|
927
933
|
* <note>
|
|
928
|
-
* <p>All compute environments that are associated with a job queue must share the same
|
|
929
|
-
*
|
|
934
|
+
* <p>All compute environments that are associated with a job queue must share the same
|
|
935
|
+
* architecture. Batch doesn't support mixing compute environment architecture types in a
|
|
936
|
+
* single job queue.</p>
|
|
930
937
|
* </note>
|
|
931
938
|
*/
|
|
932
939
|
computeEnvironmentOrder: ComputeEnvironmentOrder[] | undefined;
|
|
933
940
|
/**
|
|
934
941
|
* @public
|
|
935
|
-
* <p>The tags that you apply to the job queue to help you categorize and organize your
|
|
936
|
-
*
|
|
942
|
+
* <p>The tags that you apply to the job queue to help you categorize and organize your
|
|
943
|
+
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>
|
|
944
|
+
* in <i>Batch User Guide</i>.</p>
|
|
937
945
|
*/
|
|
938
946
|
tags?: Record<string, string>;
|
|
939
947
|
}
|
|
@@ -1028,8 +1036,8 @@ export interface FairsharePolicy {
|
|
|
1028
1036
|
export interface CreateSchedulingPolicyRequest {
|
|
1029
1037
|
/**
|
|
1030
1038
|
* @public
|
|
1031
|
-
* <p>The name of the scheduling policy. It can be up to 128 letters long. It can contain
|
|
1032
|
-
*
|
|
1039
|
+
* <p>The name of the scheduling policy. It can be up to 128 letters long. It can contain
|
|
1040
|
+
* uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
1033
1041
|
*/
|
|
1034
1042
|
name: string | undefined;
|
|
1035
1043
|
/**
|
|
@@ -1039,9 +1047,9 @@ export interface CreateSchedulingPolicyRequest {
|
|
|
1039
1047
|
fairsharePolicy?: FairsharePolicy;
|
|
1040
1048
|
/**
|
|
1041
1049
|
* @public
|
|
1042
|
-
* <p>The tags that you apply to the scheduling policy to help you categorize and organize your
|
|
1043
|
-
*
|
|
1044
|
-
*
|
|
1050
|
+
* <p>The tags that you apply to the scheduling policy to help you categorize and organize your
|
|
1051
|
+
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
1052
|
+
* Resources</a> in <i>Amazon Web Services General Reference</i>.</p>
|
|
1045
1053
|
* <p>These tags can be updated or removed using the <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_TagResource.html">TagResource</a> and <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_UntagResource.html">UntagResource</a> API operations.</p>
|
|
1046
1054
|
*/
|
|
1047
1055
|
tags?: Record<string, string>;
|
|
@@ -1058,10 +1066,10 @@ export interface CreateSchedulingPolicyResponse {
|
|
|
1058
1066
|
/**
|
|
1059
1067
|
* @public
|
|
1060
1068
|
* <p>The Amazon Resource Name (ARN) of the scheduling policy. The format is
|
|
1061
|
-
*
|
|
1069
|
+
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
1062
1070
|
* </code>.
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1071
|
+
* For example,
|
|
1072
|
+
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
1065
1073
|
*/
|
|
1066
1074
|
arn: string | undefined;
|
|
1067
1075
|
}
|
|
@@ -1119,7 +1127,8 @@ export interface DeleteSchedulingPolicyResponse {
|
|
|
1119
1127
|
export interface DeregisterJobDefinitionRequest {
|
|
1120
1128
|
/**
|
|
1121
1129
|
* @public
|
|
1122
|
-
* <p>The name and revision (<code>name:revision</code>) or full Amazon Resource Name (ARN) of the job definition
|
|
1130
|
+
* <p>The name and revision (<code>name:revision</code>) or full Amazon Resource Name (ARN) of the job definition
|
|
1131
|
+
* to deregister.</p>
|
|
1123
1132
|
*/
|
|
1124
1133
|
jobDefinition: string | undefined;
|
|
1125
1134
|
}
|
|
@@ -1140,21 +1149,24 @@ export interface DescribeComputeEnvironmentsRequest {
|
|
|
1140
1149
|
computeEnvironments?: string[];
|
|
1141
1150
|
/**
|
|
1142
1151
|
* @public
|
|
1143
|
-
* <p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code>
|
|
1144
|
-
*
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1147
|
-
*
|
|
1148
|
-
*
|
|
1149
|
-
*
|
|
1152
|
+
* <p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code>
|
|
1153
|
+
* in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</code>
|
|
1154
|
+
* only returns <code>maxResults</code> results in a single page along with a
|
|
1155
|
+
* <code>nextToken</code> response element. The remaining results of the initial request can be
|
|
1156
|
+
* seen by sending another <code>DescribeComputeEnvironments</code> request with the returned
|
|
1157
|
+
* <code>nextToken</code> value. This value can be between 1 and
|
|
1158
|
+
* 100. If this parameter isn't used, then <code>DescribeComputeEnvironments</code>
|
|
1159
|
+
* returns up to 100 results and a <code>nextToken</code> value if
|
|
1160
|
+
* applicable.</p>
|
|
1150
1161
|
*/
|
|
1151
1162
|
maxResults?: number;
|
|
1152
1163
|
/**
|
|
1153
1164
|
* @public
|
|
1154
|
-
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1155
|
-
*
|
|
1156
|
-
*
|
|
1157
|
-
*
|
|
1165
|
+
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1166
|
+
* <code>DescribeComputeEnvironments</code> request where <code>maxResults</code> was used and
|
|
1167
|
+
* the results exceeded the value of that parameter. Pagination continues from the end of the
|
|
1168
|
+
* previous results that returned the <code>nextToken</code> value. This value is
|
|
1169
|
+
* <code>null</code> when there are no more results to return.</p>
|
|
1158
1170
|
* <note>
|
|
1159
1171
|
* <p>Treat this token as an opaque identifier that's only used to
|
|
1160
1172
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
@@ -1292,8 +1304,8 @@ export interface ComputeEnvironmentDetail {
|
|
|
1292
1304
|
/**
|
|
1293
1305
|
* @public
|
|
1294
1306
|
* <p>The service role that's associated with the compute environment that allows Batch to make
|
|
1295
|
-
* calls to Amazon Web Services API operations on your behalf. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in
|
|
1296
|
-
*
|
|
1307
|
+
* calls to Amazon Web Services API operations on your behalf. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the
|
|
1308
|
+
* <i>Batch User Guide</i>.</p>
|
|
1297
1309
|
*/
|
|
1298
1310
|
serviceRole?: string;
|
|
1299
1311
|
/**
|
|
@@ -1332,10 +1344,11 @@ export interface DescribeComputeEnvironmentsResponse {
|
|
|
1332
1344
|
computeEnvironments?: ComputeEnvironmentDetail[];
|
|
1333
1345
|
/**
|
|
1334
1346
|
* @public
|
|
1335
|
-
* <p>The <code>nextToken</code> value to include in a future
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1347
|
+
* <p>The <code>nextToken</code> value to include in a future
|
|
1348
|
+
* <code>DescribeComputeEnvironments</code> request. When the results of a
|
|
1349
|
+
* <code>DescribeComputeEnvironments</code> request exceed <code>maxResults</code>, this value
|
|
1350
|
+
* can be used to retrieve the next page of results. This value is <code>null</code> when there
|
|
1351
|
+
* are no more results to return.</p>
|
|
1339
1352
|
*/
|
|
1340
1353
|
nextToken?: string;
|
|
1341
1354
|
}
|
|
@@ -1349,18 +1362,20 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
1349
1362
|
* <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the
|
|
1350
1363
|
* format
|
|
1351
1364
|
* <code>arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}</code>
|
|
1352
|
-
* or a short version using the form <code>$\{JobDefinitionName\}:$\{Revision\}</code>. This
|
|
1365
|
+
* or a short version using the form <code>$\{JobDefinitionName\}:$\{Revision\}</code>. This
|
|
1366
|
+
* parameter can't be used with other parameters.</p>
|
|
1353
1367
|
*/
|
|
1354
1368
|
jobDefinitions?: string[];
|
|
1355
1369
|
/**
|
|
1356
1370
|
* @public
|
|
1357
|
-
* <p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated
|
|
1358
|
-
*
|
|
1359
|
-
*
|
|
1360
|
-
*
|
|
1361
|
-
*
|
|
1362
|
-
*
|
|
1363
|
-
*
|
|
1371
|
+
* <p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated
|
|
1372
|
+
* output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns
|
|
1373
|
+
* <code>maxResults</code> results in a single page and a <code>nextToken</code> response
|
|
1374
|
+
* element. The remaining results of the initial request can be seen by sending another
|
|
1375
|
+
* <code>DescribeJobDefinitions</code> request with the returned <code>nextToken</code> value.
|
|
1376
|
+
* This value can be between 1 and 100. If this parameter isn't
|
|
1377
|
+
* used, then <code>DescribeJobDefinitions</code> returns up to 100 results and
|
|
1378
|
+
* a <code>nextToken</code> value if applicable.</p>
|
|
1364
1379
|
*/
|
|
1365
1380
|
maxResults?: number;
|
|
1366
1381
|
/**
|
|
@@ -1375,10 +1390,11 @@ export interface DescribeJobDefinitionsRequest {
|
|
|
1375
1390
|
status?: string;
|
|
1376
1391
|
/**
|
|
1377
1392
|
* @public
|
|
1378
|
-
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1379
|
-
*
|
|
1380
|
-
*
|
|
1381
|
-
*
|
|
1393
|
+
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
1394
|
+
* <code>DescribeJobDefinitions</code> request where <code>maxResults</code> was used and the
|
|
1395
|
+
* results exceeded the value of that parameter. Pagination continues from the end of the
|
|
1396
|
+
* previous results that returned the <code>nextToken</code> value. This value is
|
|
1397
|
+
* <code>null</code> when there are no more results to return.</p>
|
|
1382
1398
|
* <note>
|
|
1383
1399
|
* <p>Treat this token as an opaque identifier that's only used to
|
|
1384
1400
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
@@ -1421,7 +1437,7 @@ export interface EphemeralStorage {
|
|
|
1421
1437
|
/**
|
|
1422
1438
|
* @public
|
|
1423
1439
|
* <p>The platform configuration for jobs that are running on Fargate resources. Jobs that run
|
|
1424
|
-
* on EC2 resources must not specify this parameter.</p>
|
|
1440
|
+
* on Amazon EC2 resources must not specify this parameter.</p>
|
|
1425
1441
|
*/
|
|
1426
1442
|
export interface FargatePlatformConfiguration {
|
|
1427
1443
|
/**
|
|
@@ -1762,7 +1778,8 @@ export interface LogConfiguration {
|
|
|
1762
1778
|
/**
|
|
1763
1779
|
* @public
|
|
1764
1780
|
* <p>Details for a Docker volume mount point that's used in a job's container properties. This
|
|
1765
|
-
* parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate">Create a
|
|
1781
|
+
* parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate">Create a
|
|
1782
|
+
* container</a> section of the <i>Docker Remote API</i> and the
|
|
1766
1783
|
* <code>--volume</code> option to docker run.</p>
|
|
1767
1784
|
*/
|
|
1768
1785
|
export interface MountPoint {
|
|
@@ -1786,7 +1803,7 @@ export interface MountPoint {
|
|
|
1786
1803
|
/**
|
|
1787
1804
|
* @public
|
|
1788
1805
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
1789
|
-
* running on EC2 resources must not specify this parameter.</p>
|
|
1806
|
+
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
1790
1807
|
*/
|
|
1791
1808
|
export interface NetworkConfiguration {
|
|
1792
1809
|
/**
|
|
@@ -1806,7 +1823,8 @@ export interface NetworkConfiguration {
|
|
|
1806
1823
|
export interface RepositoryCredentials {
|
|
1807
1824
|
/**
|
|
1808
1825
|
* @public
|
|
1809
|
-
* <p>The Amazon Resource Name (ARN) of the secret containing the private repository
|
|
1826
|
+
* <p>The Amazon Resource Name (ARN) of the secret containing the private repository
|
|
1827
|
+
* credentials.</p>
|
|
1810
1828
|
*/
|
|
1811
1829
|
credentialsParameter: string | undefined;
|
|
1812
1830
|
}
|
|
@@ -1846,7 +1864,7 @@ export interface ResourceRequirement {
|
|
|
1846
1864
|
* <dt>type="MEMORY"</dt>
|
|
1847
1865
|
* <dd>
|
|
1848
1866
|
* <p>The memory hard limit (in MiB) present to the container. This parameter is supported for
|
|
1849
|
-
* jobs that are running on EC2 resources. If your container attempts to exceed the memory
|
|
1867
|
+
* jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory
|
|
1850
1868
|
* specified, the container is terminated. This parameter maps to <code>Memory</code> in the
|
|
1851
1869
|
* <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
|
|
1852
1870
|
* <code>--memory</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. You
|
|
@@ -1940,7 +1958,7 @@ export interface ResourceRequirement {
|
|
|
1940
1958
|
* <p>The number of vCPUs reserved for the container. This parameter maps to
|
|
1941
1959
|
* <code>CpuShares</code> in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the
|
|
1942
1960
|
* <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares.
|
|
1943
|
-
* For EC2 resources, you must specify at least one vCPU. This is required but can be specified
|
|
1961
|
+
* For Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified
|
|
1944
1962
|
* in several places; it must be specified for each node at least once.</p>
|
|
1945
1963
|
* <p>The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more
|
|
1946
1964
|
* information about Fargate quotas, see <a href="https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate">Fargate quotas</a>
|
|
@@ -2002,51 +2020,49 @@ export interface ResourceRequirement {
|
|
|
2002
2020
|
}
|
|
2003
2021
|
/**
|
|
2004
2022
|
* @public
|
|
2005
|
-
* <p>
|
|
2006
|
-
*
|
|
2007
|
-
* </p>
|
|
2023
|
+
* <p> An object that represents the compute environment architecture for Batch jobs on
|
|
2024
|
+
* Fargate. </p>
|
|
2008
2025
|
*/
|
|
2009
2026
|
export interface RuntimePlatform {
|
|
2010
2027
|
/**
|
|
2011
2028
|
* @public
|
|
2012
2029
|
* <p>The operating system for the compute environment.
|
|
2013
2030
|
* Valid values are:
|
|
2014
|
-
*
|
|
2015
|
-
*
|
|
2016
|
-
*
|
|
2031
|
+
* <code>LINUX</code> (default), <code>WINDOWS_SERVER_2019_CORE</code>,
|
|
2032
|
+
* <code>WINDOWS_SERVER_2019_FULL</code>, <code>WINDOWS_SERVER_2022_CORE</code>, and
|
|
2033
|
+
* <code>WINDOWS_SERVER_2022_FULL</code>.</p>
|
|
2017
2034
|
* <note>
|
|
2018
2035
|
* <p>The following parameters can’t be set for Windows containers: <code>linuxParameters</code>,
|
|
2019
|
-
*
|
|
2020
|
-
*
|
|
2021
|
-
*
|
|
2036
|
+
* <code>privileged</code>, <code>user</code>, <code>ulimits</code>,
|
|
2037
|
+
* <code>readonlyRootFilesystem</code>,
|
|
2038
|
+
* and <code>efsVolumeConfiguration</code>.</p>
|
|
2022
2039
|
* </note>
|
|
2023
2040
|
* <note>
|
|
2024
2041
|
* <p>The Batch Scheduler checks
|
|
2025
|
-
*
|
|
2026
|
-
*
|
|
2027
|
-
*
|
|
2028
|
-
*
|
|
2029
|
-
*
|
|
2030
|
-
*
|
|
2031
|
-
*
|
|
2042
|
+
* the compute environments
|
|
2043
|
+
* that are attached to the job queue before registering a task definition with
|
|
2044
|
+
* Fargate. In this
|
|
2045
|
+
* scenario, the job queue is where the job is submitted. If the job requires a
|
|
2046
|
+
* Windows container and the first compute environment is <code>LINUX</code>, the compute
|
|
2047
|
+
* environment is skipped and the next compute environment is checked until a Windows-based compute
|
|
2048
|
+
* environment is found.</p>
|
|
2032
2049
|
* </note>
|
|
2033
2050
|
* <note>
|
|
2034
2051
|
* <p>Fargate Spot is not supported for
|
|
2035
|
-
*
|
|
2036
|
-
*
|
|
2037
|
-
*
|
|
2038
|
-
*
|
|
2039
|
-
*
|
|
2040
|
-
*
|
|
2041
|
-
*
|
|
2052
|
+
* <code>ARM64</code> and
|
|
2053
|
+
* Windows-based containers on Fargate. A job queue will be blocked if a
|
|
2054
|
+
* Fargate
|
|
2055
|
+
* <code>ARM64</code> or
|
|
2056
|
+
* Windows job is submitted to a job queue with only Fargate Spot compute environments.
|
|
2057
|
+
* However, you can attach both <code>FARGATE</code> and
|
|
2058
|
+
* <code>FARGATE_SPOT</code> compute environments to the same job queue.</p>
|
|
2042
2059
|
* </note>
|
|
2043
2060
|
*/
|
|
2044
2061
|
operatingSystemFamily?: string;
|
|
2045
2062
|
/**
|
|
2046
2063
|
* @public
|
|
2047
|
-
* <p>
|
|
2048
|
-
*
|
|
2049
|
-
* <code>X86_64</code> and <code>ARM64</code>.</p>
|
|
2064
|
+
* <p> The vCPU architecture. The default value is <code>X86_64</code>. Valid values are
|
|
2065
|
+
* <code>X86_64</code> and <code>ARM64</code>.</p>
|
|
2050
2066
|
* <note>
|
|
2051
2067
|
* <p>This parameter must be set to
|
|
2052
2068
|
* <code>X86_64</code>
|
|
@@ -2064,8 +2080,7 @@ export interface RuntimePlatform {
|
|
|
2064
2080
|
}
|
|
2065
2081
|
/**
|
|
2066
2082
|
* @public
|
|
2067
|
-
* <p>The <code>ulimit</code> settings to pass to the container. For more information, see
|
|
2068
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html">Ulimit</a>.</p>
|
|
2083
|
+
* <p>The <code>ulimit</code> settings to pass to the container. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html">Ulimit</a>.</p>
|
|
2069
2084
|
* <note>
|
|
2070
2085
|
* <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
|
|
2071
2086
|
* </note>
|
|
@@ -2078,10 +2093,11 @@ export interface Ulimit {
|
|
|
2078
2093
|
hardLimit: number | undefined;
|
|
2079
2094
|
/**
|
|
2080
2095
|
* @public
|
|
2081
|
-
* <p>The <code>type</code> of the <code>ulimit</code>. Valid values are: <code>core</code> |
|
|
2082
|
-
*
|
|
2083
|
-
*
|
|
2084
|
-
*
|
|
2096
|
+
* <p>The <code>type</code> of the <code>ulimit</code>. Valid values are: <code>core</code> |
|
|
2097
|
+
* <code>cpu</code> | <code>data</code> | <code>fsize</code> | <code>locks</code> |
|
|
2098
|
+
* <code>memlock</code> | <code>msgqueue</code> | <code>nice</code> | <code>nofile</code> |
|
|
2099
|
+
* <code>nproc</code> | <code>rss</code> | <code>rtprio</code> | <code>rttime</code> |
|
|
2100
|
+
* <code>sigpending</code> | <code>stack</code>.</p>
|
|
2085
2101
|
*/
|
|
2086
2102
|
name: string | undefined;
|
|
2087
2103
|
/**
|
|
@@ -2301,7 +2317,8 @@ export interface ContainerProperties {
|
|
|
2301
2317
|
*
|
|
2302
2318
|
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the vCPU
|
|
2303
2319
|
* requirements for the job definition. It's not supported for jobs running on Fargate resources.
|
|
2304
|
-
* For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the
|
|
2320
|
+
* For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the
|
|
2321
|
+
* job.</p>
|
|
2305
2322
|
* <p>Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to <code>CpuShares</code>
|
|
2306
2323
|
* in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
|
|
2307
2324
|
* <code>--cpu-shares</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. The
|
|
@@ -2315,10 +2332,10 @@ export interface ContainerProperties {
|
|
|
2315
2332
|
*
|
|
2316
2333
|
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the memory
|
|
2317
2334
|
* requirements for the job definition. It's not supported for jobs running on Fargate resources.
|
|
2318
|
-
* For jobs that run on EC2 resources, it specifies the memory hard limit (in MiB) for a
|
|
2319
|
-
* If your container attempts to exceed the specified number, it's terminated. You must
|
|
2320
|
-
* least 4 MiB of memory for a job using this parameter. The memory hard limit can be
|
|
2321
|
-
* several places. It must be specified for each node at least once.</p>
|
|
2335
|
+
* For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a
|
|
2336
|
+
* container. If your container attempts to exceed the specified number, it's terminated. You must
|
|
2337
|
+
* specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be
|
|
2338
|
+
* specified in several places. It must be specified for each node at least once.</p>
|
|
2322
2339
|
*/
|
|
2323
2340
|
memory?: number;
|
|
2324
2341
|
/**
|
|
@@ -2445,7 +2462,7 @@ export interface ContainerProperties {
|
|
|
2445
2462
|
* in the Docker documentation.</p>
|
|
2446
2463
|
* <note>
|
|
2447
2464
|
* <p>Batch currently supports a subset of the logging drivers available to the Docker daemon
|
|
2448
|
-
* (shown in the <a>LogConfiguration</a> data type).</p>
|
|
2465
|
+
* (shown in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html">LogConfiguration</a> data type).</p>
|
|
2449
2466
|
* </note>
|
|
2450
2467
|
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your
|
|
2451
2468
|
* container instance. To check the Docker Remote API version on your container instance, log in to your
|
|
@@ -2469,13 +2486,13 @@ export interface ContainerProperties {
|
|
|
2469
2486
|
/**
|
|
2470
2487
|
* @public
|
|
2471
2488
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
2472
|
-
* running on EC2 resources must not specify this parameter.</p>
|
|
2489
|
+
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
2473
2490
|
*/
|
|
2474
2491
|
networkConfiguration?: NetworkConfiguration;
|
|
2475
2492
|
/**
|
|
2476
2493
|
* @public
|
|
2477
2494
|
* <p>The platform configuration for jobs that are running on Fargate resources. Jobs that are
|
|
2478
|
-
* running on EC2 resources must not specify this parameter.</p>
|
|
2495
|
+
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
2479
2496
|
*/
|
|
2480
2497
|
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
2481
2498
|
/**
|
|
@@ -2487,7 +2504,8 @@ export interface ContainerProperties {
|
|
|
2487
2504
|
ephemeralStorage?: EphemeralStorage;
|
|
2488
2505
|
/**
|
|
2489
2506
|
* @public
|
|
2490
|
-
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
2507
|
+
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
2508
|
+
* Fargate.</p>
|
|
2491
2509
|
*/
|
|
2492
2510
|
runtimePlatform?: RuntimePlatform;
|
|
2493
2511
|
/**
|
|
@@ -2496,6 +2514,381 @@ export interface ContainerProperties {
|
|
|
2496
2514
|
*/
|
|
2497
2515
|
repositoryCredentials?: RepositoryCredentials;
|
|
2498
2516
|
}
|
|
2517
|
+
/**
|
|
2518
|
+
* @public
|
|
2519
|
+
* <p>A list of containers that this task depends on.</p>
|
|
2520
|
+
*/
|
|
2521
|
+
export interface TaskContainerDependency {
|
|
2522
|
+
/**
|
|
2523
|
+
* @public
|
|
2524
|
+
* <p>A unique identifier for the container.</p>
|
|
2525
|
+
*/
|
|
2526
|
+
containerName?: string;
|
|
2527
|
+
/**
|
|
2528
|
+
* @public
|
|
2529
|
+
* <p>The dependency condition of the container. The following are the available conditions and
|
|
2530
|
+
* their behavior:</p>
|
|
2531
|
+
* <ul>
|
|
2532
|
+
* <li>
|
|
2533
|
+
* <p>
|
|
2534
|
+
* <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. </p>
|
|
2535
|
+
* </li>
|
|
2536
|
+
* <li>
|
|
2537
|
+
* <p>
|
|
2538
|
+
* <code>COMPLETE</code> - This condition validates that a dependent container runs to
|
|
2539
|
+
* completion (exits) before permitting other containers to start. This can be useful for
|
|
2540
|
+
* nonessential containers that run a script and then exit. This condition can't be set on an
|
|
2541
|
+
* essential container. </p>
|
|
2542
|
+
* </li>
|
|
2543
|
+
* <li>
|
|
2544
|
+
* <p>
|
|
2545
|
+
* <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also
|
|
2546
|
+
* requires that the container exits with a zero status. This condition can't be set on an
|
|
2547
|
+
* essential container. </p>
|
|
2548
|
+
* </li>
|
|
2549
|
+
* </ul>
|
|
2550
|
+
*/
|
|
2551
|
+
condition?: string;
|
|
2552
|
+
}
|
|
2553
|
+
/**
|
|
2554
|
+
* @public
|
|
2555
|
+
* <p>Container properties are used for Amazon ECS-based job definitions. These properties to describe
|
|
2556
|
+
* the container that's launched as part of a job.</p>
|
|
2557
|
+
*/
|
|
2558
|
+
export interface TaskContainerProperties {
|
|
2559
|
+
/**
|
|
2560
|
+
* @public
|
|
2561
|
+
* <p>The command that's passed to the container. This parameter maps to <code>Cmd</code> in the
|
|
2562
|
+
* <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a
|
|
2563
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker
|
|
2564
|
+
* Remote API</a> and the <code>COMMAND</code> parameter to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. For more information,
|
|
2565
|
+
* see <a href="https://docs.docker.com/engine/reference/builder/#cmd">Dockerfile reference:
|
|
2566
|
+
* CMD</a>.</p>
|
|
2567
|
+
*/
|
|
2568
|
+
command?: string[];
|
|
2569
|
+
/**
|
|
2570
|
+
* @public
|
|
2571
|
+
* <p>A list of containers that this container depends on.</p>
|
|
2572
|
+
*/
|
|
2573
|
+
dependsOn?: TaskContainerDependency[];
|
|
2574
|
+
/**
|
|
2575
|
+
* @public
|
|
2576
|
+
* <p>The environment variables to pass to a container. This parameter maps to Env inthe <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a>
|
|
2577
|
+
* section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
|
|
2578
|
+
* and the <code>--env</code> parameter to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. </p>
|
|
2579
|
+
* <important>
|
|
2580
|
+
* <p>We don't recommend using plaintext environment variables for sensitive information, such as
|
|
2581
|
+
* credential data.</p>
|
|
2582
|
+
* </important>
|
|
2583
|
+
* <note>
|
|
2584
|
+
* <p>Environment variables cannot start with <code>AWS_BATCH</code>. This naming convention is
|
|
2585
|
+
* reserved for variables that Batch sets.</p>
|
|
2586
|
+
* </note>
|
|
2587
|
+
*/
|
|
2588
|
+
environment?: KeyValuePair[];
|
|
2589
|
+
/**
|
|
2590
|
+
* @public
|
|
2591
|
+
* <p>If the essential parameter of a container is marked as <code>true</code>, and that container
|
|
2592
|
+
* fails or stops for any reason, all other containers that are part of the task are stopped. If the
|
|
2593
|
+
* <code>essential</code> parameter of a container is marked as false, its failure doesn't affect
|
|
2594
|
+
* the rest of the containers in a task. If this parameter is omitted, a container is assumed to be
|
|
2595
|
+
* essential.</p>
|
|
2596
|
+
* <p>All tasks must have at least one essential container. If you have an application that's
|
|
2597
|
+
* composed of multiple containers, group containers that are used for a common purpose into
|
|
2598
|
+
* components, and separate the different components into multiple task definitions. For more
|
|
2599
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html">Application
|
|
2600
|
+
* Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2601
|
+
*/
|
|
2602
|
+
essential?: boolean;
|
|
2603
|
+
/**
|
|
2604
|
+
* @public
|
|
2605
|
+
* <p>The image used to start a container. This string is passed directly to the Docker daemon. By
|
|
2606
|
+
* default, images in the Docker Hub registry are available. Other repositories are specified with
|
|
2607
|
+
* either <code>repository-url/image:tag</code> or <code>repository-url/image@digest</code>. Up to
|
|
2608
|
+
* 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward
|
|
2609
|
+
* slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
2610
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
2611
|
+
* Remote API</a> and the <code>IMAGE</code> parameter of the <a href="https://docs.docker.com/engine/reference/run/#security-configuration">
|
|
2612
|
+
* <i>docker
|
|
2613
|
+
* run</i>
|
|
2614
|
+
* </a>.</p>
|
|
2615
|
+
*/
|
|
2616
|
+
image: string | undefined;
|
|
2617
|
+
/**
|
|
2618
|
+
* @public
|
|
2619
|
+
* <p>Linux-specific modifications that are applied to the container, such as Linux kernel
|
|
2620
|
+
* capabilities. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html">KernelCapabilities</a>.</p>
|
|
2621
|
+
*/
|
|
2622
|
+
linuxParameters?: LinuxParameters;
|
|
2623
|
+
/**
|
|
2624
|
+
* @public
|
|
2625
|
+
* <p>The log configuration specification for the container.</p>
|
|
2626
|
+
* <p>This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
2627
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
2628
|
+
* Remote API</a> and the <code>--log-driver</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
2629
|
+
* run</a>.</p>
|
|
2630
|
+
* <p>By default, containers use the same logging driver that the Docker daemon uses. However the
|
|
2631
|
+
* container can use a different logging driver than the Docker daemon by specifying a log driver
|
|
2632
|
+
* with this parameter in the container definition. To use a different logging driver for a
|
|
2633
|
+
* container, the log system must be configured properly on the container instance (or on a
|
|
2634
|
+
* different log server for remote logging options). For more information about the options for
|
|
2635
|
+
* different supported log drivers, see <a href="https://docs.docker.com/engine/admin/logging/overview/">Configure logging drivers </a>
|
|
2636
|
+
* in the <i>Docker documentation</i>.</p>
|
|
2637
|
+
* <note>
|
|
2638
|
+
* <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon
|
|
2639
|
+
* (shown in the <code>LogConfiguration</code> data type). Additional log drivers may be available
|
|
2640
|
+
* in future releases of the Amazon ECS container agent.</p>
|
|
2641
|
+
* </note>
|
|
2642
|
+
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container
|
|
2643
|
+
* instance. To check the Docker Remote API version on your container instance, log in to your
|
|
2644
|
+
* container instance and run the following command: sudo docker version <code>--format
|
|
2645
|
+
* '\{\{.Server.APIVersion\}\}'</code>
|
|
2646
|
+
* </p>
|
|
2647
|
+
* <note>
|
|
2648
|
+
* <p>The Amazon ECS container agent running on a container instance must register the logging drivers
|
|
2649
|
+
* available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment
|
|
2650
|
+
* variable before containers placed on that instance can use these log configuration options. For
|
|
2651
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS container agent
|
|
2652
|
+
* configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2653
|
+
* </note>
|
|
2654
|
+
*/
|
|
2655
|
+
logConfiguration?: LogConfiguration;
|
|
2656
|
+
/**
|
|
2657
|
+
* @public
|
|
2658
|
+
* <p>The mount points for data volumes in your container.</p>
|
|
2659
|
+
* <p>This parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
2660
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
2661
|
+
* Remote API</a> and the <a href="">--volume</a> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
2662
|
+
* run</a>.</p>
|
|
2663
|
+
* <p>Windows containers can mount whole directories on the same drive as
|
|
2664
|
+
* <code>$env:ProgramData</code>. Windows containers can't mount directories on a different drive,
|
|
2665
|
+
* and mount point can't be across drives.</p>
|
|
2666
|
+
*/
|
|
2667
|
+
mountPoints?: MountPoint[];
|
|
2668
|
+
/**
|
|
2669
|
+
* @public
|
|
2670
|
+
* <p>The name of a container. The name can be used as a unique identifier to target your <code>dependsOn</code> and <code>Overrides</code> objects. </p>
|
|
2671
|
+
*/
|
|
2672
|
+
name?: string;
|
|
2673
|
+
/**
|
|
2674
|
+
* @public
|
|
2675
|
+
* <p>When this parameter is <code>true</code>, the container is given elevated privileges on the
|
|
2676
|
+
* host container instance (similar to the <code>root</code> user). This parameter maps to
|
|
2677
|
+
* <code>Privileged</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
2678
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
2679
|
+
* Remote API</a> and the <code>--privileged</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
2680
|
+
* run</a>.</p>
|
|
2681
|
+
* <note>
|
|
2682
|
+
* <p>This parameter is not supported for Windows containers or tasks run on Fargate.</p>
|
|
2683
|
+
* </note>
|
|
2684
|
+
*/
|
|
2685
|
+
privileged?: boolean;
|
|
2686
|
+
/**
|
|
2687
|
+
* @public
|
|
2688
|
+
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
2689
|
+
* system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
2690
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
2691
|
+
* Remote API</a> and the <code>--read-only</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
2692
|
+
* run</a>.</p>
|
|
2693
|
+
* <note>
|
|
2694
|
+
* <p>This parameter is not supported for Windows containers.</p>
|
|
2695
|
+
* </note>
|
|
2696
|
+
*/
|
|
2697
|
+
readonlyRootFilesystem?: boolean;
|
|
2698
|
+
/**
|
|
2699
|
+
* @public
|
|
2700
|
+
* <p>The private repository authentication credentials to use.</p>
|
|
2701
|
+
*/
|
|
2702
|
+
repositoryCredentials?: RepositoryCredentials;
|
|
2703
|
+
/**
|
|
2704
|
+
* @public
|
|
2705
|
+
* <p>The type and amount of a resource to assign to a container. The only supported resource is a
|
|
2706
|
+
* GPU.</p>
|
|
2707
|
+
*/
|
|
2708
|
+
resourceRequirements?: ResourceRequirement[];
|
|
2709
|
+
/**
|
|
2710
|
+
* @public
|
|
2711
|
+
* <p>The secrets to pass to the container. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html">Specifying Sensitive
|
|
2712
|
+
* Data</a> in the Amazon Elastic Container Service Developer Guide.</p>
|
|
2713
|
+
*/
|
|
2714
|
+
secrets?: Secret[];
|
|
2715
|
+
/**
|
|
2716
|
+
* @public
|
|
2717
|
+
* <p>A list of <code>ulimits</code> to set in the container. If a <code>ulimit</code> value is
|
|
2718
|
+
* specified in a task definition, it overrides the default values set by Docker. This parameter
|
|
2719
|
+
* maps to <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
2720
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
2721
|
+
* Remote API</a> and the <code>--ulimit</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
2722
|
+
* run</a>.</p>
|
|
2723
|
+
* <p>Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating
|
|
2724
|
+
* system with the exception of the nofile resource limit parameter which Fargate overrides. The
|
|
2725
|
+
* <code>nofile</code> resource limit sets a restriction on the number of open files that a
|
|
2726
|
+
* container can use. The default <code>nofile</code> soft limit is <code>1024</code> and the
|
|
2727
|
+
* default hard limit is <code>65535</code>.</p>
|
|
2728
|
+
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container
|
|
2729
|
+
* instance. To check the Docker Remote API version on your container instance, log in to your
|
|
2730
|
+
* container instance and run the following command: sudo docker version <code>--format
|
|
2731
|
+
* '\{\{.Server.APIVersion\}\}'</code>
|
|
2732
|
+
* </p>
|
|
2733
|
+
* <note>
|
|
2734
|
+
* <p>This parameter is not supported for Windows containers.</p>
|
|
2735
|
+
* </note>
|
|
2736
|
+
*/
|
|
2737
|
+
ulimits?: Ulimit[];
|
|
2738
|
+
/**
|
|
2739
|
+
* @public
|
|
2740
|
+
* <p>The user to use inside the container. This parameter maps to User in the Create a container
|
|
2741
|
+
* section of the Docker Remote API and the --user option to docker run.</p>
|
|
2742
|
+
* <note>
|
|
2743
|
+
* <p>When running tasks using the <code>host</code> network mode, don't run containers using the
|
|
2744
|
+
* <code>root user (UID 0)</code>. We recommend using a non-root user for better security.</p>
|
|
2745
|
+
* </note>
|
|
2746
|
+
* <p>You can specify the <code>user</code> using the following formats. If specifying a UID or
|
|
2747
|
+
* GID, you must specify it as a positive integer.</p>
|
|
2748
|
+
* <ul>
|
|
2749
|
+
* <li>
|
|
2750
|
+
* <p>
|
|
2751
|
+
* <code>user</code>
|
|
2752
|
+
* </p>
|
|
2753
|
+
* </li>
|
|
2754
|
+
* <li>
|
|
2755
|
+
* <p>
|
|
2756
|
+
* <code>user:group</code>
|
|
2757
|
+
* </p>
|
|
2758
|
+
* </li>
|
|
2759
|
+
* <li>
|
|
2760
|
+
* <p>
|
|
2761
|
+
* <code>uid</code>
|
|
2762
|
+
* </p>
|
|
2763
|
+
* </li>
|
|
2764
|
+
* <li>
|
|
2765
|
+
* <p>
|
|
2766
|
+
* <code>uid:gid</code>
|
|
2767
|
+
* </p>
|
|
2768
|
+
* </li>
|
|
2769
|
+
* <li>
|
|
2770
|
+
* <p>
|
|
2771
|
+
* <code>user:gi</code>
|
|
2772
|
+
* </p>
|
|
2773
|
+
* </li>
|
|
2774
|
+
* <li>
|
|
2775
|
+
* <p>
|
|
2776
|
+
* <code>uid:group</code>
|
|
2777
|
+
* </p>
|
|
2778
|
+
* </li>
|
|
2779
|
+
* </ul>
|
|
2780
|
+
* <note>
|
|
2781
|
+
* <p>This parameter is not supported for Windows containers.</p>
|
|
2782
|
+
* </note>
|
|
2783
|
+
*/
|
|
2784
|
+
user?: string;
|
|
2785
|
+
}
|
|
2786
|
+
/**
|
|
2787
|
+
* @public
|
|
2788
|
+
* <p>The properties for a task definition that describes the container and volume definitions of
|
|
2789
|
+
* an Amazon ECS task. You can specify which Docker images to use, the required resources, and other
|
|
2790
|
+
* configurations related to launching the task definition through an Amazon ECS service or task.</p>
|
|
2791
|
+
*/
|
|
2792
|
+
export interface EcsTaskProperties {
|
|
2793
|
+
/**
|
|
2794
|
+
* @public
|
|
2795
|
+
* <p>This object is a list of containers.</p>
|
|
2796
|
+
*/
|
|
2797
|
+
containers: TaskContainerProperties[] | undefined;
|
|
2798
|
+
/**
|
|
2799
|
+
* @public
|
|
2800
|
+
* <p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand
|
|
2801
|
+
* the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
|
|
2802
|
+
* Fargate.</p>
|
|
2803
|
+
*/
|
|
2804
|
+
ephemeralStorage?: EphemeralStorage;
|
|
2805
|
+
/**
|
|
2806
|
+
* @public
|
|
2807
|
+
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate
|
|
2808
|
+
* resources, you must provide an execution role. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM role</a>
|
|
2809
|
+
* in the <i>Batch User Guide</i>.</p>
|
|
2810
|
+
*/
|
|
2811
|
+
executionRoleArn?: string;
|
|
2812
|
+
/**
|
|
2813
|
+
* @public
|
|
2814
|
+
* <p>The Fargate platform version where the jobs are running. A platform version is specified
|
|
2815
|
+
* only for jobs that are running on Fargate resources. If one isn't specified, the
|
|
2816
|
+
* <code>LATEST</code> platform version is used by default. This uses a recent, approved version of
|
|
2817
|
+
* the Fargate platform for compute resources. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate
|
|
2818
|
+
* platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
2819
|
+
*/
|
|
2820
|
+
platformVersion?: string;
|
|
2821
|
+
/**
|
|
2822
|
+
* @public
|
|
2823
|
+
* <p>The IPC resource namespace to use for the containers in the task. The valid values are
|
|
2824
|
+
* <code>host</code>, <code>task</code>, or <code>none</code>.</p>
|
|
2825
|
+
* <p>If <code>host</code> is specified, all containers within the tasks that specified the
|
|
2826
|
+
* <code>host</code> IPC mode on the same container instance share the same IPC resources with the
|
|
2827
|
+
* host Amazon EC2 instance.</p>
|
|
2828
|
+
* <p>If <code>task</code> is specified, all containers within the specified <code>task</code>
|
|
2829
|
+
* share the same IPC resources.</p>
|
|
2830
|
+
* <p>If <code>none</code> is specified, the IPC resources within the containers of a task are
|
|
2831
|
+
* private, and are not shared with other containers in a task or on the container instance. </p>
|
|
2832
|
+
* <p>If no value is specified, then the IPC resource namespace sharing depends on the Docker
|
|
2833
|
+
* daemon setting on the container instance. For more information, see <a href="https://docs.docker.com/engine/reference/run/#ipc-settings---ipc">IPC settings</a> in
|
|
2834
|
+
* the Docker run reference.</p>
|
|
2835
|
+
*/
|
|
2836
|
+
ipcMode?: string;
|
|
2837
|
+
/**
|
|
2838
|
+
* @public
|
|
2839
|
+
* <p>The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.</p>
|
|
2840
|
+
* <note>
|
|
2841
|
+
* <p>This is object is comparable to <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html">ContainerProperties:jobRoleArn</a>.</p>
|
|
2842
|
+
* </note>
|
|
2843
|
+
*/
|
|
2844
|
+
taskRoleArn?: string;
|
|
2845
|
+
/**
|
|
2846
|
+
* @public
|
|
2847
|
+
* <p>The process namespace to use for the containers in the task. The valid values are
|
|
2848
|
+
* <code>host</code> or <code>task</code>. For example, monitoring sidecars might need
|
|
2849
|
+
* <code>pidMode</code> to access information about other containers running in the same
|
|
2850
|
+
* task.</p>
|
|
2851
|
+
* <p>If <code>host</code> is specified, all containers within the tasks that specified the
|
|
2852
|
+
* <code>host</code> PID mode on the same container instance share the process namespace with the
|
|
2853
|
+
* host Amazon EC2 instance.</p>
|
|
2854
|
+
* <p>If <code>task</code> is specified, all containers within the specified task share the same
|
|
2855
|
+
* process namespace.</p>
|
|
2856
|
+
* <p>If no value is specified, the default is a private namespace for each container. For more
|
|
2857
|
+
* information, see <a href="https://docs.docker.com/engine/reference/run/#pid-settings---pid">PID settings</a> in the Docker run reference.</p>
|
|
2858
|
+
*/
|
|
2859
|
+
pidMode?: string;
|
|
2860
|
+
/**
|
|
2861
|
+
* @public
|
|
2862
|
+
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
2863
|
+
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
2864
|
+
*/
|
|
2865
|
+
networkConfiguration?: NetworkConfiguration;
|
|
2866
|
+
/**
|
|
2867
|
+
* @public
|
|
2868
|
+
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
2869
|
+
* Fargate.</p>
|
|
2870
|
+
*/
|
|
2871
|
+
runtimePlatform?: RuntimePlatform;
|
|
2872
|
+
/**
|
|
2873
|
+
* @public
|
|
2874
|
+
* <p>A list of volumes that are associated with the job.</p>
|
|
2875
|
+
*/
|
|
2876
|
+
volumes?: Volume[];
|
|
2877
|
+
}
|
|
2878
|
+
/**
|
|
2879
|
+
* @public
|
|
2880
|
+
* <p>An object that contains the properties for the Amazon ECS resources of a job.</p>
|
|
2881
|
+
*/
|
|
2882
|
+
export interface EcsProperties {
|
|
2883
|
+
/**
|
|
2884
|
+
* @public
|
|
2885
|
+
* <p>An object that contains the properties for the Amazon ECS task definition of a job.</p>
|
|
2886
|
+
* <note>
|
|
2887
|
+
* <p>This object is currently limited to one element.</p>
|
|
2888
|
+
* </note>
|
|
2889
|
+
*/
|
|
2890
|
+
taskProperties: EcsTaskProperties[] | undefined;
|
|
2891
|
+
}
|
|
2499
2892
|
/**
|
|
2500
2893
|
* @public
|
|
2501
2894
|
* <p>An environment variable.</p>
|
|
@@ -2728,8 +3121,8 @@ export interface EksContainer {
|
|
|
2728
3121
|
* environment variable doesn't exist, the command string will remain "<code>$(NAME1)</code>."
|
|
2729
3122
|
* <code>$$</code> is replaced with <code>$</code>, and the resulting string isn't expanded. For
|
|
2730
3123
|
* example, <code>$$(VAR_NAME)</code> is passed as <code>$(VAR_NAME)</code> whether or not the
|
|
2731
|
-
* <code>VAR_NAME</code> environment variable exists. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">CMD</a>
|
|
2732
|
-
*
|
|
3124
|
+
* <code>VAR_NAME</code> environment variable exists. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">Dockerfile reference: CMD</a>
|
|
3125
|
+
* and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command and arguments for a pod</a> in the <i>Kubernetes
|
|
2733
3126
|
* documentation</i>.</p>
|
|
2734
3127
|
*/
|
|
2735
3128
|
args?: string[];
|
|
@@ -2767,10 +3160,9 @@ export interface EksContainer {
|
|
|
2767
3160
|
}
|
|
2768
3161
|
/**
|
|
2769
3162
|
* @public
|
|
2770
|
-
* <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment
|
|
2771
|
-
*
|
|
2772
|
-
*
|
|
2773
|
-
* documentation</i>.</p>
|
|
3163
|
+
* <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment that
|
|
3164
|
+
* a pod runs in or the <code>jobID</code> for a job running in the pod. For more information, see
|
|
3165
|
+
* <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes documentation</i>.</p>
|
|
2774
3166
|
*/
|
|
2775
3167
|
export interface EksMetadata {
|
|
2776
3168
|
/**
|
|
@@ -2925,6 +3317,15 @@ export interface EksPodProperties {
|
|
|
2925
3317
|
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
|
|
2926
3318
|
*/
|
|
2927
3319
|
containers?: EksContainer[];
|
|
3320
|
+
/**
|
|
3321
|
+
* @public
|
|
3322
|
+
* <p>These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-containers/">Init
|
|
3323
|
+
* Containers</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3324
|
+
* <note>
|
|
3325
|
+
* <p>This object is limited to 10 elements</p>
|
|
3326
|
+
* </note>
|
|
3327
|
+
*/
|
|
3328
|
+
initContainers?: EksContainer[];
|
|
2928
3329
|
/**
|
|
2929
3330
|
* @public
|
|
2930
3331
|
* <p>Specifies the volumes for a job definition that uses Amazon EKS resources.</p>
|
|
@@ -2939,6 +3340,13 @@ export interface EksPodProperties {
|
|
|
2939
3340
|
* documentation</i>.</p>
|
|
2940
3341
|
*/
|
|
2941
3342
|
metadata?: EksMetadata;
|
|
3343
|
+
/**
|
|
3344
|
+
* @public
|
|
3345
|
+
* <p>Indicates if the processes in a container are shared, or visible, to other containers in the
|
|
3346
|
+
* same pod. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/">Share
|
|
3347
|
+
* Process Namespace between Containers in a Pod</a>.</p>
|
|
3348
|
+
*/
|
|
3349
|
+
shareProcessNamespace?: boolean;
|
|
2942
3350
|
}
|
|
2943
3351
|
/**
|
|
2944
3352
|
* @public
|
|
@@ -2953,7 +3361,7 @@ export interface EksProperties {
|
|
|
2953
3361
|
}
|
|
2954
3362
|
/**
|
|
2955
3363
|
* @public
|
|
2956
|
-
* <p>
|
|
3364
|
+
* <p>This is an object that represents the properties of the node range for a multi-node parallel
|
|
2957
3365
|
* job.</p>
|
|
2958
3366
|
*/
|
|
2959
3367
|
export interface NodeRangeProperty {
|
|
@@ -2973,6 +3381,21 @@ export interface NodeRangeProperty {
|
|
|
2973
3381
|
* <p>The container details for the node range.</p>
|
|
2974
3382
|
*/
|
|
2975
3383
|
container?: ContainerProperties;
|
|
3384
|
+
/**
|
|
3385
|
+
* @public
|
|
3386
|
+
* <p>The instance types of the underlying host infrastructure of a multi-node parallel job.</p>
|
|
3387
|
+
* <note>
|
|
3388
|
+
* <p>This parameter isn't applicable to jobs that are running on Fargate resources.</p>
|
|
3389
|
+
* <p>In addition, this list object is currently limited to one element.</p>
|
|
3390
|
+
* </note>
|
|
3391
|
+
*/
|
|
3392
|
+
instanceTypes?: string[];
|
|
3393
|
+
/**
|
|
3394
|
+
* @public
|
|
3395
|
+
* <p>This is an object that represents the properties of the node range for a multi-node parallel
|
|
3396
|
+
* job.</p>
|
|
3397
|
+
*/
|
|
3398
|
+
ecsProperties?: EcsProperties;
|
|
2976
3399
|
}
|
|
2977
3400
|
/**
|
|
2978
3401
|
* @public
|
|
@@ -3096,7 +3519,7 @@ export interface JobTimeout {
|
|
|
3096
3519
|
/**
|
|
3097
3520
|
* @public
|
|
3098
3521
|
* <p>The job timeout time (in seconds) that's measured from the job attempt's
|
|
3099
|
-
*
|
|
3522
|
+
* <code>startedAt</code> timestamp. After this time passes, Batch terminates your jobs if they
|
|
3100
3523
|
* aren't finished. The minimum value for the timeout is 60 seconds.</p>
|
|
3101
3524
|
* <p>For array jobs, the timeout applies to the child jobs, not to the parent array job.</p>
|
|
3102
3525
|
* <p>For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the
|
|
@@ -3161,9 +3584,8 @@ export interface JobDefinition {
|
|
|
3161
3584
|
retryStrategy?: RetryStrategy;
|
|
3162
3585
|
/**
|
|
3163
3586
|
* @public
|
|
3164
|
-
* <p>An object with
|
|
3165
|
-
* <code>
|
|
3166
|
-
* Only one can be specified.</p>
|
|
3587
|
+
* <p>An object with properties specific to Amazon ECS-based jobs. When <code>containerProperties</code> is used in the job definition, it can't be used in addition to <code>eksProperties</code>, <code>ecsProperties</code>, or
|
|
3588
|
+
* <code>nodeProperties</code>.</p>
|
|
3167
3589
|
*/
|
|
3168
3590
|
containerProperties?: ContainerProperties;
|
|
3169
3591
|
/**
|
|
@@ -3174,9 +3596,7 @@ export interface JobDefinition {
|
|
|
3174
3596
|
timeout?: JobTimeout;
|
|
3175
3597
|
/**
|
|
3176
3598
|
* @public
|
|
3177
|
-
* <p>An object with
|
|
3178
|
-
* values are <code>containerProperties</code>, <code>eksProperties</code>, and
|
|
3179
|
-
* <code>nodeProperties</code>. Only one can be specified.</p>
|
|
3599
|
+
* <p>An object with properties that are specific to multi-node parallel jobs. When <code>nodeProperties</code> is used in the job definition, it can't be used in addition to <code>containerProperties</code>, <code>ecsProperties</code>, or <code>eksProperties</code>.</p>
|
|
3180
3600
|
* <note>
|
|
3181
3601
|
* <p>If the job runs on Fargate resources, don't specify <code>nodeProperties</code>. Use
|
|
3182
3602
|
* <code>containerProperties</code> instead.</p>
|
|
@@ -3206,9 +3626,14 @@ export interface JobDefinition {
|
|
|
3206
3626
|
platformCapabilities?: PlatformCapability[];
|
|
3207
3627
|
/**
|
|
3208
3628
|
* @public
|
|
3209
|
-
* <p>An object
|
|
3210
|
-
*
|
|
3211
|
-
|
|
3629
|
+
* <p>An object that contains the properties for the Amazon ECS resources of a job.When <code>ecsProperties</code>
|
|
3630
|
+
* is used in the job definition, it can't be used in addition to <code>containerProperties</code>, <code>eksProperties</code>, or <code>nodeProperties</code>.</p>
|
|
3631
|
+
*/
|
|
3632
|
+
ecsProperties?: EcsProperties;
|
|
3633
|
+
/**
|
|
3634
|
+
* @public
|
|
3635
|
+
* <p>An object with properties that are specific to Amazon EKS-based jobs. When <code>eksProperties</code>
|
|
3636
|
+
* is used in the job definition, it can't be used in addition to <code>containerProperties</code>, <code>ecsProperties</code>, or <code>nodeProperties</code>.</p>
|
|
3212
3637
|
*/
|
|
3213
3638
|
eksProperties?: EksProperties;
|
|
3214
3639
|
/**
|
|
@@ -3229,9 +3654,11 @@ export interface DescribeJobDefinitionsResponse {
|
|
|
3229
3654
|
jobDefinitions?: JobDefinition[];
|
|
3230
3655
|
/**
|
|
3231
3656
|
* @public
|
|
3232
|
-
* <p>The <code>nextToken</code> value to include in a future
|
|
3233
|
-
*
|
|
3234
|
-
*
|
|
3657
|
+
* <p>The <code>nextToken</code> value to include in a future
|
|
3658
|
+
* <code>DescribeJobDefinitions</code> request. When the results of a
|
|
3659
|
+
* <code>DescribeJobDefinitions</code> request exceed <code>maxResults</code>, this value can
|
|
3660
|
+
* be used to retrieve the next page of results. This value is <code>null</code> when there are
|
|
3661
|
+
* no more results to return.</p>
|
|
3235
3662
|
*/
|
|
3236
3663
|
nextToken?: string;
|
|
3237
3664
|
}
|
|
@@ -3247,22 +3674,25 @@ export interface DescribeJobQueuesRequest {
|
|
|
3247
3674
|
jobQueues?: string[];
|
|
3248
3675
|
/**
|
|
3249
3676
|
* @public
|
|
3250
|
-
* <p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated
|
|
3251
|
-
*
|
|
3252
|
-
*
|
|
3253
|
-
*
|
|
3254
|
-
*
|
|
3255
|
-
*
|
|
3677
|
+
* <p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated
|
|
3678
|
+
* output. When this parameter is used, <code>DescribeJobQueues</code> only returns
|
|
3679
|
+
* <code>maxResults</code> results in a single page and a <code>nextToken</code> response
|
|
3680
|
+
* element. The remaining results of the initial request can be seen by sending another
|
|
3681
|
+
* <code>DescribeJobQueues</code> request with the returned <code>nextToken</code> value. This
|
|
3682
|
+
* value can be between 1 and 100. If this parameter isn't used,
|
|
3683
|
+
* then <code>DescribeJobQueues</code> returns up to 100 results and a
|
|
3684
|
+
* <code>nextToken</code> value if applicable.</p>
|
|
3256
3685
|
*/
|
|
3257
3686
|
maxResults?: number;
|
|
3258
3687
|
/**
|
|
3259
3688
|
* @public
|
|
3260
|
-
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
3261
|
-
*
|
|
3262
|
-
*
|
|
3263
|
-
*
|
|
3264
|
-
*
|
|
3265
|
-
*
|
|
3689
|
+
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
3690
|
+
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used and the
|
|
3691
|
+
* results exceeded the value of that parameter. Pagination continues from the end of the
|
|
3692
|
+
* previous results that returned the <code>nextToken</code> value. This value is
|
|
3693
|
+
* <code>null</code> when there are no more results to return.</p>
|
|
3694
|
+
* <note>
|
|
3695
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
3266
3696
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
3267
3697
|
* </note>
|
|
3268
3698
|
*/
|
|
@@ -3333,8 +3763,8 @@ export interface JobQueueDetail {
|
|
|
3333
3763
|
* for the <code>priority</code> parameter) are evaluated first when associated with the same
|
|
3334
3764
|
* compute environment. Priority is determined in descending order. For example, a job queue with a
|
|
3335
3765
|
* priority value of <code>10</code> is given scheduling preference over a job queue with a priority
|
|
3336
|
-
* value of <code>1</code>. All of the compute environments must be either EC2 (<code>EC2</code>
|
|
3337
|
-
*
|
|
3766
|
+
* value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code>
|
|
3767
|
+
* or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and
|
|
3338
3768
|
* Fargate compute environments can't be mixed.</p>
|
|
3339
3769
|
*/
|
|
3340
3770
|
priority: number | undefined;
|
|
@@ -3362,9 +3792,10 @@ export interface DescribeJobQueuesResponse {
|
|
|
3362
3792
|
jobQueues?: JobQueueDetail[];
|
|
3363
3793
|
/**
|
|
3364
3794
|
* @public
|
|
3365
|
-
* <p>The <code>nextToken</code> value to include in a future <code>DescribeJobQueues</code>
|
|
3366
|
-
*
|
|
3367
|
-
*
|
|
3795
|
+
* <p>The <code>nextToken</code> value to include in a future <code>DescribeJobQueues</code>
|
|
3796
|
+
* request. When the results of a <code>DescribeJobQueues</code> request exceed
|
|
3797
|
+
* <code>maxResults</code>, this value can be used to retrieve the next page of results. This
|
|
3798
|
+
* value is <code>null</code> when there are no more results to return.</p>
|
|
3368
3799
|
*/
|
|
3369
3800
|
nextToken?: string;
|
|
3370
3801
|
}
|
|
@@ -3391,9 +3822,9 @@ export interface ContainerDetail {
|
|
|
3391
3822
|
image?: string;
|
|
3392
3823
|
/**
|
|
3393
3824
|
* @public
|
|
3394
|
-
* <p>The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you
|
|
3395
|
-
* specify the vCPU requirement for the job using <code>resourceRequirements</code>, but you
|
|
3396
|
-
* specify the vCPU requirements in both the <code>vcpus</code> and
|
|
3825
|
+
* <p>The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you
|
|
3826
|
+
* can specify the vCPU requirement for the job using <code>resourceRequirements</code>, but you
|
|
3827
|
+
* can't specify the vCPU requirements in both the <code>vcpus</code> and
|
|
3397
3828
|
* <code>resourceRequirements</code> object. This parameter maps to <code>CpuShares</code> in the
|
|
3398
3829
|
* <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
|
|
3399
3830
|
* <code>--cpu-shares</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. Each
|
|
@@ -3408,7 +3839,7 @@ export interface ContainerDetail {
|
|
|
3408
3839
|
vcpus?: number;
|
|
3409
3840
|
/**
|
|
3410
3841
|
* @public
|
|
3411
|
-
* <p>For jobs running on EC2 resources that didn't specify memory requirements using
|
|
3842
|
+
* <p>For jobs running on Amazon EC2 resources that didn't specify memory requirements using
|
|
3412
3843
|
* <code>resourceRequirements</code>, the number of MiB of memory reserved for the job. For other
|
|
3413
3844
|
* jobs, including all run on Fargate resources, see <code>resourceRequirements</code>.</p>
|
|
3414
3845
|
*/
|
|
@@ -3493,7 +3924,7 @@ export interface ContainerDetail {
|
|
|
3493
3924
|
user?: string;
|
|
3494
3925
|
/**
|
|
3495
3926
|
* @public
|
|
3496
|
-
* <p>The exit code
|
|
3927
|
+
* <p>The exit code returned upon completion.</p>
|
|
3497
3928
|
*/
|
|
3498
3929
|
exitCode?: number;
|
|
3499
3930
|
/**
|
|
@@ -3559,8 +3990,8 @@ export interface ContainerDetail {
|
|
|
3559
3990
|
* logging drivers</a> in the Docker documentation.</p>
|
|
3560
3991
|
* <note>
|
|
3561
3992
|
* <p>Batch currently supports a subset of the logging drivers available to the Docker daemon
|
|
3562
|
-
* (shown in the <a>LogConfiguration</a> data type). Additional log drivers might be
|
|
3563
|
-
*
|
|
3993
|
+
* (shown in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html">LogConfiguration</a> data type). Additional log drivers might be available in future
|
|
3994
|
+
* releases of the Amazon ECS container agent.</p>
|
|
3564
3995
|
* </note>
|
|
3565
3996
|
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your
|
|
3566
3997
|
* container instance. To check the Docker Remote API version on your container instance, log in to your
|
|
@@ -3584,13 +4015,13 @@ export interface ContainerDetail {
|
|
|
3584
4015
|
/**
|
|
3585
4016
|
* @public
|
|
3586
4017
|
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
3587
|
-
* running on EC2 resources must not specify this parameter.</p>
|
|
4018
|
+
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
3588
4019
|
*/
|
|
3589
4020
|
networkConfiguration?: NetworkConfiguration;
|
|
3590
4021
|
/**
|
|
3591
4022
|
* @public
|
|
3592
4023
|
* <p>The platform configuration for jobs that are running on Fargate resources. Jobs that are
|
|
3593
|
-
* running on EC2 resources must not specify this parameter.</p>
|
|
4024
|
+
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
3594
4025
|
*/
|
|
3595
4026
|
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
3596
4027
|
/**
|
|
@@ -3602,7 +4033,8 @@ export interface ContainerDetail {
|
|
|
3602
4033
|
ephemeralStorage?: EphemeralStorage;
|
|
3603
4034
|
/**
|
|
3604
4035
|
* @public
|
|
3605
|
-
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
4036
|
+
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
4037
|
+
* Fargate.</p>
|
|
3606
4038
|
*/
|
|
3607
4039
|
runtimePlatform?: RuntimePlatform;
|
|
3608
4040
|
/**
|
|
@@ -3627,6 +4059,351 @@ export interface JobDependency {
|
|
|
3627
4059
|
*/
|
|
3628
4060
|
type?: ArrayJobDependency;
|
|
3629
4061
|
}
|
|
4062
|
+
/**
|
|
4063
|
+
* @public
|
|
4064
|
+
* <p>The details for the container in this task attempt.</p>
|
|
4065
|
+
*/
|
|
4066
|
+
export interface TaskContainerDetails {
|
|
4067
|
+
/**
|
|
4068
|
+
* @public
|
|
4069
|
+
* <p>The command that's passed to the container. This parameter maps to <code>Cmd</code> in the
|
|
4070
|
+
* <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the <code>COMMAND</code>
|
|
4071
|
+
* parameter to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. For more information, see
|
|
4072
|
+
* <a href="https://docs.docker.com/engine/reference/builder/#cmd">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>
|
|
4073
|
+
*/
|
|
4074
|
+
command?: string[];
|
|
4075
|
+
/**
|
|
4076
|
+
* @public
|
|
4077
|
+
* <p>A list of containers that this container depends on.</p>
|
|
4078
|
+
*/
|
|
4079
|
+
dependsOn?: TaskContainerDependency[];
|
|
4080
|
+
/**
|
|
4081
|
+
* @public
|
|
4082
|
+
* <p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in
|
|
4083
|
+
* the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a> and the
|
|
4084
|
+
* <code>--env</code> option to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
|
|
4085
|
+
* <important>
|
|
4086
|
+
* <p>We don't recommend using plaintext environment variables for sensitive information, such as
|
|
4087
|
+
* credential data.</p>
|
|
4088
|
+
* </important>
|
|
4089
|
+
*/
|
|
4090
|
+
environment?: KeyValuePair[];
|
|
4091
|
+
/**
|
|
4092
|
+
* @public
|
|
4093
|
+
* <p>If the essential parameter of a container is marked as <code>true</code>, and that container
|
|
4094
|
+
* fails or stops for any reason, all other containers that are part of the task are stopped. If the
|
|
4095
|
+
* <code>essential</code> parameter of a container is marked as false, its failure doesn't affect
|
|
4096
|
+
* the rest of the containers in a task. If this parameter is omitted, a container is assumed to be
|
|
4097
|
+
* essential.</p>
|
|
4098
|
+
* <p>All tasks must have at least one essential container. If you have an application that's
|
|
4099
|
+
* composed of multiple containers, group containers that are used for a common purpose into
|
|
4100
|
+
* components, and separate the different components into multiple task definitions. For more
|
|
4101
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html">Application
|
|
4102
|
+
* Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4103
|
+
*/
|
|
4104
|
+
essential?: boolean;
|
|
4105
|
+
/**
|
|
4106
|
+
* @public
|
|
4107
|
+
* <p>The image used to start a container. This string is passed directly to the Docker daemon. By
|
|
4108
|
+
* default, images in the Docker Hub registry are available. Other repositories are specified with
|
|
4109
|
+
* either <code>repository-url/image:tag</code> or <code>repository-url/image@digest</code>. Up to
|
|
4110
|
+
* 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward
|
|
4111
|
+
* slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
4112
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
4113
|
+
* Remote API</a> and the <code>IMAGE</code> parameter of the <a href="https://docs.docker.com/engine/reference/run/#security-configuration">
|
|
4114
|
+
* <i>docker
|
|
4115
|
+
* run</i>
|
|
4116
|
+
* </a>.</p>
|
|
4117
|
+
*/
|
|
4118
|
+
image?: string;
|
|
4119
|
+
/**
|
|
4120
|
+
* @public
|
|
4121
|
+
* <p>Linux-specific modifications that are applied to the container, such as Linux kernel
|
|
4122
|
+
* capabilities. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html">KernelCapabilities</a>.</p>
|
|
4123
|
+
* <note>
|
|
4124
|
+
* <p>This parameter is not supported for Windows containers.</p>
|
|
4125
|
+
* </note>
|
|
4126
|
+
*/
|
|
4127
|
+
linuxParameters?: LinuxParameters;
|
|
4128
|
+
/**
|
|
4129
|
+
* @public
|
|
4130
|
+
* <p>The log configuration specification for the container.</p>
|
|
4131
|
+
* <p>This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
4132
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
4133
|
+
* Remote API</a> and the <code>--log-driver</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4134
|
+
* run</a>.</p>
|
|
4135
|
+
* <p>By default, containers use the same logging driver that the Docker daemon uses. However the
|
|
4136
|
+
* container can use a different logging driver than the Docker daemon by specifying a log driver
|
|
4137
|
+
* with this parameter in the container definition. To use a different logging driver for a
|
|
4138
|
+
* container, the log system must be configured properly on the container instance (or on a
|
|
4139
|
+
* different log server for remote logging options). For more information about the options for
|
|
4140
|
+
* different supported log drivers, see <a href="https://docs.docker.com/engine/admin/logging/overview/">Configure logging drivers </a>
|
|
4141
|
+
* in the <i>Docker documentation</i>.</p>
|
|
4142
|
+
* <note>
|
|
4143
|
+
* <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon
|
|
4144
|
+
* (shown in the <code>LogConfiguration</code> data type). Additional log drivers may be available
|
|
4145
|
+
* in future releases of the Amazon ECS container agent.</p>
|
|
4146
|
+
* </note>
|
|
4147
|
+
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container
|
|
4148
|
+
* instance. To check the Docker Remote API version on your container instance, log in to your
|
|
4149
|
+
* container instance and run the following command: sudo docker version <code>--format
|
|
4150
|
+
* '\{\{.Server.APIVersion\}\}'</code>
|
|
4151
|
+
* </p>
|
|
4152
|
+
* <note>
|
|
4153
|
+
* <p>The Amazon ECS container agent running on a container instance must register the logging drivers
|
|
4154
|
+
* available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment
|
|
4155
|
+
* variable before containers placed on that instance can use these log configuration options. For
|
|
4156
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS container agent
|
|
4157
|
+
* configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4158
|
+
* </note>
|
|
4159
|
+
*/
|
|
4160
|
+
logConfiguration?: LogConfiguration;
|
|
4161
|
+
/**
|
|
4162
|
+
* @public
|
|
4163
|
+
* <p>The mount points for data volumes in your container.</p>
|
|
4164
|
+
* <p>This parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
4165
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
4166
|
+
* Remote API</a> and the <a href="">--volume</a> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4167
|
+
* run</a>.</p>
|
|
4168
|
+
* <p>Windows containers can mount whole directories on the same drive as
|
|
4169
|
+
* <code>$env:ProgramData</code>. Windows containers can't mount directories on a different drive,
|
|
4170
|
+
* and mount point can't be across drives.</p>
|
|
4171
|
+
*/
|
|
4172
|
+
mountPoints?: MountPoint[];
|
|
4173
|
+
/**
|
|
4174
|
+
* @public
|
|
4175
|
+
* <p>The name of a container.</p>
|
|
4176
|
+
*/
|
|
4177
|
+
name?: string;
|
|
4178
|
+
/**
|
|
4179
|
+
* @public
|
|
4180
|
+
* <p>When this parameter is <code>true</code>, the container is given elevated privileges on the
|
|
4181
|
+
* host container instance (similar to the <code>root</code> user). This parameter maps to
|
|
4182
|
+
* <code>Privileged</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
4183
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
4184
|
+
* Remote API</a> and the <code>--privileged</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4185
|
+
* run</a>.</p>
|
|
4186
|
+
* <note>
|
|
4187
|
+
* <p>This parameter is not supported for Windows containers or tasks run on Fargate.</p>
|
|
4188
|
+
* </note>
|
|
4189
|
+
*/
|
|
4190
|
+
privileged?: boolean;
|
|
4191
|
+
/**
|
|
4192
|
+
* @public
|
|
4193
|
+
* <p>When this parameter is true, the container is given read-only access to its root file
|
|
4194
|
+
* system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
4195
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
4196
|
+
* Remote API</a> and the <code>--read-only</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4197
|
+
* run</a>.</p>
|
|
4198
|
+
* <note>
|
|
4199
|
+
* <p>This parameter is not supported for Windows containers.</p>
|
|
4200
|
+
* </note>
|
|
4201
|
+
*/
|
|
4202
|
+
readonlyRootFilesystem?: boolean;
|
|
4203
|
+
/**
|
|
4204
|
+
* @public
|
|
4205
|
+
* <p>The private repository authentication credentials to use.</p>
|
|
4206
|
+
*/
|
|
4207
|
+
repositoryCredentials?: RepositoryCredentials;
|
|
4208
|
+
/**
|
|
4209
|
+
* @public
|
|
4210
|
+
* <p>The type and amount of a resource to assign to a container. The only supported resource is a
|
|
4211
|
+
* GPU.</p>
|
|
4212
|
+
*/
|
|
4213
|
+
resourceRequirements?: ResourceRequirement[];
|
|
4214
|
+
/**
|
|
4215
|
+
* @public
|
|
4216
|
+
* <p>The secrets to pass to the container. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html">Specifying Sensitive
|
|
4217
|
+
* Data</a> in the Amazon Elastic Container Service Developer Guide.</p>
|
|
4218
|
+
*/
|
|
4219
|
+
secrets?: Secret[];
|
|
4220
|
+
/**
|
|
4221
|
+
* @public
|
|
4222
|
+
* <p>A list of <code>ulimits</code> to set in the container. If a <code>ulimit</code> value is
|
|
4223
|
+
* specified in a task definition, it overrides the default values set by Docker. This parameter
|
|
4224
|
+
* maps to <code>Ulimits</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a
|
|
4225
|
+
* container</a> section of the <a href="https://docs.docker.com/engine/api/v1.35/">Docker
|
|
4226
|
+
* Remote API</a> and the <code>--ulimit</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker
|
|
4227
|
+
* run</a>.</p>
|
|
4228
|
+
* <p>Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating
|
|
4229
|
+
* system with the exception of the nofile resource limit parameter which Fargate overrides. The
|
|
4230
|
+
* <code>nofile</code> resource limit sets a restriction on the number of open files that a
|
|
4231
|
+
* container can use. The default <code>nofile</code> soft limit is <code>1024</code> and the
|
|
4232
|
+
* default hard limit is <code>65535</code>.</p>
|
|
4233
|
+
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container
|
|
4234
|
+
* instance. To check the Docker Remote API version on your container instance, log in to your
|
|
4235
|
+
* container instance and run the following command: sudo docker version <code>--format
|
|
4236
|
+
* '\{\{.Server.APIVersion\}\}'</code>
|
|
4237
|
+
* </p>
|
|
4238
|
+
* <note>
|
|
4239
|
+
* <p>This parameter is not supported for Windows containers.</p>
|
|
4240
|
+
* </note>
|
|
4241
|
+
*/
|
|
4242
|
+
ulimits?: Ulimit[];
|
|
4243
|
+
/**
|
|
4244
|
+
* @public
|
|
4245
|
+
* <p>The user to use inside the container. This parameter maps to User in the Create a container
|
|
4246
|
+
* section of the Docker Remote API and the --user option to docker run.</p>
|
|
4247
|
+
* <note>
|
|
4248
|
+
* <p>When running tasks using the <code>host</code> network mode, don't run containers using the
|
|
4249
|
+
* <code>root user (UID 0)</code>. We recommend using a non-root user for better security.</p>
|
|
4250
|
+
* </note>
|
|
4251
|
+
* <p>You can specify the <code>user</code> using the following formats. If specifying a UID or
|
|
4252
|
+
* GID, you must specify it as a positive integer.</p>
|
|
4253
|
+
* <ul>
|
|
4254
|
+
* <li>
|
|
4255
|
+
* <p>
|
|
4256
|
+
* <code>user</code>
|
|
4257
|
+
* </p>
|
|
4258
|
+
* </li>
|
|
4259
|
+
* <li>
|
|
4260
|
+
* <p>
|
|
4261
|
+
* <code>user:group</code>
|
|
4262
|
+
* </p>
|
|
4263
|
+
* </li>
|
|
4264
|
+
* <li>
|
|
4265
|
+
* <p>
|
|
4266
|
+
* <code>uid</code>
|
|
4267
|
+
* </p>
|
|
4268
|
+
* </li>
|
|
4269
|
+
* <li>
|
|
4270
|
+
* <p>
|
|
4271
|
+
* <code>uid:gid</code>
|
|
4272
|
+
* </p>
|
|
4273
|
+
* </li>
|
|
4274
|
+
* <li>
|
|
4275
|
+
* <p>
|
|
4276
|
+
* <code>user:gi</code>
|
|
4277
|
+
* </p>
|
|
4278
|
+
* </li>
|
|
4279
|
+
* <li>
|
|
4280
|
+
* <p>
|
|
4281
|
+
* <code>uid:group</code>
|
|
4282
|
+
* </p>
|
|
4283
|
+
* </li>
|
|
4284
|
+
* <li>
|
|
4285
|
+
* <p>
|
|
4286
|
+
* <code></code>
|
|
4287
|
+
* </p>
|
|
4288
|
+
* </li>
|
|
4289
|
+
* </ul>
|
|
4290
|
+
* <note>
|
|
4291
|
+
* <p>This parameter is not supported for Windows containers.</p>
|
|
4292
|
+
* </note>
|
|
4293
|
+
*/
|
|
4294
|
+
user?: string;
|
|
4295
|
+
/**
|
|
4296
|
+
* @public
|
|
4297
|
+
* <p>The exit code returned upon completion.</p>
|
|
4298
|
+
*/
|
|
4299
|
+
exitCode?: number;
|
|
4300
|
+
/**
|
|
4301
|
+
* @public
|
|
4302
|
+
* <p>A short (255 max characters) human-readable string to provide additional details for a
|
|
4303
|
+
* running or stopped container.</p>
|
|
4304
|
+
*/
|
|
4305
|
+
reason?: string;
|
|
4306
|
+
/**
|
|
4307
|
+
* @public
|
|
4308
|
+
* <p>The name of the CloudWatch Logs log stream that's associated with the container. The log group for
|
|
4309
|
+
* Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach
|
|
4310
|
+
* the <code>RUNNING</code> status. </p>
|
|
4311
|
+
*/
|
|
4312
|
+
logStreamName?: string;
|
|
4313
|
+
/**
|
|
4314
|
+
* @public
|
|
4315
|
+
* <p>The network interfaces that are associated with the job.</p>
|
|
4316
|
+
*/
|
|
4317
|
+
networkInterfaces?: NetworkInterface[];
|
|
4318
|
+
}
|
|
4319
|
+
/**
|
|
4320
|
+
* @public
|
|
4321
|
+
* <p>The details of a task definition that describes the container and volume definitions of an
|
|
4322
|
+
* Amazon ECS task.</p>
|
|
4323
|
+
*/
|
|
4324
|
+
export interface EcsTaskDetails {
|
|
4325
|
+
/**
|
|
4326
|
+
* @public
|
|
4327
|
+
* <p>A list of containers that are included in the <code>taskProperties</code>
|
|
4328
|
+
* list.</p>
|
|
4329
|
+
*/
|
|
4330
|
+
containers?: TaskContainerDetails[];
|
|
4331
|
+
/**
|
|
4332
|
+
* @public
|
|
4333
|
+
* <p>The Amazon Resource Name (ARN) of the container instance that hosts the task.</p>
|
|
4334
|
+
*/
|
|
4335
|
+
containerInstanceArn?: string;
|
|
4336
|
+
/**
|
|
4337
|
+
* @public
|
|
4338
|
+
* <p>The ARN of the Amazon ECS task.</p>
|
|
4339
|
+
*/
|
|
4340
|
+
taskArn?: string;
|
|
4341
|
+
/**
|
|
4342
|
+
* @public
|
|
4343
|
+
* <p>The amount of ephemeral storage allocated for the task.</p>
|
|
4344
|
+
*/
|
|
4345
|
+
ephemeralStorage?: EphemeralStorage;
|
|
4346
|
+
/**
|
|
4347
|
+
* @public
|
|
4348
|
+
* <p>The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see
|
|
4349
|
+
* <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM
|
|
4350
|
+
* role</a> in the <i>Batch User Guide</i>.</p>
|
|
4351
|
+
*/
|
|
4352
|
+
executionRoleArn?: string;
|
|
4353
|
+
/**
|
|
4354
|
+
* @public
|
|
4355
|
+
* <p>The Fargate platform version where the jobs are running.</p>
|
|
4356
|
+
*/
|
|
4357
|
+
platformVersion?: string;
|
|
4358
|
+
/**
|
|
4359
|
+
* @public
|
|
4360
|
+
* <p>The IPC resource namespace to use for the containers in the task.</p>
|
|
4361
|
+
*/
|
|
4362
|
+
ipcMode?: string;
|
|
4363
|
+
/**
|
|
4364
|
+
* @public
|
|
4365
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more
|
|
4366
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM roles for tasks</a> in the
|
|
4367
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4368
|
+
* <note>
|
|
4369
|
+
* <p>This is object is comparable to <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html">ContainerProperties:jobRoleArn</a>.</p>
|
|
4370
|
+
* </note>
|
|
4371
|
+
*/
|
|
4372
|
+
taskRoleArn?: string;
|
|
4373
|
+
/**
|
|
4374
|
+
* @public
|
|
4375
|
+
* <p>The process namespace to use for the containers in the task.</p>
|
|
4376
|
+
*/
|
|
4377
|
+
pidMode?: string;
|
|
4378
|
+
/**
|
|
4379
|
+
* @public
|
|
4380
|
+
* <p>The network configuration for jobs that are running on Fargate resources. Jobs that are
|
|
4381
|
+
* running on Amazon EC2 resources must not specify this parameter.</p>
|
|
4382
|
+
*/
|
|
4383
|
+
networkConfiguration?: NetworkConfiguration;
|
|
4384
|
+
/**
|
|
4385
|
+
* @public
|
|
4386
|
+
* <p>An object that represents the compute environment architecture for Batch jobs on
|
|
4387
|
+
* Fargate.</p>
|
|
4388
|
+
*/
|
|
4389
|
+
runtimePlatform?: RuntimePlatform;
|
|
4390
|
+
/**
|
|
4391
|
+
* @public
|
|
4392
|
+
* <p>A list of data volumes used in a job.</p>
|
|
4393
|
+
*/
|
|
4394
|
+
volumes?: Volume[];
|
|
4395
|
+
}
|
|
4396
|
+
/**
|
|
4397
|
+
* @public
|
|
4398
|
+
* <p>An object that contains the details for the Amazon ECS resources of a job.</p>
|
|
4399
|
+
*/
|
|
4400
|
+
export interface EcsPropertiesDetail {
|
|
4401
|
+
/**
|
|
4402
|
+
* @public
|
|
4403
|
+
* <p>The properties for the Amazon ECS task definition of a job.</p>
|
|
4404
|
+
*/
|
|
4405
|
+
taskProperties?: EcsTaskDetails[];
|
|
4406
|
+
}
|
|
3630
4407
|
/**
|
|
3631
4408
|
* @public
|
|
3632
4409
|
* <p>An object that represents the details for an attempt for a job attempt that an Amazon EKS
|
|
@@ -3635,7 +4412,7 @@ export interface JobDependency {
|
|
|
3635
4412
|
export interface EksAttemptContainerDetail {
|
|
3636
4413
|
/**
|
|
3637
4414
|
* @public
|
|
3638
|
-
* <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
|
|
4415
|
+
* <p>The exit code returned for the job attempt. A non-zero exit code is considered failed.</p>
|
|
3639
4416
|
*/
|
|
3640
4417
|
exitCode?: number;
|
|
3641
4418
|
/**
|
|
@@ -3656,6 +4433,11 @@ export interface EksAttemptDetail {
|
|
|
3656
4433
|
* <p>The details for the final status of the containers for this job attempt.</p>
|
|
3657
4434
|
*/
|
|
3658
4435
|
containers?: EksAttemptContainerDetail[];
|
|
4436
|
+
/**
|
|
4437
|
+
* @public
|
|
4438
|
+
* <p>The details for the init containers.</p>
|
|
4439
|
+
*/
|
|
4440
|
+
initContainers?: EksAttemptContainerDetail[];
|
|
3659
4441
|
/**
|
|
3660
4442
|
* @public
|
|
3661
4443
|
* <p>The name of the pod for this job attempt.</p>
|
|
@@ -3727,8 +4509,8 @@ export interface EksContainerDetail {
|
|
|
3727
4509
|
* environment variable doesn't exist, the command string will remain "<code>$(NAME1)</code>".
|
|
3728
4510
|
* <code>$$</code> is replaced with <code>$</code> and the resulting string isn't expanded. For
|
|
3729
4511
|
* example, <code>$$(VAR_NAME)</code> is passed as <code>$(VAR_NAME)</code> whether or not the
|
|
3730
|
-
* <code>VAR_NAME</code> environment variable exists. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">CMD</a>
|
|
3731
|
-
*
|
|
4512
|
+
* <code>VAR_NAME</code> environment variable exists. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">Dockerfile reference: CMD</a>
|
|
4513
|
+
* and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command and arguments for a pod</a> in the <i>Kubernetes
|
|
3732
4514
|
* documentation</i>.</p>
|
|
3733
4515
|
*/
|
|
3734
4516
|
args?: string[];
|
|
@@ -3751,7 +4533,7 @@ export interface EksContainerDetail {
|
|
|
3751
4533
|
resources?: EksContainerResourceRequirements;
|
|
3752
4534
|
/**
|
|
3753
4535
|
* @public
|
|
3754
|
-
* <p>The exit code for the job attempt. A non-zero exit code is considered failed.</p>
|
|
4536
|
+
* <p>The exit code returned for the job attempt. A non-zero exit code is considered failed.</p>
|
|
3755
4537
|
*/
|
|
3756
4538
|
exitCode?: number;
|
|
3757
4539
|
/**
|
|
@@ -3820,6 +4602,12 @@ export interface EksPodPropertiesDetail {
|
|
|
3820
4602
|
* <p>The properties of the container that's used on the Amazon EKS pod.</p>
|
|
3821
4603
|
*/
|
|
3822
4604
|
containers?: EksContainerDetail[];
|
|
4605
|
+
/**
|
|
4606
|
+
* @public
|
|
4607
|
+
* <p>The container registered with the Amazon EKS Connector agent and persists the registration
|
|
4608
|
+
* information in the Kubernetes backend data store.</p>
|
|
4609
|
+
*/
|
|
4610
|
+
initContainers?: EksContainerDetail[];
|
|
3823
4611
|
/**
|
|
3824
4612
|
* @public
|
|
3825
4613
|
* <p>Specifies the volumes for a job definition using Amazon EKS resources.</p>
|
|
@@ -3837,12 +4625,18 @@ export interface EksPodPropertiesDetail {
|
|
|
3837
4625
|
nodeName?: string;
|
|
3838
4626
|
/**
|
|
3839
4627
|
* @public
|
|
3840
|
-
* <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment
|
|
3841
|
-
*
|
|
3842
|
-
*
|
|
3843
|
-
* documentation</i>.</p>
|
|
4628
|
+
* <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment that
|
|
4629
|
+
* a pod runs in or the <code>jobID</code> for a job running in the pod. For more information, see
|
|
4630
|
+
* <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes documentation</i>.</p>
|
|
3844
4631
|
*/
|
|
3845
4632
|
metadata?: EksMetadata;
|
|
4633
|
+
/**
|
|
4634
|
+
* @public
|
|
4635
|
+
* <p>Indicates if the processes in a container are shared, or visible, to other containers in the
|
|
4636
|
+
* same pod. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/">Share
|
|
4637
|
+
* Process Namespace between Containers in a Pod</a>.</p>
|
|
4638
|
+
*/
|
|
4639
|
+
shareProcessNamespace?: boolean;
|
|
3846
4640
|
}
|
|
3847
4641
|
/**
|
|
3848
4642
|
* @public
|
|
@@ -3951,8 +4745,9 @@ export interface JobDetail {
|
|
|
3951
4745
|
* @public
|
|
3952
4746
|
* <p>The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
|
|
3953
4747
|
* parent array jobs, this is when the job entered the <code>SUBMITTED</code> state. This is
|
|
3954
|
-
* specifically at the time <a>SubmitJob</a> was called. For array child
|
|
3955
|
-
* when the child job was spawned by its parent and entered the <code>PENDING</code>
|
|
4748
|
+
* specifically at the time <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> was called. For array child
|
|
4749
|
+
* jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code>
|
|
4750
|
+
* state.</p>
|
|
3956
4751
|
*/
|
|
3957
4752
|
createdAt?: number;
|
|
3958
4753
|
/**
|
|
@@ -3993,7 +4788,7 @@ export interface JobDetail {
|
|
|
3993
4788
|
/**
|
|
3994
4789
|
* @public
|
|
3995
4790
|
* <p>An object that represents the details for the container that's associated with the
|
|
3996
|
-
* job
|
|
4791
|
+
* job. If the details are for a multiple-container job, this object will be empty. </p>
|
|
3997
4792
|
*/
|
|
3998
4793
|
container?: ContainerDetail;
|
|
3999
4794
|
/**
|
|
@@ -4043,9 +4838,7 @@ export interface JobDetail {
|
|
|
4043
4838
|
platformCapabilities?: PlatformCapability[];
|
|
4044
4839
|
/**
|
|
4045
4840
|
* @public
|
|
4046
|
-
* <p>An object with various properties that are specific to Amazon EKS based jobs.
|
|
4047
|
-
* <code>container</code>, <code>eksProperties</code>, or <code>nodeDetails</code> is
|
|
4048
|
-
* specified.</p>
|
|
4841
|
+
* <p>An object with various properties that are specific to Amazon EKS based jobs. </p>
|
|
4049
4842
|
*/
|
|
4050
4843
|
eksProperties?: EksPropertiesDetail;
|
|
4051
4844
|
/**
|
|
@@ -4053,6 +4846,11 @@ export interface JobDetail {
|
|
|
4053
4846
|
* <p>A list of job attempts that are associated with this job.</p>
|
|
4054
4847
|
*/
|
|
4055
4848
|
eksAttempts?: EksAttemptDetail[];
|
|
4849
|
+
/**
|
|
4850
|
+
* @public
|
|
4851
|
+
* <p>An object with properties that are specific to Amazon ECS-based jobs. </p>
|
|
4852
|
+
*/
|
|
4853
|
+
ecsProperties?: EcsPropertiesDetail;
|
|
4056
4854
|
/**
|
|
4057
4855
|
* @public
|
|
4058
4856
|
* <p>Indicates whether the job is canceled.</p>
|
|
@@ -4154,39 +4952,42 @@ export interface ListJobsRequest {
|
|
|
4154
4952
|
jobQueue?: string;
|
|
4155
4953
|
/**
|
|
4156
4954
|
* @public
|
|
4157
|
-
* <p>The job ID for an array job. Specifying an array job ID with this parameter lists all
|
|
4158
|
-
*
|
|
4955
|
+
* <p>The job ID for an array job. Specifying an array job ID with this parameter lists all
|
|
4956
|
+
* child jobs from within the specified array.</p>
|
|
4159
4957
|
*/
|
|
4160
4958
|
arrayJobId?: string;
|
|
4161
4959
|
/**
|
|
4162
4960
|
* @public
|
|
4163
|
-
* <p>The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with
|
|
4164
|
-
*
|
|
4961
|
+
* <p>The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with
|
|
4962
|
+
* this parameter lists all nodes that are associated with the specified job.</p>
|
|
4165
4963
|
*/
|
|
4166
4964
|
multiNodeJobId?: string;
|
|
4167
4965
|
/**
|
|
4168
4966
|
* @public
|
|
4169
|
-
* <p>The job status used to filter jobs in the specified queue. If the <code>filters</code>
|
|
4170
|
-
*
|
|
4171
|
-
*
|
|
4967
|
+
* <p>The job status used to filter jobs in the specified queue. If the <code>filters</code>
|
|
4968
|
+
* parameter is specified, the <code>jobStatus</code> parameter is ignored and jobs with any
|
|
4969
|
+
* status are returned. If you don't specify a status, only <code>RUNNING</code> jobs are
|
|
4970
|
+
* returned.</p>
|
|
4172
4971
|
*/
|
|
4173
4972
|
jobStatus?: JobStatus;
|
|
4174
4973
|
/**
|
|
4175
4974
|
* @public
|
|
4176
|
-
* <p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When
|
|
4177
|
-
*
|
|
4178
|
-
*
|
|
4179
|
-
*
|
|
4180
|
-
*
|
|
4181
|
-
*
|
|
4975
|
+
* <p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When
|
|
4976
|
+
* this parameter is used, <code>ListJobs</code> only returns <code>maxResults</code> results in
|
|
4977
|
+
* a single page and a <code>nextToken</code> response element. The remaining results of the
|
|
4978
|
+
* initial request can be seen by sending another <code>ListJobs</code> request with the returned
|
|
4979
|
+
* <code>nextToken</code> value. This value can be between 1 and
|
|
4980
|
+
* 100. If this parameter isn't used, then <code>ListJobs</code> returns up to
|
|
4981
|
+
* 100 results and a <code>nextToken</code> value if applicable.</p>
|
|
4182
4982
|
*/
|
|
4183
4983
|
maxResults?: number;
|
|
4184
4984
|
/**
|
|
4185
4985
|
* @public
|
|
4186
|
-
* <p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobs</code>
|
|
4187
|
-
*
|
|
4188
|
-
*
|
|
4189
|
-
*
|
|
4986
|
+
* <p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobs</code>
|
|
4987
|
+
* request where <code>maxResults</code> was used and the results exceeded the value of that
|
|
4988
|
+
* parameter. Pagination continues from the end of the previous results that returned the
|
|
4989
|
+
* <code>nextToken</code> value. This value is <code>null</code> when there are no more results
|
|
4990
|
+
* to return.</p>
|
|
4190
4991
|
* <note>
|
|
4191
4992
|
* <p>Treat this token as an opaque identifier that's only used to
|
|
4192
4993
|
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
@@ -4195,42 +4996,47 @@ export interface ListJobsRequest {
|
|
|
4195
4996
|
nextToken?: string;
|
|
4196
4997
|
/**
|
|
4197
4998
|
* @public
|
|
4198
|
-
* <p>The filter to apply to the query. Only one filter can be used at a time. When the filter
|
|
4199
|
-
*
|
|
4200
|
-
*
|
|
4999
|
+
* <p>The filter to apply to the query. Only one filter can be used at a time. When the filter
|
|
5000
|
+
* is used, <code>jobStatus</code> is ignored. The filter doesn't apply to child jobs in an array
|
|
5001
|
+
* or multi-node parallel (MNP) jobs. The results are sorted by the <code>createdAt</code> field,
|
|
5002
|
+
* with the most recent jobs being first.</p>
|
|
4201
5003
|
* <dl>
|
|
4202
5004
|
* <dt>JOB_NAME</dt>
|
|
4203
5005
|
* <dd>
|
|
4204
|
-
* <p>The value of the filter is a case-insensitive match for the job name. If the value
|
|
4205
|
-
*
|
|
4206
|
-
*
|
|
4207
|
-
*
|
|
4208
|
-
*
|
|
5006
|
+
* <p>The value of the filter is a case-insensitive match for the job name. If the value
|
|
5007
|
+
* ends with an asterisk (*), the filter matches any job name that begins with the string
|
|
5008
|
+
* before the '*'. This corresponds to the <code>jobName</code> value. For example,
|
|
5009
|
+
* <code>test1</code> matches both <code>Test1</code> and <code>test1</code>, and
|
|
5010
|
+
* <code>test1*</code> matches both <code>test1</code> and <code>Test10</code>. When the
|
|
5011
|
+
* <code>JOB_NAME</code> filter is used, the results are grouped by the job name and
|
|
5012
|
+
* version.</p>
|
|
4209
5013
|
* </dd>
|
|
4210
5014
|
* <dt>JOB_DEFINITION</dt>
|
|
4211
5015
|
* <dd>
|
|
4212
|
-
* <p>The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This
|
|
4213
|
-
*
|
|
4214
|
-
*
|
|
4215
|
-
*
|
|
4216
|
-
*
|
|
4217
|
-
*
|
|
4218
|
-
*
|
|
4219
|
-
*
|
|
4220
|
-
*
|
|
4221
|
-
*
|
|
5016
|
+
* <p>The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This
|
|
5017
|
+
* corresponds to the <code>jobDefinition</code> value. The value is case sensitive. When
|
|
5018
|
+
* the value for the filter is the job definition name, the results include all the jobs
|
|
5019
|
+
* that used any revision of that job definition name. If the value ends with an asterisk
|
|
5020
|
+
* (*), the filter matches any job definition name that begins with the string before the
|
|
5021
|
+
* '*'. For example, <code>jd1</code> matches only <code>jd1</code>, and <code>jd1*</code>
|
|
5022
|
+
* matches both <code>jd1</code> and <code>jd1A</code>. The version of the job definition
|
|
5023
|
+
* that's used doesn't affect the sort order. When the <code>JOB_DEFINITION</code> filter
|
|
5024
|
+
* is used and the ARN is used (which is in the form
|
|
5025
|
+
* <code>arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}</code>),
|
|
5026
|
+
* the results include jobs that used the specified revision of the job definition.
|
|
5027
|
+
* Asterisk (*) isn't supported when the ARN is used.</p>
|
|
4222
5028
|
* </dd>
|
|
4223
5029
|
* <dt>BEFORE_CREATED_AT</dt>
|
|
4224
5030
|
* <dd>
|
|
4225
|
-
* <p>The value for the filter is the time that's before the job was created. This
|
|
4226
|
-
*
|
|
4227
|
-
*
|
|
5031
|
+
* <p>The value for the filter is the time that's before the job was created. This
|
|
5032
|
+
* corresponds to the <code>createdAt</code> value. The value is a string representation of
|
|
5033
|
+
* the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.</p>
|
|
4228
5034
|
* </dd>
|
|
4229
5035
|
* <dt>AFTER_CREATED_AT</dt>
|
|
4230
5036
|
* <dd>
|
|
4231
|
-
* <p>The value for the filter is the time that's after the job was created. This
|
|
4232
|
-
*
|
|
4233
|
-
*
|
|
5037
|
+
* <p>The value for the filter is the time that's after the job was created. This
|
|
5038
|
+
* corresponds to the <code>createdAt</code> value. The value is a string representation of
|
|
5039
|
+
* the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.</p>
|
|
4234
5040
|
* </dd>
|
|
4235
5041
|
* </dl>
|
|
4236
5042
|
*/
|
|
@@ -4300,8 +5106,9 @@ export interface JobSummary {
|
|
|
4300
5106
|
* @public
|
|
4301
5107
|
* <p>The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
|
|
4302
5108
|
* parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time
|
|
4303
|
-
* <a>SubmitJob</a>
|
|
4304
|
-
* spawned by its parent and
|
|
5109
|
+
* <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a>
|
|
5110
|
+
* was called). For array child jobs, this is when the child job was spawned by its parent and
|
|
5111
|
+
* entered the <code>PENDING</code> state.</p>
|
|
4305
5112
|
*/
|
|
4306
5113
|
createdAt?: number;
|
|
4307
5114
|
/**
|
|
@@ -4364,9 +5171,10 @@ export interface ListJobsResponse {
|
|
|
4364
5171
|
jobSummaryList: JobSummary[] | undefined;
|
|
4365
5172
|
/**
|
|
4366
5173
|
* @public
|
|
4367
|
-
* <p>The <code>nextToken</code> value to include in a future <code>ListJobs</code> request.
|
|
4368
|
-
*
|
|
4369
|
-
*
|
|
5174
|
+
* <p>The <code>nextToken</code> value to include in a future <code>ListJobs</code> request.
|
|
5175
|
+
* When the results of a <code>ListJobs</code> request exceed <code>maxResults</code>, this value
|
|
5176
|
+
* can be used to retrieve the next page of results. This value is <code>null</code> when there
|
|
5177
|
+
* are no more results to return.</p>
|
|
4370
5178
|
*/
|
|
4371
5179
|
nextToken?: string;
|
|
4372
5180
|
}
|
|
@@ -4377,13 +5185,14 @@ export interface ListJobsResponse {
|
|
|
4377
5185
|
export interface ListSchedulingPoliciesRequest {
|
|
4378
5186
|
/**
|
|
4379
5187
|
* @public
|
|
4380
|
-
* <p>The maximum number of results that's returned by <code>ListSchedulingPolicies</code> in
|
|
4381
|
-
*
|
|
4382
|
-
*
|
|
4383
|
-
*
|
|
4384
|
-
*
|
|
4385
|
-
*
|
|
4386
|
-
*
|
|
5188
|
+
* <p>The maximum number of results that's returned by <code>ListSchedulingPolicies</code> in
|
|
5189
|
+
* paginated output. When this parameter is used, <code>ListSchedulingPolicies</code> only
|
|
5190
|
+
* returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response
|
|
5191
|
+
* element. You can see the remaining results of the initial request by sending another
|
|
5192
|
+
* <code>ListSchedulingPolicies</code> request with the returned <code>nextToken</code> value.
|
|
5193
|
+
* This value can be between 1 and 100. If this parameter isn't
|
|
5194
|
+
* used, <code>ListSchedulingPolicies</code> returns up to 100 results and a
|
|
5195
|
+
* <code>nextToken</code> value if applicable.</p>
|
|
4387
5196
|
*/
|
|
4388
5197
|
maxResults?: number;
|
|
4389
5198
|
/**
|
|
@@ -4423,9 +5232,11 @@ export interface ListSchedulingPoliciesResponse {
|
|
|
4423
5232
|
schedulingPolicies?: SchedulingPolicyListingDetail[];
|
|
4424
5233
|
/**
|
|
4425
5234
|
* @public
|
|
4426
|
-
* <p>The <code>nextToken</code> value to include in a future
|
|
4427
|
-
*
|
|
4428
|
-
*
|
|
5235
|
+
* <p>The <code>nextToken</code> value to include in a future
|
|
5236
|
+
* <code>ListSchedulingPolicies</code> request. When the results of a
|
|
5237
|
+
* <code>ListSchedulingPolicies</code> request exceed <code>maxResults</code>, this value can
|
|
5238
|
+
* be used to retrieve the next page of results. This value is <code>null</code> when there are
|
|
5239
|
+
* no more results to return.</p>
|
|
4429
5240
|
*/
|
|
4430
5241
|
nextToken?: string;
|
|
4431
5242
|
}
|
|
@@ -4470,14 +5281,23 @@ export type JobDefinitionType = (typeof JobDefinitionType)[keyof typeof JobDefin
|
|
|
4470
5281
|
export interface RegisterJobDefinitionRequest {
|
|
4471
5282
|
/**
|
|
4472
5283
|
* @public
|
|
4473
|
-
* <p>The name of the job definition to register. It can be up to 128 letters long. It can
|
|
4474
|
-
*
|
|
5284
|
+
* <p>The name of the job definition to register. It can be up to 128 letters long. It can
|
|
5285
|
+
* contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
4475
5286
|
*/
|
|
4476
5287
|
jobDefinitionName: string | undefined;
|
|
4477
5288
|
/**
|
|
4478
5289
|
* @public
|
|
4479
|
-
* <p>The type of job definition. For more information about multi-node parallel jobs, see
|
|
4480
|
-
*
|
|
5290
|
+
* <p>The type of job definition. For more information about multi-node parallel jobs, see
|
|
5291
|
+
* <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html">Creating a multi-node
|
|
5292
|
+
* parallel job definition</a> in the <i>Batch User Guide</i>.</p>
|
|
5293
|
+
* <ul>
|
|
5294
|
+
* <li>
|
|
5295
|
+
* <p>If the value is <code>container</code>, then one of the following is required: <code>containerProperties</code>, <code>ecsProperties</code>, or <code>eksProperties</code>.</p>
|
|
5296
|
+
* </li>
|
|
5297
|
+
* <li>
|
|
5298
|
+
* <p>If the value is <code>multinode</code>, then <code>nodeProperties</code> is required.</p>
|
|
5299
|
+
* </li>
|
|
5300
|
+
* </ul>
|
|
4481
5301
|
* <note>
|
|
4482
5302
|
* <p>If the job is run on Fargate resources, then <code>multinode</code> isn't supported.</p>
|
|
4483
5303
|
* </note>
|
|
@@ -4485,93 +5305,106 @@ export interface RegisterJobDefinitionRequest {
|
|
|
4485
5305
|
type: JobDefinitionType | undefined;
|
|
4486
5306
|
/**
|
|
4487
5307
|
* @public
|
|
4488
|
-
* <p>Default parameter substitution placeholders to set in the job definition. Parameters are
|
|
4489
|
-
*
|
|
4490
|
-
*
|
|
5308
|
+
* <p>Default parameter substitution placeholders to set in the job definition. Parameters are
|
|
5309
|
+
* specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override
|
|
5310
|
+
* any corresponding parameter defaults from the job definition.</p>
|
|
4491
5311
|
*/
|
|
4492
5312
|
parameters?: Record<string, string>;
|
|
4493
5313
|
/**
|
|
4494
5314
|
* @public
|
|
4495
|
-
* <p>The scheduling priority for jobs that are submitted with this job definition. This only
|
|
4496
|
-
*
|
|
4497
|
-
*
|
|
5315
|
+
* <p>The scheduling priority for jobs that are submitted with this job definition. This only
|
|
5316
|
+
* affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority
|
|
5317
|
+
* are scheduled before jobs with a lower scheduling priority.</p>
|
|
4498
5318
|
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
4499
5319
|
*/
|
|
4500
5320
|
schedulingPriority?: number;
|
|
4501
5321
|
/**
|
|
4502
5322
|
* @public
|
|
4503
|
-
* <p>An object with
|
|
4504
|
-
*
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
5323
|
+
* <p>An object with properties specific to Amazon ECS-based single-node container-based jobs. If the
|
|
5324
|
+
* job definition's <code>type</code> parameter is <code>container</code>, then you must specify
|
|
5325
|
+
* either <code>containerProperties</code> or <code>nodeProperties</code>. This must not be
|
|
5326
|
+
* specified for Amazon EKS-based job definitions.</p>
|
|
4507
5327
|
* <note>
|
|
4508
|
-
* <p>If the job runs on Fargate resources, then you must not specify
|
|
4509
|
-
*
|
|
5328
|
+
* <p>If the job runs on Fargate resources, then you must not specify
|
|
5329
|
+
* <code>nodeProperties</code>; use only <code>containerProperties</code>.</p>
|
|
4510
5330
|
* </note>
|
|
4511
5331
|
*/
|
|
4512
5332
|
containerProperties?: ContainerProperties;
|
|
4513
5333
|
/**
|
|
4514
5334
|
* @public
|
|
4515
|
-
* <p>An object with
|
|
4516
|
-
*
|
|
4517
|
-
*
|
|
4518
|
-
* then you must specify either <code>containerProperties</code> or <code>nodeProperties</code>.</p>
|
|
5335
|
+
* <p>An object with properties specific to multi-node parallel jobs. If you specify node
|
|
5336
|
+
* properties for a job, it becomes a multi-node parallel job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html">Multi-node Parallel
|
|
5337
|
+
* Jobs</a> in the <i>Batch User Guide</i>.</p>
|
|
4519
5338
|
* <note>
|
|
4520
|
-
* <p>If the job runs on Fargate resources, then you must not specify
|
|
4521
|
-
*
|
|
5339
|
+
* <p>If the job runs on Fargate resources, then you must not specify
|
|
5340
|
+
* <code>nodeProperties</code>; use <code>containerProperties</code> instead.</p>
|
|
4522
5341
|
* </note>
|
|
4523
5342
|
* <note>
|
|
4524
|
-
* <p>If the job runs on Amazon EKS resources, then you must not specify
|
|
5343
|
+
* <p>If the job runs on Amazon EKS resources, then you must not specify
|
|
5344
|
+
* <code>nodeProperties</code>.</p>
|
|
4525
5345
|
* </note>
|
|
4526
5346
|
*/
|
|
4527
5347
|
nodeProperties?: NodeProperties;
|
|
4528
5348
|
/**
|
|
4529
5349
|
* @public
|
|
4530
|
-
* <p>The retry strategy to use for failed jobs that are submitted with this job definition. Any
|
|
4531
|
-
*
|
|
4532
|
-
*
|
|
5350
|
+
* <p>The retry strategy to use for failed jobs that are submitted with this job definition. Any
|
|
5351
|
+
* retry strategy that's specified during a <a>SubmitJob</a> operation overrides the
|
|
5352
|
+
* retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.</p>
|
|
4533
5353
|
*/
|
|
4534
5354
|
retryStrategy?: RetryStrategy;
|
|
4535
5355
|
/**
|
|
4536
5356
|
* @public
|
|
4537
|
-
* <p>Specifies whether to propagate the tags from the job or job definition to the
|
|
4538
|
-
*
|
|
4539
|
-
*
|
|
4540
|
-
*
|
|
5357
|
+
* <p>Specifies whether to propagate the tags from the job or job definition to the
|
|
5358
|
+
* corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only
|
|
5359
|
+
* be propagated to the tasks during task creation. For tags with the same name, job tags are
|
|
5360
|
+
* given priority over job definitions tags. If the total number of combined tags from the job
|
|
5361
|
+
* and job definition is over 50, the job is moved to the <code>FAILED</code> state.</p>
|
|
4541
5362
|
* <note>
|
|
4542
|
-
* <p>If the job runs on Amazon EKS resources, then you must not specify
|
|
5363
|
+
* <p>If the job runs on Amazon EKS resources, then you must not specify
|
|
5364
|
+
* <code>propagateTags</code>.</p>
|
|
4543
5365
|
* </note>
|
|
4544
5366
|
*/
|
|
4545
5367
|
propagateTags?: boolean;
|
|
4546
5368
|
/**
|
|
4547
5369
|
* @public
|
|
4548
|
-
* <p>The timeout configuration for jobs that are submitted with this job definition, after
|
|
4549
|
-
*
|
|
4550
|
-
*
|
|
4551
|
-
*
|
|
5370
|
+
* <p>The timeout configuration for jobs that are submitted with this job definition, after
|
|
5371
|
+
* which Batch terminates your jobs if they have not finished. If a job is terminated due to a
|
|
5372
|
+
* timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout
|
|
5373
|
+
* configuration that's specified during a <a>SubmitJob</a> operation overrides the
|
|
5374
|
+
* timeout configuration defined here. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_timeouts.html">Job Timeouts</a> in the
|
|
5375
|
+
* <i>Batch User Guide</i>.</p>
|
|
4552
5376
|
*/
|
|
4553
5377
|
timeout?: JobTimeout;
|
|
4554
5378
|
/**
|
|
4555
5379
|
* @public
|
|
4556
|
-
* <p>The tags that you apply to the job definition to help you categorize and organize your
|
|
4557
|
-
*
|
|
5380
|
+
* <p>The tags that you apply to the job definition to help you categorize and organize your
|
|
5381
|
+
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging Amazon Web Services Resources</a> in
|
|
5382
|
+
* <i>Batch User Guide</i>.</p>
|
|
4558
5383
|
*/
|
|
4559
5384
|
tags?: Record<string, string>;
|
|
4560
5385
|
/**
|
|
4561
5386
|
* @public
|
|
4562
|
-
* <p>The platform capabilities required by the job definition. If no value is specified, it
|
|
4563
|
-
*
|
|
5387
|
+
* <p>The platform capabilities required by the job definition. If no value is specified, it
|
|
5388
|
+
* defaults to <code>EC2</code>. To run the job on Fargate resources, specify
|
|
5389
|
+
* <code>FARGATE</code>.</p>
|
|
4564
5390
|
* <note>
|
|
4565
|
-
* <p>If the job runs on Amazon EKS resources, then you must not specify
|
|
5391
|
+
* <p>If the job runs on Amazon EKS resources, then you must not specify
|
|
5392
|
+
* <code>platformCapabilities</code>.</p>
|
|
4566
5393
|
* </note>
|
|
4567
5394
|
*/
|
|
4568
5395
|
platformCapabilities?: PlatformCapability[];
|
|
4569
5396
|
/**
|
|
4570
5397
|
* @public
|
|
4571
|
-
* <p>An object with
|
|
4572
|
-
*
|
|
5398
|
+
* <p>An object with properties that are specific to Amazon EKS-based jobs. This must not be
|
|
5399
|
+
* specified for Amazon ECS based job definitions.</p>
|
|
4573
5400
|
*/
|
|
4574
5401
|
eksProperties?: EksProperties;
|
|
5402
|
+
/**
|
|
5403
|
+
* @public
|
|
5404
|
+
* <p>An object with properties that are specific to Amazon ECS-based jobs. This must not be
|
|
5405
|
+
* specified for Amazon EKS-based job definitions.</p>
|
|
5406
|
+
*/
|
|
5407
|
+
ecsProperties?: EcsProperties;
|
|
4575
5408
|
}
|
|
4576
5409
|
/**
|
|
4577
5410
|
* @public
|
|
@@ -4597,7 +5430,7 @@ export interface RegisterJobDefinitionResponse {
|
|
|
4597
5430
|
* @public
|
|
4598
5431
|
* <p>The overrides that should be sent to a container.</p>
|
|
4599
5432
|
* <p>For information about using Batch overrides when you connect event sources to targets, see
|
|
4600
|
-
*
|
|
5433
|
+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_BatchContainerOverrides.html">BatchContainerOverrides</a>.</p>
|
|
4601
5434
|
*/
|
|
4602
5435
|
export interface ContainerOverrides {
|
|
4603
5436
|
/**
|
|
@@ -4606,7 +5439,7 @@ export interface ContainerOverrides {
|
|
|
4606
5439
|
*
|
|
4607
5440
|
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to override the
|
|
4608
5441
|
* <code>vcpus</code> parameter that's set in the job definition. It's not supported for jobs
|
|
4609
|
-
* running on Fargate resources. For jobs that run on EC2 resources, it overrides the
|
|
5442
|
+
* running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the
|
|
4610
5443
|
* <code>vcpus</code> parameter set in the job definition, but doesn't override any vCPU
|
|
4611
5444
|
* requirement specified in the <code>resourceRequirements</code> structure in the job definition.
|
|
4612
5445
|
* To override vCPU requirements that are specified in the <code>resourceRequirements</code>
|
|
@@ -4622,8 +5455,8 @@ export interface ContainerOverrides {
|
|
|
4622
5455
|
*
|
|
4623
5456
|
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to override the memory
|
|
4624
5457
|
* requirements specified in the job definition. It's not supported for jobs running on Fargate
|
|
4625
|
-
* resources. For jobs that run on EC2 resources, it overrides the <code>memory</code> parameter
|
|
4626
|
-
* in the job definition, but doesn't override any memory requirement that's specified in the
|
|
5458
|
+
* resources. For jobs that run on Amazon EC2 resources, it overrides the <code>memory</code> parameter
|
|
5459
|
+
* set in the job definition, but doesn't override any memory requirement that's specified in the
|
|
4627
5460
|
* <code>resourceRequirements</code> structure in the job definition. To override memory
|
|
4628
5461
|
* requirements that are specified in the <code>resourceRequirements</code> structure in the job
|
|
4629
5462
|
* definition, <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code>
|
|
@@ -4671,9 +5504,81 @@ export interface ContainerOverrides {
|
|
|
4671
5504
|
}
|
|
4672
5505
|
/**
|
|
4673
5506
|
* @public
|
|
4674
|
-
* <p>
|
|
5507
|
+
* <p>The overrides that should be sent to a container.</p>
|
|
5508
|
+
* <p>For information about using Batch overrides when you connect event sources to targets, see
|
|
5509
|
+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_BatchContainerOverrides.html">BatchContainerOverrides</a>.</p>
|
|
5510
|
+
*/
|
|
5511
|
+
export interface TaskContainerOverrides {
|
|
5512
|
+
/**
|
|
5513
|
+
* @public
|
|
5514
|
+
* <p>The command to send to the container that overrides the default command from the Docker
|
|
5515
|
+
* image or the job definition.</p>
|
|
5516
|
+
* <note>
|
|
5517
|
+
* <p>This parameter can't contain an empty string.</p>
|
|
5518
|
+
* </note>
|
|
5519
|
+
*/
|
|
5520
|
+
command?: string[];
|
|
5521
|
+
/**
|
|
5522
|
+
* @public
|
|
5523
|
+
* <p>The environment variables to send to the container. You can add new environment variables,
|
|
5524
|
+
* which are added to the container at launch, or you can override the existing environment
|
|
5525
|
+
* variables from the Docker image or the job definition.</p>
|
|
5526
|
+
* <note>
|
|
5527
|
+
* <p>Environment variables cannot start with <code>AWS_BATCH</code>. This naming convention is
|
|
5528
|
+
* reserved for variables that Batch sets.</p>
|
|
5529
|
+
* </note>
|
|
5530
|
+
*/
|
|
5531
|
+
environment?: KeyValuePair[];
|
|
5532
|
+
/**
|
|
5533
|
+
* @public
|
|
5534
|
+
* <p>A pointer to the container that you want to override. The container's name provides a unique
|
|
5535
|
+
* identifier for the container being used.</p>
|
|
5536
|
+
*/
|
|
5537
|
+
name?: string;
|
|
5538
|
+
/**
|
|
5539
|
+
* @public
|
|
5540
|
+
* <p>The type and amount of resources to assign to a container. This overrides the settings in
|
|
5541
|
+
* the job definition. The supported resources include <code>GPU</code>, <code>MEMORY</code>, and
|
|
5542
|
+
* <code>VCPU</code>.</p>
|
|
5543
|
+
*/
|
|
5544
|
+
resourceRequirements?: ResourceRequirement[];
|
|
5545
|
+
}
|
|
5546
|
+
/**
|
|
5547
|
+
* @public
|
|
5548
|
+
* <p>An object that contains overrides for the task definition of a job.</p>
|
|
5549
|
+
*/
|
|
5550
|
+
export interface TaskPropertiesOverride {
|
|
5551
|
+
/**
|
|
5552
|
+
* @public
|
|
5553
|
+
* <p>The overrides for the container definition of a job.</p>
|
|
5554
|
+
*/
|
|
5555
|
+
containers?: TaskContainerOverrides[];
|
|
5556
|
+
}
|
|
5557
|
+
/**
|
|
5558
|
+
* @public
|
|
5559
|
+
* <p>An object that contains overrides for the Amazon ECS task definition of a job.</p>
|
|
5560
|
+
*/
|
|
5561
|
+
export interface EcsPropertiesOverride {
|
|
5562
|
+
/**
|
|
5563
|
+
* @public
|
|
5564
|
+
* <p>The overrides for the Amazon ECS task definition of a job.</p>
|
|
5565
|
+
* <note>
|
|
5566
|
+
* <p>This object is currently limited to one element.</p>
|
|
5567
|
+
* </note>
|
|
5568
|
+
*/
|
|
5569
|
+
taskProperties?: TaskPropertiesOverride[];
|
|
5570
|
+
}
|
|
5571
|
+
/**
|
|
5572
|
+
* @public
|
|
5573
|
+
* <p>Object representing any Kubernetes overrides to a job definition that's used in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> API
|
|
5574
|
+
* operation.</p>
|
|
4675
5575
|
*/
|
|
4676
5576
|
export interface EksContainerOverride {
|
|
5577
|
+
/**
|
|
5578
|
+
* @public
|
|
5579
|
+
* <p>A pointer to the container that you want to override. The name must match a unique container name that you wish to override.</p>
|
|
5580
|
+
*/
|
|
5581
|
+
name?: string;
|
|
4677
5582
|
/**
|
|
4678
5583
|
* @public
|
|
4679
5584
|
* <p>The override of the Docker image that's used to start the container.</p>
|
|
@@ -4688,8 +5593,8 @@ export interface EksContainerOverride {
|
|
|
4688
5593
|
/**
|
|
4689
5594
|
* @public
|
|
4690
5595
|
* <p>The arguments to the entrypoint to send to the container that overrides the default
|
|
4691
|
-
* arguments from the Docker image or the job definition. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">CMD</a>
|
|
4692
|
-
*
|
|
5596
|
+
* arguments from the Docker image or the job definition. For more information, see <a href="https://docs.docker.com/engine/reference/builder/#cmd">Dockerfile reference: CMD</a>
|
|
5597
|
+
* and <a href="https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/">Define a command an arguments for a pod</a> in the <i>Kubernetes
|
|
4693
5598
|
* documentation</i>.</p>
|
|
4694
5599
|
*/
|
|
4695
5600
|
args?: string[];
|
|
@@ -4724,6 +5629,15 @@ export interface EksPodPropertiesOverride {
|
|
|
4724
5629
|
* <p>The overrides for the container that's used on the Amazon EKS pod.</p>
|
|
4725
5630
|
*/
|
|
4726
5631
|
containers?: EksContainerOverride[];
|
|
5632
|
+
/**
|
|
5633
|
+
* @public
|
|
5634
|
+
* <p>The overrides for the conatainers defined in the Amazon EKS pod. These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-containers/">Init
|
|
5635
|
+
* Containers</a> in the <i>Kubernetes documentation</i>.</p>
|
|
5636
|
+
* <note>
|
|
5637
|
+
* <p>This object is limited to 10 elements</p>
|
|
5638
|
+
* </note>
|
|
5639
|
+
*/
|
|
5640
|
+
initContainers?: EksContainerOverride[];
|
|
4727
5641
|
/**
|
|
4728
5642
|
* @public
|
|
4729
5643
|
* <p>Metadata about the
|
|
@@ -4744,7 +5658,8 @@ export interface EksPropertiesOverride {
|
|
|
4744
5658
|
}
|
|
4745
5659
|
/**
|
|
4746
5660
|
* @public
|
|
4747
|
-
* <p>The object that represents any node overrides to a job definition that's used in a <a>SubmitJob</a> API
|
|
5661
|
+
* <p>The object that represents any node overrides to a job definition that's used in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> API
|
|
5662
|
+
* operation.</p>
|
|
4748
5663
|
*/
|
|
4749
5664
|
export interface NodePropertyOverride {
|
|
4750
5665
|
/**
|
|
@@ -4761,10 +5676,23 @@ export interface NodePropertyOverride {
|
|
|
4761
5676
|
* <p>The overrides that are sent to a node range.</p>
|
|
4762
5677
|
*/
|
|
4763
5678
|
containerOverrides?: ContainerOverrides;
|
|
5679
|
+
/**
|
|
5680
|
+
* @public
|
|
5681
|
+
* <p>An object that contains the properties that you want to replace for the existing Amazon ECS
|
|
5682
|
+
* resources of a job.</p>
|
|
5683
|
+
*/
|
|
5684
|
+
ecsPropertiesOverride?: EcsPropertiesOverride;
|
|
5685
|
+
/**
|
|
5686
|
+
* @public
|
|
5687
|
+
* <p>An object that contains the instance types that you want to replace for the existing
|
|
5688
|
+
* resources of a job.</p>
|
|
5689
|
+
*/
|
|
5690
|
+
instanceTypes?: string[];
|
|
4764
5691
|
}
|
|
4765
5692
|
/**
|
|
4766
5693
|
* @public
|
|
4767
|
-
* <p>An object that represents any node overrides to a job definition that's used in a <a>SubmitJob</a> API
|
|
5694
|
+
* <p>An object that represents any node overrides to a job definition that's used in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> API
|
|
5695
|
+
* operation.</p>
|
|
4768
5696
|
* <note>
|
|
4769
5697
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't
|
|
4770
5698
|
* provide it for these jobs. Rather, use <code>containerOverrides</code> instead.</p>
|
|
@@ -4805,13 +5733,15 @@ export interface NodeOverrides {
|
|
|
4805
5733
|
export interface SubmitJobRequest {
|
|
4806
5734
|
/**
|
|
4807
5735
|
* @public
|
|
4808
|
-
* <p>The name of the job. It can be up to 128 letters long. The first character must be
|
|
4809
|
-
*
|
|
5736
|
+
* <p>The name of the job. It can be up to 128 letters long. The first character must be
|
|
5737
|
+
* alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and
|
|
5738
|
+
* underscores (_).</p>
|
|
4810
5739
|
*/
|
|
4811
5740
|
jobName: string | undefined;
|
|
4812
5741
|
/**
|
|
4813
5742
|
* @public
|
|
4814
|
-
* <p>The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN)
|
|
5743
|
+
* <p>The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN)
|
|
5744
|
+
* of the queue.</p>
|
|
4815
5745
|
*/
|
|
4816
5746
|
jobQueue: string | undefined;
|
|
4817
5747
|
/**
|
|
@@ -4825,8 +5755,8 @@ export interface SubmitJobRequest {
|
|
|
4825
5755
|
shareIdentifier?: string;
|
|
4826
5756
|
/**
|
|
4827
5757
|
* @public
|
|
4828
|
-
* <p>The scheduling priority for the job. This only affects jobs in job queues with a fair
|
|
4829
|
-
* policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
|
|
5758
|
+
* <p>The scheduling priority for the job. This only affects jobs in job queues with a fair
|
|
5759
|
+
* share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
|
|
4830
5760
|
* scheduling priority.
|
|
4831
5761
|
* This
|
|
4832
5762
|
* overrides any scheduling priority in the job definition and works only within a single share
|
|
@@ -4836,96 +5766,107 @@ export interface SubmitJobRequest {
|
|
|
4836
5766
|
schedulingPriorityOverride?: number;
|
|
4837
5767
|
/**
|
|
4838
5768
|
* @public
|
|
4839
|
-
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
4840
|
-
*
|
|
4841
|
-
*
|
|
5769
|
+
* <p>The array properties for the submitted job, such as the size of the array. The array size
|
|
5770
|
+
* can be between 2 and 10,000. If you specify array properties for a job, it becomes an array
|
|
5771
|
+
* job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html">Array Jobs</a> in the <i>Batch User Guide</i>.</p>
|
|
4842
5772
|
*/
|
|
4843
5773
|
arrayProperties?: ArrayProperties;
|
|
4844
5774
|
/**
|
|
4845
5775
|
* @public
|
|
4846
|
-
* <p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can
|
|
4847
|
-
*
|
|
4848
|
-
*
|
|
4849
|
-
*
|
|
4850
|
-
*
|
|
5776
|
+
* <p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can
|
|
5777
|
+
* specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs
|
|
5778
|
+
* so that each child array job completes sequentially, starting at index 0. You can also specify
|
|
5779
|
+
* an <code>N_TO_N</code> type dependency with a job ID for array jobs. In that case, each index
|
|
5780
|
+
* child of this job must wait for the corresponding index child of each dependency to complete
|
|
5781
|
+
* before it can begin.</p>
|
|
4851
5782
|
*/
|
|
4852
5783
|
dependsOn?: JobDependency[];
|
|
4853
5784
|
/**
|
|
4854
5785
|
* @public
|
|
4855
|
-
* <p>The job definition used by this job. This value can be one of
|
|
4856
|
-
*
|
|
4857
|
-
*
|
|
5786
|
+
* <p>The job definition used by this job. This value can be one of
|
|
5787
|
+
* <code>definition-name</code>, <code>definition-name:revision</code>, or the Amazon Resource Name (ARN) for the
|
|
5788
|
+
* job definition, with or without the revision
|
|
5789
|
+
* (<code>arn:aws:batch:<i>region</i>:<i>account</i>:job-definition/<i>definition-name</i>:<i>revision</i>
|
|
4858
5790
|
* </code>,
|
|
4859
|
-
*
|
|
4860
|
-
*
|
|
5791
|
+
* or
|
|
5792
|
+
* <code>arn:aws:batch:<i>region</i>:<i>account</i>:job-definition/<i>definition-name</i>
|
|
4861
5793
|
* </code>).</p>
|
|
4862
5794
|
* <p>If the revision is not specified, then the latest active revision is used.</p>
|
|
4863
5795
|
*/
|
|
4864
5796
|
jobDefinition: string | undefined;
|
|
4865
5797
|
/**
|
|
4866
5798
|
* @public
|
|
4867
|
-
* <p>Additional parameters passed to the job that replace parameter substitution placeholders
|
|
4868
|
-
*
|
|
4869
|
-
*
|
|
5799
|
+
* <p>Additional parameters passed to the job that replace parameter substitution placeholders
|
|
5800
|
+
* that are set in the job definition. Parameters are specified as a key and value pair mapping.
|
|
5801
|
+
* Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults
|
|
5802
|
+
* from the job definition.</p>
|
|
4870
5803
|
*/
|
|
4871
5804
|
parameters?: Record<string, string>;
|
|
4872
5805
|
/**
|
|
4873
5806
|
* @public
|
|
4874
|
-
* <p>An object with
|
|
4875
|
-
*
|
|
4876
|
-
*
|
|
4877
|
-
*
|
|
4878
|
-
*
|
|
5807
|
+
* <p>An object with properties that override the defaults for the job definition that specify
|
|
5808
|
+
* the name of a container in the specified job definition and the overrides it should receive.
|
|
5809
|
+
* You can override the default command for a container, which is specified in the job definition
|
|
5810
|
+
* or the Docker image, with a <code>command</code> override. You can also override existing
|
|
5811
|
+
* environment variables on a container or add new environment variables to it with an
|
|
5812
|
+
* <code>environment</code> override.</p>
|
|
4879
5813
|
*/
|
|
4880
5814
|
containerOverrides?: ContainerOverrides;
|
|
4881
5815
|
/**
|
|
4882
5816
|
* @public
|
|
4883
|
-
* <p>A list of node overrides in JSON format that specify the node range to target and the
|
|
4884
|
-
*
|
|
5817
|
+
* <p>A list of node overrides in JSON format that specify the node range to target and the
|
|
5818
|
+
* container overrides for that node range.</p>
|
|
4885
5819
|
* <note>
|
|
4886
5820
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources; use
|
|
4887
|
-
*
|
|
5821
|
+
* <code>containerOverrides</code> instead.</p>
|
|
4888
5822
|
* </note>
|
|
4889
5823
|
*/
|
|
4890
5824
|
nodeOverrides?: NodeOverrides;
|
|
4891
5825
|
/**
|
|
4892
5826
|
* @public
|
|
4893
|
-
* <p>The retry strategy to use for failed jobs from this <a>SubmitJob</a> operation.
|
|
4894
|
-
*
|
|
5827
|
+
* <p>The retry strategy to use for failed jobs from this <a>SubmitJob</a> operation.
|
|
5828
|
+
* When a retry strategy is specified here, it overrides the retry strategy defined in the job
|
|
5829
|
+
* definition.</p>
|
|
4895
5830
|
*/
|
|
4896
5831
|
retryStrategy?: RetryStrategy;
|
|
4897
5832
|
/**
|
|
4898
5833
|
* @public
|
|
4899
|
-
* <p>Specifies whether to propagate the tags from the job or job definition to the
|
|
4900
|
-
*
|
|
4901
|
-
*
|
|
4902
|
-
*
|
|
4903
|
-
*
|
|
5834
|
+
* <p>Specifies whether to propagate the tags from the job or job definition to the
|
|
5835
|
+
* corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only
|
|
5836
|
+
* be propagated to the tasks during task creation. For tags with the same name, job tags are
|
|
5837
|
+
* given priority over job definitions tags. If the total number of combined tags from the job
|
|
5838
|
+
* and job definition is over 50, the job is moved to the <code>FAILED</code> state. When
|
|
5839
|
+
* specified, this overrides the tag propagation setting in the job definition.</p>
|
|
4904
5840
|
*/
|
|
4905
5841
|
propagateTags?: boolean;
|
|
4906
5842
|
/**
|
|
4907
5843
|
* @public
|
|
4908
|
-
* <p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify
|
|
4909
|
-
*
|
|
4910
|
-
*
|
|
4911
|
-
*
|
|
4912
|
-
*
|
|
4913
|
-
*
|
|
5844
|
+
* <p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify
|
|
5845
|
+
* a timeout duration after which Batch terminates your jobs if they haven't finished. If a job
|
|
5846
|
+
* is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60
|
|
5847
|
+
* seconds. This configuration overrides any timeout configuration specified in the job
|
|
5848
|
+
* definition. For array jobs, child jobs have the same timeout configuration as the parent job.
|
|
5849
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html">Job Timeouts</a> in the
|
|
5850
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
4914
5851
|
*/
|
|
4915
5852
|
timeout?: JobTimeout;
|
|
4916
5853
|
/**
|
|
4917
5854
|
* @public
|
|
4918
|
-
* <p>The tags that you apply to the job request to help you categorize and organize your
|
|
4919
|
-
*
|
|
4920
|
-
*
|
|
5855
|
+
* <p>The tags that you apply to the job request to help you categorize and organize your
|
|
5856
|
+
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
5857
|
+
* Resources</a> in <i>Amazon Web Services General Reference</i>.</p>
|
|
4921
5858
|
*/
|
|
4922
5859
|
tags?: Record<string, string>;
|
|
4923
5860
|
/**
|
|
4924
5861
|
* @public
|
|
4925
|
-
* <p>An object that can only be specified for jobs that are run on Amazon EKS resources
|
|
4926
|
-
* override defaults for the job definition.</p>
|
|
5862
|
+
* <p>An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.</p>
|
|
4927
5863
|
*/
|
|
4928
5864
|
eksPropertiesOverride?: EksPropertiesOverride;
|
|
5865
|
+
/**
|
|
5866
|
+
* @public
|
|
5867
|
+
* <p>An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.</p>
|
|
5868
|
+
*/
|
|
5869
|
+
ecsPropertiesOverride?: EcsPropertiesOverride;
|
|
4929
5870
|
}
|
|
4930
5871
|
/**
|
|
4931
5872
|
* @public
|
|
@@ -4960,9 +5901,9 @@ export interface TagResourceRequest {
|
|
|
4960
5901
|
resourceArn: string | undefined;
|
|
4961
5902
|
/**
|
|
4962
5903
|
* @public
|
|
4963
|
-
* <p>The tags that you apply to the resource to help you categorize and organize your
|
|
4964
|
-
*
|
|
4965
|
-
*
|
|
5904
|
+
* <p>The tags that you apply to the resource to help you categorize and organize your
|
|
5905
|
+
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
5906
|
+
* Resources</a> in <i>Amazon Web Services General Reference</i>.</p>
|
|
4966
5907
|
*/
|
|
4967
5908
|
tags: Record<string, string> | undefined;
|
|
4968
5909
|
}
|
|
@@ -4983,9 +5924,9 @@ export interface TerminateJobRequest {
|
|
|
4983
5924
|
jobId: string | undefined;
|
|
4984
5925
|
/**
|
|
4985
5926
|
* @public
|
|
4986
|
-
* <p>A message to attach to the job that explains the reason for canceling it. This message is
|
|
4987
|
-
*
|
|
4988
|
-
*
|
|
5927
|
+
* <p>A message to attach to the job that explains the reason for canceling it. This message is
|
|
5928
|
+
* returned by future <a>DescribeJobs</a> operations on the job. This message is also
|
|
5929
|
+
* recorded in the Batch activity logs.</p>
|
|
4989
5930
|
*/
|
|
4990
5931
|
reason: string | undefined;
|
|
4991
5932
|
}
|
|
@@ -5051,11 +5992,11 @@ export interface ComputeResourceUpdate {
|
|
|
5051
5992
|
* <p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p>
|
|
5052
5993
|
* <note>
|
|
5053
5994
|
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
5054
|
-
*
|
|
5995
|
+
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
|
|
5055
5996
|
* (recommended) strategies using On-Demand or Spot Instances, and the
|
|
5056
|
-
*
|
|
5057
|
-
*
|
|
5058
|
-
*
|
|
5997
|
+
* <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
5998
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
|
|
5999
|
+
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
5059
6000
|
* </note>
|
|
5060
6001
|
*/
|
|
5061
6002
|
maxvCpus?: number;
|
|
@@ -5085,7 +6026,7 @@ export interface ComputeResourceUpdate {
|
|
|
5085
6026
|
* @public
|
|
5086
6027
|
* <p>The VPC subnets where the compute resources are launched. Fargate compute resources can
|
|
5087
6028
|
* contain up to 16 subnets. For Fargate compute resources, providing an empty list will be
|
|
5088
|
-
* handled as if this parameter wasn't specified and no change is made. For EC2 compute resources,
|
|
6029
|
+
* handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources,
|
|
5089
6030
|
* providing an empty list removes the VPC subnets from the compute resource. For more information,
|
|
5090
6031
|
* see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and
|
|
5091
6032
|
* subnets</a> in the <i>Amazon VPC User Guide</i>.</p>
|
|
@@ -5107,9 +6048,9 @@ export interface ComputeResourceUpdate {
|
|
|
5107
6048
|
* <p>The Amazon EC2 security groups that are associated with instances launched in the compute
|
|
5108
6049
|
* environment. This parameter is required for Fargate compute resources, where it can contain up
|
|
5109
6050
|
* to 5 security groups. For Fargate compute resources, providing an empty list is handled as if
|
|
5110
|
-
* this parameter wasn't specified and no change is made. For EC2 compute resources, providing an
|
|
6051
|
+
* this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an
|
|
5111
6052
|
* empty list removes the security groups from the compute resource.</p>
|
|
5112
|
-
* <p>When updating a compute environment, changing the EC2 security groups requires an
|
|
6053
|
+
* <p>When updating a compute environment, changing the Amazon EC2 security groups requires an
|
|
5113
6054
|
* infrastructure update of the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute
|
|
5114
6055
|
* environments</a> in the <i>Batch User Guide</i>.</p>
|
|
5115
6056
|
*/
|
|
@@ -5144,18 +6085,18 @@ export interface ComputeResourceUpdate {
|
|
|
5144
6085
|
* </dd>
|
|
5145
6086
|
* <dt>SPOT_PRICE_CAPACITY_OPTIMIZED</dt>
|
|
5146
6087
|
* <dd>
|
|
5147
|
-
* <p>The price and capacity optimized allocation strategy looks at both price and
|
|
6088
|
+
* <p>The price and capacity optimized allocation strategy looks at both price and capacity to
|
|
5148
6089
|
* select the Spot Instance pools that are the least likely to be interrupted and have the lowest
|
|
5149
6090
|
* possible price. This allocation strategy is only available for Spot Instance compute
|
|
5150
6091
|
* resources.</p>
|
|
5151
6092
|
* </dd>
|
|
5152
6093
|
* </dl>
|
|
5153
6094
|
* <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
|
|
5154
|
-
*
|
|
6095
|
+
* <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
|
|
5155
6096
|
* (recommended) strategies using On-Demand or Spot Instances, and the
|
|
5156
|
-
*
|
|
5157
|
-
*
|
|
5158
|
-
*
|
|
6097
|
+
* <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
|
|
6098
|
+
* <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
|
|
6099
|
+
* <code>maxvCpus</code> by more than a single instance.</p>
|
|
5159
6100
|
*/
|
|
5160
6101
|
allocationStrategy?: CRUpdateAllocationStrategy;
|
|
5161
6102
|
/**
|
|
@@ -5188,7 +6129,7 @@ export interface ComputeResourceUpdate {
|
|
|
5188
6129
|
* <p>The Amazon EC2 key pair that's used for instances launched in the compute environment. You can
|
|
5189
6130
|
* use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this
|
|
5190
6131
|
* value to an empty string.</p>
|
|
5191
|
-
* <p>When updating a compute environment, changing the EC2 key pair requires an infrastructure
|
|
6132
|
+
* <p>When updating a compute environment, changing the Amazon EC2 key pair requires an infrastructure
|
|
5192
6133
|
* update of the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
5193
6134
|
* <i>Batch User Guide</i>.</p>
|
|
5194
6135
|
* <note>
|
|
@@ -5217,7 +6158,7 @@ export interface ComputeResourceUpdate {
|
|
|
5217
6158
|
instanceRole?: string;
|
|
5218
6159
|
/**
|
|
5219
6160
|
* @public
|
|
5220
|
-
* <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute
|
|
6161
|
+
* <p>Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute
|
|
5221
6162
|
* environment. For Batch, these take the form of <code>"String1": "String2"</code>, where
|
|
5222
6163
|
* <code>String1</code> is the tag key and <code>String2</code> is the tag value-for example,
|
|
5223
6164
|
* <code>\{ "Name": "Batch Instance - C4OnDemand" \}</code>. This is helpful for recognizing your
|
|
@@ -5284,12 +6225,12 @@ export interface ComputeResourceUpdate {
|
|
|
5284
6225
|
launchTemplate?: LaunchTemplateSpecification;
|
|
5285
6226
|
/**
|
|
5286
6227
|
* @public
|
|
5287
|
-
* <p>Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the
|
|
6228
|
+
* <p>Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the
|
|
5288
6229
|
* compute environment. If <code>Ec2Configuration</code> isn't specified, the default is
|
|
5289
6230
|
* <code>ECS_AL2</code>.</p>
|
|
5290
6231
|
* <p>When updating a compute environment, changing this setting requires an infrastructure update
|
|
5291
6232
|
* of the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
|
|
5292
|
-
* <i>Batch User Guide</i>. To remove the EC2 configuration and any custom AMI ID
|
|
6233
|
+
* <i>Batch User Guide</i>. To remove the Amazon EC2 configuration and any custom AMI ID
|
|
5293
6234
|
* specified in <code>imageIdOverride</code>, set this value to an empty string.</p>
|
|
5294
6235
|
* <p>One or two values can be provided.</p>
|
|
5295
6236
|
* <note>
|
|
@@ -5388,46 +6329,48 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
5388
6329
|
state?: CEState;
|
|
5389
6330
|
/**
|
|
5390
6331
|
* @public
|
|
5391
|
-
* <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
|
5392
|
-
*
|
|
5393
|
-
*
|
|
5394
|
-
*
|
|
6332
|
+
* <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
|
6333
|
+
* Don't specify this parameter for a managed compute environment. This parameter is only used
|
|
6334
|
+
* for fair share scheduling to reserve vCPU capacity for new share identifiers. If this
|
|
6335
|
+
* parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p>
|
|
5395
6336
|
*/
|
|
5396
6337
|
unmanagedvCpus?: number;
|
|
5397
6338
|
/**
|
|
5398
6339
|
* @public
|
|
5399
|
-
* <p>Details of the compute resources managed by the compute environment. Required for a
|
|
5400
|
-
*
|
|
5401
|
-
*
|
|
6340
|
+
* <p>Details of the compute resources managed by the compute environment. Required for a
|
|
6341
|
+
* managed compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute Environments</a> in the
|
|
6342
|
+
* <i>Batch User Guide</i>.</p>
|
|
5402
6343
|
*/
|
|
5403
6344
|
computeResources?: ComputeResourceUpdate;
|
|
5404
6345
|
/**
|
|
5405
6346
|
* @public
|
|
5406
|
-
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
|
|
5407
|
-
*
|
|
5408
|
-
*
|
|
6347
|
+
* <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
|
|
6348
|
+
* services on your behalf. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the
|
|
6349
|
+
* <i>Batch User Guide</i>.</p>
|
|
5409
6350
|
* <important>
|
|
5410
|
-
* <p>If the compute environment has a service-linked role, it can't be changed to use a
|
|
5411
|
-
*
|
|
5412
|
-
*
|
|
5413
|
-
*
|
|
5414
|
-
*
|
|
6351
|
+
* <p>If the compute environment has a service-linked role, it can't be changed to use a
|
|
6352
|
+
* regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't
|
|
6353
|
+
* be changed to use a service-linked role. To update the parameters for the compute
|
|
6354
|
+
* environment that require an infrastructure update to change, the <b>AWSServiceRoleForBatch</b> service-linked role must be used. For more information,
|
|
6355
|
+
* see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating
|
|
6356
|
+
* compute environments</a> in the <i>Batch User Guide</i>.</p>
|
|
5415
6357
|
* </important>
|
|
5416
|
-
* <p>If your specified role has a path other than <code>/</code>, then you must either specify
|
|
5417
|
-
*
|
|
6358
|
+
* <p>If your specified role has a path other than <code>/</code>, then you must either specify
|
|
6359
|
+
* the full role ARN (recommended) or prefix the role name with the path.</p>
|
|
5418
6360
|
* <note>
|
|
5419
|
-
* <p>Depending on how you created your Batch service role, its ARN might contain the
|
|
5420
|
-
*
|
|
5421
|
-
*
|
|
5422
|
-
*
|
|
6361
|
+
* <p>Depending on how you created your Batch service role, its ARN might contain the
|
|
6362
|
+
* <code>service-role</code> path prefix. When you only specify the name of the service role,
|
|
6363
|
+
* Batch assumes that your ARN doesn't use the <code>service-role</code> path prefix. Because
|
|
6364
|
+
* of this, we recommend that you specify the full ARN of your service role when you create
|
|
6365
|
+
* compute environments.</p>
|
|
5423
6366
|
* </note>
|
|
5424
6367
|
*/
|
|
5425
6368
|
serviceRole?: string;
|
|
5426
6369
|
/**
|
|
5427
6370
|
* @public
|
|
5428
|
-
* <p>Specifies the updated infrastructure update policy for the compute environment. For more
|
|
5429
|
-
*
|
|
5430
|
-
*
|
|
6371
|
+
* <p>Specifies the updated infrastructure update policy for the compute environment. For more
|
|
6372
|
+
* information about infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in
|
|
6373
|
+
* the <i>Batch User Guide</i>.</p>
|
|
5431
6374
|
*/
|
|
5432
6375
|
updatePolicy?: UpdatePolicy;
|
|
5433
6376
|
}
|
|
@@ -5459,41 +6402,44 @@ export interface UpdateJobQueueRequest {
|
|
|
5459
6402
|
jobQueue: string | undefined;
|
|
5460
6403
|
/**
|
|
5461
6404
|
* @public
|
|
5462
|
-
* <p>Describes the queue's ability to accept new jobs. If the job queue state is
|
|
5463
|
-
*
|
|
5464
|
-
*
|
|
6405
|
+
* <p>Describes the queue's ability to accept new jobs. If the job queue state is
|
|
6406
|
+
* <code>ENABLED</code>, it can accept jobs. If the job queue state is <code>DISABLED</code>,
|
|
6407
|
+
* new jobs can't be added to the queue, but jobs already in the queue can finish.</p>
|
|
5465
6408
|
*/
|
|
5466
6409
|
state?: JQState;
|
|
5467
6410
|
/**
|
|
5468
6411
|
* @public
|
|
5469
|
-
* <p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share
|
|
5470
|
-
*
|
|
5471
|
-
*
|
|
6412
|
+
* <p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share
|
|
6413
|
+
* scheduling policy can be replaced but not removed. The format is
|
|
6414
|
+
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
5472
6415
|
* </code>.
|
|
5473
|
-
*
|
|
5474
|
-
*
|
|
6416
|
+
* For example,
|
|
6417
|
+
* <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
5475
6418
|
*/
|
|
5476
6419
|
schedulingPolicyArn?: string;
|
|
5477
6420
|
/**
|
|
5478
6421
|
* @public
|
|
5479
|
-
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer
|
|
5480
|
-
*
|
|
5481
|
-
*
|
|
5482
|
-
*
|
|
5483
|
-
*
|
|
5484
|
-
*
|
|
6422
|
+
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer
|
|
6423
|
+
* value for the <code>priority</code> parameter) are evaluated first when associated with the
|
|
6424
|
+
* same compute environment. Priority is determined in descending order. For example, a job queue
|
|
6425
|
+
* with a priority value of <code>10</code> is given scheduling preference over a job queue with
|
|
6426
|
+
* a priority value of <code>1</code>. All of the compute environments must be either EC2
|
|
6427
|
+
* (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or
|
|
6428
|
+
* <code>FARGATE_SPOT</code>). EC2 and Fargate compute environments can't be mixed.</p>
|
|
5485
6429
|
*/
|
|
5486
6430
|
priority?: number;
|
|
5487
6431
|
/**
|
|
5488
6432
|
* @public
|
|
5489
|
-
* <p>Details the set of compute environments mapped to a job queue and their order relative to
|
|
5490
|
-
*
|
|
5491
|
-
*
|
|
5492
|
-
*
|
|
5493
|
-
*
|
|
6433
|
+
* <p>Details the set of compute environments mapped to a job queue and their order relative to
|
|
6434
|
+
* each other. This is one of the parameters used by the job scheduler to determine which compute
|
|
6435
|
+
* environment runs a given job. Compute environments must be in the <code>VALID</code> state
|
|
6436
|
+
* before you can associate them with a job queue. All of the compute environments must be either
|
|
6437
|
+
* EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or
|
|
6438
|
+
* <code>FARGATE_SPOT</code>). EC2 and Fargate compute environments can't be mixed.</p>
|
|
5494
6439
|
* <note>
|
|
5495
|
-
* <p>All compute environments that are associated with a job queue must share the same
|
|
5496
|
-
*
|
|
6440
|
+
* <p>All compute environments that are associated with a job queue must share the same
|
|
6441
|
+
* architecture. Batch doesn't support mixing compute environment architecture types in a
|
|
6442
|
+
* single job queue.</p>
|
|
5497
6443
|
* </note>
|
|
5498
6444
|
*/
|
|
5499
6445
|
computeEnvironmentOrder?: ComputeEnvironmentOrder[];
|