@aws-sdk/client-batch 3.1012.0 → 3.1013.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.
Files changed (52) hide show
  1. package/README.md +42 -0
  2. package/dist-cjs/index.js +116 -0
  3. package/dist-cjs/schemas/schemas_0.js +244 -25
  4. package/dist-es/Batch.js +14 -0
  5. package/dist-es/commands/CreateQuotaShareCommand.js +16 -0
  6. package/dist-es/commands/DeleteQuotaShareCommand.js +16 -0
  7. package/dist-es/commands/DescribeQuotaShareCommand.js +16 -0
  8. package/dist-es/commands/ListQuotaSharesCommand.js +16 -0
  9. package/dist-es/commands/UpdateQuotaShareCommand.js +16 -0
  10. package/dist-es/commands/UpdateServiceJobCommand.js +16 -0
  11. package/dist-es/commands/index.js +6 -0
  12. package/dist-es/models/enums.js +23 -0
  13. package/dist-es/pagination/ListQuotaSharesPaginator.js +4 -0
  14. package/dist-es/pagination/index.js +1 -0
  15. package/dist-es/schemas/schemas_0.js +238 -20
  16. package/dist-types/Batch.d.ts +49 -0
  17. package/dist-types/BatchClient.d.ts +8 -2
  18. package/dist-types/commands/CreateQuotaShareCommand.d.ts +101 -0
  19. package/dist-types/commands/CreateSchedulingPolicyCommand.d.ts +3 -0
  20. package/dist-types/commands/DeleteJobQueueCommand.d.ts +1 -2
  21. package/dist-types/commands/DeleteQuotaShareCommand.d.ts +82 -0
  22. package/dist-types/commands/DescribeQuotaShareCommand.d.ts +102 -0
  23. package/dist-types/commands/DescribeSchedulingPoliciesCommand.d.ts +3 -0
  24. package/dist-types/commands/DescribeServiceJobCommand.d.ts +15 -0
  25. package/dist-types/commands/GetJobQueueSnapshotCommand.d.ts +28 -2
  26. package/dist-types/commands/ListQuotaSharesCommand.d.ts +106 -0
  27. package/dist-types/commands/ListServiceJobsCommand.d.ts +1 -0
  28. package/dist-types/commands/SubmitServiceJobCommand.d.ts +4 -0
  29. package/dist-types/commands/UpdateQuotaShareCommand.d.ts +97 -0
  30. package/dist-types/commands/UpdateSchedulingPolicyCommand.d.ts +3 -0
  31. package/dist-types/commands/UpdateServiceJobCommand.d.ts +85 -0
  32. package/dist-types/commands/index.d.ts +6 -0
  33. package/dist-types/models/enums.d.ts +63 -0
  34. package/dist-types/models/models_0.d.ts +596 -18
  35. package/dist-types/pagination/ListQuotaSharesPaginator.d.ts +7 -0
  36. package/dist-types/pagination/index.d.ts +1 -0
  37. package/dist-types/schemas/schemas_0.d.ts +31 -0
  38. package/dist-types/ts3.4/Batch.d.ts +109 -0
  39. package/dist-types/ts3.4/BatchClient.d.ts +38 -2
  40. package/dist-types/ts3.4/commands/CreateQuotaShareCommand.d.ts +50 -0
  41. package/dist-types/ts3.4/commands/DeleteQuotaShareCommand.d.ts +50 -0
  42. package/dist-types/ts3.4/commands/DescribeQuotaShareCommand.d.ts +51 -0
  43. package/dist-types/ts3.4/commands/ListQuotaSharesCommand.d.ts +50 -0
  44. package/dist-types/ts3.4/commands/UpdateQuotaShareCommand.d.ts +50 -0
  45. package/dist-types/ts3.4/commands/UpdateServiceJobCommand.d.ts +50 -0
  46. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  47. package/dist-types/ts3.4/models/enums.d.ts +33 -0
  48. package/dist-types/ts3.4/models/models_0.d.ts +142 -0
  49. package/dist-types/ts3.4/pagination/ListQuotaSharesPaginator.d.ts +11 -0
  50. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  51. package/dist-types/ts3.4/schemas/schemas_0.d.ts +31 -0
  52. package/package.json +5 -5
@@ -11,11 +11,13 @@ import { CancelJobCommandInput, CancelJobCommandOutput } from "./commands/Cancel
11
11
  import { CreateComputeEnvironmentCommandInput, CreateComputeEnvironmentCommandOutput } from "./commands/CreateComputeEnvironmentCommand";
12
12
  import { CreateConsumableResourceCommandInput, CreateConsumableResourceCommandOutput } from "./commands/CreateConsumableResourceCommand";
13
13
  import { CreateJobQueueCommandInput, CreateJobQueueCommandOutput } from "./commands/CreateJobQueueCommand";
