@aws-sdk/client-batch 3.848.0 → 3.856.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/README.md +64 -0
- package/dist-cjs/index.js +490 -3
- package/dist-es/Batch.js +16 -0
- package/dist-es/commands/CreateServiceEnvironmentCommand.js +22 -0
- package/dist-es/commands/DeleteServiceEnvironmentCommand.js +22 -0
- package/dist-es/commands/DescribeServiceEnvironmentsCommand.js +22 -0
- package/dist-es/commands/DescribeServiceJobCommand.js +22 -0
- package/dist-es/commands/ListServiceJobsCommand.js +22 -0
- package/dist-es/commands/SubmitServiceJobCommand.js +22 -0
- package/dist-es/commands/TerminateServiceJobCommand.js +22 -0
- package/dist-es/commands/UpdateServiceEnvironmentCommand.js +22 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +42 -0
- package/dist-es/pagination/DescribeServiceEnvironmentsPaginator.js +4 -0
- package/dist-es/pagination/ListServiceJobsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +257 -0
- package/dist-types/Batch.d.ts +58 -0
- package/dist-types/BatchClient.d.ts +10 -2
- package/dist-types/commands/CreateJobQueueCommand.d.ts +9 -2
- package/dist-types/commands/CreateServiceEnvironmentCommand.d.ts +92 -0
- package/dist-types/commands/DeleteServiceEnvironmentCommand.d.ts +78 -0
- package/dist-types/commands/DescribeJobQueuesCommand.d.ts +8 -1
- package/dist-types/commands/DescribeServiceEnvironmentsCommand.d.ts +102 -0
- package/dist-types/commands/DescribeServiceJobCommand.d.ts +125 -0
- package/dist-types/commands/ListServiceJobsCommand.d.ts +111 -0
- package/dist-types/commands/SubmitServiceJobCommand.d.ts +103 -0
- package/dist-types/commands/TerminateServiceJobCommand.d.ts +79 -0
- package/dist-types/commands/UpdateJobQueueCommand.d.ts +7 -1
- package/dist-types/commands/UpdateServiceEnvironmentCommand.d.ts +88 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/models_0.d.ts +843 -75
- package/dist-types/pagination/DescribeServiceEnvironmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListServiceJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
- package/dist-types/ts3.4/Batch.d.ts +138 -0
- package/dist-types/ts3.4/BatchClient.d.ts +50 -2
- package/dist-types/ts3.4/commands/CreateServiceEnvironmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteServiceEnvironmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeServiceEnvironmentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeServiceJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListServiceJobsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/SubmitServiceJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/TerminateServiceJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateServiceEnvironmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +207 -1
- package/dist-types/ts3.4/pagination/DescribeServiceEnvironmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListServiceJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
- package/package.json +5 -5
|
@@ -1112,12 +1112,27 @@ export interface ComputeEnvironmentOrder {
|
|
|
1112
1112
|
*/
|
|
1113
1113
|
computeEnvironment: string | undefined;
|
|
1114
1114
|
}
|
|
1115
|
+
/**
|
|
1116
|
+
* @public
|
|
1117
|
+
* @enum
|
|
1118
|
+
*/
|
|
1119
|
+
export declare const JobQueueType: {
|
|
1120
|
+
readonly ECS: "ECS";
|
|
1121
|
+
readonly ECS_FARGATE: "ECS_FARGATE";
|
|
1122
|
+
readonly EKS: "EKS";
|
|
1123
|
+
readonly SAGEMAKER_TRAINING: "SAGEMAKER_TRAINING";
|
|
1124
|
+
};
|
|
1125
|
+
/**
|
|
1126
|
+
* @public
|
|
1127
|
+
*/
|
|
1128
|
+
export type JobQueueType = (typeof JobQueueType)[keyof typeof JobQueueType];
|
|
1115
1129
|
/**
|
|
1116
1130
|
* @public
|
|
1117
1131
|
* @enum
|
|
1118
1132
|
*/
|
|
1119
1133
|
export declare const JobStateTimeLimitActionsAction: {
|
|
1120
1134
|
readonly CANCEL: "CANCEL";
|
|
1135
|
+
readonly TERMINATE: "TERMINATE";
|
|
1121
1136
|
};
|
|
1122
1137
|
/**
|
|
1123
1138
|
* @public
|
|
@@ -1162,6 +1177,22 @@ export interface JobStateTimeLimitAction {
|
|
|
1162
1177
|
*/
|
|
1163
1178
|
action: JobStateTimeLimitActionsAction | undefined;
|
|
1164
1179
|
}
|
|
1180
|
+
/**
|
|
1181
|
+
* <p>Specifies the order of a service environment for a job queue. This determines the priority order when multiple service environments are associated with the same job queue.</p>
|
|
1182
|
+
* @public
|
|
1183
|
+
*/
|
|
1184
|
+
export interface ServiceEnvironmentOrder {
|
|
1185
|
+
/**
|
|
1186
|
+
* <p>The order of the service environment. Job queues with a higher priority are evaluated first when associated with the same service environment.</p>
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
order: number | undefined;
|
|
1190
|
+
/**
|
|
1191
|
+
* <p>The name or ARN of the service environment.</p>
|
|
1192
|
+
* @public
|
|
1193
|
+
*/
|
|
1194
|
+
serviceEnvironment: string | undefined;
|
|
1195
|
+
}
|
|
1165
1196
|
/**
|
|
1166
1197
|
* @public
|
|
1167
1198
|
* @enum
|
|
@@ -1229,7 +1260,17 @@ export interface CreateJobQueueRequest {
|
|
|
1229
1260
|
* </note>
|
|
1230
1261
|
* @public
|
|
1231
1262
|
*/
|
|
1232
|
-
computeEnvironmentOrder
|
|
1263
|
+
computeEnvironmentOrder?: ComputeEnvironmentOrder[] | undefined;
|
|
1264
|
+
/**
|
|
1265
|
+
* <p>A list of service environments that this job queue can use to allocate jobs. All serviceEnvironments must have the same type. A job queue can't have both a serviceEnvironmentOrder and a computeEnvironmentOrder field.</p>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
serviceEnvironmentOrder?: ServiceEnvironmentOrder[] | undefined;
|
|
1269
|
+
/**
|
|
1270
|
+
* <p>The type of job queue. For service jobs that run on SageMaker Training, this value is <code>SAGEMAKER_TRAINING</code>. For regular container jobs, this value is <code>EKS</code>, <code>ECS</code>, or <code>ECS_FARGATE</code> depending on the compute environment.</p>
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
jobQueueType?: JobQueueType | undefined;
|
|
1233
1274
|
/**
|
|
1234
1275
|
* <p>The tags that you apply to the job queue to help you categorize and organize your
|
|
1235
1276
|
* resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>
|
|
@@ -1374,6 +1415,94 @@ export interface CreateSchedulingPolicyResponse {
|
|
|
1374
1415
|
*/
|
|
1375
1416
|
arn: string | undefined;
|
|
1376
1417
|
}
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>Defines the capacity limit for a service environment. This structure specifies the maximum amount of resources that can be used by service jobs in the environment.</p>
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
export interface CapacityLimit {
|
|
1423
|
+
/**
|
|
1424
|
+
* <p>The maximum capacity available for the service environment. This value represents the maximum amount of resources that can be allocated to service jobs.</p>
|
|
1425
|
+
* <p>For example, <code>maxCapacity=50</code>, <code>capacityUnit=NUM_INSTANCES</code>. This indicates that the
|
|
1426
|
+
* maximum number of instances that can be run on this service environment is 50. You could
|
|
1427
|
+
* then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that
|
|
1428
|
+
* requires 10 instances, it will wait in the queue.</p>
|
|
1429
|
+
* @public
|
|
1430
|
+
*/
|
|
1431
|
+
maxCapacity?: number | undefined;
|
|
1432
|
+
/**
|
|
1433
|
+
* <p>The unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For <code>SAGEMAKER_TRAINING</code> jobs, use <code>NUM_INSTANCES</code>.</p>
|
|
1434
|
+
* @public
|
|
1435
|
+
*/
|
|
1436
|
+
capacityUnit?: string | undefined;
|
|
1437
|
+
}
|
|
1438
|
+
/**
|
|
1439
|
+
* @public
|
|
1440
|
+
* @enum
|
|
1441
|
+
*/
|
|
1442
|
+
export declare const ServiceEnvironmentType: {
|
|
1443
|
+
readonly SAGEMAKER_TRAINING: "SAGEMAKER_TRAINING";
|
|
1444
|
+
};
|
|
1445
|
+
/**
|
|
1446
|
+
* @public
|
|
1447
|
+
*/
|
|
1448
|
+
export type ServiceEnvironmentType = (typeof ServiceEnvironmentType)[keyof typeof ServiceEnvironmentType];
|
|
1449
|
+
/**
|
|
1450
|
+
* @public
|
|
1451
|
+
* @enum
|
|
1452
|
+
*/
|
|
1453
|
+
export declare const ServiceEnvironmentState: {
|
|
1454
|
+
readonly DISABLED: "DISABLED";
|
|
1455
|
+
readonly ENABLED: "ENABLED";
|
|
1456
|
+
};
|
|
1457
|
+
/**
|
|
1458
|
+
* @public
|
|
1459
|
+
*/
|
|
1460
|
+
export type ServiceEnvironmentState = (typeof ServiceEnvironmentState)[keyof typeof ServiceEnvironmentState];
|
|
1461
|
+
/**
|
|
1462
|
+
* @public
|
|
1463
|
+
*/
|
|
1464
|
+
export interface CreateServiceEnvironmentRequest {
|
|
1465
|
+
/**
|
|
1466
|
+
* <p>The name for the service environment. It can be up to 128 characters long and can contain letters, numbers, hyphens (-), and underscores (_).</p>
|
|
1467
|
+
* @public
|
|
1468
|
+
*/
|
|
1469
|
+
serviceEnvironmentName: string | undefined;
|
|
1470
|
+
/**
|
|
1471
|
+
* <p>The type of service environment. For SageMaker Training jobs, specify <code>SAGEMAKER_TRAINING</code>.</p>
|
|
1472
|
+
* @public
|
|
1473
|
+
*/
|
|
1474
|
+
serviceEnvironmentType: ServiceEnvironmentType | undefined;
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>The state of the service environment. Valid values are <code>ENABLED</code> and <code>DISABLED</code>. The default value is <code>ENABLED</code>.</p>
|
|
1477
|
+
* @public
|
|
1478
|
+
*/
|
|
1479
|
+
state?: ServiceEnvironmentState | undefined;
|
|
1480
|
+
/**
|
|
1481
|
+
* <p>The capacity limits for the service environment. The number of instances a job consumes is the total number of instances requested in the submit training job request resource configuration.</p>
|
|
1482
|
+
* @public
|
|
1483
|
+
*/
|
|
1484
|
+
capacityLimits: CapacityLimit[] | undefined;
|
|
1485
|
+
/**
|
|
1486
|
+
* <p>The tags that you apply to the service environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
|
|
1487
|
+
* @public
|
|
1488
|
+
*/
|
|
1489
|
+
tags?: Record<string, string> | undefined;
|
|
1490
|
+
}
|
|
1491
|
+
/**
|
|
1492
|
+
* @public
|
|
1493
|
+
*/
|
|
1494
|
+
export interface CreateServiceEnvironmentResponse {
|
|
1495
|
+
/**
|
|
1496
|
+
* <p>The name of the service environment.</p>
|
|
1497
|
+
* @public
|
|
1498
|
+
*/
|
|
1499
|
+
serviceEnvironmentName: string | undefined;
|
|
1500
|
+
/**
|
|
1501
|
+
* <p>The Amazon Resource Name (ARN) of the service environment.</p>
|
|
1502
|
+
* @public
|
|
1503
|
+
*/
|
|
1504
|
+
serviceEnvironmentArn: string | undefined;
|
|
1505
|
+
}
|
|
1377
1506
|
/**
|
|
1378
1507
|
* <p>Contains the parameters for <code>DeleteComputeEnvironment</code>.</p>
|
|
1379
1508
|
* @public
|
|
@@ -1437,6 +1566,21 @@ export interface DeleteSchedulingPolicyRequest {
|
|
|
1437
1566
|
*/
|
|
1438
1567
|
export interface DeleteSchedulingPolicyResponse {
|
|
1439
1568
|
}
|
|
1569
|
+
/**
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
export interface DeleteServiceEnvironmentRequest {
|
|
1573
|
+
/**
|
|
1574
|
+
* <p>The name or ARN of the service environment to delete.</p>
|
|
1575
|
+
* @public
|
|
1576
|
+
*/
|
|
1577
|
+
serviceEnvironment: string | undefined;
|
|
1578
|
+
}
|
|
1579
|
+
/**
|
|
1580
|
+
* @public
|
|
1581
|
+
*/
|
|
1582
|
+
export interface DeleteServiceEnvironmentResponse {
|
|
1583
|
+
}
|
|
1440
1584
|
/**
|
|
1441
1585
|
* @public
|
|
1442
1586
|
*/
|
|
@@ -4401,6 +4545,16 @@ export interface JobQueueDetail {
|
|
|
4401
4545
|
* @public
|
|
4402
4546
|
*/
|
|
4403
4547
|
computeEnvironmentOrder: ComputeEnvironmentOrder[] | undefined;
|
|
4548
|
+
/**
|
|
4549
|
+
* <p>The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.</p>
|
|
4550
|
+
* @public
|
|
4551
|
+
*/
|
|
4552
|
+
serviceEnvironmentOrder?: ServiceEnvironmentOrder[] | undefined;
|
|
4553
|
+
/**
|
|
4554
|
+
* <p>The type of job queue. For service jobs that run on SageMaker Training, this value is <code>SAGEMAKER_TRAINING</code>. For regular container jobs, this value is <code>EKS</code>, <code>ECS</code>, or <code>ECS_FARGATE</code> depending on the compute environment.</p>
|
|
4555
|
+
* @public
|
|
4556
|
+
*/
|
|
4557
|
+
jobQueueType?: JobQueueType | undefined;
|
|
4404
4558
|
/**
|
|
4405
4559
|
* <p>The tags that are applied to the job queue. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a> in
|
|
4406
4560
|
* <i>Batch User Guide</i>.</p>
|
|
@@ -5629,150 +5783,504 @@ export interface DescribeSchedulingPoliciesResponse {
|
|
|
5629
5783
|
/**
|
|
5630
5784
|
* @public
|
|
5631
5785
|
*/
|
|
5632
|
-
export interface
|
|
5786
|
+
export interface DescribeServiceEnvironmentsRequest {
|
|
5633
5787
|
/**
|
|
5634
|
-
* <p>
|
|
5788
|
+
* <p>An array of service environment names or ARN entries.</p>
|
|
5635
5789
|
* @public
|
|
5636
5790
|
*/
|
|
5637
|
-
|
|
5791
|
+
serviceEnvironments?: string[] | undefined;
|
|
5792
|
+
/**
|
|
5793
|
+
* <p>The maximum number of results returned by <code>DescribeServiceEnvironments</code> in paginated output. When this parameter is used, <code>DescribeServiceEnvironments</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeServiceEnvironments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeServiceEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
|
|
5794
|
+
* @public
|
|
5795
|
+
*/
|
|
5796
|
+
maxResults?: number | undefined;
|
|
5797
|
+
/**
|
|
5798
|
+
* <p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeServiceEnvironments</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p>
|
|
5799
|
+
* <note>
|
|
5800
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
5801
|
+
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
5802
|
+
* </note>
|
|
5803
|
+
* @public
|
|
5804
|
+
*/
|
|
5805
|
+
nextToken?: string | undefined;
|
|
5638
5806
|
}
|
|
5639
5807
|
/**
|
|
5640
|
-
* <p>An object that represents summary details for the first 100 <code>RUNNABLE</code> jobs in a job queue.</p>
|
|
5641
5808
|
* @public
|
|
5809
|
+
* @enum
|
|
5642
5810
|
*/
|
|
5643
|
-
export
|
|
5811
|
+
export declare const ServiceEnvironmentStatus: {
|
|
5812
|
+
readonly CREATING: "CREATING";
|
|
5813
|
+
readonly DELETED: "DELETED";
|
|
5814
|
+
readonly DELETING: "DELETING";
|
|
5815
|
+
readonly INVALID: "INVALID";
|
|
5816
|
+
readonly UPDATING: "UPDATING";
|
|
5817
|
+
readonly VALID: "VALID";
|
|
5818
|
+
};
|
|
5819
|
+
/**
|
|
5820
|
+
* @public
|
|
5821
|
+
*/
|
|
5822
|
+
export type ServiceEnvironmentStatus = (typeof ServiceEnvironmentStatus)[keyof typeof ServiceEnvironmentStatus];
|
|
5823
|
+
/**
|
|
5824
|
+
* <p>Detailed information about a service environment, including its configuration, state, and capacity limits.</p>
|
|
5825
|
+
* @public
|
|
5826
|
+
*/
|
|
5827
|
+
export interface ServiceEnvironmentDetail {
|
|
5644
5828
|
/**
|
|
5645
|
-
* <p>The
|
|
5829
|
+
* <p>The name of the service environment.</p>
|
|
5646
5830
|
* @public
|
|
5647
5831
|
*/
|
|
5648
|
-
|
|
5832
|
+
serviceEnvironmentName: string | undefined;
|
|
5649
5833
|
/**
|
|
5650
|
-
* <p>The
|
|
5834
|
+
* <p>The Amazon Resource Name (ARN) of the service environment.</p>
|
|
5651
5835
|
* @public
|
|
5652
5836
|
*/
|
|
5653
|
-
|
|
5837
|
+
serviceEnvironmentArn: string | undefined;
|
|
5838
|
+
/**
|
|
5839
|
+
* <p>The type of service environment. For SageMaker Training jobs, this value is <code>SAGEMAKER_TRAINING</code>.</p>
|
|
5840
|
+
* @public
|
|
5841
|
+
*/
|
|
5842
|
+
serviceEnvironmentType: ServiceEnvironmentType | undefined;
|
|
5843
|
+
/**
|
|
5844
|
+
* <p>The state of the service environment. Valid values are <code>ENABLED</code> and <code>DISABLED</code>.</p>
|
|
5845
|
+
* @public
|
|
5846
|
+
*/
|
|
5847
|
+
state?: ServiceEnvironmentState | undefined;
|
|
5848
|
+
/**
|
|
5849
|
+
* <p>The current status of the service environment.</p>
|
|
5850
|
+
* @public
|
|
5851
|
+
*/
|
|
5852
|
+
status?: ServiceEnvironmentStatus | undefined;
|
|
5853
|
+
/**
|
|
5854
|
+
* <p>The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.</p>
|
|
5855
|
+
* @public
|
|
5856
|
+
*/
|
|
5857
|
+
capacityLimits: CapacityLimit[] | undefined;
|
|
5858
|
+
/**
|
|
5859
|
+
* <p>The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
|
|
5860
|
+
* @public
|
|
5861
|
+
*/
|
|
5862
|
+
tags?: Record<string, string> | undefined;
|
|
5654
5863
|
}
|
|
5655
5864
|
/**
|
|
5656
|
-
* <p>Contains a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>
|
|
5657
5865
|
* @public
|
|
5658
5866
|
*/
|
|
5659
|
-
export interface
|
|
5867
|
+
export interface DescribeServiceEnvironmentsResponse {
|
|
5660
5868
|
/**
|
|
5661
|
-
* <p>The
|
|
5869
|
+
* <p>The list of service environments that match the request.</p>
|
|
5662
5870
|
* @public
|
|
5663
5871
|
*/
|
|
5664
|
-
|
|
5872
|
+
serviceEnvironments?: ServiceEnvironmentDetail[] | undefined;
|
|
5665
5873
|
/**
|
|
5666
|
-
* <p>The
|
|
5874
|
+
* <p>The <code>nextToken</code> value to include in a future <code>DescribeServiceEnvironments</code> request. When the results of a <code>DescribeServiceEnvironments</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
|
|
5667
5875
|
* @public
|
|
5668
5876
|
*/
|
|
5669
|
-
|
|
5877
|
+
nextToken?: string | undefined;
|
|
5670
5878
|
}
|
|
5671
5879
|
/**
|
|
5672
5880
|
* @public
|
|
5673
5881
|
*/
|
|
5674
|
-
export interface
|
|
5882
|
+
export interface DescribeServiceJobRequest {
|
|
5675
5883
|
/**
|
|
5676
|
-
* <p>The
|
|
5884
|
+
* <p>The job ID for the service job to describe.</p>
|
|
5677
5885
|
* @public
|
|
5678
5886
|
*/
|
|
5679
|
-
|
|
5887
|
+
jobId: string | undefined;
|
|
5680
5888
|
}
|
|
5681
5889
|
/**
|
|
5682
|
-
* <p>A filter name and value pair that's used to return a more specific list of results from a
|
|
5683
|
-
* <code>ListJobs</code> or <code>ListJobsByConsumableResource</code> API operation.</p>
|
|
5684
5890
|
* @public
|
|
5891
|
+
* @enum
|
|
5685
5892
|
*/
|
|
5686
|
-
export
|
|
5893
|
+
export declare const ServiceResourceIdName: {
|
|
5894
|
+
readonly SAGEMAKER_TRAINING_JOB_ARN: "TrainingJobArn";
|
|
5895
|
+
};
|
|
5896
|
+
/**
|
|
5897
|
+
* @public
|
|
5898
|
+
*/
|
|
5899
|
+
export type ServiceResourceIdName = (typeof ServiceResourceIdName)[keyof typeof ServiceResourceIdName];
|
|
5900
|
+
/**
|
|
5901
|
+
* <p>The Batch unique identifier.</p>
|
|
5902
|
+
* @public
|
|
5903
|
+
*/
|
|
5904
|
+
export interface ServiceResourceId {
|
|
5687
5905
|
/**
|
|
5688
|
-
* <p>The name of the
|
|
5906
|
+
* <p>The name of the resource identifier. </p>
|
|
5689
5907
|
* @public
|
|
5690
5908
|
*/
|
|
5691
|
-
name
|
|
5909
|
+
name: ServiceResourceIdName | undefined;
|
|
5692
5910
|
/**
|
|
5693
|
-
* <p>The
|
|
5911
|
+
* <p>The value of the resource identifier. </p>
|
|
5694
5912
|
* @public
|
|
5695
5913
|
*/
|
|
5696
|
-
|
|
5914
|
+
value: string | undefined;
|
|
5697
5915
|
}
|
|
5698
5916
|
/**
|
|
5917
|
+
* <p>Detailed information about an attempt to run a service job.</p>
|
|
5699
5918
|
* @public
|
|
5700
5919
|
*/
|
|
5701
|
-
export interface
|
|
5920
|
+
export interface ServiceJobAttemptDetail {
|
|
5702
5921
|
/**
|
|
5703
|
-
* <p>The
|
|
5704
|
-
* resources that match the filter are listed. Filter names and values can be:</p>
|
|
5705
|
-
* <ul>
|
|
5706
|
-
* <li>
|
|
5707
|
-
* <p>name: <code>CONSUMABLE_RESOURCE_NAME </code>
|
|
5708
|
-
* </p>
|
|
5709
|
-
* <p>values: case-insensitive matches for the consumable resource name. If a filter
|
|
5710
|
-
* value ends with an asterisk (*), it matches any consumable resource name that begins
|
|
5711
|
-
* with the string before the '*'.</p>
|
|
5712
|
-
* </li>
|
|
5713
|
-
* </ul>
|
|
5922
|
+
* <p>The service resource identifier associated with the service job attempt.</p>
|
|
5714
5923
|
* @public
|
|
5715
5924
|
*/
|
|
5716
|
-
|
|
5925
|
+
serviceResourceId?: ServiceResourceId | undefined;
|
|
5717
5926
|
/**
|
|
5718
|
-
* <p>The
|
|
5719
|
-
* output. When this parameter is used, <code>ListConsumableResources</code> only returns
|
|
5720
|
-
* <code>maxResults</code> results in a single page and a <code>nextToken</code> response
|
|
5721
|
-
* element. The remaining results of the initial request can be seen by sending another
|
|
5722
|
-
* <code>ListConsumableResources</code> request with the returned <code>nextToken</code> value.
|
|
5723
|
-
* This value can be between 1 and 100. If this parameter isn't
|
|
5724
|
-
* used, then <code>ListConsumableResources</code> returns up to 100 results and
|
|
5725
|
-
* a <code>nextToken</code> value if applicable.</p>
|
|
5927
|
+
* <p>The Unix timestamp (in milliseconds) for when the service job attempt was started.</p>
|
|
5726
5928
|
* @public
|
|
5727
5929
|
*/
|
|
5728
|
-
|
|
5930
|
+
startedAt?: number | undefined;
|
|
5729
5931
|
/**
|
|
5730
|
-
* <p>The
|
|
5731
|
-
* <code>ListConsumableResources</code> request where <code>maxResults</code> was used and the
|
|
5732
|
-
* results exceeded the value of that parameter. Pagination continues from the end of the previous
|
|
5733
|
-
* results that returned the <code>nextToken</code> value. This value is <code>null</code> when
|
|
5734
|
-
* there are no more results to return.</p>
|
|
5735
|
-
* <note>
|
|
5736
|
-
* <p>Treat this token as an opaque identifier that's only used to
|
|
5737
|
-
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
5738
|
-
* </note>
|
|
5932
|
+
* <p>The Unix timestamp (in milliseconds) for when the service job attempt stopped running.</p>
|
|
5739
5933
|
* @public
|
|
5740
5934
|
*/
|
|
5741
|
-
|
|
5935
|
+
stoppedAt?: number | undefined;
|
|
5936
|
+
/**
|
|
5937
|
+
* <p>A string that provides additional details for the current status of the service job attempt.</p>
|
|
5938
|
+
* @public
|
|
5939
|
+
*/
|
|
5940
|
+
statusReason?: string | undefined;
|
|
5742
5941
|
}
|
|
5743
5942
|
/**
|
|
5744
|
-
* <p>
|
|
5943
|
+
* <p>Information about the latest attempt of a service job. A Service job can transition from <code>SCHEDULED</code> back to <code>RUNNABLE</code> state when they encounter capacity constraints.</p>
|
|
5745
5944
|
* @public
|
|
5746
5945
|
*/
|
|
5747
|
-
export interface
|
|
5946
|
+
export interface LatestServiceJobAttempt {
|
|
5748
5947
|
/**
|
|
5749
|
-
* <p>The
|
|
5948
|
+
* <p>The service resource identifier associated with the service job attempt.</p>
|
|
5750
5949
|
* @public
|
|
5751
5950
|
*/
|
|
5752
|
-
|
|
5951
|
+
serviceResourceId?: ServiceResourceId | undefined;
|
|
5952
|
+
}
|
|
5953
|
+
/**
|
|
5954
|
+
* @public
|
|
5955
|
+
* @enum
|
|
5956
|
+
*/
|
|
5957
|
+
export declare const ServiceJobRetryAction: {
|
|
5958
|
+
readonly EXIT: "EXIT";
|
|
5959
|
+
readonly RETRY: "RETRY";
|
|
5960
|
+
};
|
|
5961
|
+
/**
|
|
5962
|
+
* @public
|
|
5963
|
+
*/
|
|
5964
|
+
export type ServiceJobRetryAction = (typeof ServiceJobRetryAction)[keyof typeof ServiceJobRetryAction];
|
|
5965
|
+
/**
|
|
5966
|
+
* <p>Specifies conditions for when to exit or retry a service job based on the exit status or status reason.</p>
|
|
5967
|
+
* @public
|
|
5968
|
+
*/
|
|
5969
|
+
export interface ServiceJobEvaluateOnExit {
|
|
5753
5970
|
/**
|
|
5754
|
-
* <p>The
|
|
5971
|
+
* <p>The action to take if the service job exits with the specified condition. Valid values are <code>RETRY</code> and <code>EXIT</code>.</p>
|
|
5755
5972
|
* @public
|
|
5756
5973
|
*/
|
|
5757
|
-
|
|
5974
|
+
action?: ServiceJobRetryAction | undefined;
|
|
5758
5975
|
/**
|
|
5759
|
-
* <p>The
|
|
5976
|
+
* <p>Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters and can contain all printable characters. It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.</p>
|
|
5760
5977
|
* @public
|
|
5761
5978
|
*/
|
|
5762
|
-
|
|
5979
|
+
onStatusReason?: string | undefined;
|
|
5980
|
+
}
|
|
5981
|
+
/**
|
|
5982
|
+
* <p>The retry strategy for service jobs. This defines how many times to retry a failed service job and under what conditions. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service-job-retries.html">Service job retry strategies</a> in the <i>Batch User Guide</i>.</p>
|
|
5983
|
+
* @public
|
|
5984
|
+
*/
|
|
5985
|
+
export interface ServiceJobRetryStrategy {
|
|
5763
5986
|
/**
|
|
5764
|
-
* <p>The
|
|
5987
|
+
* <p>The number of times to move a service job to <code>RUNNABLE</code> status. You can specify between 1 and 10 attempts.</p>
|
|
5765
5988
|
* @public
|
|
5766
5989
|
*/
|
|
5767
|
-
|
|
5990
|
+
attempts: number | undefined;
|
|
5768
5991
|
/**
|
|
5769
|
-
* <p>
|
|
5770
|
-
*
|
|
5771
|
-
|
|
5772
|
-
|
|
5773
|
-
|
|
5774
|
-
|
|
5775
|
-
|
|
5992
|
+
* <p>Array of <code>ServiceJobEvaluateOnExit</code> objects that specify conditions under which the service job should be retried or failed.</p>
|
|
5993
|
+
* @public
|
|
5994
|
+
*/
|
|
5995
|
+
evaluateOnExit?: ServiceJobEvaluateOnExit[] | undefined;
|
|
5996
|
+
}
|
|
5997
|
+
/**
|
|
5998
|
+
* @public
|
|
5999
|
+
* @enum
|
|
6000
|
+
*/
|
|
6001
|
+
export declare const ServiceJobType: {
|
|
6002
|
+
readonly SAGEMAKER_TRAINING: "SAGEMAKER_TRAINING";
|
|
6003
|
+
};
|
|
6004
|
+
/**
|
|
6005
|
+
* @public
|
|
6006
|
+
*/
|
|
6007
|
+
export type ServiceJobType = (typeof ServiceJobType)[keyof typeof ServiceJobType];
|
|
6008
|
+
/**
|
|
6009
|
+
* @public
|
|
6010
|
+
* @enum
|
|
6011
|
+
*/
|
|
6012
|
+
export declare const ServiceJobStatus: {
|
|
6013
|
+
readonly FAILED: "FAILED";
|
|
6014
|
+
readonly PENDING: "PENDING";
|
|
6015
|
+
readonly RUNNABLE: "RUNNABLE";
|
|
6016
|
+
readonly RUNNING: "RUNNING";
|
|
6017
|
+
readonly SCHEDULED: "SCHEDULED";
|
|
6018
|
+
readonly STARTING: "STARTING";
|
|
6019
|
+
readonly SUBMITTED: "SUBMITTED";
|
|
6020
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
6021
|
+
};
|
|
6022
|
+
/**
|
|
6023
|
+
* @public
|
|
6024
|
+
*/
|
|
6025
|
+
export type ServiceJobStatus = (typeof ServiceJobStatus)[keyof typeof ServiceJobStatus];
|
|
6026
|
+
/**
|
|
6027
|
+
* <p>The timeout configuration for service jobs. </p>
|
|
6028
|
+
* @public
|
|
6029
|
+
*/
|
|
6030
|
+
export interface ServiceJobTimeout {
|
|
6031
|
+
/**
|
|
6032
|
+
* <p>The maximum duration in seconds that a service job attempt can run. After this time is reached, Batch terminates the service job attempt.</p>
|
|
6033
|
+
* @public
|
|
6034
|
+
*/
|
|
6035
|
+
attemptDurationSeconds?: number | undefined;
|
|
6036
|
+
}
|
|
6037
|
+
/**
|
|
6038
|
+
* @public
|
|
6039
|
+
*/
|
|
6040
|
+
export interface DescribeServiceJobResponse {
|
|
6041
|
+
/**
|
|
6042
|
+
* <p>A list of job attempts associated with the service job.</p>
|
|
6043
|
+
* @public
|
|
6044
|
+
*/
|
|
6045
|
+
attempts?: ServiceJobAttemptDetail[] | undefined;
|
|
6046
|
+
/**
|
|
6047
|
+
* <p>The Unix timestamp (in milliseconds) for when the service job was created.</p>
|
|
6048
|
+
* @public
|
|
6049
|
+
*/
|
|
6050
|
+
createdAt?: number | undefined;
|
|
6051
|
+
/**
|
|
6052
|
+
* <p>Indicates whether the service job has been terminated.</p>
|
|
6053
|
+
* @public
|
|
6054
|
+
*/
|
|
6055
|
+
isTerminated?: boolean | undefined;
|
|
6056
|
+
/**
|
|
6057
|
+
* <p>The Amazon Resource Name (ARN) of the service job.</p>
|
|
6058
|
+
* @public
|
|
6059
|
+
*/
|
|
6060
|
+
jobArn?: string | undefined;
|
|
6061
|
+
/**
|
|
6062
|
+
* <p>The job ID for the service job.</p>
|
|
6063
|
+
* @public
|
|
6064
|
+
*/
|
|
6065
|
+
jobId: string | undefined;
|
|
6066
|
+
/**
|
|
6067
|
+
* <p>The name of the service job.</p>
|
|
6068
|
+
* @public
|
|
6069
|
+
*/
|
|
6070
|
+
jobName: string | undefined;
|
|
6071
|
+
/**
|
|
6072
|
+
* <p>The ARN of the job queue that the service job is associated with.</p>
|
|
6073
|
+
* @public
|
|
6074
|
+
*/
|
|
6075
|
+
jobQueue: string | undefined;
|
|
6076
|
+
/**
|
|
6077
|
+
* <p>The latest attempt associated with the service job.</p>
|
|
6078
|
+
* @public
|
|
6079
|
+
*/
|
|
6080
|
+
latestAttempt?: LatestServiceJobAttempt | undefined;
|
|
6081
|
+
/**
|
|
6082
|
+
* <p>The retry strategy to use for failed service jobs that are submitted with this service job.</p>
|
|
6083
|
+
* @public
|
|
6084
|
+
*/
|
|
6085
|
+
retryStrategy?: ServiceJobRetryStrategy | undefined;
|
|
6086
|
+
/**
|
|
6087
|
+
* <p>The scheduling priority of the service job. </p>
|
|
6088
|
+
* @public
|
|
6089
|
+
*/
|
|
6090
|
+
schedulingPriority?: number | undefined;
|
|
6091
|
+
/**
|
|
6092
|
+
* <p>The request, in JSON, for the service that the <code>SubmitServiceJob</code> operation is queueing. </p>
|
|
6093
|
+
* @public
|
|
6094
|
+
*/
|
|
6095
|
+
serviceRequestPayload?: string | undefined;
|
|
6096
|
+
/**
|
|
6097
|
+
* <p>The type of service job. For SageMaker Training jobs, this value is <code>SAGEMAKER_TRAINING</code>.</p>
|
|
6098
|
+
* @public
|
|
6099
|
+
*/
|
|
6100
|
+
serviceJobType: ServiceJobType | undefined;
|
|
6101
|
+
/**
|
|
6102
|
+
* <p>The share identifier for the service job. This is used for fair-share scheduling.</p>
|
|
6103
|
+
* @public
|
|
6104
|
+
*/
|
|
6105
|
+
shareIdentifier?: string | undefined;
|
|
6106
|
+
/**
|
|
6107
|
+
* <p>The Unix timestamp (in milliseconds) for when the service job was started.</p>
|
|
6108
|
+
* @public
|
|
6109
|
+
*/
|
|
6110
|
+
startedAt: number | undefined;
|
|
6111
|
+
/**
|
|
6112
|
+
* <p>The current status of the service job. </p>
|
|
6113
|
+
* @public
|
|
6114
|
+
*/
|
|
6115
|
+
status: ServiceJobStatus | undefined;
|
|
6116
|
+
/**
|
|
6117
|
+
* <p>A short, human-readable string to provide more details for the current status of the service job.</p>
|
|
6118
|
+
* @public
|
|
6119
|
+
*/
|
|
6120
|
+
statusReason?: string | undefined;
|
|
6121
|
+
/**
|
|
6122
|
+
* <p>The Unix timestamp (in milliseconds) for when the service job stopped running.</p>
|
|
6123
|
+
* @public
|
|
6124
|
+
*/
|
|
6125
|
+
stoppedAt?: number | undefined;
|
|
6126
|
+
/**
|
|
6127
|
+
* <p>The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
|
|
6128
|
+
* @public
|
|
6129
|
+
*/
|
|
6130
|
+
tags?: Record<string, string> | undefined;
|
|
6131
|
+
/**
|
|
6132
|
+
* <p>The timeout configuration for the service job.</p>
|
|
6133
|
+
* @public
|
|
6134
|
+
*/
|
|
6135
|
+
timeoutConfig?: ServiceJobTimeout | undefined;
|
|
6136
|
+
}
|
|
6137
|
+
/**
|
|
6138
|
+
* @public
|
|
6139
|
+
*/
|
|
6140
|
+
export interface GetJobQueueSnapshotRequest {
|
|
6141
|
+
/**
|
|
6142
|
+
* <p>The job queue’s name or full queue Amazon Resource Name (ARN).</p>
|
|
6143
|
+
* @public
|
|
6144
|
+
*/
|
|
6145
|
+
jobQueue: string | undefined;
|
|
6146
|
+
}
|
|
6147
|
+
/**
|
|
6148
|
+
* <p>An object that represents summary details for the first 100 <code>RUNNABLE</code> jobs in a job queue.</p>
|
|
6149
|
+
* @public
|
|
6150
|
+
*/
|
|
6151
|
+
export interface FrontOfQueueJobSummary {
|
|
6152
|
+
/**
|
|
6153
|
+
* <p>The ARN for a job in a named job queue.</p>
|
|
6154
|
+
* @public
|
|
6155
|
+
*/
|
|
6156
|
+
jobArn?: string | undefined;
|
|
6157
|
+
/**
|
|
6158
|
+
* <p>The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.</p>
|
|
6159
|
+
* @public
|
|
6160
|
+
*/
|
|
6161
|
+
earliestTimeAtPosition?: number | undefined;
|
|
6162
|
+
}
|
|
6163
|
+
/**
|
|
6164
|
+
* <p>Contains a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job queue.</p>
|
|
6165
|
+
* @public
|
|
6166
|
+
*/
|
|
6167
|
+
export interface FrontOfQueueDetail {
|
|
6168
|
+
/**
|
|
6169
|
+
* <p>The Amazon Resource Names (ARNs) of the first 100 <code>RUNNABLE</code> jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
|
|
6170
|
+
* @public
|
|
6171
|
+
*/
|
|
6172
|
+
jobs?: FrontOfQueueJobSummary[] | undefined;
|
|
6173
|
+
/**
|
|
6174
|
+
* <p>The Unix timestamp (in milliseconds) for when each of the first 100 <code>RUNNABLE</code> jobs were last updated. </p>
|
|
6175
|
+
* @public
|
|
6176
|
+
*/
|
|
6177
|
+
lastUpdatedAt?: number | undefined;
|
|
6178
|
+
}
|
|
6179
|
+
/**
|
|
6180
|
+
* @public
|
|
6181
|
+
*/
|
|
6182
|
+
export interface GetJobQueueSnapshotResponse {
|
|
6183
|
+
/**
|
|
6184
|
+
* <p>The list of the first 100 <code>RUNNABLE</code> jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
|
|
6185
|
+
* @public
|
|
6186
|
+
*/
|
|
6187
|
+
frontOfQueue?: FrontOfQueueDetail | undefined;
|
|
6188
|
+
}
|
|
6189
|
+
/**
|
|
6190
|
+
* <p>A filter name and value pair that's used to return a more specific list of results from a
|
|
6191
|
+
* <code>ListJobs</code> or <code>ListJobsByConsumableResource</code> API operation.</p>
|
|
6192
|
+
* @public
|
|
6193
|
+
*/
|
|
6194
|
+
export interface KeyValuesPair {
|
|
6195
|
+
/**
|
|
6196
|
+
* <p>The name of the filter. Filter names are case sensitive.</p>
|
|
6197
|
+
* @public
|
|
6198
|
+
*/
|
|
6199
|
+
name?: string | undefined;
|
|
6200
|
+
/**
|
|
6201
|
+
* <p>The filter values.</p>
|
|
6202
|
+
* @public
|
|
6203
|
+
*/
|
|
6204
|
+
values?: string[] | undefined;
|
|
6205
|
+
}
|
|
6206
|
+
/**
|
|
6207
|
+
* @public
|
|
6208
|
+
*/
|
|
6209
|
+
export interface ListConsumableResourcesRequest {
|
|
6210
|
+
/**
|
|
6211
|
+
* <p>The filters to apply to the consumable resource list query. If used, only those consumable
|
|
6212
|
+
* resources that match the filter are listed. Filter names and values can be:</p>
|
|
6213
|
+
* <ul>
|
|
6214
|
+
* <li>
|
|
6215
|
+
* <p>name: <code>CONSUMABLE_RESOURCE_NAME </code>
|
|
6216
|
+
* </p>
|
|
6217
|
+
* <p>values: case-insensitive matches for the consumable resource name. If a filter
|
|
6218
|
+
* value ends with an asterisk (*), it matches any consumable resource name that begins
|
|
6219
|
+
* with the string before the '*'.</p>
|
|
6220
|
+
* </li>
|
|
6221
|
+
* </ul>
|
|
6222
|
+
* @public
|
|
6223
|
+
*/
|
|
6224
|
+
filters?: KeyValuesPair[] | undefined;
|
|
6225
|
+
/**
|
|
6226
|
+
* <p>The maximum number of results returned by <code>ListConsumableResources</code> in paginated
|
|
6227
|
+
* output. When this parameter is used, <code>ListConsumableResources</code> only returns
|
|
6228
|
+
* <code>maxResults</code> results in a single page and a <code>nextToken</code> response
|
|
6229
|
+
* element. The remaining results of the initial request can be seen by sending another
|
|
6230
|
+
* <code>ListConsumableResources</code> request with the returned <code>nextToken</code> value.
|
|
6231
|
+
* This value can be between 1 and 100. If this parameter isn't
|
|
6232
|
+
* used, then <code>ListConsumableResources</code> returns up to 100 results and
|
|
6233
|
+
* a <code>nextToken</code> value if applicable.</p>
|
|
6234
|
+
* @public
|
|
6235
|
+
*/
|
|
6236
|
+
maxResults?: number | undefined;
|
|
6237
|
+
/**
|
|
6238
|
+
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
6239
|
+
* <code>ListConsumableResources</code> request where <code>maxResults</code> was used and the
|
|
6240
|
+
* results exceeded the value of that parameter. Pagination continues from the end of the previous
|
|
6241
|
+
* results that returned the <code>nextToken</code> value. This value is <code>null</code> when
|
|
6242
|
+
* there are no more results to return.</p>
|
|
6243
|
+
* <note>
|
|
6244
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
6245
|
+
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
6246
|
+
* </note>
|
|
6247
|
+
* @public
|
|
6248
|
+
*/
|
|
6249
|
+
nextToken?: string | undefined;
|
|
6250
|
+
}
|
|
6251
|
+
/**
|
|
6252
|
+
* <p>Current information about a consumable resource.</p>
|
|
6253
|
+
* @public
|
|
6254
|
+
*/
|
|
6255
|
+
export interface ConsumableResourceSummary {
|
|
6256
|
+
/**
|
|
6257
|
+
* <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
|
|
6258
|
+
* @public
|
|
6259
|
+
*/
|
|
6260
|
+
consumableResourceArn: string | undefined;
|
|
6261
|
+
/**
|
|
6262
|
+
* <p>The name of the consumable resource.</p>
|
|
6263
|
+
* @public
|
|
6264
|
+
*/
|
|
6265
|
+
consumableResourceName: string | undefined;
|
|
6266
|
+
/**
|
|
6267
|
+
* <p>The total amount of the consumable resource that is available.</p>
|
|
6268
|
+
* @public
|
|
6269
|
+
*/
|
|
6270
|
+
totalQuantity?: number | undefined;
|
|
6271
|
+
/**
|
|
6272
|
+
* <p>The amount of the consumable resource that is currently in use.</p>
|
|
6273
|
+
* @public
|
|
6274
|
+
*/
|
|
6275
|
+
inUseQuantity?: number | undefined;
|
|
6276
|
+
/**
|
|
6277
|
+
* <p>Indicates whether the resource is available to be re-used after a job completes. Can be
|
|
6278
|
+
* one of: </p>
|
|
6279
|
+
* <ul>
|
|
6280
|
+
* <li>
|
|
6281
|
+
* <p>
|
|
6282
|
+
* <code>REPLENISHABLE</code>
|
|
6283
|
+
* </p>
|
|
5776
6284
|
* </li>
|
|
5777
6285
|
* <li>
|
|
5778
6286
|
* <p>
|
|
@@ -6286,6 +6794,129 @@ export interface ListSchedulingPoliciesResponse {
|
|
|
6286
6794
|
*/
|
|
6287
6795
|
nextToken?: string | undefined;
|
|
6288
6796
|
}
|
|
6797
|
+
/**
|
|
6798
|
+
* @public
|
|
6799
|
+
*/
|
|
6800
|
+
export interface ListServiceJobsRequest {
|
|
6801
|
+
/**
|
|
6802
|
+
* <p>The name or ARN of the job queue with which to list service jobs.</p>
|
|
6803
|
+
* @public
|
|
6804
|
+
*/
|
|
6805
|
+
jobQueue?: string | undefined;
|
|
6806
|
+
/**
|
|
6807
|
+
* <p>The job status with which to filter service jobs. </p>
|
|
6808
|
+
* @public
|
|
6809
|
+
*/
|
|
6810
|
+
jobStatus?: ServiceJobStatus | undefined;
|
|
6811
|
+
/**
|
|
6812
|
+
* <p>The maximum number of results returned by <code>ListServiceJobs</code> in paginated output. When this parameter is used, <code>ListServiceJobs</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListServiceJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListServiceJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>
|
|
6813
|
+
* @public
|
|
6814
|
+
*/
|
|
6815
|
+
maxResults?: number | undefined;
|
|
6816
|
+
/**
|
|
6817
|
+
* <p>The <code>nextToken</code> value returned from a previous paginated <code>ListServiceJobs</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p>
|
|
6818
|
+
* <note>
|
|
6819
|
+
* <p>Treat this token as an opaque identifier that's only used to
|
|
6820
|
+
* retrieve the next items in a list and not for other programmatic purposes.</p>
|
|
6821
|
+
* </note>
|
|
6822
|
+
* @public
|
|
6823
|
+
*/
|
|
6824
|
+
nextToken?: string | undefined;
|
|
6825
|
+
/**
|
|
6826
|
+
* <p>The filters to apply to the service job list query. The filter names and values can be:</p>
|
|
6827
|
+
* <ul>
|
|
6828
|
+
* <li>
|
|
6829
|
+
* <p>name: <code>JOB_STATUS</code>
|
|
6830
|
+
* </p>
|
|
6831
|
+
* <p>values: <code>SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED</code>
|
|
6832
|
+
* </p>
|
|
6833
|
+
* </li>
|
|
6834
|
+
* <li>
|
|
6835
|
+
* <p>name: <code>JOB_NAME</code>
|
|
6836
|
+
* </p>
|
|
6837
|
+
* <p>values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.</p>
|
|
6838
|
+
* </li>
|
|
6839
|
+
* </ul>
|
|
6840
|
+
* @public
|
|
6841
|
+
*/
|
|
6842
|
+
filters?: KeyValuesPair[] | undefined;
|
|
6843
|
+
}
|
|
6844
|
+
/**
|
|
6845
|
+
* <p>Summary information about a service job.</p>
|
|
6846
|
+
* @public
|
|
6847
|
+
*/
|
|
6848
|
+
export interface ServiceJobSummary {
|
|
6849
|
+
/**
|
|
6850
|
+
* <p>Information about the latest attempt for the service job.</p>
|
|
6851
|
+
* @public
|
|
6852
|
+
*/
|
|
6853
|
+
latestAttempt?: LatestServiceJobAttempt | undefined;
|
|
6854
|
+
/**
|
|
6855
|
+
* <p>The Unix timestamp (in milliseconds) for when the service job was created.</p>
|
|
6856
|
+
* @public
|
|
6857
|
+
*/
|
|
6858
|
+
createdAt?: number | undefined;
|
|
6859
|
+
/**
|
|
6860
|
+
* <p>The Amazon Resource Name (ARN) of the service job.</p>
|
|
6861
|
+
* @public
|
|
6862
|
+
*/
|
|
6863
|
+
jobArn?: string | undefined;
|
|
6864
|
+
/**
|
|
6865
|
+
* <p>The job ID for the service job.</p>
|
|
6866
|
+
* @public
|
|
6867
|
+
*/
|
|
6868
|
+
jobId: string | undefined;
|
|
6869
|
+
/**
|
|
6870
|
+
* <p>The name of the service job.</p>
|
|
6871
|
+
* @public
|
|
6872
|
+
*/
|
|
6873
|
+
jobName: string | undefined;
|
|
6874
|
+
/**
|
|
6875
|
+
* <p>The type of service job. For SageMaker Training jobs, this value is <code>SAGEMAKER_TRAINING</code>.</p>
|
|
6876
|
+
* @public
|
|
6877
|
+
*/
|
|
6878
|
+
serviceJobType: ServiceJobType | undefined;
|
|
6879
|
+
/**
|
|
6880
|
+
* <p>The share identifier for the job.</p>
|
|
6881
|
+
* @public
|
|
6882
|
+
*/
|
|
6883
|
+
shareIdentifier?: string | undefined;
|
|
6884
|
+
/**
|
|
6885
|
+
* <p>The current status of the service job. </p>
|
|
6886
|
+
* @public
|
|
6887
|
+
*/
|
|
6888
|
+
status?: ServiceJobStatus | undefined;
|
|
6889
|
+
/**
|
|
6890
|
+
* <p>A short string to provide more details on the current status of the service job.</p>
|
|
6891
|
+
* @public
|
|
6892
|
+
*/
|
|
6893
|
+
statusReason?: string | undefined;
|
|
6894
|
+
/**
|
|
6895
|
+
* <p>The Unix timestamp (in milliseconds) for when the service job was started.</p>
|
|
6896
|
+
* @public
|
|
6897
|
+
*/
|
|
6898
|
+
startedAt?: number | undefined;
|
|
6899
|
+
/**
|
|
6900
|
+
* <p>The Unix timestamp (in milliseconds) for when the service job stopped running.</p>
|
|
6901
|
+
* @public
|
|
6902
|
+
*/
|
|
6903
|
+
stoppedAt?: number | undefined;
|
|
6904
|
+
}
|
|
6905
|
+
/**
|
|
6906
|
+
* @public
|
|
6907
|
+
*/
|
|
6908
|
+
export interface ListServiceJobsResponse {
|
|
6909
|
+
/**
|
|
6910
|
+
* <p>A list of service job summaries.</p>
|
|
6911
|
+
* @public
|
|
6912
|
+
*/
|
|
6913
|
+
jobSummaryList: ServiceJobSummary[] | undefined;
|
|
6914
|
+
/**
|
|
6915
|
+
* <p>The <code>nextToken</code> value to include in a future <code>ListServiceJobs</code> request. When the results of a <code>ListServiceJobs</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
|
|
6916
|
+
* @public
|
|
6917
|
+
*/
|
|
6918
|
+
nextToken?: string | undefined;
|
|
6919
|
+
}
|
|
6289
6920
|
/**
|
|
6290
6921
|
* <p>Contains the parameters for <code>ListTagsForResource</code>.</p>
|
|
6291
6922
|
* @public
|
|
@@ -6952,6 +7583,83 @@ export interface SubmitJobResponse {
|
|
|
6952
7583
|
*/
|
|
6953
7584
|
jobId: string | undefined;
|
|
6954
7585
|
}
|
|
7586
|
+
/**
|
|
7587
|
+
* @public
|
|
7588
|
+
*/
|
|
7589
|
+
export interface SubmitServiceJobRequest {
|
|
7590
|
+
/**
|
|
7591
|
+
* <p>The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>
|
|
7592
|
+
* @public
|
|
7593
|
+
*/
|
|
7594
|
+
jobName: string | undefined;
|
|
7595
|
+
/**
|
|
7596
|
+
* <p>The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type <code>SAGEMAKER_TRAINING</code>.</p>
|
|
7597
|
+
* @public
|
|
7598
|
+
*/
|
|
7599
|
+
jobQueue: string | undefined;
|
|
7600
|
+
/**
|
|
7601
|
+
* <p>The retry strategy to use for failed service jobs that are submitted with this service job request. </p>
|
|
7602
|
+
* @public
|
|
7603
|
+
*/
|
|
7604
|
+
retryStrategy?: ServiceJobRetryStrategy | undefined;
|
|
7605
|
+
/**
|
|
7606
|
+
* <p>The scheduling priority of the service job. Valid values are integers between 0 and 9999.</p>
|
|
7607
|
+
* @public
|
|
7608
|
+
*/
|
|
7609
|
+
schedulingPriority?: number | undefined;
|
|
7610
|
+
/**
|
|
7611
|
+
* <p>The request, in JSON, for the service that the SubmitServiceJob operation is queueing. </p>
|
|
7612
|
+
* @public
|
|
7613
|
+
*/
|
|
7614
|
+
serviceRequestPayload: string | undefined;
|
|
7615
|
+
/**
|
|
7616
|
+
* <p>The type of service job. For SageMaker Training jobs, specify <code>SAGEMAKER_TRAINING</code>.</p>
|
|
7617
|
+
* @public
|
|
7618
|
+
*/
|
|
7619
|
+
serviceJobType: ServiceJobType | undefined;
|
|
7620
|
+
/**
|
|
7621
|
+
* <p>The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-
|
|
7622
|
+
* share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter
|
|
7623
|
+
* must be specified.</p>
|
|
7624
|
+
* @public
|
|
7625
|
+
*/
|
|
7626
|
+
shareIdentifier?: string | undefined;
|
|
7627
|
+
/**
|
|
7628
|
+
* <p>The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.</p>
|
|
7629
|
+
* @public
|
|
7630
|
+
*/
|
|
7631
|
+
timeoutConfig?: ServiceJobTimeout | undefined;
|
|
7632
|
+
/**
|
|
7633
|
+
* <p>The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
|
|
7634
|
+
* @public
|
|
7635
|
+
*/
|
|
7636
|
+
tags?: Record<string, string> | undefined;
|
|
7637
|
+
/**
|
|
7638
|
+
* <p>A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and <code>clientToken</code>s are received, these requests are considered the same request and the second request is rejected.</p>
|
|
7639
|
+
* @public
|
|
7640
|
+
*/
|
|
7641
|
+
clientToken?: string | undefined;
|
|
7642
|
+
}
|
|
7643
|
+
/**
|
|
7644
|
+
* @public
|
|
7645
|
+
*/
|
|
7646
|
+
export interface SubmitServiceJobResponse {
|
|
7647
|
+
/**
|
|
7648
|
+
* <p>The Amazon Resource Name (ARN) for the service job.</p>
|
|
7649
|
+
* @public
|
|
7650
|
+
*/
|
|
7651
|
+
jobArn?: string | undefined;
|
|
7652
|
+
/**
|
|
7653
|
+
* <p>The name of the service job.</p>
|
|
7654
|
+
* @public
|
|
7655
|
+
*/
|
|
7656
|
+
jobName: string | undefined;
|
|
7657
|
+
/**
|
|
7658
|
+
* <p>The unique identifier for the service job.</p>
|
|
7659
|
+
* @public
|
|
7660
|
+
*/
|
|
7661
|
+
jobId: string | undefined;
|
|
7662
|
+
}
|
|
6955
7663
|
/**
|
|
6956
7664
|
* <p>Contains the parameters for <code>TagResource</code>.</p>
|
|
6957
7665
|
* @public
|
|
@@ -7000,6 +7708,26 @@ export interface TerminateJobRequest {
|
|
|
7000
7708
|
*/
|
|
7001
7709
|
export interface TerminateJobResponse {
|
|
7002
7710
|
}
|
|
7711
|
+
/**
|
|
7712
|
+
* @public
|
|
7713
|
+
*/
|
|
7714
|
+
export interface TerminateServiceJobRequest {
|
|
7715
|
+
/**
|
|
7716
|
+
* <p>The service job ID of the service job to terminate.</p>
|
|
7717
|
+
* @public
|
|
7718
|
+
*/
|
|
7719
|
+
jobId: string | undefined;
|
|
7720
|
+
/**
|
|
7721
|
+
* <p>A message to attach to the service job that explains the reason for canceling it. This message is returned by <code>DescribeServiceJob</code> operations on the service job.</p>
|
|
7722
|
+
* @public
|
|
7723
|
+
*/
|
|
7724
|
+
reason: string | undefined;
|
|
7725
|
+
}
|
|
7726
|
+
/**
|
|
7727
|
+
* @public
|
|
7728
|
+
*/
|
|
7729
|
+
export interface TerminateServiceJobResponse {
|
|
7730
|
+
}
|
|
7003
7731
|
/**
|
|
7004
7732
|
* <p>Contains the parameters for <code>UntagResource</code>.</p>
|
|
7005
7733
|
* @public
|
|
@@ -7580,6 +8308,11 @@ export interface UpdateJobQueueRequest {
|
|
|
7580
8308
|
* @public
|
|
7581
8309
|
*/
|
|
7582
8310
|
computeEnvironmentOrder?: ComputeEnvironmentOrder[] | undefined;
|
|
8311
|
+
/**
|
|
8312
|
+
* <p>The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.</p>
|
|
8313
|
+
* @public
|
|
8314
|
+
*/
|
|
8315
|
+
serviceEnvironmentOrder?: ServiceEnvironmentOrder[] | undefined;
|
|
7583
8316
|
/**
|
|
7584
8317
|
* <p>The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after <code>maxTimeSeconds</code> has passed. (<b>Note</b>: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)</p>
|
|
7585
8318
|
* @public
|
|
@@ -7622,3 +8355,38 @@ export interface UpdateSchedulingPolicyRequest {
|
|
|
7622
8355
|
*/
|
|
7623
8356
|
export interface UpdateSchedulingPolicyResponse {
|
|
7624
8357
|
}
|
|
8358
|
+
/**
|
|
8359
|
+
* @public
|
|
8360
|
+
*/
|
|
8361
|
+
export interface UpdateServiceEnvironmentRequest {
|
|
8362
|
+
/**
|
|
8363
|
+
* <p>The name or ARN of the service environment to update.</p>
|
|
8364
|
+
* @public
|
|
8365
|
+
*/
|
|
8366
|
+
serviceEnvironment: string | undefined;
|
|
8367
|
+
/**
|
|
8368
|
+
* <p>The state of the service environment. </p>
|
|
8369
|
+
* @public
|
|
8370
|
+
*/
|
|
8371
|
+
state?: ServiceEnvironmentState | undefined;
|
|
8372
|
+
/**
|
|
8373
|
+
* <p>The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.</p>
|
|
8374
|
+
* @public
|
|
8375
|
+
*/
|
|
8376
|
+
capacityLimits?: CapacityLimit[] | undefined;
|
|
8377
|
+
}
|
|
8378
|
+
/**
|
|
8379
|
+
* @public
|
|
8380
|
+
*/
|
|
8381
|
+
export interface UpdateServiceEnvironmentResponse {
|
|
8382
|
+
/**
|
|
8383
|
+
* <p>The name of the service environment that was updated.</p>
|
|
8384
|
+
* @public
|
|
8385
|
+
*/
|
|
8386
|
+
serviceEnvironmentName: string | undefined;
|
|
8387
|
+
/**
|
|
8388
|
+
* <p>The Amazon Resource Name (ARN) of the service environment that was updated.</p>
|
|
8389
|
+
* @public
|
|
8390
|
+
*/
|
|
8391
|
+
serviceEnvironmentArn: string | undefined;
|
|
8392
|
+
}
|