@aws-sdk/client-batch 3.757.0 → 3.758.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/CreateConsumableResourceCommand.d.ts +23 -0
- package/dist-types/commands/DeleteConsumableResourceCommand.d.ts +11 -0
- package/dist-types/commands/DescribeConsumableResourceCommand.d.ts +26 -0
- package/dist-types/commands/ListConsumableResourcesCommand.d.ts +32 -0
- package/dist-types/commands/ListJobsByConsumableResourceCommand.d.ts +43 -0
- package/dist-types/commands/UpdateConsumableResourceCommand.d.ts +20 -0
- package/package.json +12 -12
|
@@ -69,6 +69,29 @@ declare const CreateConsumableResourceCommand_base: {
|
|
|
69
69
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
70
70
|
*
|
|
71
71
|
* @public
|
|
72
|
+
* @example To create a consumable resource
|
|
73
|
+
* ```javascript
|
|
74
|
+
* // Creates a Batch consumable resource.
|
|
75
|
+
* const input = {
|
|
76
|
+
* "consumableResourceName": "myConsumableResource",
|
|
77
|
+
* "resourceType": "REPLENISHABLE",
|
|
78
|
+
* "tags": {
|
|
79
|
+
* "Department": "Engineering",
|
|
80
|
+
* "User": "JaneDoe"
|
|
81
|
+
* },
|
|
82
|
+
* "totalQuantity": 123
|
|
83
|
+
* };
|
|
84
|
+
* const command = new CreateConsumableResourceCommand(input);
|
|
85
|
+
* const response = await client.send(command);
|
|
86
|
+
* /* response ==
|
|
87
|
+
* {
|
|
88
|
+
* "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
|
89
|
+
* "consumableResourceName": "myConsumableResource"
|
|
90
|
+
* }
|
|
91
|
+
* *\/
|
|
92
|
+
* // example id: to-create-a-consumable-resource-1739494856623
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
72
95
|
*/
|
|
73
96
|
export declare class CreateConsumableResourceCommand extends CreateConsumableResourceCommand_base {
|
|
74
97
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -61,6 +61,17 @@ declare const DeleteConsumableResourceCommand_base: {
|
|
|
61
61
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
62
62
|
*
|
|
63
63
|
* @public
|
|
64
|
+
* @example To delete a consumable resource
|
|
65
|
+
* ```javascript
|
|
66
|
+
* // Deletes the specified consumable resource.
|
|
67
|
+
* const input = {
|
|
68
|
+
* "consumableResource": "myConsumableResource"
|
|
69
|
+
* };
|
|
70
|
+
* const command = new DeleteConsumableResourceCommand(input);
|
|
71
|
+
* await client.send(command);
|
|
72
|
+
* // example id: to-delete-a-consumable-resource-1739495667751
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
64
75
|
*/
|
|
65
76
|
export declare class DeleteConsumableResourceCommand extends DeleteConsumableResourceCommand_base {
|
|
66
77
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,6 +72,32 @@ declare const DescribeConsumableResourceCommand_base: {
|
|
|
72
72
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
73
73
|
*
|
|
74
74
|
* @public
|
|
75
|
+
* @example To get a description of a consumable resource
|
|
76
|
+
* ```javascript
|
|
77
|
+
* // Returns a description of the specified consumable resource.
|
|
78
|
+
* const input = {
|
|
79
|
+
* "consumableResource": "myConsumableResource"
|
|
80
|
+
* };
|
|
81
|
+
* const command = new DescribeConsumableResourceCommand(input);
|
|
82
|
+
* const response = await client.send(command);
|
|
83
|
+
* /* response ==
|
|
84
|
+
* {
|
|
85
|
+
* "availableQuantity": 123,
|
|
86
|
+
* "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
|
87
|
+
* "consumableResourceName": "myConsumableResource",
|
|
88
|
+
* "createdAt": 123,
|
|
89
|
+
* "inUseQuantity": 123,
|
|
90
|
+
* "resourceType": "REPLENISHABLE",
|
|
91
|
+
* "tags": {
|
|
92
|
+
* "Department": "Engineering",
|
|
93
|
+
* "User": "JaneDoe"
|
|
94
|
+
* },
|
|
95
|
+
* "totalQuantity": 123
|
|
96
|
+
* }
|
|
97
|
+
* *\/
|
|
98
|
+
* // example id: to-get-a-description-of-a-consumable-resource-1739495864808
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
75
101
|
*/
|
|
76
102
|
export declare class DescribeConsumableResourceCommand extends DescribeConsumableResourceCommand_base {
|
|
77
103
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -81,6 +81,38 @@ declare const ListConsumableResourcesCommand_base: {
|
|
|
81
81
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
82
82
|
*
|
|
83
83
|
* @public
|
|
84
|
+
* @example To get a list of a consumable resources
|
|
85
|
+
* ```javascript
|
|
86
|
+
* // Returns a list of the consumable resources for your account.
|
|
87
|
+
* const input = {
|
|
88
|
+
* "filters": [
|
|
89
|
+
* {
|
|
90
|
+
* "name": "CONSUMABLE_RESOURCE_NAME",
|
|
91
|
+
* "values": [
|
|
92
|
+
* "my*"
|
|
93
|
+
* ]
|
|
94
|
+
* }
|
|
95
|
+
* ],
|
|
96
|
+
* "maxResults": 123
|
|
97
|
+
* };
|
|
98
|
+
* const command = new ListConsumableResourcesCommand(input);
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response ==
|
|
101
|
+
* {
|
|
102
|
+
* "consumableResources": [
|
|
103
|
+
* {
|
|
104
|
+
* "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
|
105
|
+
* "consumableResourceName": "myConsumableResource",
|
|
106
|
+
* "inUseQuantity": 12,
|
|
107
|
+
* "resourceType": "REPLENISHABLE",
|
|
108
|
+
* "totalQuantity": 123
|
|
109
|
+
* }
|
|
110
|
+
* ]
|
|
111
|
+
* }
|
|
112
|
+
* *\/
|
|
113
|
+
* // example id: to-get-a-list-of-a-consumable-resources-1739496071960
|
|
114
|
+
* ```
|
|
115
|
+
*
|
|
84
116
|
*/
|
|
85
117
|
export declare class ListConsumableResourcesCommand extends ListConsumableResourcesCommand_base {
|
|
86
118
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -95,6 +95,49 @@ declare const ListJobsByConsumableResourceCommand_base: {
|
|
|
95
95
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
96
96
|
*
|
|
97
97
|
* @public
|
|
98
|
+
* @example To get a list of Batch jobs by consumable resource
|
|
99
|
+
* ```javascript
|
|
100
|
+
* // Returns a list of Batch jobs that require a specific consumable resource.
|
|
101
|
+
* const input = {
|
|
102
|
+
* "consumableResource": "myConsumableResource",
|
|
103
|
+
* "filters": [
|
|
104
|
+
* {
|
|
105
|
+
* "name": "CONSUMABLE_RESOURCE_NAME",
|
|
106
|
+
* "values": [
|
|
107
|
+
* "my*"
|
|
108
|
+
* ]
|
|
109
|
+
* }
|
|
110
|
+
* ],
|
|
111
|
+
* "maxResults": 123
|
|
112
|
+
* };
|
|
113
|
+
* const command = new ListJobsByConsumableResourceCommand(input);
|
|
114
|
+
* const response = await client.send(command);
|
|
115
|
+
* /* response ==
|
|
116
|
+
* {
|
|
117
|
+
* "jobs": [
|
|
118
|
+
* {
|
|
119
|
+
* "consumableResourceProperties": {
|
|
120
|
+
* "consumableResourceList": [
|
|
121
|
+
* {
|
|
122
|
+
* "consumableResource": "myConsumableResource",
|
|
123
|
+
* "quantity": 123
|
|
124
|
+
* }
|
|
125
|
+
* ]
|
|
126
|
+
* },
|
|
127
|
+
* "createdAt": 1480460782010,
|
|
128
|
+
* "jobArn": "arn:aws:batch:us-east-1:012345678910:job/myJob",
|
|
129
|
+
* "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/myJobDef",
|
|
130
|
+
* "jobName": "myJob",
|
|
131
|
+
* "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/myJobQueue",
|
|
132
|
+
* "jobStatus": "PENDING",
|
|
133
|
+
* "quantity": 123
|
|
134
|
+
* }
|
|
135
|
+
* ]
|
|
136
|
+
* }
|
|
137
|
+
* *\/
|
|
138
|
+
* // example id: to-get-a-list-of-batch-jobs-by-consumable-resource-1739496640347
|
|
139
|
+
* ```
|
|
140
|
+
*
|
|
98
141
|
*/
|
|
99
142
|
export declare class ListJobsByConsumableResourceCommand extends ListJobsByConsumableResourceCommand_base {
|
|
100
143
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -68,6 +68,26 @@ declare const UpdateConsumableResourceCommand_base: {
|
|
|
68
68
|
* <p>Base exception class for all service exceptions from Batch service.</p>
|
|
69
69
|
*
|
|
70
70
|
* @public
|
|
71
|
+
* @example To update a consumable resource
|
|
72
|
+
* ```javascript
|
|
73
|
+
* // Updates a consumable resource.
|
|
74
|
+
* const input = {
|
|
75
|
+
* "consumableResource": "myConsumableResource",
|
|
76
|
+
* "operation": "ADD",
|
|
77
|
+
* "quantity": 12
|
|
78
|
+
* };
|
|
79
|
+
* const command = new UpdateConsumableResourceCommand(input);
|
|
80
|
+
* const response = await client.send(command);
|
|
81
|
+
* /* response ==
|
|
82
|
+
* {
|
|
83
|
+
* "consumableResourceArn": "arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource",
|
|
84
|
+
* "consumableResourceName": "myConsumableResource",
|
|
85
|
+
* "totalQuantity": 135
|
|
86
|
+
* }
|
|
87
|
+
* *\/
|
|
88
|
+
* // example id: to-update-a-consumable-resource-1739497761692
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
71
91
|
*/
|
|
72
92
|
export declare class UpdateConsumableResourceCommand extends UpdateConsumableResourceCommand_base {
|
|
73
93
|
/** @internal type navigation helper, not in runtime. */
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-batch",
|
|
3
3
|
"description": "AWS SDK for JavaScript Batch Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.758.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-batch",
|
|
@@ -20,38 +20,38 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/core": "3.758.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.758.0",
|
|
25
25
|
"@aws-sdk/middleware-host-header": "3.734.0",
|
|
26
26
|
"@aws-sdk/middleware-logger": "3.734.0",
|
|
27
27
|
"@aws-sdk/middleware-recursion-detection": "3.734.0",
|
|
28
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
28
|
+
"@aws-sdk/middleware-user-agent": "3.758.0",
|
|
29
29
|
"@aws-sdk/region-config-resolver": "3.734.0",
|
|
30
30
|
"@aws-sdk/types": "3.734.0",
|
|
31
31
|
"@aws-sdk/util-endpoints": "3.743.0",
|
|
32
32
|
"@aws-sdk/util-user-agent-browser": "3.734.0",
|
|
33
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
33
|
+
"@aws-sdk/util-user-agent-node": "3.758.0",
|
|
34
34
|
"@smithy/config-resolver": "^4.0.1",
|
|
35
|
-
"@smithy/core": "^3.1.
|
|
35
|
+
"@smithy/core": "^3.1.5",
|
|
36
36
|
"@smithy/fetch-http-handler": "^5.0.1",
|
|
37
37
|
"@smithy/hash-node": "^4.0.1",
|
|
38
38
|
"@smithy/invalid-dependency": "^4.0.1",
|
|
39
39
|
"@smithy/middleware-content-length": "^4.0.1",
|
|
40
|
-
"@smithy/middleware-endpoint": "^4.0.
|
|
41
|
-
"@smithy/middleware-retry": "^4.0.
|
|
40
|
+
"@smithy/middleware-endpoint": "^4.0.6",
|
|
41
|
+
"@smithy/middleware-retry": "^4.0.7",
|
|
42
42
|
"@smithy/middleware-serde": "^4.0.2",
|
|
43
43
|
"@smithy/middleware-stack": "^4.0.1",
|
|
44
44
|
"@smithy/node-config-provider": "^4.0.1",
|
|
45
|
-
"@smithy/node-http-handler": "^4.0.
|
|
45
|
+
"@smithy/node-http-handler": "^4.0.3",
|
|
46
46
|
"@smithy/protocol-http": "^5.0.1",
|
|
47
|
-
"@smithy/smithy-client": "^4.1.
|
|
47
|
+
"@smithy/smithy-client": "^4.1.6",
|
|
48
48
|
"@smithy/types": "^4.1.0",
|
|
49
49
|
"@smithy/url-parser": "^4.0.1",
|
|
50
50
|
"@smithy/util-base64": "^4.0.0",
|
|
51
51
|
"@smithy/util-body-length-browser": "^4.0.0",
|
|
52
52
|
"@smithy/util-body-length-node": "^4.0.0",
|
|
53
|
-
"@smithy/util-defaults-mode-browser": "^4.0.
|
|
54
|
-
"@smithy/util-defaults-mode-node": "^4.0.
|
|
53
|
+
"@smithy/util-defaults-mode-browser": "^4.0.7",
|
|
54
|
+
"@smithy/util-defaults-mode-node": "^4.0.7",
|
|
55
55
|
"@smithy/util-endpoints": "^3.0.1",
|
|
56
56
|
"@smithy/util-middleware": "^4.0.1",
|
|
57
57
|
"@smithy/util-retry": "^4.0.1",
|