@aws-sdk/client-batch 3.40.0 → 3.45.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/CHANGELOG.md +44 -0
- package/README.md +2 -2
- package/dist-cjs/Batch.js +75 -0
- package/dist-cjs/commands/CreateSchedulingPolicyCommand.js +36 -0
- package/dist-cjs/commands/DeleteSchedulingPolicyCommand.js +36 -0
- package/dist-cjs/commands/DescribeSchedulingPoliciesCommand.js +36 -0
- package/dist-cjs/commands/ListSchedulingPoliciesCommand.js +36 -0
- package/dist-cjs/commands/UpdateSchedulingPolicyCommand.js +36 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/endpoints.js +25 -0
- package/dist-cjs/models/models_0.js +87 -3
- package/dist-cjs/pagination/ListSchedulingPoliciesPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +509 -1
- package/dist-es/Batch.js +75 -0
- package/dist-es/commands/CreateSchedulingPolicyCommand.js +39 -0
- package/dist-es/commands/DeleteSchedulingPolicyCommand.js +39 -0
- package/dist-es/commands/DescribeSchedulingPoliciesCommand.js +39 -0
- package/dist-es/commands/ListSchedulingPoliciesCommand.js +39 -0
- package/dist-es/commands/UpdateSchedulingPolicyCommand.js +39 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoints.js +25 -0
- package/dist-es/models/models_0.js +56 -0
- package/dist-es/pagination/ListSchedulingPoliciesPaginator.js +74 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +584 -13
- package/dist-types/Batch.d.ts +50 -12
- package/dist-types/BatchClient.d.ts +9 -4
- package/dist-types/commands/CancelJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +5 -6
- package/dist-types/commands/CreateJobQueueCommand.d.ts +1 -1
- package/dist-types/commands/CreateSchedulingPolicyCommand.d.ts +35 -0
- package/dist-types/commands/DeleteComputeEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteJobQueueCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSchedulingPolicyCommand.d.ts +36 -0
- package/dist-types/commands/DeregisterJobDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeJobQueuesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeJobsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSchedulingPoliciesCommand.d.ts +35 -0
- package/dist-types/commands/ListJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListSchedulingPoliciesCommand.d.ts +35 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
- package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/SubmitJobCommand.d.ts +5 -2
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/TerminateJobCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateComputeEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateJobQueueCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSchedulingPolicyCommand.d.ts +35 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +455 -114
- package/dist-types/pagination/ListSchedulingPoliciesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
- package/dist-types/ts3.4/Batch.d.ts +25 -0
- package/dist-types/ts3.4/BatchClient.d.ts +7 -2
- package/dist-types/ts3.4/commands/CreateSchedulingPolicyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteSchedulingPolicyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeSchedulingPoliciesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListSchedulingPoliciesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateSchedulingPolicyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +164 -0
- package/dist-types/ts3.4/pagination/ListSchedulingPoliciesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +15 -0
- package/package.json +6 -6
|
@@ -225,10 +225,7 @@ export declare enum CRAllocationStrategy {
|
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
227
|
* <p>Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If
|
|
228
|
-
* <code>Ec2Configuration</code> isn't specified, the default is
|
|
229
|
-
* non-GPU, non AWSGraviton instances. Starting on March 31, 2021, this default will be changing to <code>ECS_AL2</code>
|
|
230
|
-
* (<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami">Amazon Linux
|
|
231
|
-
* 2</a>).</p>
|
|
228
|
+
* <code>Ec2Configuration</code> isn't specified, the default is <code>ECS_AL2</code> (<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami">Amazon Linux 2</a>).</p>
|
|
232
229
|
* <note>
|
|
233
230
|
* <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
|
|
234
231
|
* </note>
|
|
@@ -236,15 +233,14 @@ export declare enum CRAllocationStrategy {
|
|
|
236
233
|
export interface Ec2Configuration {
|
|
237
234
|
/**
|
|
238
235
|
* <p>The image type to match with the instance type to select an AMI. If the <code>imageIdOverride</code> parameter
|
|
239
|
-
* isn't specified, then a recent <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized AMI</a>
|
|
240
|
-
*
|
|
236
|
+
* isn't specified, then a recent <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami">Amazon ECS-optimized Amazon Linux 2 AMI</a>
|
|
237
|
+
* (<code>ECS_AL2</code>) is used.</p>
|
|
241
238
|
* <dl>
|
|
242
239
|
* <dt>ECS_AL2</dt>
|
|
243
240
|
* <dd>
|
|
244
241
|
* <p>
|
|
245
242
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami">Amazon Linux
|
|
246
|
-
* 2</a>− Default for all
|
|
247
|
-
* <code>M6g</code>, <code>R6g</code>, and <code>T4g</code>) and can be used for all non-GPU instance types.</p>
|
|
243
|
+
* 2</a>− Default for all non-GPU instance families.</p>
|
|
248
244
|
* </dd>
|
|
249
245
|
* <dt>ECS_AL2_NVIDIA</dt>
|
|
250
246
|
* <dd>
|
|
@@ -256,10 +252,8 @@ export interface Ec2Configuration {
|
|
|
256
252
|
* <dt>ECS_AL1</dt>
|
|
257
253
|
* <dd>
|
|
258
254
|
* <p>
|
|
259
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami">Amazon
|
|
260
|
-
*
|
|
261
|
-
* end-of-life of standard support. For more information, see <a href="http://aws.amazon.com/amazon-linux-ami/">Amazon
|
|
262
|
-
* Linux AMI</a>.</p>
|
|
255
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami">Amazon Linux</a>.
|
|
256
|
+
* Amazon Linux is reaching the end-of-life of standard support. For more information, see <a href="http://aws.amazon.com/amazon-linux-ami/">Amazon Linux AMI</a>.</p>
|
|
263
257
|
* </dd>
|
|
264
258
|
* </dl>
|
|
265
259
|
*/
|
|
@@ -484,10 +478,10 @@ export interface ComputeResource {
|
|
|
484
478
|
/**
|
|
485
479
|
* <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,
|
|
486
480
|
* these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value−for
|
|
487
|
-
* example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is helpful for recognizing your Batch
|
|
488
|
-
* Amazon EC2 console. These tags can't be updated or removed after the compute environment is created.
|
|
489
|
-
* tags require that you create a new compute environment and remove the old compute environment. These
|
|
490
|
-
* when using the Batch <code>ListTagsForResource</code> API operation.</p>
|
|
481
|
+
* example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is helpful for recognizing your Batch
|
|
482
|
+
* instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any
|
|
483
|
+
* changes to these tags require that you create a new compute environment and remove the old compute environment. These
|
|
484
|
+
* tags aren't seen when using the Batch <code>ListTagsForResource</code> API operation.</p>
|
|
491
485
|
* <note>
|
|
492
486
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be
|
|
493
487
|
* specified.</p>
|
|
@@ -550,7 +544,8 @@ export interface ComputeResource {
|
|
|
550
544
|
launchTemplate?: LaunchTemplateSpecification;
|
|
551
545
|
/**
|
|
552
546
|
* <p>Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.
|
|
553
|
-
* If <code>Ec2Configuration</code> isn't specified, the default is <code>
|
|
547
|
+
* If <code>Ec2Configuration</code> isn't specified, the default is <code>ECS_AL2</code>.</p>
|
|
548
|
+
* <p>One or two values can be provided.</p>
|
|
554
549
|
* <note>
|
|
555
550
|
* <p>This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be
|
|
556
551
|
* specified.</p>
|
|
@@ -577,8 +572,8 @@ export declare enum CEType {
|
|
|
577
572
|
*/
|
|
578
573
|
export interface CreateComputeEnvironmentRequest {
|
|
579
574
|
/**
|
|
580
|
-
* <p>The name for your compute environment.
|
|
581
|
-
* underscores
|
|
575
|
+
* <p>The name for your compute environment. It can be up to 128 letters long. It can contain uppercase and
|
|
576
|
+
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
582
577
|
*/
|
|
583
578
|
computeEnvironmentName: string | undefined;
|
|
584
579
|
/**
|
|
@@ -599,6 +594,15 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
599
594
|
* <code>minvCpus</code> value after instances become idle.</p>
|
|
600
595
|
*/
|
|
601
596
|
state?: CEState | string;
|
|
597
|
+
/**
|
|
598
|
+
* <p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share
|
|
599
|
+
* scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job
|
|
600
|
+
* queue, no vCPU capacity is reserved.</p>
|
|
601
|
+
* <note>
|
|
602
|
+
* <p>This parameter is only supported when the <code>type</code> parameter is set to <code>UNMANAGED</code>/</p>
|
|
603
|
+
* </note>
|
|
604
|
+
*/
|
|
605
|
+
unmanagedvCpus?: number;
|
|
602
606
|
/**
|
|
603
607
|
* <p>Details about the compute resources managed by the compute environment. This parameter is required for managed
|
|
604
608
|
* compute environments. For 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>
|
|
@@ -629,7 +633,7 @@ export interface CreateComputeEnvironmentRequest {
|
|
|
629
633
|
/**
|
|
630
634
|
* <p>The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag
|
|
631
635
|
* 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 Resources</a> in <i>Amazon Web Services General
|
|
632
|
-
*
|
|
636
|
+
* Reference</i>.</p>
|
|
633
637
|
* <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
|
|
634
638
|
* propagate to the underlying compute resources.</p>
|
|
635
639
|
*/
|
|
@@ -645,8 +649,8 @@ export declare namespace CreateComputeEnvironmentRequest {
|
|
|
645
649
|
}
|
|
646
650
|
export interface CreateComputeEnvironmentResponse {
|
|
647
651
|
/**
|
|
648
|
-
* <p>The name of the compute environment.
|
|
649
|
-
* underscores
|
|
652
|
+
* <p>The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and
|
|
653
|
+
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
650
654
|
*/
|
|
651
655
|
computeEnvironmentName?: string;
|
|
652
656
|
/**
|
|
@@ -699,8 +703,8 @@ export declare enum JQState {
|
|
|
699
703
|
*/
|
|
700
704
|
export interface CreateJobQueueRequest {
|
|
701
705
|
/**
|
|
702
|
-
* <p>The name of the job queue.
|
|
703
|
-
*
|
|
706
|
+
* <p>The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters,
|
|
707
|
+
* numbers, hyphens (-), and underscores (_).</p>
|
|
704
708
|
*/
|
|
705
709
|
jobQueueName: string | undefined;
|
|
706
710
|
/**
|
|
@@ -709,6 +713,17 @@ export interface CreateJobQueueRequest {
|
|
|
709
713
|
* finish.</p>
|
|
710
714
|
*/
|
|
711
715
|
state?: JQState | string;
|
|
716
|
+
/**
|
|
717
|
+
* <p>The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair
|
|
718
|
+
* share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO)
|
|
719
|
+
* scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy.
|
|
720
|
+
* The format is
|
|
721
|
+
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
722
|
+
* </code>.
|
|
723
|
+
* An example is
|
|
724
|
+
* <code>aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
725
|
+
*/
|
|
726
|
+
schedulingPolicyArn?: string;
|
|
712
727
|
/**
|
|
713
728
|
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
|
|
714
729
|
* <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is
|
|
@@ -761,6 +776,120 @@ export declare namespace CreateJobQueueResponse {
|
|
|
761
776
|
*/
|
|
762
777
|
const filterSensitiveLog: (obj: CreateJobQueueResponse) => any;
|
|
763
778
|
}
|
|
779
|
+
/**
|
|
780
|
+
* <p>Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that
|
|
781
|
+
* aren't included have a default weight of <code>1.0</code>.</p>
|
|
782
|
+
*/
|
|
783
|
+
export interface ShareAttributes {
|
|
784
|
+
/**
|
|
785
|
+
* <p>A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry
|
|
786
|
+
* specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share
|
|
787
|
+
* identifiers in a fair share policy cannot overlap. For example, you can't have one that specifies a
|
|
788
|
+
* <code>shareIdentifier</code> of <code>UserA*</code> and another that specifies a <code>shareIdentifier</code> of
|
|
789
|
+
* <code>UserA-1</code>.</p>
|
|
790
|
+
* <p>There can be no more than 500 fair share identifiers active in a job queue.</p>
|
|
791
|
+
* <p>The string is limited to 255 alphanumeric characters, optionally followed by an asterisk (*).</p>
|
|
792
|
+
*/
|
|
793
|
+
shareIdentifier: string | undefined;
|
|
794
|
+
/**
|
|
795
|
+
* <p>The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority
|
|
796
|
+
* for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times
|
|
797
|
+
* the compute resources of jobs that use a share identifier with a weight factor of 1.</p>
|
|
798
|
+
* <p>The smallest supported value is 0.0001, and the largest supported value is 999.9999.</p>
|
|
799
|
+
*/
|
|
800
|
+
weightFactor?: number;
|
|
801
|
+
}
|
|
802
|
+
export declare namespace ShareAttributes {
|
|
803
|
+
/**
|
|
804
|
+
* @internal
|
|
805
|
+
*/
|
|
806
|
+
const filterSensitiveLog: (obj: ShareAttributes) => any;
|
|
807
|
+
}
|
|
808
|
+
/**
|
|
809
|
+
* <p>The fair share policy for a scheduling policy.</p>
|
|
810
|
+
*/
|
|
811
|
+
export interface FairsharePolicy {
|
|
812
|
+
/**
|
|
813
|
+
* <p>The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A
|
|
814
|
+
* value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs
|
|
815
|
+
* to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).</p>
|
|
816
|
+
*/
|
|
817
|
+
shareDecaySeconds?: number;
|
|
818
|
+
/**
|
|
819
|
+
* <p>A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been
|
|
820
|
+
* used.</p>
|
|
821
|
+
* <p>The reserved ratio is
|
|
822
|
+
* <code>(<i>computeReservation</i>/100)^<i>ActiveFairShares</i>
|
|
823
|
+
* </code> where
|
|
824
|
+
* <code>
|
|
825
|
+
* <i>ActiveFairShares</i>
|
|
826
|
+
* </code> is the number of active fair share identifiers.</p>
|
|
827
|
+
* <p>For example, a <code>computeReservation</code> value of 50 indicates that Batch should reserve 50% of the
|
|
828
|
+
* maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and
|
|
829
|
+
* 12.5% if there are three fair share identifiers. A <code>computeReservation</code> value of 25 indicates that Batch
|
|
830
|
+
* should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two
|
|
831
|
+
* fair share identifiers, and 1.56% if there are three fair share identifiers.</p>
|
|
832
|
+
* <p>The minimum value is 0 and the maximum value is 99.</p>
|
|
833
|
+
*/
|
|
834
|
+
computeReservation?: number;
|
|
835
|
+
/**
|
|
836
|
+
* <p>An array of <code>SharedIdentifier</code> objects that contain the weights for the fair share identifiers for
|
|
837
|
+
* the fair share policy. Fair share identifiers that aren't included have a default weight of <code>1.0</code>.</p>
|
|
838
|
+
*/
|
|
839
|
+
shareDistribution?: ShareAttributes[];
|
|
840
|
+
}
|
|
841
|
+
export declare namespace FairsharePolicy {
|
|
842
|
+
/**
|
|
843
|
+
* @internal
|
|
844
|
+
*/
|
|
845
|
+
const filterSensitiveLog: (obj: FairsharePolicy) => any;
|
|
846
|
+
}
|
|
847
|
+
export interface CreateSchedulingPolicyRequest {
|
|
848
|
+
/**
|
|
849
|
+
* <p>The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase
|
|
850
|
+
* letters, numbers, hyphens (-), and underscores (_).</p>
|
|
851
|
+
*/
|
|
852
|
+
name: string | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* <p>The fair share policy of the scheduling policy.</p>
|
|
855
|
+
*/
|
|
856
|
+
fairsharePolicy?: FairsharePolicy;
|
|
857
|
+
/**
|
|
858
|
+
* <p>The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag
|
|
859
|
+
* 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 Resources</a> in <i>Amazon Web Services General
|
|
860
|
+
* Reference</i>.</p>
|
|
861
|
+
* <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>
|
|
862
|
+
*/
|
|
863
|
+
tags?: {
|
|
864
|
+
[key: string]: string;
|
|
865
|
+
};
|
|
866
|
+
}
|
|
867
|
+
export declare namespace CreateSchedulingPolicyRequest {
|
|
868
|
+
/**
|
|
869
|
+
* @internal
|
|
870
|
+
*/
|
|
871
|
+
const filterSensitiveLog: (obj: CreateSchedulingPolicyRequest) => any;
|
|
872
|
+
}
|
|
873
|
+
export interface CreateSchedulingPolicyResponse {
|
|
874
|
+
/**
|
|
875
|
+
* <p>The name of the scheduling policy.</p>
|
|
876
|
+
*/
|
|
877
|
+
name: string | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* <p>The Amazon Resource Name (ARN) of the scheduling policy. The format is
|
|
880
|
+
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
881
|
+
* </code>.
|
|
882
|
+
* For example,
|
|
883
|
+
* <code>aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
884
|
+
*/
|
|
885
|
+
arn: string | undefined;
|
|
886
|
+
}
|
|
887
|
+
export declare namespace CreateSchedulingPolicyResponse {
|
|
888
|
+
/**
|
|
889
|
+
* @internal
|
|
890
|
+
*/
|
|
891
|
+
const filterSensitiveLog: (obj: CreateSchedulingPolicyResponse) => any;
|
|
892
|
+
}
|
|
764
893
|
/**
|
|
765
894
|
* <p>Contains the parameters for <code>DeleteComputeEnvironment</code>.</p>
|
|
766
895
|
*/
|
|
@@ -807,6 +936,26 @@ export declare namespace DeleteJobQueueResponse {
|
|
|
807
936
|
*/
|
|
808
937
|
const filterSensitiveLog: (obj: DeleteJobQueueResponse) => any;
|
|
809
938
|
}
|
|
939
|
+
export interface DeleteSchedulingPolicyRequest {
|
|
940
|
+
/**
|
|
941
|
+
* <p>The Amazon Resource Name (ARN) of the scheduling policy to delete.</p>
|
|
942
|
+
*/
|
|
943
|
+
arn: string | undefined;
|
|
944
|
+
}
|
|
945
|
+
export declare namespace DeleteSchedulingPolicyRequest {
|
|
946
|
+
/**
|
|
947
|
+
* @internal
|
|
948
|
+
*/
|
|
949
|
+
const filterSensitiveLog: (obj: DeleteSchedulingPolicyRequest) => any;
|
|
950
|
+
}
|
|
951
|
+
export interface DeleteSchedulingPolicyResponse {
|
|
952
|
+
}
|
|
953
|
+
export declare namespace DeleteSchedulingPolicyResponse {
|
|
954
|
+
/**
|
|
955
|
+
* @internal
|
|
956
|
+
*/
|
|
957
|
+
const filterSensitiveLog: (obj: DeleteSchedulingPolicyResponse) => any;
|
|
958
|
+
}
|
|
810
959
|
export interface DeregisterJobDefinitionRequest {
|
|
811
960
|
/**
|
|
812
961
|
* <p>The name and revision (<code>name:revision</code>) or full Amazon Resource Name (ARN) of the job definition to deregister.</p>
|
|
@@ -876,14 +1025,18 @@ export declare enum CEStatus {
|
|
|
876
1025
|
*/
|
|
877
1026
|
export interface ComputeEnvironmentDetail {
|
|
878
1027
|
/**
|
|
879
|
-
* <p>The name of the compute environment.
|
|
880
|
-
* underscores
|
|
1028
|
+
* <p>The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and
|
|
1029
|
+
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
881
1030
|
*/
|
|
882
1031
|
computeEnvironmentName: string | undefined;
|
|
883
1032
|
/**
|
|
884
1033
|
* <p>The Amazon Resource Name (ARN) of the compute environment.</p>
|
|
885
1034
|
*/
|
|
886
1035
|
computeEnvironmentArn: string | undefined;
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>The maximum number of VCPUs expected to be used for an unmanaged compute environment.</p>
|
|
1038
|
+
*/
|
|
1039
|
+
unmanagedvCpus?: number;
|
|
887
1040
|
/**
|
|
888
1041
|
* <p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.</p>
|
|
889
1042
|
*/
|
|
@@ -945,8 +1098,8 @@ export interface DescribeComputeEnvironmentsResponse {
|
|
|
945
1098
|
computeEnvironments?: ComputeEnvironmentDetail[];
|
|
946
1099
|
/**
|
|
947
1100
|
* <p>The <code>nextToken</code> value to include in a future <code>DescribeComputeEnvironments</code> request. When
|
|
948
|
-
* the results of a <code>
|
|
949
|
-
* to retrieve the next page of results. This value is <code>null</code> when there are no more results to
|
|
1101
|
+
* the results of a <code>DescribeComputeEnvironments</code> request exceed <code>maxResults</code>, this value can be
|
|
1102
|
+
* used to retrieve the next page of results. This value is <code>null</code> when there are no more results to
|
|
950
1103
|
* return.</p>
|
|
951
1104
|
*/
|
|
952
1105
|
nextToken?: string;
|
|
@@ -962,8 +1115,7 @@ export declare namespace DescribeComputeEnvironmentsResponse {
|
|
|
962
1115
|
*/
|
|
963
1116
|
export interface DescribeJobDefinitionsRequest {
|
|
964
1117
|
/**
|
|
965
|
-
* <p>A list of up to 100 job definitions. Each
|
|
966
|
-
* entry in the list can either be an ARN of the form
|
|
1118
|
+
* <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format
|
|
967
1119
|
* <code>arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}</code> or a short version
|
|
968
1120
|
* using the form <code>${JobDefinitionName}:${Revision}</code>.</p>
|
|
969
1121
|
*/
|
|
@@ -1481,8 +1633,8 @@ export interface ResourceRequirement {
|
|
|
1481
1633
|
* resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be
|
|
1482
1634
|
* specified for each node at least once.</p>
|
|
1483
1635
|
* <p>For jobs that are running on Fargate resources, then <code>value</code> must match one of the supported
|
|
1484
|
-
* values and the <code>MEMORY</code> values must be one of the values supported for that VCPU value.
|
|
1485
|
-
* values are 0.25, 0.5, 1, 2, and 4</p>
|
|
1636
|
+
* values and the <code>MEMORY</code> values must be one of the values supported for that <code>VCPU</code> value.
|
|
1637
|
+
* The supported values are 0.25, 0.5, 1, 2, and 4</p>
|
|
1486
1638
|
* <dl>
|
|
1487
1639
|
* <dt>value = 0.25</dt>
|
|
1488
1640
|
* <dd>
|
|
@@ -1571,9 +1723,9 @@ export interface EFSAuthorizationConfig {
|
|
|
1571
1723
|
accessPointId?: string;
|
|
1572
1724
|
/**
|
|
1573
1725
|
* <p>Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.
|
|
1574
|
-
* If enabled, transit encryption must be enabled in the <code>EFSVolumeConfiguration</code>. If this
|
|
1575
|
-
*
|
|
1576
|
-
*
|
|
1726
|
+
* If enabled, transit encryption must be enabled in the <code>EFSVolumeConfiguration</code>. If this parameter is
|
|
1727
|
+
* omitted, the default value of <code>DISABLED</code> is used. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints">Using Amazon EFS Access Points</a> in the
|
|
1728
|
+
* <i>Batch User Guide</i>. EFS IAM authorization requires that <code>TransitEncryption</code> be
|
|
1577
1729
|
* <code>ENABLED</code> and that a <code>JobRoleArn</code> is specified.</p>
|
|
1578
1730
|
*/
|
|
1579
1731
|
iam?: EFSAuthorizationConfigIAM | string;
|
|
@@ -1671,8 +1823,8 @@ export interface Volume {
|
|
|
1671
1823
|
*/
|
|
1672
1824
|
host?: Host;
|
|
1673
1825
|
/**
|
|
1674
|
-
* <p>The name of the volume.
|
|
1675
|
-
*
|
|
1826
|
+
* <p>The name of the volume. It can be up to 255 letters long. It can contain uppercase and lowercase letters,
|
|
1827
|
+
* numbers, hyphens (-), and underscores (_). This name is referenced in the <code>sourceVolume</code>
|
|
1676
1828
|
* parameter of container definition <code>mountPoints</code>.</p>
|
|
1677
1829
|
*/
|
|
1678
1830
|
name?: string;
|
|
@@ -1730,37 +1882,23 @@ export interface ContainerProperties {
|
|
|
1730
1882
|
/**
|
|
1731
1883
|
* @deprecated
|
|
1732
1884
|
*
|
|
1733
|
-
* <p>
|
|
1734
|
-
*
|
|
1735
|
-
*
|
|
1736
|
-
*
|
|
1737
|
-
*
|
|
1738
|
-
*
|
|
1739
|
-
*
|
|
1740
|
-
* <note>
|
|
1741
|
-
* <p>This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided. For
|
|
1742
|
-
* jobs that run on Fargate resources, you must specify the vCPU requirement for the job using
|
|
1743
|
-
* <code>resourceRequirements</code>.</p>
|
|
1744
|
-
* </note>
|
|
1885
|
+
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the vCPU requirements for the job
|
|
1886
|
+
* definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies
|
|
1887
|
+
* the number of vCPUs reserved for the job.</p>
|
|
1888
|
+
* <p>Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to <code>CpuShares</code> in the
|
|
1889
|
+
* <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>--cpu-shares</code> option to
|
|
1890
|
+
* <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. The number of vCPUs must be specified but can be specified
|
|
1891
|
+
* in several places. You must specify it at least once for each node.</p>
|
|
1745
1892
|
*/
|
|
1746
1893
|
vcpus?: number;
|
|
1747
1894
|
/**
|
|
1748
1895
|
* @deprecated
|
|
1749
1896
|
*
|
|
1750
|
-
* <p>This parameter
|
|
1751
|
-
*
|
|
1752
|
-
* memory hard limit
|
|
1753
|
-
*
|
|
1754
|
-
*
|
|
1755
|
-
* run</a>.</p>
|
|
1756
|
-
* <p>This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate
|
|
1757
|
-
* resources, you should specify the memory requirement using <code>resourceRequirement</code>. You can also do this for
|
|
1758
|
-
* EC2 resources.</p>
|
|
1759
|
-
* <note>
|
|
1760
|
-
* <p>If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a
|
|
1761
|
-
* particular instance type, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html">Memory
|
|
1762
|
-
* Management</a> in the <i>Batch User Guide</i>.</p>
|
|
1763
|
-
* </note>
|
|
1897
|
+
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to specify the memory requirements for the
|
|
1898
|
+
* job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it
|
|
1899
|
+
* specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number,
|
|
1900
|
+
* it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can
|
|
1901
|
+
* be specified in several places. It must be specified for each node at least once.</p>
|
|
1764
1902
|
*/
|
|
1765
1903
|
memory?: number;
|
|
1766
1904
|
/**
|
|
@@ -1962,8 +2100,10 @@ export interface EvaluateOnExit {
|
|
|
1962
2100
|
/**
|
|
1963
2101
|
* <p>Contains a glob pattern to match against the <code>StatusReason</code> returned for a job. The pattern can be up
|
|
1964
2102
|
* to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including
|
|
1965
|
-
* spaces or tabs).
|
|
1966
|
-
*
|
|
2103
|
+
* spaces or tabs).
|
|
2104
|
+
* It can optionally end with an
|
|
2105
|
+
* asterisk (*) so that only the start of the string needs to be an exact match.</p>
|
|
2106
|
+
* <p>The string can be between 1 and 512 characters in length.</p>
|
|
1967
2107
|
*/
|
|
1968
2108
|
onStatusReason?: string;
|
|
1969
2109
|
/**
|
|
@@ -1971,12 +2111,14 @@ export interface EvaluateOnExit {
|
|
|
1971
2111
|
* 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces
|
|
1972
2112
|
* and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact
|
|
1973
2113
|
* match.</p>
|
|
2114
|
+
* <p>The string can be between 1 and 512 characters in length.</p>
|
|
1974
2115
|
*/
|
|
1975
2116
|
onReason?: string;
|
|
1976
2117
|
/**
|
|
1977
2118
|
* <p>Contains a glob pattern to match against the decimal representation of the <code>ExitCode</code> returned for a
|
|
1978
2119
|
* job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an
|
|
1979
2120
|
* asterisk (*) so that only the start of the string needs to be an exact match.</p>
|
|
2121
|
+
* <p>The string can be between 1 and 512 characters in length.</p>
|
|
1980
2122
|
*/
|
|
1981
2123
|
onExitCode?: string;
|
|
1982
2124
|
/**
|
|
@@ -2050,11 +2192,17 @@ export interface JobDefinition {
|
|
|
2050
2192
|
*/
|
|
2051
2193
|
status?: string;
|
|
2052
2194
|
/**
|
|
2053
|
-
* <p>The type of job definition
|
|
2054
|
-
* supported. For more information about multi-node parallel
|
|
2055
|
-
*
|
|
2195
|
+
* <p>The type of job definition, either <code>container</code> or <code>multinode</code>. If the job is run on
|
|
2196
|
+
* Fargate resources, then <code>multinode</code> isn't supported. For more information about multi-node parallel
|
|
2197
|
+
* jobs, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html">Creating a multi-node parallel job
|
|
2198
|
+
* definition</a> in the <i>Batch User Guide</i>.</p>
|
|
2056
2199
|
*/
|
|
2057
2200
|
type: string | undefined;
|
|
2201
|
+
/**
|
|
2202
|
+
* <p>The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy.
|
|
2203
|
+
* Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.</p>
|
|
2204
|
+
*/
|
|
2205
|
+
schedulingPriority?: number;
|
|
2058
2206
|
/**
|
|
2059
2207
|
* <p>Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are
|
|
2060
2208
|
* specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding
|
|
@@ -2189,6 +2337,14 @@ export interface JobQueueDetail {
|
|
|
2189
2337
|
* already in the queue can finish.</p>
|
|
2190
2338
|
*/
|
|
2191
2339
|
state: JQState | string | undefined;
|
|
2340
|
+
/**
|
|
2341
|
+
* <p>The Amazon Resource Name (ARN) of the scheduling policy. The format is
|
|
2342
|
+
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
2343
|
+
* </code>.
|
|
2344
|
+
* For example,
|
|
2345
|
+
* <code>aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
2346
|
+
*/
|
|
2347
|
+
schedulingPolicyArn?: string;
|
|
2192
2348
|
/**
|
|
2193
2349
|
* <p>The status of the job queue (for example, <code>CREATING</code> or <code>VALID</code>).</p>
|
|
2194
2350
|
*/
|
|
@@ -2269,7 +2425,7 @@ export interface ContainerDetail {
|
|
|
2269
2425
|
/**
|
|
2270
2426
|
* <p>The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU
|
|
2271
2427
|
* requirement for the job using <code>resourceRequirements</code>, but you can't specify the vCPU requirements in both
|
|
2272
|
-
* the <code>vcpus</code> and <code>
|
|
2428
|
+
* the <code>vcpus</code> and <code>resourceRequirements</code> object. This parameter maps to <code>CpuShares</code> in
|
|
2273
2429
|
* 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 <code>--cpu-shares</code> option to
|
|
2274
2430
|
* <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must
|
|
2275
2431
|
* specify at least one vCPU. This is required but can be specified in several places. It must be specified for each
|
|
@@ -2281,7 +2437,7 @@ export interface ContainerDetail {
|
|
|
2281
2437
|
*/
|
|
2282
2438
|
vcpus?: number;
|
|
2283
2439
|
/**
|
|
2284
|
-
* <p>For jobs run on EC2 resources that didn't specify memory requirements using <code>
|
|
2440
|
+
* <p>For jobs run on EC2 resources that didn't specify memory requirements using <code>resourceRequirements</code>,
|
|
2285
2441
|
* the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see
|
|
2286
2442
|
* <code>resourceRequirements</code>.</p>
|
|
2287
2443
|
*/
|
|
@@ -2295,7 +2451,9 @@ export interface ContainerDetail {
|
|
|
2295
2451
|
*/
|
|
2296
2452
|
jobRoleArn?: string;
|
|
2297
2453
|
/**
|
|
2298
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
2454
|
+
* <p>The Amazon Resource Name (ARN) of the
|
|
2455
|
+
* execution
|
|
2456
|
+
* role that Batch can assume. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html">Batch execution IAM role</a> in the
|
|
2299
2457
|
* <i>Batch User Guide</i>.</p>
|
|
2300
2458
|
*/
|
|
2301
2459
|
executionRoleArn?: string;
|
|
@@ -2513,6 +2671,15 @@ export interface JobDetail {
|
|
|
2513
2671
|
* </note>
|
|
2514
2672
|
*/
|
|
2515
2673
|
status: JobStatus | string | undefined;
|
|
2674
|
+
/**
|
|
2675
|
+
* <p>The share identifier for the job.</p>
|
|
2676
|
+
*/
|
|
2677
|
+
shareIdentifier?: string;
|
|
2678
|
+
/**
|
|
2679
|
+
* <p>The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs
|
|
2680
|
+
* with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.</p>
|
|
2681
|
+
*/
|
|
2682
|
+
schedulingPriority?: number;
|
|
2516
2683
|
/**
|
|
2517
2684
|
* <p>A list of job attempts associated with this job.</p>
|
|
2518
2685
|
*/
|
|
@@ -2618,6 +2785,63 @@ export declare namespace DescribeJobsResponse {
|
|
|
2618
2785
|
*/
|
|
2619
2786
|
const filterSensitiveLog: (obj: DescribeJobsResponse) => any;
|
|
2620
2787
|
}
|
|
2788
|
+
export interface DescribeSchedulingPoliciesRequest {
|
|
2789
|
+
/**
|
|
2790
|
+
* <p>A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.</p>
|
|
2791
|
+
*/
|
|
2792
|
+
arns: string[] | undefined;
|
|
2793
|
+
}
|
|
2794
|
+
export declare namespace DescribeSchedulingPoliciesRequest {
|
|
2795
|
+
/**
|
|
2796
|
+
* @internal
|
|
2797
|
+
*/
|
|
2798
|
+
const filterSensitiveLog: (obj: DescribeSchedulingPoliciesRequest) => any;
|
|
2799
|
+
}
|
|
2800
|
+
/**
|
|
2801
|
+
* <p>An object that represents a scheduling policy.</p>
|
|
2802
|
+
*/
|
|
2803
|
+
export interface SchedulingPolicyDetail {
|
|
2804
|
+
/**
|
|
2805
|
+
* <p>The name of the scheduling policy.</p>
|
|
2806
|
+
*/
|
|
2807
|
+
name: string | undefined;
|
|
2808
|
+
/**
|
|
2809
|
+
* <p>The Amazon Resource Name (ARN) of the scheduling policy. An example is
|
|
2810
|
+
* <code>arn:<i>aws</i>:batch:<i>us-east-1</i>:<i>123456789012</i>:scheduling-policy/<i>HighPriority</i>
|
|
2811
|
+
* </code>.</p>
|
|
2812
|
+
*/
|
|
2813
|
+
arn: string | undefined;
|
|
2814
|
+
/**
|
|
2815
|
+
* <p>The fair share policy for the scheduling policy.</p>
|
|
2816
|
+
*/
|
|
2817
|
+
fairsharePolicy?: FairsharePolicy;
|
|
2818
|
+
/**
|
|
2819
|
+
* <p>The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of
|
|
2820
|
+
* 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 Resources</a> in <i>Amazon Web Services General
|
|
2821
|
+
* Reference</i>.</p>
|
|
2822
|
+
*/
|
|
2823
|
+
tags?: {
|
|
2824
|
+
[key: string]: string;
|
|
2825
|
+
};
|
|
2826
|
+
}
|
|
2827
|
+
export declare namespace SchedulingPolicyDetail {
|
|
2828
|
+
/**
|
|
2829
|
+
* @internal
|
|
2830
|
+
*/
|
|
2831
|
+
const filterSensitiveLog: (obj: SchedulingPolicyDetail) => any;
|
|
2832
|
+
}
|
|
2833
|
+
export interface DescribeSchedulingPoliciesResponse {
|
|
2834
|
+
/**
|
|
2835
|
+
* <p>The list of scheduling policies.</p>
|
|
2836
|
+
*/
|
|
2837
|
+
schedulingPolicies?: SchedulingPolicyDetail[];
|
|
2838
|
+
}
|
|
2839
|
+
export declare namespace DescribeSchedulingPoliciesResponse {
|
|
2840
|
+
/**
|
|
2841
|
+
* @internal
|
|
2842
|
+
*/
|
|
2843
|
+
const filterSensitiveLog: (obj: DescribeSchedulingPoliciesResponse) => any;
|
|
2844
|
+
}
|
|
2621
2845
|
/**
|
|
2622
2846
|
* <p>A filter name and value pair that's used to return a more specific list of results from a <code>ListJobs</code>
|
|
2623
2847
|
* API operation.</p>
|
|
@@ -2711,14 +2935,14 @@ export interface ListJobsRequest {
|
|
|
2711
2935
|
* <dt>BEFORE_CREATED_AT</dt>
|
|
2712
2936
|
* <dd>
|
|
2713
2937
|
* <p>The value for the filter is the time that's before the job was created. This corresponds to the
|
|
2714
|
-
* <code>createdAt</code> value. The value is a string representation of the number of
|
|
2715
|
-
* (midnight) on January 1, 1970.</p>
|
|
2938
|
+
* <code>createdAt</code> value. The value is a string representation of the number of milliseconds since 00:00:00
|
|
2939
|
+
* UTC (midnight) on January 1, 1970.</p>
|
|
2716
2940
|
* </dd>
|
|
2717
2941
|
* <dt>AFTER_CREATED_AT</dt>
|
|
2718
2942
|
* <dd>
|
|
2719
2943
|
* <p>The value for the filter is the time that's after the job was created. This corresponds to the
|
|
2720
|
-
* <code>createdAt</code> value. The value is a string representation of the number of
|
|
2721
|
-
* (midnight) on January 1, 1970.</p>
|
|
2944
|
+
* <code>createdAt</code> value. The value is a string representation of the number of milliseconds since 00:00:00
|
|
2945
|
+
* UTC (midnight) on January 1, 1970.</p>
|
|
2722
2946
|
* </dd>
|
|
2723
2947
|
* </dl>
|
|
2724
2948
|
*/
|
|
@@ -2791,9 +3015,10 @@ export interface JobSummary {
|
|
|
2791
3015
|
*/
|
|
2792
3016
|
jobName: string | undefined;
|
|
2793
3017
|
/**
|
|
2794
|
-
* <p>The Unix timestamp for when the job was created. For non-array jobs and parent array jobs,
|
|
2795
|
-
* entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called).
|
|
2796
|
-
* this is when the child job was spawned by its parent and entered the <code>PENDING</code>
|
|
3018
|
+
* <p>The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs,
|
|
3019
|
+
* this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called).
|
|
3020
|
+
* For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code>
|
|
3021
|
+
* state.</p>
|
|
2797
3022
|
*/
|
|
2798
3023
|
createdAt?: number;
|
|
2799
3024
|
/**
|
|
@@ -2858,10 +3083,74 @@ export declare namespace ListJobsResponse {
|
|
|
2858
3083
|
*/
|
|
2859
3084
|
const filterSensitiveLog: (obj: ListJobsResponse) => any;
|
|
2860
3085
|
}
|
|
3086
|
+
export interface ListSchedulingPoliciesRequest {
|
|
3087
|
+
/**
|
|
3088
|
+
* <p>The maximum number of results that's returned by <code>ListSchedulingPolicies</code> in paginated output. When
|
|
3089
|
+
* this parameter is used, <code>ListSchedulingPolicies</code> only returns <code>maxResults</code> results in a single
|
|
3090
|
+
* page and a <code>nextToken</code> response element. You can see the remaining results of the initial request by
|
|
3091
|
+
* sending another <code>ListSchedulingPolicies</code> request with the returned <code>nextToken</code> value. This
|
|
3092
|
+
* value can be between 1 and 100. If this parameter isn't used,
|
|
3093
|
+
* <code>ListSchedulingPolicies</code> returns up to 100 results and a <code>nextToken</code> value
|
|
3094
|
+
* if applicable.</p>
|
|
3095
|
+
*/
|
|
3096
|
+
maxResults?: number;
|
|
3097
|
+
/**
|
|
3098
|
+
* <p>The <code>nextToken</code> value that's returned from a previous paginated <code>ListSchedulingPolicies</code>
|
|
3099
|
+
* request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination
|
|
3100
|
+
* continues from the end of the previous results that returned the <code>nextToken</code> value. This value is
|
|
3101
|
+
* <code>null</code> when there are no more results to
|
|
3102
|
+
* return.</p>
|
|
3103
|
+
* <note>
|
|
3104
|
+
* <p>This token should be treated as an opaque identifier that's only used to
|
|
3105
|
+
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
3106
|
+
* </note>
|
|
3107
|
+
*/
|
|
3108
|
+
nextToken?: string;
|
|
3109
|
+
}
|
|
3110
|
+
export declare namespace ListSchedulingPoliciesRequest {
|
|
3111
|
+
/**
|
|
3112
|
+
* @internal
|
|
3113
|
+
*/
|
|
3114
|
+
const filterSensitiveLog: (obj: ListSchedulingPoliciesRequest) => any;
|
|
3115
|
+
}
|
|
3116
|
+
/**
|
|
3117
|
+
* <p>An object that contains the details of a scheduling policy that's returned in a
|
|
3118
|
+
* <code>ListSchedulingPolicy</code> action.</p>
|
|
3119
|
+
*/
|
|
3120
|
+
export interface SchedulingPolicyListingDetail {
|
|
3121
|
+
/**
|
|
3122
|
+
* <p>Amazon Resource Name (ARN) of the scheduling policy.</p>
|
|
3123
|
+
*/
|
|
3124
|
+
arn: string | undefined;
|
|
3125
|
+
}
|
|
3126
|
+
export declare namespace SchedulingPolicyListingDetail {
|
|
3127
|
+
/**
|
|
3128
|
+
* @internal
|
|
3129
|
+
*/
|
|
3130
|
+
const filterSensitiveLog: (obj: SchedulingPolicyListingDetail) => any;
|
|
3131
|
+
}
|
|
3132
|
+
export interface ListSchedulingPoliciesResponse {
|
|
3133
|
+
/**
|
|
3134
|
+
* <p>A list of scheduling policies that match the request.</p>
|
|
3135
|
+
*/
|
|
3136
|
+
schedulingPolicies?: SchedulingPolicyListingDetail[];
|
|
3137
|
+
/**
|
|
3138
|
+
* <p>The <code>nextToken</code> value to include in a future <code>ListSchedulingPolicies</code> request. When the
|
|
3139
|
+
* results of a <code>ListSchedulingPolicies</code> request exceed <code>maxResults</code>, this value can be used to
|
|
3140
|
+
* retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
|
|
3141
|
+
*/
|
|
3142
|
+
nextToken?: string;
|
|
3143
|
+
}
|
|
3144
|
+
export declare namespace ListSchedulingPoliciesResponse {
|
|
3145
|
+
/**
|
|
3146
|
+
* @internal
|
|
3147
|
+
*/
|
|
3148
|
+
const filterSensitiveLog: (obj: ListSchedulingPoliciesResponse) => any;
|
|
3149
|
+
}
|
|
2861
3150
|
export interface ListTagsForResourceRequest {
|
|
2862
3151
|
/**
|
|
2863
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions,
|
|
2864
|
-
*
|
|
3152
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
|
|
3153
|
+
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
|
|
2865
3154
|
*/
|
|
2866
3155
|
resourceArn: string | undefined;
|
|
2867
3156
|
}
|
|
@@ -2894,8 +3183,8 @@ export declare enum JobDefinitionType {
|
|
|
2894
3183
|
*/
|
|
2895
3184
|
export interface RegisterJobDefinitionRequest {
|
|
2896
3185
|
/**
|
|
2897
|
-
* <p>The name of the job definition to register.
|
|
2898
|
-
* underscores
|
|
3186
|
+
* <p>The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and
|
|
3187
|
+
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
2899
3188
|
*/
|
|
2900
3189
|
jobDefinitionName: string | undefined;
|
|
2901
3190
|
/**
|
|
@@ -2914,6 +3203,13 @@ export interface RegisterJobDefinitionRequest {
|
|
|
2914
3203
|
parameters?: {
|
|
2915
3204
|
[key: string]: string;
|
|
2916
3205
|
};
|
|
3206
|
+
/**
|
|
3207
|
+
* <p>The scheduling priority for jobs that are submitted with this job definition. This will only affect jobs in job
|
|
3208
|
+
* queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower
|
|
3209
|
+
* scheduling priority.</p>
|
|
3210
|
+
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
3211
|
+
*/
|
|
3212
|
+
schedulingPriority?: number;
|
|
2917
3213
|
/**
|
|
2918
3214
|
* <p>An object with various properties specific to single-node container-based jobs. If the job definition's
|
|
2919
3215
|
* <code>type</code> parameter is <code>container</code>, then you must specify either <code>containerProperties</code>
|
|
@@ -3002,33 +3298,27 @@ export interface ContainerOverrides {
|
|
|
3002
3298
|
/**
|
|
3003
3299
|
* @deprecated
|
|
3004
3300
|
*
|
|
3005
|
-
* <p>This parameter
|
|
3006
|
-
*
|
|
3007
|
-
*
|
|
3008
|
-
* in the <code>
|
|
3009
|
-
* specified in the <code>
|
|
3010
|
-
* <code>
|
|
3011
|
-
*
|
|
3012
|
-
*
|
|
3013
|
-
* Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.</p>
|
|
3014
|
-
* <note>
|
|
3015
|
-
* <p>This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on
|
|
3016
|
-
* Fargate resources. For Fargate resources, you can only use <code>resourceRequirement</code>. For EC2 resources,
|
|
3017
|
-
* you can use either this parameter or <code>resourceRequirement</code> but not both.</p>
|
|
3018
|
-
* </note>
|
|
3301
|
+
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to override the <code>vcpus</code> parameter
|
|
3302
|
+
* that's set in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2
|
|
3303
|
+
* resources, it overrides the <code>vcpus</code> parameter set in the job definition, but doesn't override any vCPU
|
|
3304
|
+
* requirement specified in the <code>resourceRequirements</code> structure in the job definition. To override vCPU
|
|
3305
|
+
* requirements that are specified in the <code>resourceRequirements</code> structure in the job definition,
|
|
3306
|
+
* <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code> request, with <code>type</code>
|
|
3307
|
+
* set to <code>VCPU</code> and <code>value</code> set to the new value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements">Can't override
|
|
3308
|
+
* job definition resource requirements</a> in the <i>Batch User Guide</i>.</p>
|
|
3019
3309
|
*/
|
|
3020
3310
|
vcpus?: number;
|
|
3021
3311
|
/**
|
|
3022
3312
|
* @deprecated
|
|
3023
3313
|
*
|
|
3024
|
-
* <p>This parameter
|
|
3025
|
-
*
|
|
3026
|
-
* the <code>
|
|
3027
|
-
* specified in the <code>
|
|
3028
|
-
*
|
|
3029
|
-
* <code>
|
|
3030
|
-
*
|
|
3031
|
-
*
|
|
3314
|
+
* <p>This parameter is deprecated, use <code>resourceRequirements</code> to override the memory requirements
|
|
3315
|
+
* specified in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2
|
|
3316
|
+
* resources, it overrides the <code>memory</code> parameter set in the job definition, but doesn't override any memory
|
|
3317
|
+
* requirement specified in the <code>resourceRequirements</code> structure in the job definition. To override memory
|
|
3318
|
+
* requirements that are specified in the <code>resourceRequirements</code> structure in the job definition,
|
|
3319
|
+
* <code>resourceRequirements</code> must be specified in the <code>SubmitJob</code> request, with <code>type</code>
|
|
3320
|
+
* set to <code>MEMORY</code> and <code>value</code> set to the new value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#override-resource-requirements">Can't override
|
|
3321
|
+
* job definition resource requirements</a> in the <i>Batch User Guide</i>.</p>
|
|
3032
3322
|
*/
|
|
3033
3323
|
memory?: number;
|
|
3034
3324
|
/**
|
|
@@ -3133,14 +3423,25 @@ export declare namespace NodeOverrides {
|
|
|
3133
3423
|
*/
|
|
3134
3424
|
export interface SubmitJobRequest {
|
|
3135
3425
|
/**
|
|
3136
|
-
* <p>The name of the job.
|
|
3137
|
-
* numbers, hyphens, and underscores
|
|
3426
|
+
* <p>The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain
|
|
3427
|
+
* uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
3138
3428
|
*/
|
|
3139
3429
|
jobName: string | undefined;
|
|
3140
3430
|
/**
|
|
3141
3431
|
* <p>The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.</p>
|
|
3142
3432
|
*/
|
|
3143
3433
|
jobQueue: string | undefined;
|
|
3434
|
+
/**
|
|
3435
|
+
* <p>The share identifier for the job.</p>
|
|
3436
|
+
*/
|
|
3437
|
+
shareIdentifier?: string;
|
|
3438
|
+
/**
|
|
3439
|
+
* <p>The scheduling priority for the job. This will only affect jobs in job queues with a fair share policy. Jobs
|
|
3440
|
+
* with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority. This will override
|
|
3441
|
+
* any scheduling priority in the job definition.</p>
|
|
3442
|
+
* <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
|
|
3443
|
+
*/
|
|
3444
|
+
schedulingPriorityOverride?: number;
|
|
3144
3445
|
/**
|
|
3145
3446
|
* <p>The array properties for the submitted job, such as the size of the array. The array size can be between 2 and
|
|
3146
3447
|
* 10,000. If you specify array properties for a job, it becomes an array job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html">Array Jobs</a> in the
|
|
@@ -3211,7 +3512,7 @@ export interface SubmitJobRequest {
|
|
|
3211
3512
|
/**
|
|
3212
3513
|
* <p>The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists
|
|
3213
3514
|
* 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 Resources</a> in <i>Amazon Web Services General
|
|
3214
|
-
*
|
|
3515
|
+
* Reference</i>.</p>
|
|
3215
3516
|
*/
|
|
3216
3517
|
tags?: {
|
|
3217
3518
|
[key: string]: string;
|
|
@@ -3245,14 +3546,14 @@ export declare namespace SubmitJobResponse {
|
|
|
3245
3546
|
}
|
|
3246
3547
|
export interface TagResourceRequest {
|
|
3247
3548
|
/**
|
|
3248
|
-
* <p>The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions,
|
|
3249
|
-
*
|
|
3549
|
+
* <p>The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
|
|
3550
|
+
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
|
|
3250
3551
|
*/
|
|
3251
3552
|
resourceArn: string | undefined;
|
|
3252
3553
|
/**
|
|
3253
3554
|
* <p>The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of
|
|
3254
3555
|
* 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 Resources</a> in <i>Amazon Web Services General
|
|
3255
|
-
*
|
|
3556
|
+
* Reference</i>.</p>
|
|
3256
3557
|
*/
|
|
3257
3558
|
tags: {
|
|
3258
3559
|
[key: string]: string;
|
|
@@ -3303,8 +3604,8 @@ export declare namespace TerminateJobResponse {
|
|
|
3303
3604
|
}
|
|
3304
3605
|
export interface UntagResourceRequest {
|
|
3305
3606
|
/**
|
|
3306
|
-
* <p>The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions,
|
|
3307
|
-
*
|
|
3607
|
+
* <p>The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
|
|
3608
|
+
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
|
|
3308
3609
|
*/
|
|
3309
3610
|
resourceArn: string | undefined;
|
|
3310
3611
|
/**
|
|
@@ -3399,6 +3700,13 @@ export interface UpdateComputeEnvironmentRequest {
|
|
|
3399
3700
|
* <code>minvCpus</code> value after instances become idle.</p>
|
|
3400
3701
|
*/
|
|
3401
3702
|
state?: CEState | string;
|
|
3703
|
+
/**
|
|
3704
|
+
* <p>The maximum number of vCPUs expected to be used for an unmanaged compute environment. This parameter should not
|
|
3705
|
+
* be specified for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU
|
|
3706
|
+
* capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity
|
|
3707
|
+
* will be reserved.</p>
|
|
3708
|
+
*/
|
|
3709
|
+
unmanagedvCpus?: number;
|
|
3402
3710
|
/**
|
|
3403
3711
|
* <p>Details of the compute resources managed by the compute environment. Required for a managed compute environment.
|
|
3404
3712
|
* For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute
|
|
@@ -3433,8 +3741,8 @@ export declare namespace UpdateComputeEnvironmentRequest {
|
|
|
3433
3741
|
}
|
|
3434
3742
|
export interface UpdateComputeEnvironmentResponse {
|
|
3435
3743
|
/**
|
|
3436
|
-
* <p>The name of the compute environment.
|
|
3437
|
-
* underscores
|
|
3744
|
+
* <p>The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and
|
|
3745
|
+
* lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
3438
3746
|
*/
|
|
3439
3747
|
computeEnvironmentName?: string;
|
|
3440
3748
|
/**
|
|
@@ -3462,6 +3770,15 @@ export interface UpdateJobQueueRequest {
|
|
|
3462
3770
|
* queue can finish.</p>
|
|
3463
3771
|
*/
|
|
3464
3772
|
state?: JQState | string;
|
|
3773
|
+
/**
|
|
3774
|
+
* <p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can
|
|
3775
|
+
* be replaced but not removed. The format is
|
|
3776
|
+
* <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i>
|
|
3777
|
+
* </code>.
|
|
3778
|
+
* For example,
|
|
3779
|
+
* <code>aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy</code>.</p>
|
|
3780
|
+
*/
|
|
3781
|
+
schedulingPolicyArn?: string;
|
|
3465
3782
|
/**
|
|
3466
3783
|
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
|
|
3467
3784
|
* <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is
|
|
@@ -3506,3 +3823,27 @@ export declare namespace UpdateJobQueueResponse {
|
|
|
3506
3823
|
*/
|
|
3507
3824
|
const filterSensitiveLog: (obj: UpdateJobQueueResponse) => any;
|
|
3508
3825
|
}
|
|
3826
|
+
export interface UpdateSchedulingPolicyRequest {
|
|
3827
|
+
/**
|
|
3828
|
+
* <p>The Amazon Resource Name (ARN) of the scheduling policy to update.</p>
|
|
3829
|
+
*/
|
|
3830
|
+
arn: string | undefined;
|
|
3831
|
+
/**
|
|
3832
|
+
* <p>The fair share policy.</p>
|
|
3833
|
+
*/
|
|
3834
|
+
fairsharePolicy?: FairsharePolicy;
|
|
3835
|
+
}
|
|
3836
|
+
export declare namespace UpdateSchedulingPolicyRequest {
|
|
3837
|
+
/**
|
|
3838
|
+
* @internal
|
|
3839
|
+
*/
|
|
3840
|
+
const filterSensitiveLog: (obj: UpdateSchedulingPolicyRequest) => any;
|
|
3841
|
+
}
|
|
3842
|
+
export interface UpdateSchedulingPolicyResponse {
|
|
3843
|
+
}
|
|
3844
|
+
export declare namespace UpdateSchedulingPolicyResponse {
|
|
3845
|
+
/**
|
|
3846
|
+
* @internal
|
|
3847
|
+
*/
|
|
3848
|
+
const filterSensitiveLog: (obj: UpdateSchedulingPolicyResponse) => any;
|
|
3849
|
+
}
|