14
+ import { CreateQuotaShareCommandInput, CreateQuotaShareCommandOutput } from "./commands/CreateQuotaShareCommand";
14
15
  import { CreateSchedulingPolicyCommandInput, CreateSchedulingPolicyCommandOutput } from "./commands/CreateSchedulingPolicyCommand";
15
16
  import { CreateServiceEnvironmentCommandInput, CreateServiceEnvironmentCommandOutput } from "./commands/CreateServiceEnvironmentCommand";
16
17
  import { DeleteComputeEnvironmentCommandInput, DeleteComputeEnvironmentCommandOutput } from "./commands/DeleteComputeEnvironmentCommand";
17
18
  import { DeleteConsumableResourceCommandInput, DeleteConsumableResourceCommandOutput } from "./commands/DeleteConsumableResourceCommand";
18
19
  import { DeleteJobQueueCommandInput, DeleteJobQueueCommandOutput } from "./commands/DeleteJobQueueCommand";
20
+ import { DeleteQuotaShareCommandInput, DeleteQuotaShareCommandOutput } from "./commands/DeleteQuotaShareCommand";
19
21
  import { DeleteSchedulingPolicyCommandInput, DeleteSchedulingPolicyCommandOutput } from "./commands/DeleteSchedulingPolicyCommand";
20
22
  import { DeleteServiceEnvironmentCommandInput, DeleteServiceEnvironmentCommandOutput } from "./commands/DeleteServiceEnvironmentCommand";
21
23
  import { DeregisterJobDefinitionCommandInput, DeregisterJobDefinitionCommandOutput } from "./commands/DeregisterJobDefinitionCommand";
