aws-sdk 2.801.0 → 2.805.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 +25 -1
- package/README.md +1 -1
- package/apis/amplifybackend-2020-08-11.min.json +0 -8
- package/apis/batch-2016-08-10.min.json +81 -21
- package/apis/compute-optimizer-2019-11-01.min.json +110 -0
- package/apis/{profile-2020-08-15.examples.json → customer-profiles-2020-08-15.examples.json} +0 -0
- package/apis/{profile-2020-08-15.min.json → customer-profiles-2020-08-15.min.json} +3 -3
- package/apis/{profile-2020-08-15.paginators.json → customer-profiles-2020-08-15.paginators.json} +0 -0
- package/apis/dms-2016-01-01.min.json +9 -1
- package/apis/ec2-2016-11-15.min.json +4 -0
- package/apis/lambda-2015-03-31.examples.json +6 -6
- package/apis/license-manager-2018-08-01.min.json +957 -51
- package/apis/medialive-2017-10-14.min.json +240 -158
- package/apis/metadata.json +4 -3
- package/apis/rds-2014-10-31.min.json +200 -132
- package/apis/servicecatalog-appregistry-2020-06-24.min.json +80 -0
- package/apis/ssm-2014-11-06.min.json +348 -203
- package/clients/all.d.ts +1 -1
- package/clients/all.js +2 -2
- package/clients/amplifybackend.d.ts +74 -74
- package/clients/batch.d.ts +200 -133
- package/clients/computeoptimizer.d.ts +179 -22
- package/clients/{profile.d.ts → customerprofiles.d.ts} +63 -63
- package/clients/customerprofiles.js +18 -0
- package/clients/directoryservice.d.ts +24 -21
- package/clients/dms.d.ts +16 -0
- package/clients/ec2.d.ts +6 -2
- package/clients/kafka.d.ts +4 -4
- package/clients/lambda.d.ts +10 -10
- package/clients/licensemanager.d.ts +1350 -72
- package/clients/medialive.d.ts +80 -1
- package/clients/rds.d.ts +128 -43
- package/clients/servicecatalogappregistry.d.ts +61 -0
- package/clients/ssm.d.ts +197 -10
- package/clients/workspaces.d.ts +10 -10
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +31 -27
- package/dist/aws-sdk.js +565 -343
- package/dist/aws-sdk.min.js +60 -60
- package/lib/config_service_placeholders.d.ts +2 -2
- package/lib/core.js +1 -1
- package/lib/services/s3.js +6 -2
- package/package.json +1 -1
- package/clients/profile.js +0 -18
package/clients/batch.d.ts
CHANGED
|
@@ -12,19 +12,19 @@ declare class Batch extends Service {
|
|
|
12
12
|
constructor(options?: Batch.Types.ClientConfiguration)
|
|
13
13
|
config: Config & Batch.Types.ClientConfiguration;
|
|
14
14
|
/**
|
|
15
|
-
* Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are
|
|
15
|
+
* Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING are not canceled (but the API operation still succeeds, even if no job is canceled); these jobs must be terminated with the TerminateJob operation.
|
|
16
16
|
*/
|
|
17
17
|
cancelJob(params: Batch.Types.CancelJobRequest, callback?: (err: AWSError, data: Batch.Types.CancelJobResponse) => void): Request<Batch.Types.CancelJobResponse, AWSError>;
|
|
18
18
|
/**
|
|
19
|
-
* Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are
|
|
19
|
+
* Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING are not canceled (but the API operation still succeeds, even if no job is canceled); these jobs must be terminated with the TerminateJob operation.
|
|
20
20
|
*/
|
|
21
21
|
cancelJob(callback?: (err: AWSError, data: Batch.Types.CancelJobResponse) => void): Request<Batch.Types.CancelJobResponse, AWSError>;
|
|
22
22
|
/**
|
|
23
|
-
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose to use
|
|
23
|
+
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources. In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price. Multi-node parallel jobs are not supported on Spot Instances. In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide. AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the earlier compute environment from your job queue. Delete the earlier compute environment.
|
|
24
24
|
*/
|
|
25
25
|
createComputeEnvironment(params: Batch.Types.CreateComputeEnvironmentRequest, callback?: (err: AWSError, data: Batch.Types.CreateComputeEnvironmentResponse) => void): Request<Batch.Types.CreateComputeEnvironmentResponse, AWSError>;
|
|
26
26
|
/**
|
|
27
|
-
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose to use
|
|
27
|
+
* Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources. In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price. Multi-node parallel jobs are not supported on Spot Instances. In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide. AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps: Create a new compute environment with the new AMI. Add the compute environment to an existing job queue. Remove the earlier compute environment from your job queue. Delete the earlier compute environment.
|
|
28
28
|
*/
|
|
29
29
|
createComputeEnvironment(callback?: (err: AWSError, data: Batch.Types.CreateComputeEnvironmentResponse) => void): Request<Batch.Types.CreateComputeEnvironmentResponse, AWSError>;
|
|
30
30
|
/**
|
|
@@ -36,35 +36,35 @@ declare class Batch extends Service {
|
|
|
36
36
|
*/
|
|
37
37
|
createJobQueue(callback?: (err: AWSError, data: Batch.Types.CreateJobQueueResponse) => void): Request<Batch.Types.CreateJobQueueResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* Deletes an AWS Batch compute environment. Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.
|
|
39
|
+
* Deletes an AWS Batch compute environment. Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use AWS Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment will end up in an invalid state.
|
|
40
40
|
*/
|
|
41
41
|
deleteComputeEnvironment(params: Batch.Types.DeleteComputeEnvironmentRequest, callback?: (err: AWSError, data: Batch.Types.DeleteComputeEnvironmentResponse) => void): Request<Batch.Types.DeleteComputeEnvironmentResponse, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* Deletes an AWS Batch compute environment. Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.
|
|
43
|
+
* Deletes an AWS Batch compute environment. Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use AWS Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment will end up in an invalid state.
|
|
44
44
|
*/
|
|
45
45
|
deleteComputeEnvironment(callback?: (err: AWSError, data: Batch.Types.DeleteComputeEnvironmentResponse) => void): Request<Batch.Types.DeleteComputeEnvironmentResponse, AWSError>;
|
|
46
46
|
/**
|
|
47
|
-
* Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue. It
|
|
47
|
+
* Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue. It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.
|
|
48
48
|
*/
|
|
49
49
|
deleteJobQueue(params: Batch.Types.DeleteJobQueueRequest, callback?: (err: AWSError, data: Batch.Types.DeleteJobQueueResponse) => void): Request<Batch.Types.DeleteJobQueueResponse, AWSError>;
|
|
50
50
|
/**
|
|
51
|
-
* Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue. It
|
|
51
|
+
* Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue. It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.
|
|
52
52
|
*/
|
|
53
53
|
deleteJobQueue(callback?: (err: AWSError, data: Batch.Types.DeleteJobQueueResponse) => void): Request<Batch.Types.DeleteJobQueueResponse, AWSError>;
|
|
54
54
|
/**
|
|
55
|
-
* Deregisters an AWS Batch job definition. Job definitions
|
|
55
|
+
* Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.
|
|
56
56
|
*/
|
|
57
57
|
deregisterJobDefinition(params: Batch.Types.DeregisterJobDefinitionRequest, callback?: (err: AWSError, data: Batch.Types.DeregisterJobDefinitionResponse) => void): Request<Batch.Types.DeregisterJobDefinitionResponse, AWSError>;
|
|
58
58
|
/**
|
|
59
|
-
* Deregisters an AWS Batch job definition. Job definitions
|
|
59
|
+
* Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.
|
|
60
60
|
*/
|
|
61
61
|
deregisterJobDefinition(callback?: (err: AWSError, data: Batch.Types.DeregisterJobDefinitionResponse) => void): Request<Batch.Types.DeregisterJobDefinitionResponse, AWSError>;
|
|
62
62
|
/**
|
|
63
|
-
* Describes one or more of your compute environments. If you
|
|
63
|
+
* Describes one or more of your compute environments. If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.
|
|
64
64
|
*/
|
|
65
65
|
describeComputeEnvironments(params: Batch.Types.DescribeComputeEnvironmentsRequest, callback?: (err: AWSError, data: Batch.Types.DescribeComputeEnvironmentsResponse) => void): Request<Batch.Types.DescribeComputeEnvironmentsResponse, AWSError>;
|
|
66
66
|
/**
|
|
67
|
-
* Describes one or more of your compute environments. If you
|
|
67
|
+
* Describes one or more of your compute environments. If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.
|
|
68
68
|
*/
|
|
69
69
|
describeComputeEnvironments(callback?: (err: AWSError, data: Batch.Types.DescribeComputeEnvironmentsResponse) => void): Request<Batch.Types.DescribeComputeEnvironmentsResponse, AWSError>;
|
|
70
70
|
/**
|
|
@@ -92,19 +92,19 @@ declare class Batch extends Service {
|
|
|
92
92
|
*/
|
|
93
93
|
describeJobs(callback?: (err: AWSError, data: Batch.Types.DescribeJobsResponse) => void): Request<Batch.Types.DescribeJobsResponse, AWSError>;
|
|
94
94
|
/**
|
|
95
|
-
* Returns a list of AWS Batch jobs. You must specify only one of the following:
|
|
95
|
+
* Returns a list of AWS Batch jobs. You must specify only one of the following items: A job queue ID to return a list of jobs in that job queue A multi-node parallel job ID to return a list of that job's nodes An array job ID to return a list of that job's children You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.
|
|
96
96
|
*/
|
|
97
97
|
listJobs(params: Batch.Types.ListJobsRequest, callback?: (err: AWSError, data: Batch.Types.ListJobsResponse) => void): Request<Batch.Types.ListJobsResponse, AWSError>;
|
|
98
98
|
/**
|
|
99
|
-
* Returns a list of AWS Batch jobs. You must specify only one of the following:
|
|
99
|
+
* Returns a list of AWS Batch jobs. You must specify only one of the following items: A job queue ID to return a list of jobs in that job queue A multi-node parallel job ID to return a list of that job's nodes An array job ID to return a list of that job's children You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.
|
|
100
100
|
*/
|
|
101
101
|
listJobs(callback?: (err: AWSError, data: Batch.Types.ListJobsResponse) => void): Request<Batch.Types.ListJobsResponse, AWSError>;
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
103
|
+
* Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
|
|
104
104
|
*/
|
|
105
105
|
listTagsForResource(params: Batch.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Batch.Types.ListTagsForResourceResponse) => void): Request<Batch.Types.ListTagsForResourceResponse, AWSError>;
|
|
106
106
|
/**
|
|
107
|
-
*
|
|
107
|
+
* Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
|
|
108
108
|
*/
|
|
109
109
|
listTagsForResource(callback?: (err: AWSError, data: Batch.Types.ListTagsForResourceResponse) => void): Request<Batch.Types.ListTagsForResourceResponse, AWSError>;
|
|
110
110
|
/**
|
|
@@ -116,19 +116,19 @@ declare class Batch extends Service {
|
|
|
116
116
|
*/
|
|
117
117
|
registerJobDefinition(callback?: (err: AWSError, data: Batch.Types.RegisterJobDefinitionResponse) => void): Request<Batch.Types.RegisterJobDefinitionResponse, AWSError>;
|
|
118
118
|
/**
|
|
119
|
-
* Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
|
|
119
|
+
* Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition. Jobs run on Fargate resources don't run for more than 14 days. After 14 days, the Fargate resources might no longer be available and the job is terminated.
|
|
120
120
|
*/
|
|
121
121
|
submitJob(params: Batch.Types.SubmitJobRequest, callback?: (err: AWSError, data: Batch.Types.SubmitJobResponse) => void): Request<Batch.Types.SubmitJobResponse, AWSError>;
|
|
122
122
|
/**
|
|
123
|
-
* Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
|
|
123
|
+
* Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition. Jobs run on Fargate resources don't run for more than 14 days. After 14 days, the Fargate resources might no longer be available and the job is terminated.
|
|
124
124
|
*/
|
|
125
125
|
submitJob(callback?: (err: AWSError, data: Batch.Types.SubmitJobResponse) => void): Request<Batch.Types.SubmitJobResponse, AWSError>;
|
|
126
126
|
/**
|
|
127
|
-
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource
|
|
127
|
+
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
|
|
128
128
|
*/
|
|
129
129
|
tagResource(params: Batch.Types.TagResourceRequest, callback?: (err: AWSError, data: Batch.Types.TagResourceResponse) => void): Request<Batch.Types.TagResourceResponse, AWSError>;
|
|
130
130
|
/**
|
|
131
|
-
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource
|
|
131
|
+
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
|
|
132
132
|
*/
|
|
133
133
|
tagResource(callback?: (err: AWSError, data: Batch.Types.TagResourceResponse) => void): Request<Batch.Types.TagResourceResponse, AWSError>;
|
|
134
134
|
/**
|
|
@@ -197,6 +197,7 @@ declare namespace Batch {
|
|
|
197
197
|
*/
|
|
198
198
|
index?: Integer;
|
|
199
199
|
}
|
|
200
|
+
export type AssignPublicIp = "ENABLED"|"DISABLED"|string;
|
|
200
201
|
export interface AttemptContainerDetail {
|
|
201
202
|
/**
|
|
202
203
|
* The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
|
|
@@ -247,7 +248,7 @@ declare namespace Batch {
|
|
|
247
248
|
export type CEStatus = "CREATING"|"UPDATING"|"DELETING"|"DELETED"|"VALID"|"INVALID"|string;
|
|
248
249
|
export type CEType = "MANAGED"|"UNMANAGED"|string;
|
|
249
250
|
export type CRAllocationStrategy = "BEST_FIT"|"BEST_FIT_PROGRESSIVE"|"SPOT_CAPACITY_OPTIMIZED"|string;
|
|
250
|
-
export type CRType = "EC2"|"SPOT"|string;
|
|
251
|
+
export type CRType = "EC2"|"SPOT"|"FARGATE"|"FARGATE_SPOT"|string;
|
|
251
252
|
export interface CancelJobRequest {
|
|
252
253
|
/**
|
|
253
254
|
* The AWS Batch job ID of the job to cancel.
|
|
@@ -278,11 +279,11 @@ declare namespace Batch {
|
|
|
278
279
|
*/
|
|
279
280
|
tags?: TagrisTagsMap;
|
|
280
281
|
/**
|
|
281
|
-
* The type of
|
|
282
|
+
* The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.
|
|
282
283
|
*/
|
|
283
284
|
type?: CEType;
|
|
284
285
|
/**
|
|
285
|
-
* The state of the compute environment. The valid values are ENABLED or DISABLED. If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand. If the state is DISABLED, then the AWS Batch scheduler
|
|
286
|
+
* The state of the compute environment. The valid values are ENABLED or DISABLED. If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand. If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state do not scale out. However, they scale in to minvCpus value after instances become idle.
|
|
286
287
|
*/
|
|
287
288
|
state?: CEState;
|
|
288
289
|
/**
|
|
@@ -305,7 +306,7 @@ declare namespace Batch {
|
|
|
305
306
|
export type ComputeEnvironmentDetailList = ComputeEnvironmentDetail[];
|
|
306
307
|
export interface ComputeEnvironmentOrder {
|
|
307
308
|
/**
|
|
308
|
-
* The order of the compute environment.
|
|
309
|
+
* The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.
|
|
309
310
|
*/
|
|
310
311
|
order: Integer;
|
|
311
312
|
/**
|
|
@@ -316,77 +317,77 @@ declare namespace Batch {
|
|
|
316
317
|
export type ComputeEnvironmentOrders = ComputeEnvironmentOrder[];
|
|
317
318
|
export interface ComputeResource {
|
|
318
319
|
/**
|
|
319
|
-
* The type of compute environment: EC2 or
|
|
320
|
+
* The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.
|
|
320
321
|
*/
|
|
321
322
|
type: CRType;
|
|
322
323
|
/**
|
|
323
|
-
* The allocation strategy to use for the compute resource
|
|
324
|
+
* The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified. BEST_FIT (default) AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS Batch will wait for the additional instances to be available. If there are not enough instances available, or if the user is hitting Amazon EC2 service limits then additional jobs aren't run until currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified. BEST_FIT_PROGRESSIVE AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types. SPOT_CAPACITY_OPTIMIZED AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources. With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.
|
|
324
325
|
*/
|
|
325
326
|
allocationStrategy?: CRAllocationStrategy;
|
|
326
327
|
/**
|
|
327
|
-
* The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
|
|
328
|
+
* The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED). This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
328
329
|
*/
|
|
329
|
-
minvCpus
|
|
330
|
+
minvCpus?: Integer;
|
|
330
331
|
/**
|
|
331
|
-
* The maximum number of Amazon EC2 vCPUs that an environment can reach.
|
|
332
|
+
* The maximum number of Amazon EC2 vCPUs that an environment can reach. With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS Batch may need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch will never go above maxvCpus by more than a single instance (e.g., no more than a single instance from among those specified in your compute environment).
|
|
332
333
|
*/
|
|
333
334
|
maxvCpus: Integer;
|
|
334
335
|
/**
|
|
335
|
-
* The desired number of Amazon EC2 vCPUS in the compute environment.
|
|
336
|
+
* The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
336
337
|
*/
|
|
337
338
|
desiredvCpus?: Integer;
|
|
338
339
|
/**
|
|
339
|
-
* The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to
|
|
340
|
+
* The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified. When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
|
|
340
341
|
*/
|
|
341
|
-
instanceTypes
|
|
342
|
+
instanceTypes?: StringList;
|
|
342
343
|
/**
|
|
343
|
-
* The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.
|
|
344
|
+
* The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified. The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
|
|
344
345
|
*/
|
|
345
346
|
imageId?: String;
|
|
346
347
|
/**
|
|
347
|
-
* The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
|
|
348
|
+
* The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. This parameter is required for jobs running on Fargate resources, where it can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
|
|
348
349
|
*/
|
|
349
350
|
subnets: StringList;
|
|
350
351
|
/**
|
|
351
|
-
* The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.
|
|
352
|
+
* The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs running on Fargate resources and must contain at least one security group. (Fargate does not support launch templates.) If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.
|
|
352
353
|
*/
|
|
353
354
|
securityGroupIds?: StringList;
|
|
354
355
|
/**
|
|
355
|
-
* The Amazon EC2 key pair that is used for instances launched in the compute environment.
|
|
356
|
+
* The Amazon EC2 key pair that is used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
356
357
|
*/
|
|
357
358
|
ec2KeyPair?: String;
|
|
358
359
|
/**
|
|
359
|
-
* The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.
|
|
360
|
+
* The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
360
361
|
*/
|
|
361
|
-
instanceRole
|
|
362
|
+
instanceRole?: String;
|
|
362
363
|
/**
|
|
363
|
-
* Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
|
|
364
|
+
* Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
|
|
364
365
|
*/
|
|
365
366
|
tags?: TagsMap;
|
|
366
367
|
/**
|
|
367
|
-
* The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
|
|
368
|
+
* The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
368
369
|
*/
|
|
369
370
|
placementGroup?: String;
|
|
370
371
|
/**
|
|
371
|
-
* The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.
|
|
372
|
+
* The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
372
373
|
*/
|
|
373
374
|
bidPercentage?: Integer;
|
|
374
375
|
/**
|
|
375
|
-
* The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy
|
|
376
|
+
* The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified. To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the AWS Batch User Guide.
|
|
376
377
|
*/
|
|
377
378
|
spotIamFleetRole?: String;
|
|
378
379
|
/**
|
|
379
|
-
* The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide.
|
|
380
|
+
* The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
380
381
|
*/
|
|
381
382
|
launchTemplate?: LaunchTemplateSpecification;
|
|
382
383
|
/**
|
|
383
|
-
* Provides
|
|
384
|
+
* Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL1. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
384
385
|
*/
|
|
385
386
|
ec2Configuration?: Ec2ConfigurationList;
|
|
386
387
|
}
|
|
387
388
|
export interface ComputeResourceUpdate {
|
|
388
389
|
/**
|
|
389
|
-
* The minimum number of Amazon EC2 vCPUs that an environment should maintain.
|
|
390
|
+
* The minimum number of Amazon EC2 vCPUs that an environment should maintain. This parameter isnt applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
390
391
|
*/
|
|
391
392
|
minvCpus?: Integer;
|
|
392
393
|
/**
|
|
@@ -394,9 +395,17 @@ declare namespace Batch {
|
|
|
394
395
|
*/
|
|
395
396
|
maxvCpus?: Integer;
|
|
396
397
|
/**
|
|
397
|
-
* The desired number of Amazon EC2 vCPUS in the compute environment.
|
|
398
|
+
* The desired number of Amazon EC2 vCPUS in the compute environment. This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.
|
|
398
399
|
*/
|
|
399
400
|
desiredvCpus?: Integer;
|
|
401
|
+
/**
|
|
402
|
+
* The VPC subnets that the compute resources are launched into. This parameter is required for jobs running on Fargate compute resources, where it can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide. This can't be specified for EC2 compute resources. Providing an empty list will be handled as if this parameter wasn't specified and no change is made.
|
|
403
|
+
*/
|
|
404
|
+
subnets?: StringList;
|
|
405
|
+
/**
|
|
406
|
+
* The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no changeis made.
|
|
407
|
+
*/
|
|
408
|
+
securityGroupIds?: StringList;
|
|
400
409
|
}
|
|
401
410
|
export interface ContainerDetail {
|
|
402
411
|
/**
|
|
@@ -404,11 +413,11 @@ declare namespace Batch {
|
|
|
404
413
|
*/
|
|
405
414
|
image?: String;
|
|
406
415
|
/**
|
|
407
|
-
* The number of
|
|
416
|
+
* The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once. This parameter isn't applicable to jobs running on Fargate resources. Jobs running on Fargate resources must specify the vCPU requirement for the job using resourceRequirements.
|
|
408
417
|
*/
|
|
409
418
|
vcpus?: Integer;
|
|
410
419
|
/**
|
|
411
|
-
*
|
|
420
|
+
* For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.
|
|
412
421
|
*/
|
|
413
422
|
memory?: Integer;
|
|
414
423
|
/**
|
|
@@ -420,7 +429,7 @@ declare namespace Batch {
|
|
|
420
429
|
*/
|
|
421
430
|
jobRoleArn?: String;
|
|
422
431
|
/**
|
|
423
|
-
* The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role.
|
|
432
|
+
* The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
|
|
424
433
|
*/
|
|
425
434
|
executionRoleArn?: String;
|
|
426
435
|
/**
|
|
@@ -436,19 +445,19 @@ declare namespace Batch {
|
|
|
436
445
|
*/
|
|
437
446
|
mountPoints?: MountPoints;
|
|
438
447
|
/**
|
|
439
|
-
* When this parameter is true, the container is given read-only access to its root file system.
|
|
448
|
+
* When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
|
|
440
449
|
*/
|
|
441
450
|
readonlyRootFilesystem?: Boolean;
|
|
442
451
|
/**
|
|
443
|
-
* A list of ulimit values to set in the container.
|
|
452
|
+
* A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. This parameter isn't applicable to jobs running on Fargate resources.
|
|
444
453
|
*/
|
|
445
454
|
ulimits?: Ulimits;
|
|
446
455
|
/**
|
|
447
|
-
* When this parameter is true, the container is given elevated
|
|
456
|
+
* When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided, or specified as false.
|
|
448
457
|
*/
|
|
449
458
|
privileged?: Boolean;
|
|
450
459
|
/**
|
|
451
|
-
* The user name to use inside the container.
|
|
460
|
+
* The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
|
|
452
461
|
*/
|
|
453
462
|
user?: String;
|
|
454
463
|
/**
|
|
@@ -460,7 +469,7 @@ declare namespace Batch {
|
|
|
460
469
|
*/
|
|
461
470
|
reason?: String;
|
|
462
471
|
/**
|
|
463
|
-
* The Amazon Resource Name (ARN) of the container instance
|
|
472
|
+
* The Amazon Resource Name (ARN) of the container instance that the container is running on.
|
|
464
473
|
*/
|
|
465
474
|
containerInstanceArn?: String;
|
|
466
475
|
/**
|
|
@@ -472,7 +481,7 @@ declare namespace Batch {
|
|
|
472
481
|
*/
|
|
473
482
|
logStreamName?: String;
|
|
474
483
|
/**
|
|
475
|
-
* The instance type of the underlying host infrastructure of a multi-node parallel job.
|
|
484
|
+
* The instance type of the underlying host infrastructure of a multi-node parallel job. This parameter isn't applicable to jobs running on Fargate resources.
|
|
476
485
|
*/
|
|
477
486
|
instanceType?: String;
|
|
478
487
|
/**
|
|
@@ -480,7 +489,7 @@ declare namespace Batch {
|
|
|
480
489
|
*/
|
|
481
490
|
networkInterfaces?: NetworkInterfaceList;
|
|
482
491
|
/**
|
|
483
|
-
* The type and amount of
|
|
492
|
+
* The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
|
|
484
493
|
*/
|
|
485
494
|
resourceRequirements?: ResourceRequirements;
|
|
486
495
|
/**
|
|
@@ -488,21 +497,29 @@ declare namespace Batch {
|
|
|
488
497
|
*/
|
|
489
498
|
linuxParameters?: LinuxParameters;
|
|
490
499
|
/**
|
|
491
|
-
* The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container
|
|
500
|
+
* The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version" The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
|
|
492
501
|
*/
|
|
493
502
|
logConfiguration?: LogConfiguration;
|
|
494
503
|
/**
|
|
495
|
-
* The secrets to pass to the container. For more information, see Specifying
|
|
504
|
+
* The secrets to pass to the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
|
|
496
505
|
*/
|
|
497
506
|
secrets?: SecretList;
|
|
507
|
+
/**
|
|
508
|
+
* The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
|
|
509
|
+
*/
|
|
510
|
+
networkConfiguration?: NetworkConfiguration;
|
|
511
|
+
/**
|
|
512
|
+
* The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
|
|
513
|
+
*/
|
|
514
|
+
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
498
515
|
}
|
|
499
516
|
export interface ContainerOverrides {
|
|
500
517
|
/**
|
|
501
|
-
*
|
|
518
|
+
* This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. For jobs run on EC2 resources, the number of vCPUs to reserve for the container. This value overrides the value set in the job definition. Jobs run on EC2 resources can specify the vCPU requirement using resourceRequirement but the vCPU requirements can't be specified both here and in resourceRequirement. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. Jobs running on Fargate resources must specify the vCPU requirement for the job using resourceRequirements.
|
|
502
519
|
*/
|
|
503
520
|
vcpus?: Integer;
|
|
504
521
|
/**
|
|
505
|
-
*
|
|
522
|
+
* This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resource, the number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
|
|
506
523
|
*/
|
|
507
524
|
memory?: Integer;
|
|
508
525
|
/**
|
|
@@ -510,7 +527,7 @@ declare namespace Batch {
|
|
|
510
527
|
*/
|
|
511
528
|
command?: StringList;
|
|
512
529
|
/**
|
|
513
|
-
* The instance type to use for a multi-node parallel job.
|
|
530
|
+
* The instance type to use for a multi-node parallel job. This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.
|
|
514
531
|
*/
|
|
515
532
|
instanceType?: String;
|
|
516
533
|
/**
|
|
@@ -518,21 +535,21 @@ declare namespace Batch {
|
|
|
518
535
|
*/
|
|
519
536
|
environment?: EnvironmentVariables;
|
|
520
537
|
/**
|
|
521
|
-
* The type and amount of
|
|
538
|
+
* The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
|
|
522
539
|
*/
|
|
523
540
|
resourceRequirements?: ResourceRequirements;
|
|
524
541
|
}
|
|
525
542
|
export interface ContainerProperties {
|
|
526
543
|
/**
|
|
527
|
-
* The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
|
|
544
|
+
* The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run. Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources. Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>). Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo). Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent). Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
|
|
528
545
|
*/
|
|
529
546
|
image?: String;
|
|
530
547
|
/**
|
|
531
|
-
* The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places for
|
|
548
|
+
* This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement structure. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. Jobs running on Fargate resources must specify the vCPU requirement for the job using resourceRequirements.
|
|
532
549
|
*/
|
|
533
550
|
vcpus?: Integer;
|
|
534
551
|
/**
|
|
535
|
-
* The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places
|
|
552
|
+
* This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resources can specify the memory requirement using the ResourceRequirement structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once. If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
|
|
536
553
|
*/
|
|
537
554
|
memory?: Integer;
|
|
538
555
|
/**
|
|
@@ -540,11 +557,11 @@ declare namespace Batch {
|
|
|
540
557
|
*/
|
|
541
558
|
command?: StringList;
|
|
542
559
|
/**
|
|
543
|
-
* The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
|
|
560
|
+
* The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
|
|
544
561
|
*/
|
|
545
562
|
jobRoleArn?: String;
|
|
546
563
|
/**
|
|
547
|
-
* The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role.
|
|
564
|
+
* The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
|
|
548
565
|
*/
|
|
549
566
|
executionRoleArn?: String;
|
|
550
567
|
/**
|
|
@@ -552,7 +569,7 @@ declare namespace Batch {
|
|
|
552
569
|
*/
|
|
553
570
|
volumes?: Volumes;
|
|
554
571
|
/**
|
|
555
|
-
* The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run. We
|
|
572
|
+
* The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run. We don't recommend using plaintext environment variables for sensitive information, such as credential data. Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
|
|
556
573
|
*/
|
|
557
574
|
environment?: EnvironmentVariables;
|
|
558
575
|
/**
|
|
@@ -564,11 +581,11 @@ declare namespace Batch {
|
|
|
564
581
|
*/
|
|
565
582
|
readonlyRootFilesystem?: Boolean;
|
|
566
583
|
/**
|
|
567
|
-
* When this parameter is true, the container is given elevated
|
|
584
|
+
* When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided, or specified as false.
|
|
568
585
|
*/
|
|
569
586
|
privileged?: Boolean;
|
|
570
587
|
/**
|
|
571
|
-
* A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
|
|
588
|
+
* A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
|
|
572
589
|
*/
|
|
573
590
|
ulimits?: Ulimits;
|
|
574
591
|
/**
|
|
@@ -576,11 +593,11 @@ declare namespace Batch {
|
|
|
576
593
|
*/
|
|
577
594
|
user?: String;
|
|
578
595
|
/**
|
|
579
|
-
* The instance type to use for a multi-node parallel job.
|
|
596
|
+
* The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type. This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.
|
|
580
597
|
*/
|
|
581
598
|
instanceType?: String;
|
|
582
599
|
/**
|
|
583
|
-
* The type and amount of
|
|
600
|
+
* The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
|
|
584
601
|
*/
|
|
585
602
|
resourceRequirements?: ResourceRequirements;
|
|
586
603
|
/**
|
|
@@ -588,13 +605,21 @@ declare namespace Batch {
|
|
|
588
605
|
*/
|
|
589
606
|
linuxParameters?: LinuxParameters;
|
|
590
607
|
/**
|
|
591
|
-
* The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container
|
|
608
|
+
* The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation. AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version" The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
|
|
592
609
|
*/
|
|
593
610
|
logConfiguration?: LogConfiguration;
|
|
594
611
|
/**
|
|
595
|
-
* The secrets for the container. For more information, see Specifying
|
|
612
|
+
* The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
|
|
596
613
|
*/
|
|
597
614
|
secrets?: SecretList;
|
|
615
|
+
/**
|
|
616
|
+
* The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
|
|
617
|
+
*/
|
|
618
|
+
networkConfiguration?: NetworkConfiguration;
|
|
619
|
+
/**
|
|
620
|
+
* The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
|
|
621
|
+
*/
|
|
622
|
+
fargatePlatformConfiguration?: FargatePlatformConfiguration;
|
|
598
623
|
}
|
|
599
624
|
export interface ContainerSummary {
|
|
600
625
|
/**
|
|
@@ -612,7 +637,7 @@ declare namespace Batch {
|
|
|
612
637
|
*/
|
|
613
638
|
computeEnvironmentName: String;
|
|
614
639
|
/**
|
|
615
|
-
* The type of the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
|
|
640
|
+
* The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
|
|
616
641
|
*/
|
|
617
642
|
type: CEType;
|
|
618
643
|
/**
|
|
@@ -620,15 +645,15 @@ declare namespace Batch {
|
|
|
620
645
|
*/
|
|
621
646
|
state?: CEState;
|
|
622
647
|
/**
|
|
623
|
-
* Details
|
|
648
|
+
* Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.
|
|
624
649
|
*/
|
|
625
650
|
computeResources?: ComputeResource;
|
|
626
651
|
/**
|
|
627
|
-
* The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN
|
|
652
|
+
* The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
|
|
628
653
|
*/
|
|
629
654
|
serviceRole: String;
|
|
630
655
|
/**
|
|
631
|
-
* The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference. These tags can be updated or removed using the TagResource and UntagResource API operations. These tags
|
|
656
|
+
* The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference. These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
|
|
632
657
|
*/
|
|
633
658
|
tags?: TagrisTagsMap;
|
|
634
659
|
}
|
|
@@ -648,15 +673,15 @@ declare namespace Batch {
|
|
|
648
673
|
*/
|
|
649
674
|
jobQueueName: String;
|
|
650
675
|
/**
|
|
651
|
-
* The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs
|
|
676
|
+
* The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.
|
|
652
677
|
*/
|
|
653
678
|
state?: JQState;
|
|
654
679
|
/**
|
|
655
|
-
* The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order
|
|
680
|
+
* The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.
|
|
656
681
|
*/
|
|
657
682
|
priority: Integer;
|
|
658
683
|
/**
|
|
659
|
-
* The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should
|
|
684
|
+
* The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should run a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
|
|
660
685
|
*/
|
|
661
686
|
computeEnvironmentOrder: ComputeEnvironmentOrders;
|
|
662
687
|
/**
|
|
@@ -704,7 +729,7 @@ declare namespace Batch {
|
|
|
704
729
|
*/
|
|
705
730
|
computeEnvironments?: StringList;
|
|
706
731
|
/**
|
|
707
|
-
* The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter
|
|
732
|
+
* The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.
|
|
708
733
|
*/
|
|
709
734
|
maxResults?: Integer;
|
|
710
735
|
/**
|
|
@@ -728,7 +753,7 @@ declare namespace Batch {
|
|
|
728
753
|
*/
|
|
729
754
|
jobDefinitions?: StringList;
|
|
730
755
|
/**
|
|
731
|
-
* The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter
|
|
756
|
+
* The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.
|
|
732
757
|
*/
|
|
733
758
|
maxResults?: Integer;
|
|
734
759
|
/**
|
|
@@ -736,7 +761,7 @@ declare namespace Batch {
|
|
|
736
761
|
*/
|
|
737
762
|
jobDefinitionName?: String;
|
|
738
763
|
/**
|
|
739
|
-
* The status
|
|
764
|
+
* The status used to filter job definitions.
|
|
740
765
|
*/
|
|
741
766
|
status?: String;
|
|
742
767
|
/**
|
|
@@ -760,7 +785,7 @@ declare namespace Batch {
|
|
|
760
785
|
*/
|
|
761
786
|
jobQueues?: StringList;
|
|
762
787
|
/**
|
|
763
|
-
* The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter
|
|
788
|
+
* The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.
|
|
764
789
|
*/
|
|
765
790
|
maxResults?: Integer;
|
|
766
791
|
/**
|
|
@@ -796,7 +821,7 @@ declare namespace Batch {
|
|
|
796
821
|
*/
|
|
797
822
|
hostPath: String;
|
|
798
823
|
/**
|
|
799
|
-
* The path inside the container
|
|
824
|
+
* The path inside the container used to expose the host device. By default the hostPath value is used.
|
|
800
825
|
*/
|
|
801
826
|
containerPath?: String;
|
|
802
827
|
/**
|
|
@@ -809,7 +834,7 @@ declare namespace Batch {
|
|
|
809
834
|
export type DevicesList = Device[];
|
|
810
835
|
export interface Ec2Configuration {
|
|
811
836
|
/**
|
|
812
|
-
* The image type to match with the instance type to
|
|
837
|
+
* The image type to match with the instance type to select an AMI. If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized AMI is used. ECS_AL2 Amazon Linux 2− Default for all AWS Graviton-based instance families (for example, C6g, M6g, R6g, and T4g) and can be used for all non-GPU instance types. ECS_AL2_NVIDIA Amazon Linux 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be used for all non-AWS Graviton-based instance types. ECS_AL1 Amazon Linux−Default for all non-GPU, non-AWS-Graviton instance families. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.
|
|
813
838
|
*/
|
|
814
839
|
imageType: ImageType;
|
|
815
840
|
/**
|
|
@@ -821,11 +846,11 @@ declare namespace Batch {
|
|
|
821
846
|
export type EnvironmentVariables = KeyValuePair[];
|
|
822
847
|
export interface EvaluateOnExit {
|
|
823
848
|
/**
|
|
824
|
-
* Contains a glob pattern to match against the StatusReason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and
|
|
849
|
+
* Contains a glob pattern to match against the StatusReason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs). and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
|
|
825
850
|
*/
|
|
826
851
|
onStatusReason?: String;
|
|
827
852
|
/**
|
|
828
|
-
* Contains a glob pattern to match against the Reason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and
|
|
853
|
+
* Contains a glob pattern to match against the Reason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs), and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
|
|
829
854
|
*/
|
|
830
855
|
onReason?: String;
|
|
831
856
|
/**
|
|
@@ -833,14 +858,20 @@ declare namespace Batch {
|
|
|
833
858
|
*/
|
|
834
859
|
onExitCode?: String;
|
|
835
860
|
/**
|
|
836
|
-
* Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met.
|
|
861
|
+
* Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values are not case sensitive.
|
|
837
862
|
*/
|
|
838
863
|
action: RetryAction;
|
|
839
864
|
}
|
|
840
865
|
export type EvaluateOnExitList = EvaluateOnExit[];
|
|
866
|
+
export interface FargatePlatformConfiguration {
|
|
867
|
+
/**
|
|
868
|
+
* The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
|
|
869
|
+
*/
|
|
870
|
+
platformVersion?: String;
|
|
871
|
+
}
|
|
841
872
|
export interface Host {
|
|
842
873
|
/**
|
|
843
|
-
* The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
|
|
874
|
+
* The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
|
|
844
875
|
*/
|
|
845
876
|
sourcePath?: String;
|
|
846
877
|
}
|
|
@@ -867,7 +898,7 @@ declare namespace Batch {
|
|
|
867
898
|
*/
|
|
868
899
|
status?: String;
|
|
869
900
|
/**
|
|
870
|
-
* The type of job definition.
|
|
901
|
+
* The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.
|
|
871
902
|
*/
|
|
872
903
|
type: String;
|
|
873
904
|
/**
|
|
@@ -883,17 +914,25 @@ declare namespace Batch {
|
|
|
883
914
|
*/
|
|
884
915
|
containerProperties?: ContainerProperties;
|
|
885
916
|
/**
|
|
886
|
-
* The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they
|
|
917
|
+
* The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished.
|
|
887
918
|
*/
|
|
888
919
|
timeout?: JobTimeout;
|
|
889
920
|
/**
|
|
890
|
-
* An object with various properties specific to multi-node parallel jobs.
|
|
921
|
+
* An object with various properties specific to multi-node parallel jobs. If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
|
|
891
922
|
*/
|
|
892
923
|
nodeProperties?: NodeProperties;
|
|
893
924
|
/**
|
|
894
925
|
* The tags applied to the job definition.
|
|
895
926
|
*/
|
|
896
927
|
tags?: TagrisTagsMap;
|
|
928
|
+
/**
|
|
929
|
+
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
|
|
930
|
+
*/
|
|
931
|
+
propagateTags?: Boolean;
|
|
932
|
+
/**
|
|
933
|
+
* The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
|
|
934
|
+
*/
|
|
935
|
+
platformCapabilities?: PlatformCapabilityList;
|
|
897
936
|
}
|
|
898
937
|
export type JobDefinitionList = JobDefinition[];
|
|
899
938
|
export type JobDefinitionType = "container"|"multinode"|string;
|
|
@@ -922,7 +961,7 @@ declare namespace Batch {
|
|
|
922
961
|
*/
|
|
923
962
|
jobId: String;
|
|
924
963
|
/**
|
|
925
|
-
* The Amazon Resource Name (ARN) of the job queue
|
|
964
|
+
* The Amazon Resource Name (ARN) of the job queue that the job is associated with.
|
|
926
965
|
*/
|
|
927
966
|
jobQueue: String;
|
|
928
967
|
/**
|
|
@@ -946,7 +985,7 @@ declare namespace Batch {
|
|
|
946
985
|
*/
|
|
947
986
|
retryStrategy?: RetryStrategy;
|
|
948
987
|
/**
|
|
949
|
-
* The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter
|
|
988
|
+
* The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
|
|
950
989
|
*/
|
|
951
990
|
startedAt: Long;
|
|
952
991
|
/**
|
|
@@ -954,7 +993,7 @@ declare namespace Batch {
|
|
|
954
993
|
*/
|
|
955
994
|
stoppedAt?: Long;
|
|
956
995
|
/**
|
|
957
|
-
* A list of job IDs
|
|
996
|
+
* A list of job IDs that this job depends on.
|
|
958
997
|
*/
|
|
959
998
|
dependsOn?: JobDependencyList;
|
|
960
999
|
/**
|
|
@@ -966,7 +1005,7 @@ declare namespace Batch {
|
|
|
966
1005
|
*/
|
|
967
1006
|
parameters?: ParametersMap;
|
|
968
1007
|
/**
|
|
969
|
-
* An object representing the details of the container that
|
|
1008
|
+
* An object representing the details of the container that's associated with the job.
|
|
970
1009
|
*/
|
|
971
1010
|
container?: ContainerDetail;
|
|
972
1011
|
/**
|
|
@@ -974,7 +1013,7 @@ declare namespace Batch {
|
|
|
974
1013
|
*/
|
|
975
1014
|
nodeDetails?: NodeDetails;
|
|
976
1015
|
/**
|
|
977
|
-
* An object representing the node properties of a multi-node parallel job.
|
|
1016
|
+
* An object representing the node properties of a multi-node parallel job. This isn't applicable to jobs running on Fargate resources.
|
|
978
1017
|
*/
|
|
979
1018
|
nodeProperties?: NodeProperties;
|
|
980
1019
|
/**
|
|
@@ -989,6 +1028,14 @@ declare namespace Batch {
|
|
|
989
1028
|
* The tags applied to the job.
|
|
990
1029
|
*/
|
|
991
1030
|
tags?: TagrisTagsMap;
|
|
1031
|
+
/**
|
|
1032
|
+
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
|
|
1033
|
+
*/
|
|
1034
|
+
propagateTags?: Boolean;
|
|
1035
|
+
/**
|
|
1036
|
+
* The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
|
|
1037
|
+
*/
|
|
1038
|
+
platformCapabilities?: PlatformCapabilityList;
|
|
992
1039
|
}
|
|
993
1040
|
export type JobDetailList = JobDetail[];
|
|
994
1041
|
export interface JobQueueDetail {
|
|
@@ -1001,7 +1048,7 @@ declare namespace Batch {
|
|
|
1001
1048
|
*/
|
|
1002
1049
|
jobQueueArn: String;
|
|
1003
1050
|
/**
|
|
1004
|
-
* Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it
|
|
1051
|
+
* Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it's able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.
|
|
1005
1052
|
*/
|
|
1006
1053
|
state: JQState;
|
|
1007
1054
|
/**
|
|
@@ -1017,7 +1064,7 @@ declare namespace Batch {
|
|
|
1017
1064
|
*/
|
|
1018
1065
|
priority: Integer;
|
|
1019
1066
|
/**
|
|
1020
|
-
* The compute environments that are attached to the job queue and the order
|
|
1067
|
+
* The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
|
|
1021
1068
|
*/
|
|
1022
1069
|
computeEnvironmentOrder: ComputeEnvironmentOrders;
|
|
1023
1070
|
/**
|
|
@@ -1069,14 +1116,14 @@ declare namespace Batch {
|
|
|
1069
1116
|
*/
|
|
1070
1117
|
arrayProperties?: ArrayPropertiesSummary;
|
|
1071
1118
|
/**
|
|
1072
|
-
* The node properties for a single node in a job summary list.
|
|
1119
|
+
* The node properties for a single node in a job summary list. This isn't applicable to jobs running on Fargate resources.
|
|
1073
1120
|
*/
|
|
1074
1121
|
nodeProperties?: NodePropertiesSummary;
|
|
1075
1122
|
}
|
|
1076
1123
|
export type JobSummaryList = JobSummary[];
|
|
1077
1124
|
export interface JobTimeout {
|
|
1078
1125
|
/**
|
|
1079
|
-
* The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished.
|
|
1126
|
+
* The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.
|
|
1080
1127
|
*/
|
|
1081
1128
|
attemptDurationSeconds?: Integer;
|
|
1082
1129
|
}
|
|
@@ -1106,7 +1153,7 @@ declare namespace Batch {
|
|
|
1106
1153
|
}
|
|
1107
1154
|
export interface LinuxParameters {
|
|
1108
1155
|
/**
|
|
1109
|
-
* Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
|
|
1156
|
+
* Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
|
|
1110
1157
|
*/
|
|
1111
1158
|
devices?: DevicesList;
|
|
1112
1159
|
/**
|
|
@@ -1114,25 +1161,25 @@ declare namespace Batch {
|
|
|
1114
1161
|
*/
|
|
1115
1162
|
initProcessEnabled?: Boolean;
|
|
1116
1163
|
/**
|
|
1117
|
-
* The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
|
|
1164
|
+
* The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
|
|
1118
1165
|
*/
|
|
1119
1166
|
sharedMemorySize?: Integer;
|
|
1120
1167
|
/**
|
|
1121
|
-
* The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
|
|
1168
|
+
* The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
|
|
1122
1169
|
*/
|
|
1123
1170
|
tmpfs?: TmpfsList;
|
|
1124
1171
|
/**
|
|
1125
|
-
* The total amount of swap memory (in MiB) a container can use. This parameter
|
|
1172
|
+
* The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation. If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
|
|
1126
1173
|
*/
|
|
1127
1174
|
maxSwap?: Integer;
|
|
1128
1175
|
/**
|
|
1129
|
-
* This allows you to tune a container's memory swappiness behavior. A swappiness value of 0
|
|
1176
|
+
* This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
|
|
1130
1177
|
*/
|
|
1131
1178
|
swappiness?: Integer;
|
|
1132
1179
|
}
|
|
1133
1180
|
export interface ListJobsRequest {
|
|
1134
1181
|
/**
|
|
1135
|
-
* The name or full Amazon Resource Name (ARN) of the job queue
|
|
1182
|
+
* The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
|
|
1136
1183
|
*/
|
|
1137
1184
|
jobQueue?: String;
|
|
1138
1185
|
/**
|
|
@@ -1144,11 +1191,11 @@ declare namespace Batch {
|
|
|
1144
1191
|
*/
|
|
1145
1192
|
multiNodeJobId?: String;
|
|
1146
1193
|
/**
|
|
1147
|
-
* The job status
|
|
1194
|
+
* The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.
|
|
1148
1195
|
*/
|
|
1149
1196
|
jobStatus?: JobStatus;
|
|
1150
1197
|
/**
|
|
1151
|
-
* The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter
|
|
1198
|
+
* The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.
|
|
1152
1199
|
*/
|
|
1153
1200
|
maxResults?: Integer;
|
|
1154
1201
|
/**
|
|
@@ -1168,7 +1215,7 @@ declare namespace Batch {
|
|
|
1168
1215
|
}
|
|
1169
1216
|
export interface ListTagsForResourceRequest {
|
|
1170
1217
|
/**
|
|
1171
|
-
* The Amazon Resource Name (ARN) that identifies the resource
|
|
1218
|
+
* The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
|
|
1172
1219
|
*/
|
|
1173
1220
|
resourceArn: String;
|
|
1174
1221
|
}
|
|
@@ -1180,7 +1227,7 @@ declare namespace Batch {
|
|
|
1180
1227
|
}
|
|
1181
1228
|
export interface LogConfiguration {
|
|
1182
1229
|
/**
|
|
1183
|
-
* The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk. awslogs Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation. fluentd Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation. gelf Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation. journald Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation. json-file Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation. splunk Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation. syslog Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation. If you have a custom driver that
|
|
1230
|
+
* The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk. Jobs running on Fargate resources are restricted to the awslogs and splunk log drivers. awslogs Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation. fluentd Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation. gelf Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation. journald Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation. json-file Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation. splunk Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation. syslog Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation. If you have a custom driver that isn't listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
|
|
1184
1231
|
*/
|
|
1185
1232
|
logDriver: LogDriver;
|
|
1186
1233
|
/**
|
|
@@ -1197,11 +1244,11 @@ declare namespace Batch {
|
|
|
1197
1244
|
export type Long = number;
|
|
1198
1245
|
export interface MountPoint {
|
|
1199
1246
|
/**
|
|
1200
|
-
* The path on the container
|
|
1247
|
+
* The path on the container where the host volume is mounted.
|
|
1201
1248
|
*/
|
|
1202
1249
|
containerPath?: String;
|
|
1203
1250
|
/**
|
|
1204
|
-
* If this value is true, the container has read-only access to the volume
|
|
1251
|
+
* If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.
|
|
1205
1252
|
*/
|
|
1206
1253
|
readOnly?: Boolean;
|
|
1207
1254
|
/**
|
|
@@ -1210,6 +1257,12 @@ declare namespace Batch {
|
|
|
1210
1257
|
sourceVolume?: String;
|
|
1211
1258
|
}
|
|
1212
1259
|
export type MountPoints = MountPoint[];
|
|
1260
|
+
export interface NetworkConfiguration {
|
|
1261
|
+
/**
|
|
1262
|
+
* Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is "DISABLED".
|
|
1263
|
+
*/
|
|
1264
|
+
assignPublicIp?: AssignPublicIp;
|
|
1265
|
+
}
|
|
1213
1266
|
export interface NetworkInterface {
|
|
1214
1267
|
/**
|
|
1215
1268
|
* The attachment ID for the network interface.
|
|
@@ -1275,7 +1328,7 @@ declare namespace Batch {
|
|
|
1275
1328
|
}
|
|
1276
1329
|
export interface NodePropertyOverride {
|
|
1277
1330
|
/**
|
|
1278
|
-
* The range of nodes, using node index values,
|
|
1331
|
+
* The range of nodes, using node index values, that's used to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range.
|
|
1279
1332
|
*/
|
|
1280
1333
|
targetNodes: String;
|
|
1281
1334
|
/**
|
|
@@ -1296,13 +1349,15 @@ declare namespace Batch {
|
|
|
1296
1349
|
container?: ContainerProperties;
|
|
1297
1350
|
}
|
|
1298
1351
|
export type ParametersMap = {[key: string]: String};
|
|
1352
|
+
export type PlatformCapability = "EC2"|"FARGATE"|string;
|
|
1353
|
+
export type PlatformCapabilityList = PlatformCapability[];
|
|
1299
1354
|
export interface RegisterJobDefinitionRequest {
|
|
1300
1355
|
/**
|
|
1301
1356
|
* The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
|
|
1302
1357
|
*/
|
|
1303
1358
|
jobDefinitionName: String;
|
|
1304
1359
|
/**
|
|
1305
|
-
* The type of job definition.
|
|
1360
|
+
* The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide. If the job is run on Fargate resources, then multinode isn't supported.
|
|
1306
1361
|
*/
|
|
1307
1362
|
type: JobDefinitionType;
|
|
1308
1363
|
/**
|
|
@@ -1310,25 +1365,33 @@ declare namespace Batch {
|
|
|
1310
1365
|
*/
|
|
1311
1366
|
parameters?: ParametersMap;
|
|
1312
1367
|
/**
|
|
1313
|
-
* An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
|
|
1368
|
+
* An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.
|
|
1314
1369
|
*/
|
|
1315
1370
|
containerProperties?: ContainerProperties;
|
|
1316
1371
|
/**
|
|
1317
|
-
* An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
|
|
1372
|
+
* An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
|
|
1318
1373
|
*/
|
|
1319
1374
|
nodeProperties?: NodeProperties;
|
|
1320
1375
|
/**
|
|
1321
|
-
* The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it
|
|
1376
|
+
* The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
|
|
1322
1377
|
*/
|
|
1323
1378
|
retryStrategy?: RetryStrategy;
|
|
1324
1379
|
/**
|
|
1325
|
-
*
|
|
1380
|
+
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
|
|
1381
|
+
*/
|
|
1382
|
+
propagateTags?: Boolean;
|
|
1383
|
+
/**
|
|
1384
|
+
* The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.
|
|
1326
1385
|
*/
|
|
1327
1386
|
timeout?: JobTimeout;
|
|
1328
1387
|
/**
|
|
1329
|
-
* The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS
|
|
1388
|
+
* The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.
|
|
1330
1389
|
*/
|
|
1331
1390
|
tags?: TagrisTagsMap;
|
|
1391
|
+
/**
|
|
1392
|
+
* The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.
|
|
1393
|
+
*/
|
|
1394
|
+
platformCapabilities?: PlatformCapabilityList;
|
|
1332
1395
|
}
|
|
1333
1396
|
export interface RegisterJobDefinitionResponse {
|
|
1334
1397
|
/**
|
|
@@ -1346,16 +1409,16 @@ declare namespace Batch {
|
|
|
1346
1409
|
}
|
|
1347
1410
|
export interface ResourceRequirement {
|
|
1348
1411
|
/**
|
|
1349
|
-
* The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job
|
|
1412
|
+
* The quantity of the specified resource to reserve for the container. The values vary based on the type specified. type="GPU" The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on. GPUs are not available for jobs running on Fargate resources. type="MEMORY" For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide. For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value. value = 0.5 VCPU = 0.25 value = 1 VCPU = 0.25 or 0.5 value = 2 VCPU = 0.25, 0.5, or 1 value = 3 VCPU = 0.5, or 1 value = 4 VCPU = 0.5, 1, or 2 value = 5, 6, or 7 VCPU = 1 or 2 value = 8 VCPU = 1, 2, or 4 value = 9, 10, 11, 12, 13, 14, 15, or 16 VCPU = 2 or 4 value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30 VCPU = 4 type="VCPU" The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once. For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4 value = 0.25 MEMORY = 0.5, 1, or 2 value = 0.5 MEMORY = 1, 2, 3, or 4 value = 1 MEMORY = 2, 3, 4, 5, 6, 7, or 8 value = 2 MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16 value = 4 MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
|
|
1350
1413
|
*/
|
|
1351
1414
|
value: String;
|
|
1352
1415
|
/**
|
|
1353
|
-
* The type of resource to assign to a container.
|
|
1416
|
+
* The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
|
|
1354
1417
|
*/
|
|
1355
1418
|
type: ResourceType;
|
|
1356
1419
|
}
|
|
1357
1420
|
export type ResourceRequirements = ResourceRequirement[];
|
|
1358
|
-
export type ResourceType = "GPU"|string;
|
|
1421
|
+
export type ResourceType = "GPU"|"VCPU"|"MEMORY"|string;
|
|
1359
1422
|
export type RetryAction = "RETRY"|"EXIT"|string;
|
|
1360
1423
|
export interface RetryStrategy {
|
|
1361
1424
|
/**
|
|
@@ -1373,7 +1436,7 @@ declare namespace Batch {
|
|
|
1373
1436
|
*/
|
|
1374
1437
|
name: String;
|
|
1375
1438
|
/**
|
|
1376
|
-
* The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If the AWS Systems Manager Parameter Store parameter exists in the same Region as the
|
|
1439
|
+
* The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store. If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
|
|
1377
1440
|
*/
|
|
1378
1441
|
valueFrom: String;
|
|
1379
1442
|
}
|
|
@@ -1410,7 +1473,7 @@ declare namespace Batch {
|
|
|
1410
1473
|
*/
|
|
1411
1474
|
containerOverrides?: ContainerOverrides;
|
|
1412
1475
|
/**
|
|
1413
|
-
* A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
|
|
1476
|
+
* A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range. This parameter isn't applicable to jobs running on Fargate resources; use containerOverrides instead.
|
|
1414
1477
|
*/
|
|
1415
1478
|
nodeOverrides?: NodeOverrides;
|
|
1416
1479
|
/**
|
|
@@ -1418,7 +1481,11 @@ declare namespace Batch {
|
|
|
1418
1481
|
*/
|
|
1419
1482
|
retryStrategy?: RetryStrategy;
|
|
1420
1483
|
/**
|
|
1421
|
-
*
|
|
1484
|
+
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.
|
|
1485
|
+
*/
|
|
1486
|
+
propagateTags?: Boolean;
|
|
1487
|
+
/**
|
|
1488
|
+
* The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
|
|
1422
1489
|
*/
|
|
1423
1490
|
timeout?: JobTimeout;
|
|
1424
1491
|
/**
|
|
@@ -1444,7 +1511,7 @@ declare namespace Batch {
|
|
|
1444
1511
|
export type TagKeysList = TagKey[];
|
|
1445
1512
|
export interface TagResourceRequest {
|
|
1446
1513
|
/**
|
|
1447
|
-
* The Amazon Resource Name (ARN) of the resource
|
|
1514
|
+
* The Amazon Resource Name (ARN) of the resource that tags are added to. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.
|
|
1448
1515
|
*/
|
|
1449
1516
|
resourceArn: String;
|
|
1450
1517
|
/**
|
|
@@ -1471,7 +1538,7 @@ declare namespace Batch {
|
|
|
1471
1538
|
}
|
|
1472
1539
|
export interface Tmpfs {
|
|
1473
1540
|
/**
|
|
1474
|
-
* The absolute file path in the container where the tmpfs volume is
|
|
1541
|
+
* The absolute file path in the container where the tmpfs volume is mounted.
|
|
1475
1542
|
*/
|
|
1476
1543
|
containerPath: String;
|
|
1477
1544
|
/**
|
|
@@ -1525,7 +1592,7 @@ declare namespace Batch {
|
|
|
1525
1592
|
*/
|
|
1526
1593
|
computeResources?: ComputeResourceUpdate;
|
|
1527
1594
|
/**
|
|
1528
|
-
* The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. Depending on how you created your AWS Batch service role, its ARN
|
|
1595
|
+
* The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
|
|
1529
1596
|
*/
|
|
1530
1597
|
serviceRole?: String;
|
|
1531
1598
|
}
|
|
@@ -1553,7 +1620,7 @@ declare namespace Batch {
|
|
|
1553
1620
|
*/
|
|
1554
1621
|
priority?: Integer;
|
|
1555
1622
|
/**
|
|
1556
|
-
* Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should
|
|
1623
|
+
* Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
|
|
1557
1624
|
*/
|
|
1558
1625
|
computeEnvironmentOrder?: ComputeEnvironmentOrders;
|
|
1559
1626
|
}
|
|
@@ -1569,7 +1636,7 @@ declare namespace Batch {
|
|
|
1569
1636
|
}
|
|
1570
1637
|
export interface Volume {
|
|
1571
1638
|
/**
|
|
1572
|
-
* The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data
|
|
1639
|
+
* The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop running. This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.
|
|
1573
1640
|
*/
|
|
1574
1641
|
host?: Host;
|
|
1575
1642
|
/**
|