@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
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
|
|
4
|
+
import { CreateServiceEnvironmentRequest, CreateServiceEnvironmentResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateServiceEnvironmentCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateServiceEnvironmentCommandInput extends CreateServiceEnvironmentRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateServiceEnvironmentCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateServiceEnvironmentCommandOutput extends CreateServiceEnvironmentResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateServiceEnvironmentCommand_base: {
|
|
25
|
+
new (input: CreateServiceEnvironmentCommandInput): import("@smithy/smithy-client").CommandImpl<CreateServiceEnvironmentCommandInput, CreateServiceEnvironmentCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateServiceEnvironmentCommandInput): import("@smithy/smithy-client").CommandImpl<CreateServiceEnvironmentCommandInput, CreateServiceEnvironmentCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BatchClient, CreateServiceEnvironmentCommand } from "@aws-sdk/client-batch"; // ES Modules import
|
|
35
|
+
* // const { BatchClient, CreateServiceEnvironmentCommand } = require("@aws-sdk/client-batch"); // CommonJS import
|
|
36
|
+
* const client = new BatchClient(config);
|
|
37
|
+
* const input = { // CreateServiceEnvironmentRequest
|
|
38
|
+
* serviceEnvironmentName: "STRING_VALUE", // required
|
|
39
|
+
* serviceEnvironmentType: "SAGEMAKER_TRAINING", // required
|
|
40
|
+
* state: "ENABLED" || "DISABLED",
|
|
41
|
+
* capacityLimits: [ // CapacityLimits // required
|
|
42
|
+
* { // CapacityLimit
|
|
43
|
+
* maxCapacity: Number("int"),
|
|
44
|
+
* capacityUnit: "STRING_VALUE",
|
|
45
|
+
* },
|
|
46
|
+
* ],
|
|
47
|
+
* tags: { // TagrisTagsMap
|
|
48
|
+
* "<keys>": "STRING_VALUE",
|
|
49
|
+
* },
|
|
50
|
+
* };
|
|
51
|
+
* const command = new CreateServiceEnvironmentCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // CreateServiceEnvironmentResponse
|
|
54
|
+
* // serviceEnvironmentName: "STRING_VALUE", // required
|
|
55
|
+
* // serviceEnvironmentArn: "STRING_VALUE", // required
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param CreateServiceEnvironmentCommandInput - {@link CreateServiceEnvironmentCommandInput}
|
|
61
|
+
* @returns {@link CreateServiceEnvironmentCommandOutput}
|
|
62
|
+
* @see {@link CreateServiceEnvironmentCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link CreateServiceEnvironmentCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ClientException} (client fault)
|
|
67
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
68
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
69
|
+
* that's not valid.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ServerException} (server fault)
|
|
72
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link BatchServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export declare class CreateServiceEnvironmentCommand extends CreateServiceEnvironmentCommand_base {
|
|
81
|
+
/** @internal type navigation helper, not in runtime. */
|
|
82
|
+
protected static __types: {
|
|
83
|
+
api: {
|
|
84
|
+
input: CreateServiceEnvironmentRequest;
|
|
85
|
+
output: CreateServiceEnvironmentResponse;
|
|
86
|
+
};
|
|
87
|
+
sdk: {
|
|
88
|
+
input: CreateServiceEnvironmentCommandInput;
|
|
89
|
+
output: CreateServiceEnvironmentCommandOutput;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
|
|
4
|
+
import { DeleteServiceEnvironmentRequest, DeleteServiceEnvironmentResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteServiceEnvironmentCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteServiceEnvironmentCommandInput extends DeleteServiceEnvironmentRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteServiceEnvironmentCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteServiceEnvironmentCommandOutput extends DeleteServiceEnvironmentResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteServiceEnvironmentCommand_base: {
|
|
25
|
+
new (input: DeleteServiceEnvironmentCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteServiceEnvironmentCommandInput, DeleteServiceEnvironmentCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteServiceEnvironmentCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteServiceEnvironmentCommandInput, DeleteServiceEnvironmentCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes a Service environment. Before you can delete a service environment, you must first set its state to <code>DISABLED</code> with the <code>UpdateServiceEnvironment</code> API operation and disassociate it from any job queues with the <code>UpdateJobQueue</code> API operation.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BatchClient, DeleteServiceEnvironmentCommand } from "@aws-sdk/client-batch"; // ES Modules import
|
|
35
|
+
* // const { BatchClient, DeleteServiceEnvironmentCommand } = require("@aws-sdk/client-batch"); // CommonJS import
|
|
36
|
+
* const client = new BatchClient(config);
|
|
37
|
+
* const input = { // DeleteServiceEnvironmentRequest
|
|
38
|
+
* serviceEnvironment: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteServiceEnvironmentCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // {};
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* @param DeleteServiceEnvironmentCommandInput - {@link DeleteServiceEnvironmentCommandInput}
|
|
47
|
+
* @returns {@link DeleteServiceEnvironmentCommandOutput}
|
|
48
|
+
* @see {@link DeleteServiceEnvironmentCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link DeleteServiceEnvironmentCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ClientException} (client fault)
|
|
53
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
54
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
55
|
+
* that's not valid.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ServerException} (server fault)
|
|
58
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link BatchServiceException}
|
|
61
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
62
|
+
*
|
|
63
|
+
*
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export declare class DeleteServiceEnvironmentCommand extends DeleteServiceEnvironmentCommand_base {
|
|
67
|
+
/** @internal type navigation helper, not in runtime. */
|
|
68
|
+
protected static __types: {
|
|
69
|
+
api: {
|
|
70
|
+
input: DeleteServiceEnvironmentRequest;
|
|
71
|
+
output: {};
|
|
72
|
+
};
|
|
73
|
+
sdk: {
|
|
74
|
+
input: DeleteServiceEnvironmentCommandInput;
|
|
75
|
+
output: DeleteServiceEnvironmentCommandOutput;
|
|
76
|
+
};
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -59,6 +59,13 @@ declare const DescribeJobQueuesCommand_base: {
|
|
|
59
59
|
* // computeEnvironment: "STRING_VALUE", // required
|
|
60
60
|
* // },
|
|
61
61
|
* // ],
|
|
62
|
+
* // serviceEnvironmentOrder: [ // ServiceEnvironmentOrders
|
|
63
|
+
* // { // ServiceEnvironmentOrder
|
|
64
|
+
* // order: Number("int"), // required
|
|
65
|
+
* // serviceEnvironment: "STRING_VALUE", // required
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // jobQueueType: "EKS" || "ECS" || "ECS_FARGATE" || "SAGEMAKER_TRAINING",
|
|
62
69
|
* // tags: { // TagrisTagsMap
|
|
63
70
|
* // "<keys>": "STRING_VALUE",
|
|
64
71
|
* // },
|
|
@@ -67,7 +74,7 @@ declare const DescribeJobQueuesCommand_base: {
|
|
|
67
74
|
* // reason: "STRING_VALUE", // required
|
|
68
75
|
* // state: "RUNNABLE", // required
|
|
69
76
|
* // maxTimeSeconds: Number("int"), // required
|
|
70
|
-
* // action: "CANCEL", // required
|
|
77
|
+
* // action: "CANCEL" || "TERMINATE", // required
|
|
71
78
|
* // },
|
|
72
79
|
* // ],
|
|
73
80
|
* // },
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
|
|
4
|
+
import { DescribeServiceEnvironmentsRequest, DescribeServiceEnvironmentsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeServiceEnvironmentsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeServiceEnvironmentsCommandInput extends DescribeServiceEnvironmentsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeServiceEnvironmentsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeServiceEnvironmentsCommandOutput extends DescribeServiceEnvironmentsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeServiceEnvironmentsCommand_base: {
|
|
25
|
+
new (input: DescribeServiceEnvironmentsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeServiceEnvironmentsCommandInput, DescribeServiceEnvironmentsCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [DescribeServiceEnvironmentsCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeServiceEnvironmentsCommandInput, DescribeServiceEnvironmentsCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Describes one or more of your service environments.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BatchClient, DescribeServiceEnvironmentsCommand } from "@aws-sdk/client-batch"; // ES Modules import
|
|
35
|
+
* // const { BatchClient, DescribeServiceEnvironmentsCommand } = require("@aws-sdk/client-batch"); // CommonJS import
|
|
36
|
+
* const client = new BatchClient(config);
|
|
37
|
+
* const input = { // DescribeServiceEnvironmentsRequest
|
|
38
|
+
* serviceEnvironments: [ // StringList
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* nextToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new DescribeServiceEnvironmentsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // DescribeServiceEnvironmentsResponse
|
|
47
|
+
* // serviceEnvironments: [ // ServiceEnvironmentDetailList
|
|
48
|
+
* // { // ServiceEnvironmentDetail
|
|
49
|
+
* // serviceEnvironmentName: "STRING_VALUE", // required
|
|
50
|
+
* // serviceEnvironmentArn: "STRING_VALUE", // required
|
|
51
|
+
* // serviceEnvironmentType: "SAGEMAKER_TRAINING", // required
|
|
52
|
+
* // state: "ENABLED" || "DISABLED",
|
|
53
|
+
* // status: "CREATING" || "UPDATING" || "DELETING" || "DELETED" || "VALID" || "INVALID",
|
|
54
|
+
* // capacityLimits: [ // CapacityLimits // required
|
|
55
|
+
* // { // CapacityLimit
|
|
56
|
+
* // maxCapacity: Number("int"),
|
|
57
|
+
* // capacityUnit: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // tags: { // TagrisTagsMap
|
|
61
|
+
* // "<keys>": "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // nextToken: "STRING_VALUE",
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param DescribeServiceEnvironmentsCommandInput - {@link DescribeServiceEnvironmentsCommandInput}
|
|
71
|
+
* @returns {@link DescribeServiceEnvironmentsCommandOutput}
|
|
72
|
+
* @see {@link DescribeServiceEnvironmentsCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link DescribeServiceEnvironmentsCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ClientException} (client fault)
|
|
77
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
78
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
79
|
+
* that's not valid.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ServerException} (server fault)
|
|
82
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link BatchServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export declare class DescribeServiceEnvironmentsCommand extends DescribeServiceEnvironmentsCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: DescribeServiceEnvironmentsRequest;
|
|
95
|
+
output: DescribeServiceEnvironmentsResponse;
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: DescribeServiceEnvironmentsCommandInput;
|
|
99
|
+
output: DescribeServiceEnvironmentsCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
|
|
4
|
+
import { DescribeServiceJobRequest, DescribeServiceJobResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeServiceJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeServiceJobCommandInput extends DescribeServiceJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeServiceJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeServiceJobCommandOutput extends DescribeServiceJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeServiceJobCommand_base: {
|
|
25
|
+
new (input: DescribeServiceJobCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeServiceJobCommandInput, DescribeServiceJobCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeServiceJobCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeServiceJobCommandInput, DescribeServiceJobCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>The details of a service job.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BatchClient, DescribeServiceJobCommand } from "@aws-sdk/client-batch"; // ES Modules import
|
|
35
|
+
* // const { BatchClient, DescribeServiceJobCommand } = require("@aws-sdk/client-batch"); // CommonJS import
|
|
36
|
+
* const client = new BatchClient(config);
|
|
37
|
+
* const input = { // DescribeServiceJobRequest
|
|
38
|
+
* jobId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeServiceJobCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeServiceJobResponse
|
|
43
|
+
* // attempts: [ // ServiceJobAttemptDetails
|
|
44
|
+
* // { // ServiceJobAttemptDetail
|
|
45
|
+
* // serviceResourceId: { // ServiceResourceId
|
|
46
|
+
* // name: "TrainingJobArn", // required
|
|
47
|
+
* // value: "STRING_VALUE", // required
|
|
48
|
+
* // },
|
|
49
|
+
* // startedAt: Number("long"),
|
|
50
|
+
* // stoppedAt: Number("long"),
|
|
51
|
+
* // statusReason: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // createdAt: Number("long"),
|
|
55
|
+
* // isTerminated: true || false,
|
|
56
|
+
* // jobArn: "STRING_VALUE",
|
|
57
|
+
* // jobId: "STRING_VALUE", // required
|
|
58
|
+
* // jobName: "STRING_VALUE", // required
|
|
59
|
+
* // jobQueue: "STRING_VALUE", // required
|
|
60
|
+
* // latestAttempt: { // LatestServiceJobAttempt
|
|
61
|
+
* // serviceResourceId: {
|
|
62
|
+
* // name: "TrainingJobArn", // required
|
|
63
|
+
* // value: "STRING_VALUE", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // },
|
|
66
|
+
* // retryStrategy: { // ServiceJobRetryStrategy
|
|
67
|
+
* // attempts: Number("int"), // required
|
|
68
|
+
* // evaluateOnExit: [ // ServiceJobEvaluateOnExitList
|
|
69
|
+
* // { // ServiceJobEvaluateOnExit
|
|
70
|
+
* // action: "RETRY" || "EXIT",
|
|
71
|
+
* // onStatusReason: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // },
|
|
75
|
+
* // schedulingPriority: Number("int"),
|
|
76
|
+
* // serviceRequestPayload: "STRING_VALUE",
|
|
77
|
+
* // serviceJobType: "SAGEMAKER_TRAINING", // required
|
|
78
|
+
* // shareIdentifier: "STRING_VALUE",
|
|
79
|
+
* // startedAt: Number("long"), // required
|
|
80
|
+
* // status: "SUBMITTED" || "PENDING" || "RUNNABLE" || "SCHEDULED" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED", // required
|
|
81
|
+
* // statusReason: "STRING_VALUE",
|
|
82
|
+
* // stoppedAt: Number("long"),
|
|
83
|
+
* // tags: { // TagrisTagsMap
|
|
84
|
+
* // "<keys>": "STRING_VALUE",
|
|
85
|
+
* // },
|
|
86
|
+
* // timeoutConfig: { // ServiceJobTimeout
|
|
87
|
+
* // attemptDurationSeconds: Number("int"),
|
|
88
|
+
* // },
|
|
89
|
+
* // };
|
|
90
|
+
*
|
|
91
|
+
* ```
|
|
92
|
+
*
|
|
93
|
+
* @param DescribeServiceJobCommandInput - {@link DescribeServiceJobCommandInput}
|
|
94
|
+
* @returns {@link DescribeServiceJobCommandOutput}
|
|
95
|
+
* @see {@link DescribeServiceJobCommandInput} for command's `input` shape.
|
|
96
|
+
* @see {@link DescribeServiceJobCommandOutput} for command's `response` shape.
|
|
97
|
+
* @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ClientException} (client fault)
|
|
100
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
101
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
102
|
+
* that's not valid.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ServerException} (server fault)
|
|
105
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link BatchServiceException}
|
|
108
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
109
|
+
*
|
|
110
|
+
*
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export declare class DescribeServiceJobCommand extends DescribeServiceJobCommand_base {
|
|
114
|
+
/** @internal type navigation helper, not in runtime. */
|
|
115
|
+
protected static __types: {
|
|
116
|
+
api: {
|
|
117
|
+
input: DescribeServiceJobRequest;
|
|
118
|
+
output: DescribeServiceJobResponse;
|
|
119
|
+
};
|
|
120
|
+
sdk: {
|
|
121
|
+
input: DescribeServiceJobCommandInput;
|
|
122
|
+
output: DescribeServiceJobCommandOutput;
|
|
123
|
+
};
|
|
124
|
+
};
|
|
125
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
|
|
4
|
+
import { ListServiceJobsRequest, ListServiceJobsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListServiceJobsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListServiceJobsCommandInput extends ListServiceJobsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListServiceJobsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListServiceJobsCommandOutput extends ListServiceJobsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListServiceJobsCommand_base: {
|
|
25
|
+
new (input: ListServiceJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListServiceJobsCommandInput, ListServiceJobsCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListServiceJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListServiceJobsCommandInput, ListServiceJobsCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of service jobs for a specified job queue.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BatchClient, ListServiceJobsCommand } from "@aws-sdk/client-batch"; // ES Modules import
|
|
35
|
+
* // const { BatchClient, ListServiceJobsCommand } = require("@aws-sdk/client-batch"); // CommonJS import
|
|
36
|
+
* const client = new BatchClient(config);
|
|
37
|
+
* const input = { // ListServiceJobsRequest
|
|
38
|
+
* jobQueue: "STRING_VALUE",
|
|
39
|
+
* jobStatus: "SUBMITTED" || "PENDING" || "RUNNABLE" || "SCHEDULED" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED",
|
|
40
|
+
* maxResults: Number("int"),
|
|
41
|
+
* nextToken: "STRING_VALUE",
|
|
42
|
+
* filters: [ // ListJobsFilterList
|
|
43
|
+
* { // KeyValuesPair
|
|
44
|
+
* name: "STRING_VALUE",
|
|
45
|
+
* values: [ // StringList
|
|
46
|
+
* "STRING_VALUE",
|
|
47
|
+
* ],
|
|
48
|
+
* },
|
|
49
|
+
* ],
|
|
50
|
+
* };
|
|
51
|
+
* const command = new ListServiceJobsCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // ListServiceJobsResponse
|
|
54
|
+
* // jobSummaryList: [ // ServiceJobSummaryList // required
|
|
55
|
+
* // { // ServiceJobSummary
|
|
56
|
+
* // latestAttempt: { // LatestServiceJobAttempt
|
|
57
|
+
* // serviceResourceId: { // ServiceResourceId
|
|
58
|
+
* // name: "TrainingJobArn", // required
|
|
59
|
+
* // value: "STRING_VALUE", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // },
|
|
62
|
+
* // createdAt: Number("long"),
|
|
63
|
+
* // jobArn: "STRING_VALUE",
|
|
64
|
+
* // jobId: "STRING_VALUE", // required
|
|
65
|
+
* // jobName: "STRING_VALUE", // required
|
|
66
|
+
* // serviceJobType: "SAGEMAKER_TRAINING", // required
|
|
67
|
+
* // shareIdentifier: "STRING_VALUE",
|
|
68
|
+
* // status: "SUBMITTED" || "PENDING" || "RUNNABLE" || "SCHEDULED" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED",
|
|
69
|
+
* // statusReason: "STRING_VALUE",
|
|
70
|
+
* // startedAt: Number("long"),
|
|
71
|
+
* // stoppedAt: Number("long"),
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // nextToken: "STRING_VALUE",
|
|
75
|
+
* // };
|
|
76
|
+
*
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
79
|
+
* @param ListServiceJobsCommandInput - {@link ListServiceJobsCommandInput}
|
|
80
|
+
* @returns {@link ListServiceJobsCommandOutput}
|
|
81
|
+
* @see {@link ListServiceJobsCommandInput} for command's `input` shape.
|
|
82
|
+
* @see {@link ListServiceJobsCommandOutput} for command's `response` shape.
|
|
83
|
+
* @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ClientException} (client fault)
|
|
86
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
87
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
88
|
+
* that's not valid.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ServerException} (server fault)
|
|
91
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link BatchServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class ListServiceJobsCommand extends ListServiceJobsCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: ListServiceJobsRequest;
|
|
104
|
+
output: ListServiceJobsResponse;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: ListServiceJobsCommandInput;
|
|
108
|
+
output: ListServiceJobsCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
|
|
4
|
+
import { SubmitServiceJobRequest, SubmitServiceJobResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SubmitServiceJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SubmitServiceJobCommandInput extends SubmitServiceJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SubmitServiceJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SubmitServiceJobCommandOutput extends SubmitServiceJobResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SubmitServiceJobCommand_base: {
|
|
25
|
+
new (input: SubmitServiceJobCommandInput): import("@smithy/smithy-client").CommandImpl<SubmitServiceJobCommandInput, SubmitServiceJobCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SubmitServiceJobCommandInput): import("@smithy/smithy-client").CommandImpl<SubmitServiceJobCommandInput, SubmitServiceJobCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BatchClient, SubmitServiceJobCommand } from "@aws-sdk/client-batch"; // ES Modules import
|
|
35
|
+
* // const { BatchClient, SubmitServiceJobCommand } = require("@aws-sdk/client-batch"); // CommonJS import
|
|
36
|
+
* const client = new BatchClient(config);
|
|
37
|
+
* const input = { // SubmitServiceJobRequest
|
|
38
|
+
* jobName: "STRING_VALUE", // required
|
|
39
|
+
* jobQueue: "STRING_VALUE", // required
|
|
40
|
+
* retryStrategy: { // ServiceJobRetryStrategy
|
|
41
|
+
* attempts: Number("int"), // required
|
|
42
|
+
* evaluateOnExit: [ // ServiceJobEvaluateOnExitList
|
|
43
|
+
* { // ServiceJobEvaluateOnExit
|
|
44
|
+
* action: "RETRY" || "EXIT",
|
|
45
|
+
* onStatusReason: "STRING_VALUE",
|
|
46
|
+
* },
|
|
47
|
+
* ],
|
|
48
|
+
* },
|
|
49
|
+
* schedulingPriority: Number("int"),
|
|
50
|
+
* serviceRequestPayload: "STRING_VALUE", // required
|
|
51
|
+
* serviceJobType: "SAGEMAKER_TRAINING", // required
|
|
52
|
+
* shareIdentifier: "STRING_VALUE",
|
|
53
|
+
* timeoutConfig: { // ServiceJobTimeout
|
|
54
|
+
* attemptDurationSeconds: Number("int"),
|
|
55
|
+
* },
|
|
56
|
+
* tags: { // TagrisTagsMap
|
|
57
|
+
* "<keys>": "STRING_VALUE",
|
|
58
|
+
* },
|
|
59
|
+
* clientToken: "STRING_VALUE",
|
|
60
|
+
* };
|
|
61
|
+
* const command = new SubmitServiceJobCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* // { // SubmitServiceJobResponse
|
|
64
|
+
* // jobArn: "STRING_VALUE",
|
|
65
|
+
* // jobName: "STRING_VALUE", // required
|
|
66
|
+
* // jobId: "STRING_VALUE", // required
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param SubmitServiceJobCommandInput - {@link SubmitServiceJobCommandInput}
|
|
72
|
+
* @returns {@link SubmitServiceJobCommandOutput}
|
|
73
|
+
* @see {@link SubmitServiceJobCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link SubmitServiceJobCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ClientException} (client fault)
|
|
78
|
+
* <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
|
|
79
|
+
* of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
|
|
80
|
+
* that's not valid.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ServerException} (server fault)
|
|
83
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link BatchServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
87
|
+
*
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export declare class SubmitServiceJobCommand extends SubmitServiceJobCommand_base {
|
|
92
|
+
/** @internal type navigation helper, not in runtime. */
|
|
93
|
+
protected static __types: {
|
|
94
|
+
api: {
|
|
95
|
+
input: SubmitServiceJobRequest;
|
|
96
|
+
output: SubmitServiceJobResponse;
|
|
97
|
+
};
|
|
98
|
+
sdk: {
|
|
99
|
+
input: SubmitServiceJobCommandInput;
|
|
100
|
+
output: SubmitServiceJobCommandOutput;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
}
|