@@ -24,6 +26,7 @@ import { DescribeConsumableResourceCommandInput, DescribeConsumableResourceComma
24
26
  import { DescribeJobDefinitionsCommandInput, DescribeJobDefinitionsCommandOutput } from "./commands/DescribeJobDefinitionsCommand";
25
27
  import { DescribeJobQueuesCommandInput, DescribeJobQueuesCommandOutput } from "./commands/DescribeJobQueuesCommand";
26
28
  import { DescribeJobsCommandInput, DescribeJobsCommandOutput } from "./commands/DescribeJobsCommand";
29
+ import { DescribeQuotaShareCommandInput, DescribeQuotaShareCommandOutput } from "./commands/DescribeQuotaShareCommand";
27
30
  import { DescribeSchedulingPoliciesCommandInput, DescribeSchedulingPoliciesCommandOutput } from "./commands/DescribeSchedulingPoliciesCommand";
28
31
  import { DescribeServiceEnvironmentsCommandInput, DescribeServiceEnvironmentsCommandOutput } from "./commands/DescribeServiceEnvironmentsCommand";
29
32
  import { DescribeServiceJobCommandInput, DescribeServiceJobCommandOutput } from "./commands/DescribeServiceJobCommand";
@@ -31,6 +34,7 @@ import { GetJobQueueSnapshotCommandInput, GetJobQueueSnapshotCommandOutput } fro
31
34
  import { ListConsumableResourcesCommandInput, ListConsumableResourcesCommandOutput } from "./commands/ListConsumableResourcesCommand";
32
35
  import { ListJobsByConsumableResourceCommandInput, ListJobsByConsumableResourceCommandOutput } from "./commands/ListJobsByConsumableResourceCommand";
33
36
  import { ListJobsCommandInput, ListJobsCommandOutput } from "./commands/ListJobsCommand";
37
+ import { ListQuotaSharesCommandInput, ListQuotaSharesCommandOutput } from "./commands/ListQuotaSharesCommand";
34
38
  import { ListSchedulingPoliciesCommandInput, ListSchedulingPoliciesCommandOutput } from "./commands/ListSchedulingPoliciesCommand";
35
39
  import { ListServiceJobsCommandInput, ListServiceJobsCommandOutput } from "./commands/ListServiceJobsCommand";
36
40
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
@@ -44,19 +48,21 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
44
48
  import { UpdateComputeEnvironmentCommandInput, UpdateComputeEnvironmentCommandOutput } from "./commands/UpdateComputeEnvironmentCommand";
45
49
  import { UpdateConsumableResourceCommandInput, UpdateConsumableResourceCommandOutput } from "./commands/UpdateConsumableResourceCommand";
46
50
  import { UpdateJobQueueCommandInput, UpdateJobQueueCommandOutput } from "./commands/UpdateJobQueueCommand";
51
+ import { UpdateQuotaShareCommandInput, UpdateQuotaShareCommandOutput } from "./commands/UpdateQuotaShareCommand";
47
52
  import { UpdateSchedulingPolicyCommandInput, UpdateSchedulingPolicyCommandOutput } from "./commands/UpdateSchedulingPolicyCommand";
48
53
  import { UpdateServiceEnvironmentCommandInput, UpdateServiceEnvironmentCommandOutput } from "./commands/UpdateServiceEnvironmentCommand";
54
+ import { UpdateServiceJobCommandInput, UpdateServiceJobCommandOutput } from "./commands/UpdateServiceJobCommand";
49
55
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
50
56
  import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
51
57
  export { __Client };
52
58
  /**
53
59
  * @public
54
60
  */
55
- export type ServiceInputTypes = CancelJobCommandInput | CreateComputeEnvironmentCommandInput | CreateConsumableResourceCommandInput | CreateJobQueueCommandInput | CreateSchedulingPolicyCommandInput | CreateServiceEnvironmentCommandInput | DeleteComputeEnvironmentCommandInput | DeleteConsumableResourceCommandInput | DeleteJobQueueCommandInput | DeleteSchedulingPolicyCommandInput | DeleteServiceEnvironmentCommandInput | DeregisterJobDefinitionCommandInput | DescribeComputeEnvironmentsCommandInput | DescribeConsumableResourceCommandInput | DescribeJobDefinitionsCommandInput | DescribeJobQueuesCommandInput | DescribeJobsCommandInput | DescribeSchedulingPoliciesCommandInput | DescribeServiceEnvironmentsCommandInput | DescribeServiceJobCommandInput | GetJobQueueSnapshotCommandInput | ListConsumableResourcesCommandInput | ListJobsByConsumableResourceCommandInput | ListJobsCommandInput | ListSchedulingPoliciesCommandInput | ListServiceJobsCommandInput | ListTagsForResourceCommandInput | RegisterJobDefinitionCommandInput | SubmitJobCommandInput | SubmitServiceJobCommandInput | TagResourceCommandInput | TerminateJobCommandInput | TerminateServiceJobCommandInput | UntagResourceCommandInput | UpdateComputeEnvironmentCommandInput | UpdateConsumableResourceCommandInput | UpdateJobQueueCommandInput | UpdateSchedulingPolicyCommandInput | UpdateServiceEnvironmentCommandInput;
61
+ export type ServiceInputTypes = CancelJobCommandInput | CreateComputeEnvironmentCommandInput | CreateConsumableResourceCommandInput | CreateJobQueueCommandInput | CreateQuotaShareCommandInput | CreateSchedulingPolicyCommandInput | CreateServiceEnvironmentCommandInput | DeleteComputeEnvironmentCommandInput | DeleteConsumableResourceCommandInput | DeleteJobQueueCommandInput | DeleteQuotaShareCommandInput | DeleteSchedulingPolicyCommandInput | DeleteServiceEnvironmentCommandInput | DeregisterJobDefinitionCommandInput | DescribeComputeEnvironmentsCommandInput | DescribeConsumableResourceCommandInput | DescribeJobDefinitionsCommandInput | DescribeJobQueuesCommandInput | DescribeJobsCommandInput | DescribeQuotaShareCommandInput | DescribeSchedulingPoliciesCommandInput | DescribeServiceEnvironmentsCommandInput | DescribeServiceJobCommandInput | GetJobQueueSnapshotCommandInput | ListConsumableResourcesCommandInput | ListJobsByConsumableResourceCommandInput | ListJobsCommandInput | ListQuotaSharesCommandInput | ListSchedulingPoliciesCommandInput | ListServiceJobsCommandInput | ListTagsForResourceCommandInput | RegisterJobDefinitionCommandInput | SubmitJobCommandInput | SubmitServiceJobCommandInput | TagResourceCommandInput | TerminateJobCommandInput | TerminateServiceJobCommandInput | UntagResourceCommandInput | UpdateComputeEnvironmentCommandInput | UpdateConsumableResourceCommandInput | UpdateJobQueueCommandInput | UpdateQuotaShareCommandInput | UpdateSchedulingPolicyCommandInput | UpdateServiceEnvironmentCommandInput | UpdateServiceJobCommandInput;
56
62
  /**
57
63
  * @public
58
64
  */
59
- export type ServiceOutputTypes = CancelJobCommandOutput | CreateComputeEnvironmentCommandOutput | CreateConsumableResourceCommandOutput | CreateJobQueueCommandOutput | CreateSchedulingPolicyCommandOutput | CreateServiceEnvironmentCommandOutput | DeleteComputeEnvironmentCommandOutput | DeleteConsumableResourceCommandOutput | DeleteJobQueueCommandOutput | DeleteSchedulingPolicyCommandOutput | DeleteServiceEnvironmentCommandOutput | DeregisterJobDefinitionCommandOutput | DescribeComputeEnvironmentsCommandOutput | DescribeConsumableResourceCommandOutput | DescribeJobDefinitionsCommandOutput | DescribeJobQueuesCommandOutput | DescribeJobsCommandOutput | DescribeSchedulingPoliciesCommandOutput | DescribeServiceEnvironmentsCommandOutput | DescribeServiceJobCommandOutput | GetJobQueueSnapshotCommandOutput | ListConsumableResourcesCommandOutput | ListJobsByConsumableResourceCommandOutput | ListJobsCommandOutput | ListSchedulingPoliciesCommandOutput | ListServiceJobsCommandOutput | ListTagsForResourceCommandOutput | RegisterJobDefinitionCommandOutput | SubmitJobCommandOutput | SubmitServiceJobCommandOutput | TagResourceCommandOutput | TerminateJobCommandOutput | TerminateServiceJobCommandOutput | UntagResourceCommandOutput | UpdateComputeEnvironmentCommandOutput | UpdateConsumableResourceCommandOutput | UpdateJobQueueCommandOutput | UpdateSchedulingPolicyCommandOutput | UpdateServiceEnvironmentCommandOutput;
65
+ export type ServiceOutputTypes = CancelJobCommandOutput | CreateComputeEnvironmentCommandOutput | CreateConsumableResourceCommandOutput | CreateJobQueueCommandOutput | CreateQuotaShareCommandOutput | CreateSchedulingPolicyCommandOutput | CreateServiceEnvironmentCommandOutput | DeleteComputeEnvironmentCommandOutput | DeleteConsumableResourceCommandOutput | DeleteJobQueueCommandOutput | DeleteQuotaShareCommandOutput | DeleteSchedulingPolicyCommandOutput | DeleteServiceEnvironmentCommandOutput | DeregisterJobDefinitionCommandOutput | DescribeComputeEnvironmentsCommandOutput | DescribeConsumableResourceCommandOutput | DescribeJobDefinitionsCommandOutput | DescribeJobQueuesCommandOutput | DescribeJobsCommandOutput | DescribeQuotaShareCommandOutput | DescribeSchedulingPoliciesCommandOutput | DescribeServiceEnvironmentsCommandOutput | DescribeServiceJobCommandOutput | GetJobQueueSnapshotCommandOutput | ListConsumableResourcesCommandOutput | ListJobsByConsumableResourceCommandOutput | ListJobsCommandOutput | ListQuotaSharesCommandOutput | ListSchedulingPoliciesCommandOutput | ListServiceJobsCommandOutput | ListTagsForResourceCommandOutput | RegisterJobDefinitionCommandOutput | SubmitJobCommandOutput | SubmitServiceJobCommandOutput | TagResourceCommandOutput | TerminateJobCommandOutput | TerminateServiceJobCommandOutput | UntagResourceCommandOutput | UpdateComputeEnvironmentCommandOutput | UpdateConsumableResourceCommandOutput | UpdateJobQueueCommandOutput | UpdateQuotaShareCommandOutput | UpdateSchedulingPolicyCommandOutput | UpdateServiceEnvironmentCommandOutput | UpdateServiceJobCommandOutput;
60
66
  /**
61
67
  * @public
62
68
  */
@@ -0,0 +1,101 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
4
+ import type { CreateQuotaShareRequest, CreateQuotaShareResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateQuotaShareCommand}.
14
+ */
15
+ export interface CreateQuotaShareCommandInput extends CreateQuotaShareRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateQuotaShareCommand}.
21
+ */
22
+ export interface CreateQuotaShareCommandOutput extends CreateQuotaShareResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateQuotaShareCommand_base: {
25
+ new (input: CreateQuotaShareCommandInput): import("@smithy/smithy-client").CommandImpl<CreateQuotaShareCommandInput, CreateQuotaShareCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: CreateQuotaShareCommandInput): import("@smithy/smithy-client").CommandImpl<CreateQuotaShareCommandInput, CreateQuotaShareCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits. </p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { BatchClient, CreateQuotaShareCommand } from "@aws-sdk/client-batch"; // ES Modules import
35
+ * // const { BatchClient, CreateQuotaShareCommand } = require("@aws-sdk/client-batch"); // CommonJS import
36
+ * // import type { BatchClientConfig } from "@aws-sdk/client-batch";
37
+ * const config = {}; // type is BatchClientConfig
38
+ * const client = new BatchClient(config);
39
+ * const input = { // CreateQuotaShareRequest
40
+ * quotaShareName: "STRING_VALUE", // required
41
+ * jobQueue: "STRING_VALUE", // required
42
+ * capacityLimits: [ // QuotaShareCapacityLimits // required
43
+ * { // QuotaShareCapacityLimit
44
+ * maxCapacity: Number("int"), // required
45
+ * capacityUnit: "STRING_VALUE", // required
46
+ * },
47
+ * ],
48
+ * resourceSharingConfiguration: { // QuotaShareResourceSharingConfiguration
49
+ * strategy: "RESERVE" || "LEND" || "LEND_AND_BORROW", // required
50
+ * borrowLimit: Number("int"),
51
+ * },
52
+ * preemptionConfiguration: { // QuotaSharePreemptionConfiguration
53
+ * inSharePreemption: "ENABLED" || "DISABLED", // required
54
+ * },
55
+ * state: "ENABLED" || "DISABLED",
56
+ * tags: { // TagrisTagsMap
57
+ * "<keys>": "STRING_VALUE",
58
+ * },
59
+ * };
60
+ * const command = new CreateQuotaShareCommand(input);
61
+ * const response = await client.send(command);
62
+ * // { // CreateQuotaShareResponse
63
+ * // quotaShareName: "STRING_VALUE",
64
+ * // quotaShareArn: "STRING_VALUE",
65
+ * // };
66
+ *
67
+ * ```
68
+ *
69
+ * @param CreateQuotaShareCommandInput - {@link CreateQuotaShareCommandInput}
70
+ * @returns {@link CreateQuotaShareCommandOutput}
71
+ * @see {@link CreateQuotaShareCommandInput} for command's `input` shape.
72
+ * @see {@link CreateQuotaShareCommandOutput} for command's `response` shape.
73
+ * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
74
+ *
75
+ * @throws {@link ClientException} (client fault)
76
+ * <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
77
+ * of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
78
+ * that's not valid.</p>
79
+ *
80
+ * @throws {@link ServerException} (server fault)
81
+ * <p>These errors are usually caused by a server issue.</p>
82
+ *
83
+ * @throws {@link BatchServiceException}
84
+ * <p>Base exception class for all service exceptions from Batch service.</p>
85
+ *
86
+ *
87
+ * @public
88
+ */
89
+ export declare class CreateQuotaShareCommand extends CreateQuotaShareCommand_base {
90
+ /** @internal type navigation helper, not in runtime. */
91
+ protected static __types: {
92
+ api: {
93
+ input: CreateQuotaShareRequest;
94
+ output: CreateQuotaShareResponse;
95
+ };
96
+ sdk: {
97
+ input: CreateQuotaShareCommandInput;
98
+ output: CreateQuotaShareCommandOutput;
99
+ };
100
+ };
101
+ }
@@ -38,6 +38,9 @@ declare const CreateSchedulingPolicyCommand_base: {
38
38
  * const client = new BatchClient(config);
39
39
  * const input = { // CreateSchedulingPolicyRequest
40
40
  * name: "STRING_VALUE", // required
41
+ * quotaSharePolicy: { // QuotaSharePolicy
42
+ * idleResourceAssignmentStrategy: "FIFO", // required
43
+ * },
41
44
  * fairsharePolicy: { // FairsharePolicy
42
45
  * shareDecaySeconds: Number("int"),
43
46
  * computeReservation: Number("int"),
@@ -29,8 +29,7 @@ declare const DeleteJobQueueCommand_base: {
29
29
  /**
30
30
  * <p>Deletes the specified job queue. You must first disable submissions for a queue with the
31
31
  * <a>UpdateJobQueue</a> operation. All jobs in the queue are eventually terminated
32
- * when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each
33
- * second.</p>
32
+ * when you delete a job queue.</p>
34
33
  * <p>It's not necessary to disassociate compute environments from a queue before submitting a
35
34
  * <code>DeleteJobQueue</code> request.</p>
36
35
  * @example
@@ -0,0 +1,82 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
4
+ import type { DeleteQuotaShareRequest, DeleteQuotaShareResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteQuotaShareCommand}.
14
+ */
15
+ export interface DeleteQuotaShareCommandInput extends DeleteQuotaShareRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteQuotaShareCommand}.
21
+ */
22
+ export interface DeleteQuotaShareCommandOutput extends DeleteQuotaShareResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteQuotaShareCommand_base: {
25
+ new (input: DeleteQuotaShareCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteQuotaShareCommandInput, DeleteQuotaShareCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: DeleteQuotaShareCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteQuotaShareCommandInput, DeleteQuotaShareCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes the specified quota share. You must first disable submissions for the share by
31
+ * updating the state to <code>DISABLED</code> using the <a>UpdateQuotaShare</a> operation.
32
+ * All jobs in the share are eventually terminated when you delete a quota share.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { BatchClient, DeleteQuotaShareCommand } from "@aws-sdk/client-batch"; // ES Modules import
37
+ * // const { BatchClient, DeleteQuotaShareCommand } = require("@aws-sdk/client-batch"); // CommonJS import
38
+ * // import type { BatchClientConfig } from "@aws-sdk/client-batch";
39
+ * const config = {}; // type is BatchClientConfig
40
+ * const client = new BatchClient(config);
41
+ * const input = { // DeleteQuotaShareRequest
42
+ * quotaShareArn: "STRING_VALUE", // required
43
+ * };
44
+ * const command = new DeleteQuotaShareCommand(input);
45
+ * const response = await client.send(command);
46
+ * // {};
47
+ *
48
+ * ```
49
+ *
50
+ * @param DeleteQuotaShareCommandInput - {@link DeleteQuotaShareCommandInput}
51
+ * @returns {@link DeleteQuotaShareCommandOutput}
52
+ * @see {@link DeleteQuotaShareCommandInput} for command's `input` shape.
53
+ * @see {@link DeleteQuotaShareCommandOutput} for command's `response` shape.
54
+ * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
55
+ *
56
+ * @throws {@link ClientException} (client fault)
57
+ * <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
58
+ * of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
59
+ * that's not valid.</p>
60
+ *
61
+ * @throws {@link ServerException} (server fault)
62
+ * <p>These errors are usually caused by a server issue.</p>
63
+ *
64
+ * @throws {@link BatchServiceException}
65
+ * <p>Base exception class for all service exceptions from Batch service.</p>
66
+ *
67
+ *
68
+ * @public
69
+ */
70
+ export declare class DeleteQuotaShareCommand extends DeleteQuotaShareCommand_base {
71
+ /** @internal type navigation helper, not in runtime. */
72
+ protected static __types: {
73
+ api: {
74
+ input: DeleteQuotaShareRequest;
75
+ output: {};
76
+ };
77
+ sdk: {
78
+ input: DeleteQuotaShareCommandInput;
79
+ output: DeleteQuotaShareCommandOutput;
80
+ };
81
+ };
82
+ }
@@ -0,0 +1,102 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
4
+ import type { DescribeQuotaShareRequest, DescribeQuotaShareResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeQuotaShareCommand}.
14
+ */
15
+ export interface DescribeQuotaShareCommandInput extends DescribeQuotaShareRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeQuotaShareCommand}.
21
+ */
22
+ export interface DescribeQuotaShareCommandOutput extends DescribeQuotaShareResponse, __MetadataBearer {
23
+ }
24
+ declare const DescribeQuotaShareCommand_base: {
25
+ new (input: DescribeQuotaShareCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeQuotaShareCommandInput, DescribeQuotaShareCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: DescribeQuotaShareCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeQuotaShareCommandInput, DescribeQuotaShareCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a description of the specified quota share.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { BatchClient, DescribeQuotaShareCommand } from "@aws-sdk/client-batch"; // ES Modules import
35
+ * // const { BatchClient, DescribeQuotaShareCommand } = require("@aws-sdk/client-batch"); // CommonJS import
36
+ * // import type { BatchClientConfig } from "@aws-sdk/client-batch";
37
+ * const config = {}; // type is BatchClientConfig
38
+ * const client = new BatchClient(config);
39
+ * const input = { // DescribeQuotaShareRequest
40
+ * quotaShareArn: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new DescribeQuotaShareCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // DescribeQuotaShareResponse
45
+ * // quotaShareName: "STRING_VALUE",
46
+ * // quotaShareArn: "STRING_VALUE",
47
+ * // jobQueueArn: "STRING_VALUE",
48
+ * // capacityLimits: [ // QuotaShareCapacityLimits
49
+ * // { // QuotaShareCapacityLimit
50
+ * // maxCapacity: Number("int"), // required
51
+ * // capacityUnit: "STRING_VALUE", // required
52
+ * // },
53
+ * // ],
54
+ * // resourceSharingConfiguration: { // QuotaShareResourceSharingConfiguration
55
+ * // strategy: "RESERVE" || "LEND" || "LEND_AND_BORROW", // required
56
+ * // borrowLimit: Number("int"),
57
+ * // },
58
+ * // preemptionConfiguration: { // QuotaSharePreemptionConfiguration
59
+ * // inSharePreemption: "ENABLED" || "DISABLED", // required
60
+ * // },
61
+ * // state: "ENABLED" || "DISABLED",
62
+ * // status: "CREATING" || "VALID" || "INVALID" || "UPDATING" || "DELETING",
63
+ * // tags: { // TagrisTagsMap
64
+ * // "<keys>": "STRING_VALUE",
65
+ * // },
66
+ * // };
67
+ *
68
+ * ```
69
+ *
70
+ * @param DescribeQuotaShareCommandInput - {@link DescribeQuotaShareCommandInput}
71
+ * @returns {@link DescribeQuotaShareCommandOutput}
72
+ * @see {@link DescribeQuotaShareCommandInput} for command's `input` shape.
73
+ * @see {@link DescribeQuotaShareCommandOutput} 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 DescribeQuotaShareCommand extends DescribeQuotaShareCommand_base {
91
+ /** @internal type navigation helper, not in runtime. */
92
+ protected static __types: {
93
+ api: {
94
+ input: DescribeQuotaShareRequest;
95
+ output: DescribeQuotaShareResponse;
96
+ };
97
+ sdk: {
98
+ input: DescribeQuotaShareCommandInput;
99
+ output: DescribeQuotaShareCommandOutput;
100
+ };
101
+ };
102
+ }
@@ -48,6 +48,9 @@ declare const DescribeSchedulingPoliciesCommand_base: {
48
48
  * // { // SchedulingPolicyDetail
49
49
  * // name: "STRING_VALUE", // required
50
50
  * // arn: "STRING_VALUE", // required
51
+ * // quotaSharePolicy: { // QuotaSharePolicy
52
+ * // idleResourceAssignmentStrategy: "FIFO", // required
53
+ * // },
51
54
  * // fairsharePolicy: { // FairsharePolicy
52
55
  * // shareDecaySeconds: Number("int"),
53
56
  * // computeReservation: Number("int"),
@@ -85,6 +85,21 @@ declare const DescribeServiceJobCommand_base: {
85
85
  * // serviceRequestPayload: "STRING_VALUE",
86
86
  * // serviceJobType: "SAGEMAKER_TRAINING", // required
87
87
  * // shareIdentifier: "STRING_VALUE",
88
+ * // quotaShareName: "STRING_VALUE",
89
+ * // preemptionConfiguration: { // ServiceJobPreemptionConfiguration
90
+ * // preemptionRetriesBeforeTermination: Number("int"),
91
+ * // },
92
+ * // preemptionSummary: { // ServiceJobPreemptionSummary
93
+ * // preemptedAttemptCount: Number("int"),
94
+ * // recentPreemptedAttempts: [ // ServiceJobRecentPreemptedAttemptList
95
+ * // { // ServiceJobPreemptedAttempt
96
+ * // serviceResourceId: "<ServiceResourceId>",
97
+ * // startedAt: Number("long"),
98
+ * // stoppedAt: Number("long"),
99
+ * // statusReason: "STRING_VALUE",
100
+ * // },
101
+ * // ],
102
+ * // },
88
103
  * // startedAt: Number("long"), // required
89
104
  * // status: "SUBMITTED" || "PENDING" || "RUNNABLE" || "SCHEDULED" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED", // required
90
105
  * // statusReason: "STRING_VALUE",
@@ -27,8 +27,10 @@ declare const GetJobQueueSnapshotCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Provides a list of the first 100 <code>RUNNABLE</code> jobs associated to a single job
31
- * queue and includes capacity utilization, including total usage and breakdown by share for fairshare scheduling job queues. </p>
30
+ * <p>Provides a snapshot of job queue state, including ordering of <code>RUNNABLE</code> jobs, as well as capacity utilization for already dispatched jobs.
31
+ * The first 100 <code>RUNNABLE</code> jobs in the job queue are listed in order of dispatch. For job queues with an attached
32
+ * quota-share policy, the first <code>RUNNABLE</code> job in each quota share is also listed. Capacity utilization for the job queue is provided, as well as
33
+ * break downs by share for job queues with attached fair-share or quota-share scheduling policies.</p>
32
34
  * @example
33
35
  * Use a bare-bones client and the command you need to make an API call.
34
36
  * ```javascript
@@ -52,6 +54,17 @@ declare const GetJobQueueSnapshotCommand_base: {
52
54
  * // ],
53
55
  * // lastUpdatedAt: Number("long"),
54
56
  * // },
57
+ * // frontOfQuotaShares: { // FrontOfQuotaSharesDetail
58
+ * // quotaShares: { // FrontOfQuotaSharesJobSummaryMap
59
+ * // "<keys>": [ // FrontOfQuotaShareJobSummaryList
60
+ * // { // FrontOfQuotaShareJobSummary
61
+ * // jobArn: "STRING_VALUE",
62
+ * // earliestTimeAtPosition: Number("long"),
63
+ * // },
64
+ * // ],
65
+ * // },
66
+ * // lastUpdatedAt: Number("long"),
67
+ * // },
55
68
  * // queueUtilization: { // QueueSnapshotUtilizationDetail
56
69
  * // totalCapacityUsage: [ // QueueSnapshotCapacityUsageList
57
70
  * // { // QueueSnapshotCapacityUsage
@@ -73,6 +86,19 @@ declare const GetJobQueueSnapshotCommand_base: {
73
86
  * // },
74
87
  * // ],
75
88
  * // },
89
+ * // quotaShareUtilization: { // QuotaShareUtilizationDetail
90
+ * // topCapacityUtilization: [ // QuotaShareCapacityUtilizationList
91
+ * // { // QuotaShareCapacityUtilization
92
+ * // quotaShareName: "STRING_VALUE",
93
+ * // capacityUsage: [ // QuotaShareCapacityUsageList
94
+ * // { // QuotaShareCapacityUsage
95
+ * // capacityUnit: "STRING_VALUE",
96
+ * // quantity: Number("double"),
97
+ * // },
98
+ * // ],
99
+ * // },
100
+ * // ],
101
+ * // },
76
102
  * // lastUpdatedAt: Number("long"),
77
103
  * // },
78
104
  * // };
@@ -0,0 +1,106 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
4
+ import type { ListQuotaSharesRequest, ListQuotaSharesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListQuotaSharesCommand}.
14
+ */
15
+ export interface ListQuotaSharesCommandInput extends ListQuotaSharesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListQuotaSharesCommand}.
21
+ */
22
+ export interface ListQuotaSharesCommandOutput extends ListQuotaSharesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListQuotaSharesCommand_base: {
25
+ new (input: ListQuotaSharesCommandInput): import("@smithy/smithy-client").CommandImpl<ListQuotaSharesCommandInput, ListQuotaSharesCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListQuotaSharesCommandInput): import("@smithy/smithy-client").CommandImpl<ListQuotaSharesCommandInput, ListQuotaSharesCommandOutput, BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a list of Batch quota shares associated with a 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, ListQuotaSharesCommand } from "@aws-sdk/client-batch"; // ES Modules import
35
+ * // const { BatchClient, ListQuotaSharesCommand } = require("@aws-sdk/client-batch"); // CommonJS import
36
+ * // import type { BatchClientConfig } from "@aws-sdk/client-batch";
37
+ * const config = {}; // type is BatchClientConfig
38
+ * const client = new BatchClient(config);
39
+ * const input = { // ListQuotaSharesRequest
40
+ * jobQueue: "STRING_VALUE", // required
41
+ * maxResults: Number("int"),
42
+ * nextToken: "STRING_VALUE",
43
+ * };
44
+ * const command = new ListQuotaSharesCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // ListQuotaSharesResponse
47
+ * // quotaShares: [ // QuotaShareList
48
+ * // { // QuotaShareDetail
49
+ * // quotaShareName: "STRING_VALUE",
50
+ * // quotaShareArn: "STRING_VALUE",
51
+ * // jobQueueArn: "STRING_VALUE",
52
+ * // capacityLimits: [ // QuotaShareCapacityLimits
53
+ * // { // QuotaShareCapacityLimit
54
+ * // maxCapacity: Number("int"), // required
55
+ * // capacityUnit: "STRING_VALUE", // required
56
+ * // },
57
+ * // ],
58
+ * // resourceSharingConfiguration: { // QuotaShareResourceSharingConfiguration
59
+ * // strategy: "RESERVE" || "LEND" || "LEND_AND_BORROW", // required
60
+ * // borrowLimit: Number("int"),
61
+ * // },
62
+ * // preemptionConfiguration: { // QuotaSharePreemptionConfiguration
63
+ * // inSharePreemption: "ENABLED" || "DISABLED", // required
64
+ * // },
65
+ * // state: "ENABLED" || "DISABLED",
66
+ * // status: "CREATING" || "VALID" || "INVALID" || "UPDATING" || "DELETING",
67
+ * // },
68
+ * // ],
69
+ * // nextToken: "STRING_VALUE",
70
+ * // };
71
+ *
72
+ * ```
73
+ *
74
+ * @param ListQuotaSharesCommandInput - {@link ListQuotaSharesCommandInput}
75
+ * @returns {@link ListQuotaSharesCommandOutput}
76
+ * @see {@link ListQuotaSharesCommandInput} for command's `input` shape.
77
+ * @see {@link ListQuotaSharesCommandOutput} for command's `response` shape.
78
+ * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
79
+ *
80
+ * @throws {@link ClientException} (client fault)
81
+ * <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
82
+ * of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
83
+ * that's not valid.</p>
84
+ *
85
+ * @throws {@link ServerException} (server fault)
86
+ * <p>These errors are usually caused by a server issue.</p>
87
+ *
88
+ * @throws {@link BatchServiceException}
89
+ * <p>Base exception class for all service exceptions from Batch service.</p>
90
+ *
91
+ *
92
+ * @public
93
+ */
94
+ export declare class ListQuotaSharesCommand extends ListQuotaSharesCommand_base {
95
+ /** @internal type navigation helper, not in runtime. */
96
+ protected static __types: {
97
+ api: {
98
+ input: ListQuotaSharesRequest;
99
+ output: ListQuotaSharesResponse;
100
+ };
101
+ sdk: {
102
+ input: ListQuotaSharesCommandInput;
103
+ output: ListQuotaSharesCommandOutput;
104
+ };
105
+ };
106
+ }
@@ -74,6 +74,7 @@ declare const ListServiceJobsCommand_base: {
74
74
  * // scheduledAt: Number("long"),
75
75
  * // serviceJobType: "SAGEMAKER_TRAINING", // required
76
76
  * // shareIdentifier: "STRING_VALUE",
77
+ * // quotaShareName: "STRING_VALUE",
77
78
  * // status: "SUBMITTED" || "PENDING" || "RUNNABLE" || "SCHEDULED" || "STARTING" || "RUNNING" || "SUCCEEDED" || "FAILED",
78
79
  * // statusReason: "STRING_VALUE",
79
80
  * // startedAt: Number("long"),
@@ -52,6 +52,10 @@ declare const SubmitServiceJobCommand_base: {
52
52
  * serviceRequestPayload: "STRING_VALUE", // required
53
53
  * serviceJobType: "SAGEMAKER_TRAINING", // required
54
54
  * shareIdentifier: "STRING_VALUE",
55
+ * quotaShareName: "STRING_VALUE",
56
+ * preemptionConfiguration: { // ServiceJobPreemptionConfiguration
57
+ * preemptionRetriesBeforeTermination: Number("int"),
58
+ * },
55
59
  * timeoutConfig: { // ServiceJobTimeout
56
60
  * attemptDurationSeconds: Number("int"),
57
61
  * },