@aws-sdk/client-batch 3.325.0 → 3.326.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/CancelJobCommand.d.ts +4 -0
- package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +7 -0
- package/dist-types/commands/CreateJobQueueCommand.d.ts +7 -0
- package/dist-types/commands/CreateSchedulingPolicyCommand.d.ts +7 -0
- package/dist-types/commands/DeleteComputeEnvironmentCommand.d.ts +4 -0
- package/dist-types/commands/DeleteJobQueueCommand.d.ts +4 -0
- package/dist-types/commands/DeleteSchedulingPolicyCommand.d.ts +4 -0
- package/dist-types/commands/DeregisterJobDefinitionCommand.d.ts +4 -0
- package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts +69 -0
- package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +321 -0
- package/dist-types/commands/DescribeJobQueuesCommand.d.ts +26 -0
- package/dist-types/commands/DescribeJobsCommand.d.ts +396 -0
- package/dist-types/commands/DescribeSchedulingPoliciesCommand.d.ts +24 -0
- package/dist-types/commands/ListJobsCommand.d.ts +32 -0
- package/dist-types/commands/ListSchedulingPoliciesCommand.d.ts +11 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
- package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +8 -0
- package/dist-types/commands/SubmitJobCommand.d.ts +8 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/TerminateJobCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateComputeEnvironmentCommand.d.ts +7 -0
- package/dist-types/commands/UpdateJobQueueCommand.d.ts +7 -0
- package/dist-types/commands/UpdateSchedulingPolicyCommand.d.ts +4 -0
- package/package.json +3 -3
|
@@ -44,6 +44,8 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new CancelJobCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
47
49
|
* ```
|
|
48
50
|
*
|
|
49
51
|
* @param CancelJobCommandInput - {@link CancelJobCommandInput}
|
|
@@ -60,6 +62,8 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
|
|
|
60
62
|
* @throws {@link ServerException} (server fault)
|
|
61
63
|
* <p>These errors are usually caused by a server issue.</p>
|
|
62
64
|
*
|
|
65
|
+
* @throws {@link BatchServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
63
67
|
*
|
|
64
68
|
* @example To cancel a job
|
|
65
69
|
* ```javascript
|
|
@@ -157,6 +157,11 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
|
|
|
157
157
|
* };
|
|
158
158
|
* const command = new CreateComputeEnvironmentCommand(input);
|
|
159
159
|
* const response = await client.send(command);
|
|
160
|
+
* // { // CreateComputeEnvironmentResponse
|
|
161
|
+
* // computeEnvironmentName: "STRING_VALUE",
|
|
162
|
+
* // computeEnvironmentArn: "STRING_VALUE",
|
|
163
|
+
* // };
|
|
164
|
+
*
|
|
160
165
|
* ```
|
|
161
166
|
*
|
|
162
167
|
* @param CreateComputeEnvironmentCommandInput - {@link CreateComputeEnvironmentCommandInput}
|
|
@@ -173,6 +178,8 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
|
|
|
173
178
|
* @throws {@link ServerException} (server fault)
|
|
174
179
|
* <p>These errors are usually caused by a server issue.</p>
|
|
175
180
|
*
|
|
181
|
+
* @throws {@link BatchServiceException}
|
|
182
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
176
183
|
*
|
|
177
184
|
* @example To create a managed EC2 compute environment
|
|
178
185
|
* ```javascript
|
|
@@ -48,6 +48,11 @@ export interface CreateJobQueueCommandOutput extends CreateJobQueueResponse, __M
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new CreateJobQueueCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // { // CreateJobQueueResponse
|
|
52
|
+
* // jobQueueName: "STRING_VALUE", // required
|
|
53
|
+
* // jobQueueArn: "STRING_VALUE", // required
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
51
56
|
* ```
|
|
52
57
|
*
|
|
53
58
|
* @param CreateJobQueueCommandInput - {@link CreateJobQueueCommandInput}
|
|
@@ -64,6 +69,8 @@ export interface CreateJobQueueCommandOutput extends CreateJobQueueResponse, __M
|
|
|
64
69
|
* @throws {@link ServerException} (server fault)
|
|
65
70
|
* <p>These errors are usually caused by a server issue.</p>
|
|
66
71
|
*
|
|
72
|
+
* @throws {@link BatchServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
67
74
|
*
|
|
68
75
|
* @example To create a job queue with a single compute environment
|
|
69
76
|
* ```javascript
|
|
@@ -44,6 +44,11 @@ export interface CreateSchedulingPolicyCommandOutput extends CreateSchedulingPol
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new CreateSchedulingPolicyCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // { // CreateSchedulingPolicyResponse
|
|
48
|
+
* // name: "STRING_VALUE", // required
|
|
49
|
+
* // arn: "STRING_VALUE", // required
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
47
52
|
* ```
|
|
48
53
|
*
|
|
49
54
|
* @param CreateSchedulingPolicyCommandInput - {@link CreateSchedulingPolicyCommandInput}
|
|
@@ -60,6 +65,8 @@ export interface CreateSchedulingPolicyCommandOutput extends CreateSchedulingPol
|
|
|
60
65
|
* @throws {@link ServerException} (server fault)
|
|
61
66
|
* <p>These errors are usually caused by a server issue.</p>
|
|
62
67
|
*
|
|
68
|
+
* @throws {@link BatchServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
63
70
|
*
|
|
64
71
|
*/
|
|
65
72
|
export declare class CreateSchedulingPolicyCommand extends $Command<CreateSchedulingPolicyCommandInput, CreateSchedulingPolicyCommandOutput, BatchClientResolvedConfig> {
|
|
@@ -34,6 +34,8 @@ export interface DeleteComputeEnvironmentCommandOutput extends DeleteComputeEnvi
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DeleteComputeEnvironmentCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param DeleteComputeEnvironmentCommandInput - {@link DeleteComputeEnvironmentCommandInput}
|
|
@@ -50,6 +52,8 @@ export interface DeleteComputeEnvironmentCommandOutput extends DeleteComputeEnvi
|
|
|
50
52
|
* @throws {@link ServerException} (server fault)
|
|
51
53
|
* <p>These errors are usually caused by a server issue.</p>
|
|
52
54
|
*
|
|
55
|
+
* @throws {@link BatchServiceException}
|
|
56
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
53
57
|
*
|
|
54
58
|
* @example To delete a compute environment
|
|
55
59
|
* ```javascript
|
|
@@ -34,6 +34,8 @@ export interface DeleteJobQueueCommandOutput extends DeleteJobQueueResponse, __M
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DeleteJobQueueCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param DeleteJobQueueCommandInput - {@link DeleteJobQueueCommandInput}
|
|
@@ -50,6 +52,8 @@ export interface DeleteJobQueueCommandOutput extends DeleteJobQueueResponse, __M
|
|
|
50
52
|
* @throws {@link ServerException} (server fault)
|
|
51
53
|
* <p>These errors are usually caused by a server issue.</p>
|
|
52
54
|
*
|
|
55
|
+
* @throws {@link BatchServiceException}
|
|
56
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
53
57
|
*
|
|
54
58
|
* @example To delete a job queue
|
|
55
59
|
* ```javascript
|
|
@@ -32,6 +32,8 @@ export interface DeleteSchedulingPolicyCommandOutput extends DeleteSchedulingPol
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteSchedulingPolicyCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // {};
|
|
36
|
+
*
|
|
35
37
|
* ```
|
|
36
38
|
*
|
|
37
39
|
* @param DeleteSchedulingPolicyCommandInput - {@link DeleteSchedulingPolicyCommandInput}
|
|
@@ -48,6 +50,8 @@ export interface DeleteSchedulingPolicyCommandOutput extends DeleteSchedulingPol
|
|
|
48
50
|
* @throws {@link ServerException} (server fault)
|
|
49
51
|
* <p>These errors are usually caused by a server issue.</p>
|
|
50
52
|
*
|
|
53
|
+
* @throws {@link BatchServiceException}
|
|
54
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
51
55
|
*
|
|
52
56
|
*/
|
|
53
57
|
export declare class DeleteSchedulingPolicyCommand extends $Command<DeleteSchedulingPolicyCommandInput, DeleteSchedulingPolicyCommandOutput, BatchClientResolvedConfig> {
|
|
@@ -31,6 +31,8 @@ export interface DeregisterJobDefinitionCommandOutput extends DeregisterJobDefin
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DeregisterJobDefinitionCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // {};
|
|
35
|
+
*
|
|
34
36
|
* ```
|
|
35
37
|
*
|
|
36
38
|
* @param DeregisterJobDefinitionCommandInput - {@link DeregisterJobDefinitionCommandInput}
|
|
@@ -47,6 +49,8 @@ export interface DeregisterJobDefinitionCommandOutput extends DeregisterJobDefin
|
|
|
47
49
|
* @throws {@link ServerException} (server fault)
|
|
48
50
|
* <p>These errors are usually caused by a server issue.</p>
|
|
49
51
|
*
|
|
52
|
+
* @throws {@link BatchServiceException}
|
|
53
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
50
54
|
*
|
|
51
55
|
* @example To deregister a job definition
|
|
52
56
|
* ```javascript
|
|
@@ -38,6 +38,73 @@ export interface DescribeComputeEnvironmentsCommandOutput extends DescribeComput
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DescribeComputeEnvironmentsCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // DescribeComputeEnvironmentsResponse
|
|
42
|
+
* // computeEnvironments: [ // ComputeEnvironmentDetailList
|
|
43
|
+
* // { // ComputeEnvironmentDetail
|
|
44
|
+
* // computeEnvironmentName: "STRING_VALUE", // required
|
|
45
|
+
* // computeEnvironmentArn: "STRING_VALUE", // required
|
|
46
|
+
* // unmanagedvCpus: Number("int"),
|
|
47
|
+
* // ecsClusterArn: "STRING_VALUE",
|
|
48
|
+
* // tags: { // TagrisTagsMap
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // type: "MANAGED" || "UNMANAGED",
|
|
52
|
+
* // state: "ENABLED" || "DISABLED",
|
|
53
|
+
* // status: "CREATING" || "UPDATING" || "DELETING" || "DELETED" || "VALID" || "INVALID",
|
|
54
|
+
* // statusReason: "STRING_VALUE",
|
|
55
|
+
* // computeResources: { // ComputeResource
|
|
56
|
+
* // type: "EC2" || "SPOT" || "FARGATE" || "FARGATE_SPOT", // required
|
|
57
|
+
* // allocationStrategy: "BEST_FIT" || "BEST_FIT_PROGRESSIVE" || "SPOT_CAPACITY_OPTIMIZED",
|
|
58
|
+
* // minvCpus: Number("int"),
|
|
59
|
+
* // maxvCpus: Number("int"), // required
|
|
60
|
+
* // desiredvCpus: Number("int"),
|
|
61
|
+
* // instanceTypes: [ // StringList
|
|
62
|
+
* // "STRING_VALUE",
|
|
63
|
+
* // ],
|
|
64
|
+
* // imageId: "STRING_VALUE",
|
|
65
|
+
* // subnets: [ // required
|
|
66
|
+
* // "STRING_VALUE",
|
|
67
|
+
* // ],
|
|
68
|
+
* // securityGroupIds: [
|
|
69
|
+
* // "STRING_VALUE",
|
|
70
|
+
* // ],
|
|
71
|
+
* // ec2KeyPair: "STRING_VALUE",
|
|
72
|
+
* // instanceRole: "STRING_VALUE",
|
|
73
|
+
* // tags: { // TagsMap
|
|
74
|
+
* // "<keys>": "STRING_VALUE",
|
|
75
|
+
* // },
|
|
76
|
+
* // placementGroup: "STRING_VALUE",
|
|
77
|
+
* // bidPercentage: Number("int"),
|
|
78
|
+
* // spotIamFleetRole: "STRING_VALUE",
|
|
79
|
+
* // launchTemplate: { // LaunchTemplateSpecification
|
|
80
|
+
* // launchTemplateId: "STRING_VALUE",
|
|
81
|
+
* // launchTemplateName: "STRING_VALUE",
|
|
82
|
+
* // version: "STRING_VALUE",
|
|
83
|
+
* // },
|
|
84
|
+
* // ec2Configuration: [ // Ec2ConfigurationList
|
|
85
|
+
* // { // Ec2Configuration
|
|
86
|
+
* // imageType: "STRING_VALUE", // required
|
|
87
|
+
* // imageIdOverride: "STRING_VALUE",
|
|
88
|
+
* // imageKubernetesVersion: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
91
|
+
* // },
|
|
92
|
+
* // serviceRole: "STRING_VALUE",
|
|
93
|
+
* // updatePolicy: { // UpdatePolicy
|
|
94
|
+
* // terminateJobsOnUpdate: true || false,
|
|
95
|
+
* // jobExecutionTimeoutMinutes: Number("long"),
|
|
96
|
+
* // },
|
|
97
|
+
* // eksConfiguration: { // EksConfiguration
|
|
98
|
+
* // eksClusterArn: "STRING_VALUE", // required
|
|
99
|
+
* // kubernetesNamespace: "STRING_VALUE", // required
|
|
100
|
+
* // },
|
|
101
|
+
* // containerOrchestrationType: "ECS" || "EKS",
|
|
102
|
+
* // uuid: "STRING_VALUE",
|
|
103
|
+
* // },
|
|
104
|
+
* // ],
|
|
105
|
+
* // nextToken: "STRING_VALUE",
|
|
106
|
+
* // };
|
|
107
|
+
*
|
|
41
108
|
* ```
|
|
42
109
|
*
|
|
43
110
|
* @param DescribeComputeEnvironmentsCommandInput - {@link DescribeComputeEnvironmentsCommandInput}
|
|
@@ -54,6 +121,8 @@ export interface DescribeComputeEnvironmentsCommandOutput extends DescribeComput
|
|
|
54
121
|
* @throws {@link ServerException} (server fault)
|
|
55
122
|
* <p>These errors are usually caused by a server issue.</p>
|
|
56
123
|
*
|
|
124
|
+
* @throws {@link BatchServiceException}
|
|
125
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
57
126
|
*
|
|
58
127
|
* @example To describe a compute environment
|
|
59
128
|
* ```javascript
|
|
@@ -38,6 +38,325 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DescribeJobDefinitionsCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // DescribeJobDefinitionsResponse
|
|
42
|
+
* // jobDefinitions: [ // JobDefinitionList
|
|
43
|
+
* // { // JobDefinition
|
|
44
|
+
* // jobDefinitionName: "STRING_VALUE", // required
|
|
45
|
+
* // jobDefinitionArn: "STRING_VALUE", // required
|
|
46
|
+
* // revision: Number("int"), // required
|
|
47
|
+
* // status: "STRING_VALUE",
|
|
48
|
+
* // type: "STRING_VALUE", // required
|
|
49
|
+
* // schedulingPriority: Number("int"),
|
|
50
|
+
* // parameters: { // ParametersMap
|
|
51
|
+
* // "<keys>": "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // retryStrategy: { // RetryStrategy
|
|
54
|
+
* // attempts: Number("int"),
|
|
55
|
+
* // evaluateOnExit: [ // EvaluateOnExitList
|
|
56
|
+
* // { // EvaluateOnExit
|
|
57
|
+
* // onStatusReason: "STRING_VALUE",
|
|
58
|
+
* // onReason: "STRING_VALUE",
|
|
59
|
+
* // onExitCode: "STRING_VALUE",
|
|
60
|
+
* // action: "RETRY" || "EXIT", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // containerProperties: { // ContainerProperties
|
|
65
|
+
* // image: "STRING_VALUE",
|
|
66
|
+
* // vcpus: Number("int"),
|
|
67
|
+
* // memory: Number("int"),
|
|
68
|
+
* // command: [ // StringList
|
|
69
|
+
* // "STRING_VALUE",
|
|
70
|
+
* // ],
|
|
71
|
+
* // jobRoleArn: "STRING_VALUE",
|
|
72
|
+
* // executionRoleArn: "STRING_VALUE",
|
|
73
|
+
* // volumes: [ // Volumes
|
|
74
|
+
* // { // Volume
|
|
75
|
+
* // host: { // Host
|
|
76
|
+
* // sourcePath: "STRING_VALUE",
|
|
77
|
+
* // },
|
|
78
|
+
* // name: "STRING_VALUE",
|
|
79
|
+
* // efsVolumeConfiguration: { // EFSVolumeConfiguration
|
|
80
|
+
* // fileSystemId: "STRING_VALUE", // required
|
|
81
|
+
* // rootDirectory: "STRING_VALUE",
|
|
82
|
+
* // transitEncryption: "ENABLED" || "DISABLED",
|
|
83
|
+
* // transitEncryptionPort: Number("int"),
|
|
84
|
+
* // authorizationConfig: { // EFSAuthorizationConfig
|
|
85
|
+
* // accessPointId: "STRING_VALUE",
|
|
86
|
+
* // iam: "ENABLED" || "DISABLED",
|
|
87
|
+
* // },
|
|
88
|
+
* // },
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
91
|
+
* // environment: [ // EnvironmentVariables
|
|
92
|
+
* // { // KeyValuePair
|
|
93
|
+
* // name: "STRING_VALUE",
|
|
94
|
+
* // value: "STRING_VALUE",
|
|
95
|
+
* // },
|
|
96
|
+
* // ],
|
|
97
|
+
* // mountPoints: [ // MountPoints
|
|
98
|
+
* // { // MountPoint
|
|
99
|
+
* // containerPath: "STRING_VALUE",
|
|
100
|
+
* // readOnly: true || false,
|
|
101
|
+
* // sourceVolume: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // ],
|
|
104
|
+
* // readonlyRootFilesystem: true || false,
|
|
105
|
+
* // privileged: true || false,
|
|
106
|
+
* // ulimits: [ // Ulimits
|
|
107
|
+
* // { // Ulimit
|
|
108
|
+
* // hardLimit: Number("int"), // required
|
|
109
|
+
* // name: "STRING_VALUE", // required
|
|
110
|
+
* // softLimit: Number("int"), // required
|
|
111
|
+
* // },
|
|
112
|
+
* // ],
|
|
113
|
+
* // user: "STRING_VALUE",
|
|
114
|
+
* // instanceType: "STRING_VALUE",
|
|
115
|
+
* // resourceRequirements: [ // ResourceRequirements
|
|
116
|
+
* // { // ResourceRequirement
|
|
117
|
+
* // value: "STRING_VALUE", // required
|
|
118
|
+
* // type: "GPU" || "VCPU" || "MEMORY", // required
|
|
119
|
+
* // },
|
|
120
|
+
* // ],
|
|
121
|
+
* // linuxParameters: { // LinuxParameters
|
|
122
|
+
* // devices: [ // DevicesList
|
|
123
|
+
* // { // Device
|
|
124
|
+
* // hostPath: "STRING_VALUE", // required
|
|
125
|
+
* // containerPath: "STRING_VALUE",
|
|
126
|
+
* // permissions: [ // DeviceCgroupPermissions
|
|
127
|
+
* // "READ" || "WRITE" || "MKNOD",
|
|
128
|
+
* // ],
|
|
129
|
+
* // },
|
|
130
|
+
* // ],
|
|
131
|
+
* // initProcessEnabled: true || false,
|
|
132
|
+
* // sharedMemorySize: Number("int"),
|
|
133
|
+
* // tmpfs: [ // TmpfsList
|
|
134
|
+
* // { // Tmpfs
|
|
135
|
+
* // containerPath: "STRING_VALUE", // required
|
|
136
|
+
* // size: Number("int"), // required
|
|
137
|
+
* // mountOptions: [
|
|
138
|
+
* // "STRING_VALUE",
|
|
139
|
+
* // ],
|
|
140
|
+
* // },
|
|
141
|
+
* // ],
|
|
142
|
+
* // maxSwap: Number("int"),
|
|
143
|
+
* // swappiness: Number("int"),
|
|
144
|
+
* // },
|
|
145
|
+
* // logConfiguration: { // LogConfiguration
|
|
146
|
+
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
|
|
147
|
+
* // options: { // LogConfigurationOptionsMap
|
|
148
|
+
* // "<keys>": "STRING_VALUE",
|
|
149
|
+
* // },
|
|
150
|
+
* // secretOptions: [ // SecretList
|
|
151
|
+
* // { // Secret
|
|
152
|
+
* // name: "STRING_VALUE", // required
|
|
153
|
+
* // valueFrom: "STRING_VALUE", // required
|
|
154
|
+
* // },
|
|
155
|
+
* // ],
|
|
156
|
+
* // },
|
|
157
|
+
* // secrets: [
|
|
158
|
+
* // {
|
|
159
|
+
* // name: "STRING_VALUE", // required
|
|
160
|
+
* // valueFrom: "STRING_VALUE", // required
|
|
161
|
+
* // },
|
|
162
|
+
* // ],
|
|
163
|
+
* // networkConfiguration: { // NetworkConfiguration
|
|
164
|
+
* // assignPublicIp: "ENABLED" || "DISABLED",
|
|
165
|
+
* // },
|
|
166
|
+
* // fargatePlatformConfiguration: { // FargatePlatformConfiguration
|
|
167
|
+
* // platformVersion: "STRING_VALUE",
|
|
168
|
+
* // },
|
|
169
|
+
* // ephemeralStorage: { // EphemeralStorage
|
|
170
|
+
* // sizeInGiB: Number("int"), // required
|
|
171
|
+
* // },
|
|
172
|
+
* // },
|
|
173
|
+
* // timeout: { // JobTimeout
|
|
174
|
+
* // attemptDurationSeconds: Number("int"),
|
|
175
|
+
* // },
|
|
176
|
+
* // nodeProperties: { // NodeProperties
|
|
177
|
+
* // numNodes: Number("int"), // required
|
|
178
|
+
* // mainNode: Number("int"), // required
|
|
179
|
+
* // nodeRangeProperties: [ // NodeRangeProperties // required
|
|
180
|
+
* // { // NodeRangeProperty
|
|
181
|
+
* // targetNodes: "STRING_VALUE", // required
|
|
182
|
+
* // container: {
|
|
183
|
+
* // image: "STRING_VALUE",
|
|
184
|
+
* // vcpus: Number("int"),
|
|
185
|
+
* // memory: Number("int"),
|
|
186
|
+
* // command: [
|
|
187
|
+
* // "STRING_VALUE",
|
|
188
|
+
* // ],
|
|
189
|
+
* // jobRoleArn: "STRING_VALUE",
|
|
190
|
+
* // executionRoleArn: "STRING_VALUE",
|
|
191
|
+
* // volumes: [
|
|
192
|
+
* // {
|
|
193
|
+
* // host: {
|
|
194
|
+
* // sourcePath: "STRING_VALUE",
|
|
195
|
+
* // },
|
|
196
|
+
* // name: "STRING_VALUE",
|
|
197
|
+
* // efsVolumeConfiguration: {
|
|
198
|
+
* // fileSystemId: "STRING_VALUE", // required
|
|
199
|
+
* // rootDirectory: "STRING_VALUE",
|
|
200
|
+
* // transitEncryption: "ENABLED" || "DISABLED",
|
|
201
|
+
* // transitEncryptionPort: Number("int"),
|
|
202
|
+
* // authorizationConfig: {
|
|
203
|
+
* // accessPointId: "STRING_VALUE",
|
|
204
|
+
* // iam: "ENABLED" || "DISABLED",
|
|
205
|
+
* // },
|
|
206
|
+
* // },
|
|
207
|
+
* // },
|
|
208
|
+
* // ],
|
|
209
|
+
* // environment: [
|
|
210
|
+
* // {
|
|
211
|
+
* // name: "STRING_VALUE",
|
|
212
|
+
* // value: "STRING_VALUE",
|
|
213
|
+
* // },
|
|
214
|
+
* // ],
|
|
215
|
+
* // mountPoints: [
|
|
216
|
+
* // {
|
|
217
|
+
* // containerPath: "STRING_VALUE",
|
|
218
|
+
* // readOnly: true || false,
|
|
219
|
+
* // sourceVolume: "STRING_VALUE",
|
|
220
|
+
* // },
|
|
221
|
+
* // ],
|
|
222
|
+
* // readonlyRootFilesystem: true || false,
|
|
223
|
+
* // privileged: true || false,
|
|
224
|
+
* // ulimits: [
|
|
225
|
+
* // {
|
|
226
|
+
* // hardLimit: Number("int"), // required
|
|
227
|
+
* // name: "STRING_VALUE", // required
|
|
228
|
+
* // softLimit: Number("int"), // required
|
|
229
|
+
* // },
|
|
230
|
+
* // ],
|
|
231
|
+
* // user: "STRING_VALUE",
|
|
232
|
+
* // instanceType: "STRING_VALUE",
|
|
233
|
+
* // resourceRequirements: [
|
|
234
|
+
* // {
|
|
235
|
+
* // value: "STRING_VALUE", // required
|
|
236
|
+
* // type: "GPU" || "VCPU" || "MEMORY", // required
|
|
237
|
+
* // },
|
|
238
|
+
* // ],
|
|
239
|
+
* // linuxParameters: {
|
|
240
|
+
* // devices: [
|
|
241
|
+
* // {
|
|
242
|
+
* // hostPath: "STRING_VALUE", // required
|
|
243
|
+
* // containerPath: "STRING_VALUE",
|
|
244
|
+
* // permissions: [
|
|
245
|
+
* // "READ" || "WRITE" || "MKNOD",
|
|
246
|
+
* // ],
|
|
247
|
+
* // },
|
|
248
|
+
* // ],
|
|
249
|
+
* // initProcessEnabled: true || false,
|
|
250
|
+
* // sharedMemorySize: Number("int"),
|
|
251
|
+
* // tmpfs: [
|
|
252
|
+
* // {
|
|
253
|
+
* // containerPath: "STRING_VALUE", // required
|
|
254
|
+
* // size: Number("int"), // required
|
|
255
|
+
* // mountOptions: "<StringList>",
|
|
256
|
+
* // },
|
|
257
|
+
* // ],
|
|
258
|
+
* // maxSwap: Number("int"),
|
|
259
|
+
* // swappiness: Number("int"),
|
|
260
|
+
* // },
|
|
261
|
+
* // logConfiguration: {
|
|
262
|
+
* // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk", // required
|
|
263
|
+
* // options: {
|
|
264
|
+
* // "<keys>": "STRING_VALUE",
|
|
265
|
+
* // },
|
|
266
|
+
* // secretOptions: "<SecretList>",
|
|
267
|
+
* // },
|
|
268
|
+
* // secrets: "<SecretList>",
|
|
269
|
+
* // networkConfiguration: {
|
|
270
|
+
* // assignPublicIp: "ENABLED" || "DISABLED",
|
|
271
|
+
* // },
|
|
272
|
+
* // fargatePlatformConfiguration: {
|
|
273
|
+
* // platformVersion: "STRING_VALUE",
|
|
274
|
+
* // },
|
|
275
|
+
* // ephemeralStorage: {
|
|
276
|
+
* // sizeInGiB: Number("int"), // required
|
|
277
|
+
* // },
|
|
278
|
+
* // },
|
|
279
|
+
* // },
|
|
280
|
+
* // ],
|
|
281
|
+
* // },
|
|
282
|
+
* // tags: { // TagrisTagsMap
|
|
283
|
+
* // "<keys>": "STRING_VALUE",
|
|
284
|
+
* // },
|
|
285
|
+
* // propagateTags: true || false,
|
|
286
|
+
* // platformCapabilities: [ // PlatformCapabilityList
|
|
287
|
+
* // "EC2" || "FARGATE",
|
|
288
|
+
* // ],
|
|
289
|
+
* // eksProperties: { // EksProperties
|
|
290
|
+
* // podProperties: { // EksPodProperties
|
|
291
|
+
* // serviceAccountName: "STRING_VALUE",
|
|
292
|
+
* // hostNetwork: true || false,
|
|
293
|
+
* // dnsPolicy: "STRING_VALUE",
|
|
294
|
+
* // containers: [ // EksContainers
|
|
295
|
+
* // { // EksContainer
|
|
296
|
+
* // name: "STRING_VALUE",
|
|
297
|
+
* // image: "STRING_VALUE", // required
|
|
298
|
+
* // imagePullPolicy: "STRING_VALUE",
|
|
299
|
+
* // command: "<StringList>",
|
|
300
|
+
* // args: "<StringList>",
|
|
301
|
+
* // env: [ // EksContainerEnvironmentVariables
|
|
302
|
+
* // { // EksContainerEnvironmentVariable
|
|
303
|
+
* // name: "STRING_VALUE", // required
|
|
304
|
+
* // value: "STRING_VALUE",
|
|
305
|
+
* // },
|
|
306
|
+
* // ],
|
|
307
|
+
* // resources: { // EksContainerResourceRequirements
|
|
308
|
+
* // limits: { // EksLimits
|
|
309
|
+
* // "<keys>": "STRING_VALUE",
|
|
310
|
+
* // },
|
|
311
|
+
* // requests: { // EksRequests
|
|
312
|
+
* // "<keys>": "STRING_VALUE",
|
|
313
|
+
* // },
|
|
314
|
+
* // },
|
|
315
|
+
* // volumeMounts: [ // EksContainerVolumeMounts
|
|
316
|
+
* // { // EksContainerVolumeMount
|
|
317
|
+
* // name: "STRING_VALUE",
|
|
318
|
+
* // mountPath: "STRING_VALUE",
|
|
319
|
+
* // readOnly: true || false,
|
|
320
|
+
* // },
|
|
321
|
+
* // ],
|
|
322
|
+
* // securityContext: { // EksContainerSecurityContext
|
|
323
|
+
* // runAsUser: Number("long"),
|
|
324
|
+
* // runAsGroup: Number("long"),
|
|
325
|
+
* // privileged: true || false,
|
|
326
|
+
* // readOnlyRootFilesystem: true || false,
|
|
327
|
+
* // runAsNonRoot: true || false,
|
|
328
|
+
* // },
|
|
329
|
+
* // },
|
|
330
|
+
* // ],
|
|
331
|
+
* // volumes: [ // EksVolumes
|
|
332
|
+
* // { // EksVolume
|
|
333
|
+
* // name: "STRING_VALUE", // required
|
|
334
|
+
* // hostPath: { // EksHostPath
|
|
335
|
+
* // path: "STRING_VALUE",
|
|
336
|
+
* // },
|
|
337
|
+
* // emptyDir: { // EksEmptyDir
|
|
338
|
+
* // medium: "STRING_VALUE",
|
|
339
|
+
* // sizeLimit: "STRING_VALUE",
|
|
340
|
+
* // },
|
|
341
|
+
* // secret: { // EksSecret
|
|
342
|
+
* // secretName: "STRING_VALUE", // required
|
|
343
|
+
* // optional: true || false,
|
|
344
|
+
* // },
|
|
345
|
+
* // },
|
|
346
|
+
* // ],
|
|
347
|
+
* // metadata: { // EksMetadata
|
|
348
|
+
* // labels: { // EksLabelsMap
|
|
349
|
+
* // "<keys>": "STRING_VALUE",
|
|
350
|
+
* // },
|
|
351
|
+
* // },
|
|
352
|
+
* // },
|
|
353
|
+
* // },
|
|
354
|
+
* // containerOrchestrationType: "ECS" || "EKS",
|
|
355
|
+
* // },
|
|
356
|
+
* // ],
|
|
357
|
+
* // nextToken: "STRING_VALUE",
|
|
358
|
+
* // };
|
|
359
|
+
*
|
|
41
360
|
* ```
|
|
42
361
|
*
|
|
43
362
|
* @param DescribeJobDefinitionsCommandInput - {@link DescribeJobDefinitionsCommandInput}
|
|
@@ -54,6 +373,8 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
|
|
|
54
373
|
* @throws {@link ServerException} (server fault)
|
|
55
374
|
* <p>These errors are usually caused by a server issue.</p>
|
|
56
375
|
*
|
|
376
|
+
* @throws {@link BatchServiceException}
|
|
377
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
57
378
|
*
|
|
58
379
|
* @example To describe active job definitions
|
|
59
380
|
* ```javascript
|
|
@@ -35,6 +35,30 @@ export interface DescribeJobQueuesCommandOutput extends DescribeJobQueuesRespons
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DescribeJobQueuesCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // DescribeJobQueuesResponse
|
|
39
|
+
* // jobQueues: [ // JobQueueDetailList
|
|
40
|
+
* // { // JobQueueDetail
|
|
41
|
+
* // jobQueueName: "STRING_VALUE", // required
|
|
42
|
+
* // jobQueueArn: "STRING_VALUE", // required
|
|
43
|
+
* // state: "ENABLED" || "DISABLED", // required
|
|
44
|
+
* // schedulingPolicyArn: "STRING_VALUE",
|
|
45
|
+
* // status: "CREATING" || "UPDATING" || "DELETING" || "DELETED" || "VALID" || "INVALID",
|
|
46
|
+
* // statusReason: "STRING_VALUE",
|
|
47
|
+
* // priority: Number("int"), // required
|
|
48
|
+
* // computeEnvironmentOrder: [ // ComputeEnvironmentOrders // required
|
|
49
|
+
* // { // ComputeEnvironmentOrder
|
|
50
|
+
* // order: Number("int"), // required
|
|
51
|
+
* // computeEnvironment: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // tags: { // TagrisTagsMap
|
|
55
|
+
* // "<keys>": "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // nextToken: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
38
62
|
* ```
|
|
39
63
|
*
|
|
40
64
|
* @param DescribeJobQueuesCommandInput - {@link DescribeJobQueuesCommandInput}
|
|
@@ -51,6 +75,8 @@ export interface DescribeJobQueuesCommandOutput extends DescribeJobQueuesRespons
|
|
|
51
75
|
* @throws {@link ServerException} (server fault)
|
|
52
76
|
* <p>These errors are usually caused by a server issue.</p>
|
|
53
77
|
*
|
|
78
|
+
* @throws {@link BatchServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
54
80
|
*
|
|
55
81
|
* @example To describe a job queue
|
|
56
82
|
* ```javascript
|