@aws-sdk/client-deadline 3.1024.0 → 3.1025.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 (83) hide show
  1. package/README.md +56 -0
  2. package/dist-cjs/index.js +274 -102
  3. package/dist-cjs/schemas/schemas_0.js +399 -44
  4. package/dist-es/Deadline.js +16 -0
  5. package/dist-es/commands/BatchGetJobCommand.js +16 -0
  6. package/dist-es/commands/BatchGetSessionActionCommand.js +16 -0
  7. package/dist-es/commands/BatchGetSessionCommand.js +16 -0
  8. package/dist-es/commands/BatchGetStepCommand.js +16 -0
  9. package/dist-es/commands/BatchGetTaskCommand.js +16 -0
  10. package/dist-es/commands/BatchGetWorkerCommand.js +16 -0
  11. package/dist-es/commands/BatchUpdateJobCommand.js +16 -0
  12. package/dist-es/commands/BatchUpdateTaskCommand.js +16 -0
  13. package/dist-es/commands/index.js +8 -0
  14. package/dist-es/models/enums.js +154 -102
  15. package/dist-es/schemas/schemas_0.js +388 -34
  16. package/dist-types/Deadline.d.ts +56 -0
  17. package/dist-types/DeadlineClient.d.ts +10 -2
  18. package/dist-types/commands/BatchGetJobCommand.d.ts +176 -0
  19. package/dist-types/commands/BatchGetSessionActionCommand.d.ts +180 -0
  20. package/dist-types/commands/BatchGetSessionCommand.d.ts +177 -0
  21. package/dist-types/commands/BatchGetStepCommand.d.ts +193 -0
  22. package/dist-types/commands/BatchGetTaskCommand.d.ts +160 -0
  23. package/dist-types/commands/BatchGetWorkerCommand.d.ts +159 -0
  24. package/dist-types/commands/BatchUpdateJobCommand.d.ts +135 -0
  25. package/dist-types/commands/BatchUpdateTaskCommand.d.ts +136 -0
  26. package/dist-types/commands/CreateMonitorCommand.d.ts +1 -0
  27. package/dist-types/commands/GetMonitorCommand.d.ts +1 -0
  28. package/dist-types/commands/GetQueueFleetAssociationCommand.d.ts +1 -1
  29. package/dist-types/commands/GetQueueLimitAssociationCommand.d.ts +1 -1
  30. package/dist-types/commands/GetSessionsStatisticsAggregationCommand.d.ts +1 -2
  31. package/dist-types/commands/ListMonitorsCommand.d.ts +1 -0
  32. package/dist-types/commands/ListQueueEnvironmentsCommand.d.ts +1 -1
  33. package/dist-types/commands/ListQueueMembersCommand.d.ts +1 -1
  34. package/dist-types/commands/ListQueuesCommand.d.ts +1 -1
  35. package/dist-types/commands/ListStorageProfilesForQueueCommand.d.ts +1 -1
  36. package/dist-types/commands/ListTasksCommand.d.ts +2 -1
  37. package/dist-types/commands/UpdateFarmCommand.d.ts +1 -1
  38. package/dist-types/commands/UpdateJobCommand.d.ts +1 -1
  39. package/dist-types/commands/UpdateLimitCommand.d.ts +1 -1
  40. package/dist-types/commands/UpdateQueueCommand.d.ts +1 -1
  41. package/dist-types/commands/UpdateQueueEnvironmentCommand.d.ts +1 -1
  42. package/dist-types/commands/UpdateSessionCommand.d.ts +1 -1
  43. package/dist-types/commands/UpdateStepCommand.d.ts +1 -1
  44. package/dist-types/commands/UpdateStorageProfileCommand.d.ts +1 -1
  45. package/dist-types/commands/UpdateTaskCommand.d.ts +1 -1
  46. package/dist-types/commands/index.d.ts +8 -0
  47. package/dist-types/models/enums.d.ts +310 -194
  48. package/dist-types/models/models_0.d.ts +3347 -3110
  49. package/dist-types/models/models_1.d.ts +1057 -2
  50. package/dist-types/schemas/schemas_0.d.ts +46 -0
  51. package/dist-types/ts3.4/Deadline.d.ts +136 -0
  52. package/dist-types/ts3.4/DeadlineClient.d.ts +48 -0
  53. package/dist-types/ts3.4/commands/BatchGetJobCommand.d.ts +47 -0
  54. package/dist-types/ts3.4/commands/BatchGetSessionActionCommand.d.ts +51 -0
  55. package/dist-types/ts3.4/commands/BatchGetSessionCommand.d.ts +50 -0
  56. package/dist-types/ts3.4/commands/BatchGetStepCommand.d.ts +47 -0
  57. package/dist-types/ts3.4/commands/BatchGetTaskCommand.d.ts +47 -0
  58. package/dist-types/ts3.4/commands/BatchGetWorkerCommand.d.ts +50 -0
  59. package/dist-types/ts3.4/commands/BatchUpdateJobCommand.d.ts +50 -0
  60. package/dist-types/ts3.4/commands/BatchUpdateTaskCommand.d.ts +50 -0
  61. package/dist-types/ts3.4/commands/GetQueueFleetAssociationCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/GetQueueLimitAssociationCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/GetSessionsStatisticsAggregationCommand.d.ts +4 -2
  64. package/dist-types/ts3.4/commands/ListQueueEnvironmentsCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/ListQueueMembersCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/ListStorageProfilesForQueueCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/ListTasksCommand.d.ts +2 -1
  69. package/dist-types/ts3.4/commands/UpdateFarmCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/UpdateJobCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/UpdateLimitCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/UpdateQueueCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/UpdateQueueEnvironmentCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/UpdateStepCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/UpdateStorageProfileCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/UpdateTaskCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  79. package/dist-types/ts3.4/models/enums.d.ts +194 -126
  80. package/dist-types/ts3.4/models/models_0.d.ts +583 -522
  81. package/dist-types/ts3.4/models/models_1.d.ts +251 -1
  82. package/dist-types/ts3.4/schemas/schemas_0.d.ts +46 -0
  83. package/package.json +1 -1
@@ -0,0 +1,177 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
+ import type { BatchGetSessionRequest, BatchGetSessionResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link BatchGetSessionCommand}.
14
+ */
15
+ export interface BatchGetSessionCommandInput extends BatchGetSessionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchGetSessionCommand}.
21
+ */
22
+ export interface BatchGetSessionCommandOutput extends BatchGetSessionResponse, __MetadataBearer {
23
+ }
24
+ declare const BatchGetSessionCommand_base: {
25
+ new (input: BatchGetSessionCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetSessionCommandInput, BatchGetSessionCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: BatchGetSessionCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetSessionCommandInput, BatchGetSessionCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves multiple sessions in a single request. This is a batch version of the <code>GetSession</code> API.</p> <p>The result of getting each session is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { DeadlineClient, BatchGetSessionCommand } from "@aws-sdk/client-deadline"; // ES Modules import
35
+ * // const { DeadlineClient, BatchGetSessionCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
36
+ * // import type { DeadlineClientConfig } from "@aws-sdk/client-deadline";
37
+ * const config = {}; // type is DeadlineClientConfig
38
+ * const client = new DeadlineClient(config);
39
+ * const input = { // BatchGetSessionRequest
40
+ * identifiers: [ // BatchGetSessionIdentifiers // required
41
+ * { // BatchGetSessionIdentifier
42
+ * farmId: "STRING_VALUE", // required
43
+ * queueId: "STRING_VALUE", // required
44
+ * jobId: "STRING_VALUE", // required
45
+ * sessionId: "STRING_VALUE", // required
46
+ * },
47
+ * ],
48
+ * };
49
+ * const command = new BatchGetSessionCommand(input);
50
+ * const response = await client.send(command);
51
+ * // { // BatchGetSessionResponse
52
+ * // sessions: [ // BatchGetSessionItems // required
53
+ * // { // BatchGetSessionItem
54
+ * // farmId: "STRING_VALUE", // required
55
+ * // queueId: "STRING_VALUE", // required
56
+ * // jobId: "STRING_VALUE", // required
57
+ * // sessionId: "STRING_VALUE", // required
58
+ * // fleetId: "STRING_VALUE", // required
59
+ * // workerId: "STRING_VALUE", // required
60
+ * // startedAt: new Date("TIMESTAMP"), // required
61
+ * // lifecycleStatus: "STARTED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCEEDED" || "UPDATE_FAILED" || "ENDED", // required
62
+ * // endedAt: new Date("TIMESTAMP"),
63
+ * // targetLifecycleStatus: "ENDED",
64
+ * // updatedAt: new Date("TIMESTAMP"),
65
+ * // updatedBy: "STRING_VALUE",
66
+ * // log: { // LogConfiguration
67
+ * // logDriver: "STRING_VALUE", // required
68
+ * // options: { // LogOptions
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // parameters: { // LogParameters
72
+ * // "<keys>": "STRING_VALUE",
73
+ * // },
74
+ * // error: "STRING_VALUE",
75
+ * // },
76
+ * // hostProperties: { // HostPropertiesResponse
77
+ * // ipAddresses: { // IpAddresses
78
+ * // ipV4Addresses: [ // IpV4Addresses
79
+ * // "STRING_VALUE",
80
+ * // ],
81
+ * // ipV6Addresses: [ // IpV6Addresses
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // },
85
+ * // hostName: "STRING_VALUE",
86
+ * // ec2InstanceArn: "STRING_VALUE",
87
+ * // ec2InstanceType: "STRING_VALUE",
88
+ * // },
89
+ * // workerLog: {
90
+ * // logDriver: "STRING_VALUE", // required
91
+ * // options: {
92
+ * // "<keys>": "STRING_VALUE",
93
+ * // },
94
+ * // parameters: {
95
+ * // "<keys>": "STRING_VALUE",
96
+ * // },
97
+ * // error: "STRING_VALUE",
98
+ * // },
99
+ * // },
100
+ * // ],
101
+ * // errors: [ // BatchGetSessionErrors // required
102
+ * // { // BatchGetSessionError
103
+ * // farmId: "STRING_VALUE", // required
104
+ * // queueId: "STRING_VALUE", // required
105
+ * // jobId: "STRING_VALUE", // required
106
+ * // sessionId: "STRING_VALUE", // required
107
+ * // code: "InternalServerErrorException" || "ResourceNotFoundException" || "ValidationException", // required
108
+ * // message: "STRING_VALUE", // required
109
+ * // },
110
+ * // ],
111
+ * // };
112
+ *
113
+ * ```
114
+ *
115
+ * @param BatchGetSessionCommandInput - {@link BatchGetSessionCommandInput}
116
+ * @returns {@link BatchGetSessionCommandOutput}
117
+ * @see {@link BatchGetSessionCommandInput} for command's `input` shape.
118
+ * @see {@link BatchGetSessionCommandOutput} for command's `response` shape.
119
+ * @see {@link DeadlineClientResolvedConfig | config} for DeadlineClient's `config` shape.
120
+ *
121
+ * @throws {@link AccessDeniedException} (client fault)
122
+ * <p>You don't have permission to perform the action.</p>
123
+ *
124
+ * @throws {@link InternalServerErrorException} (server fault)
125
+ * <p>Deadline Cloud can't process your request right now. Try again later.</p>
126
+ *
127
+ * @throws {@link ThrottlingException} (client fault)
128
+ * <p>Your request exceeded a request rate quota.</p>
129
+ *
130
+ * @throws {@link ValidationException} (client fault)
131
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
132
+ *
133
+ * @throws {@link DeadlineServiceException}
134
+ * <p>Base exception class for all service exceptions from Deadline service.</p>
135
+ *
136
+ *
137
+ * @example Get multiple sessions in a single request
138
+ * ```javascript
139
+ * //
140
+ * const input = {
141
+ * identifiers: [
142
+ * {
143
+ * farmId: "farm-1234567890abcdef1234567890abcdef",
144
+ * jobId: "job-1234567890abcdef1234567890abcdef",
145
+ * queueId: "queue-1234567890abcdef1234567890abcdef",
146
+ * sessionId: "session-1234567890abcdef1234567890abcdef"
147
+ * },
148
+ * {
149
+ * farmId: "farm-1234567890abcdef1234567890abcdef",
150
+ * jobId: "job-1234567890abcdef1234567890abcdef",
151
+ * queueId: "queue-1234567890abcdef1234567890abcdef",
152
+ * sessionId: "session-234567890abcdef1234567890abcdef1"
153
+ * }
154
+ * ]
155
+ * };
156
+ * const command = new BatchGetSessionCommand(input);
157
+ * const response = await client.send(command);
158
+ * /* response is
159
+ * { /* metadata only *\/ }
160
+ * *\/
161
+ * ```
162
+ *
163
+ * @public
164
+ */
165
+ export declare class BatchGetSessionCommand extends BatchGetSessionCommand_base {
166
+ /** @internal type navigation helper, not in runtime. */
167
+ protected static __types: {
168
+ api: {
169
+ input: BatchGetSessionRequest;
170
+ output: BatchGetSessionResponse;
171
+ };
172
+ sdk: {
173
+ input: BatchGetSessionCommandInput;
174
+ output: BatchGetSessionCommandOutput;
175
+ };
176
+ };
177
+ }
@@ -0,0 +1,193 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
+ import type { BatchGetStepRequest, BatchGetStepResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link BatchGetStepCommand}.
14
+ */
15
+ export interface BatchGetStepCommandInput extends BatchGetStepRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchGetStepCommand}.
21
+ */
22
+ export interface BatchGetStepCommandOutput extends BatchGetStepResponse, __MetadataBearer {
23
+ }
24
+ declare const BatchGetStepCommand_base: {
25
+ new (input: BatchGetStepCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetStepCommandInput, BatchGetStepCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: BatchGetStepCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetStepCommandInput, BatchGetStepCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves multiple steps in a single request. This is a batch version of the <code>GetStep</code> API.</p> <p>The result of getting each step is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { DeadlineClient, BatchGetStepCommand } from "@aws-sdk/client-deadline"; // ES Modules import
35
+ * // const { DeadlineClient, BatchGetStepCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
36
+ * // import type { DeadlineClientConfig } from "@aws-sdk/client-deadline";
37
+ * const config = {}; // type is DeadlineClientConfig
38
+ * const client = new DeadlineClient(config);
39
+ * const input = { // BatchGetStepRequest
40
+ * identifiers: [ // BatchGetStepIdentifiers // required
41
+ * { // BatchGetStepIdentifier
42
+ * farmId: "STRING_VALUE", // required
43
+ * queueId: "STRING_VALUE", // required
44
+ * jobId: "STRING_VALUE", // required
45
+ * stepId: "STRING_VALUE", // required
46
+ * },
47
+ * ],
48
+ * };
49
+ * const command = new BatchGetStepCommand(input);
50
+ * const response = await client.send(command);
51
+ * // { // BatchGetStepResponse
52
+ * // steps: [ // BatchGetStepItems // required
53
+ * // { // BatchGetStepItem
54
+ * // farmId: "STRING_VALUE", // required
55
+ * // queueId: "STRING_VALUE", // required
56
+ * // jobId: "STRING_VALUE", // required
57
+ * // stepId: "STRING_VALUE", // required
58
+ * // name: "STRING_VALUE", // required
59
+ * // lifecycleStatus: "CREATE_COMPLETE" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "UPDATE_SUCCEEDED", // required
60
+ * // lifecycleStatusMessage: "STRING_VALUE",
61
+ * // taskRunStatus: "PENDING" || "READY" || "ASSIGNED" || "STARTING" || "SCHEDULED" || "INTERRUPTING" || "RUNNING" || "SUSPENDED" || "CANCELED" || "FAILED" || "SUCCEEDED" || "NOT_COMPATIBLE", // required
62
+ * // taskRunStatusCounts: { // TaskRunStatusCounts // required
63
+ * // "<keys>": Number("int"),
64
+ * // },
65
+ * // taskFailureRetryCount: Number("int"),
66
+ * // targetTaskRunStatus: "READY" || "FAILED" || "SUCCEEDED" || "CANCELED" || "SUSPENDED" || "PENDING",
67
+ * // createdAt: new Date("TIMESTAMP"), // required
68
+ * // createdBy: "STRING_VALUE", // required
69
+ * // updatedAt: new Date("TIMESTAMP"),
70
+ * // updatedBy: "STRING_VALUE",
71
+ * // startedAt: new Date("TIMESTAMP"),
72
+ * // endedAt: new Date("TIMESTAMP"),
73
+ * // dependencyCounts: { // DependencyCounts
74
+ * // dependenciesResolved: Number("int"), // required
75
+ * // dependenciesUnresolved: Number("int"), // required
76
+ * // consumersResolved: Number("int"), // required
77
+ * // consumersUnresolved: Number("int"), // required
78
+ * // },
79
+ * // requiredCapabilities: { // StepRequiredCapabilities
80
+ * // attributes: [ // StepAttributeCapabilities // required
81
+ * // { // StepAttributeCapability
82
+ * // name: "STRING_VALUE", // required
83
+ * // anyOf: [ // ListAttributeCapabilityValue
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // allOf: [
87
+ * // "STRING_VALUE",
88
+ * // ],
89
+ * // },
90
+ * // ],
91
+ * // amounts: [ // StepAmountCapabilities // required
92
+ * // { // StepAmountCapability
93
+ * // name: "STRING_VALUE", // required
94
+ * // min: Number("double"),
95
+ * // max: Number("double"),
96
+ * // value: Number("double"),
97
+ * // },
98
+ * // ],
99
+ * // },
100
+ * // parameterSpace: { // ParameterSpace
101
+ * // parameters: [ // StepParameterList // required
102
+ * // { // StepParameter
103
+ * // name: "STRING_VALUE", // required
104
+ * // type: "INT" || "FLOAT" || "STRING" || "PATH" || "CHUNK_INT", // required
105
+ * // chunks: { // StepParameterChunks
106
+ * // defaultTaskCount: Number("int"), // required
107
+ * // targetRuntimeSeconds: Number("int"),
108
+ * // rangeConstraint: "CONTIGUOUS" || "NONCONTIGUOUS", // required
109
+ * // },
110
+ * // },
111
+ * // ],
112
+ * // combination: "STRING_VALUE",
113
+ * // },
114
+ * // description: "STRING_VALUE",
115
+ * // },
116
+ * // ],
117
+ * // errors: [ // BatchGetStepErrors // required
118
+ * // { // BatchGetStepError
119
+ * // farmId: "STRING_VALUE", // required
120
+ * // queueId: "STRING_VALUE", // required
121
+ * // jobId: "STRING_VALUE", // required
122
+ * // stepId: "STRING_VALUE", // required
123
+ * // code: "InternalServerErrorException" || "ResourceNotFoundException" || "ValidationException" || "AccessDeniedException" || "ThrottlingException", // required
124
+ * // message: "STRING_VALUE", // required
125
+ * // },
126
+ * // ],
127
+ * // };
128
+ *
129
+ * ```
130
+ *
131
+ * @param BatchGetStepCommandInput - {@link BatchGetStepCommandInput}
132
+ * @returns {@link BatchGetStepCommandOutput}
133
+ * @see {@link BatchGetStepCommandInput} for command's `input` shape.
134
+ * @see {@link BatchGetStepCommandOutput} for command's `response` shape.
135
+ * @see {@link DeadlineClientResolvedConfig | config} for DeadlineClient's `config` shape.
136
+ *
137
+ * @throws {@link AccessDeniedException} (client fault)
138
+ * <p>You don't have permission to perform the action.</p>
139
+ *
140
+ * @throws {@link InternalServerErrorException} (server fault)
141
+ * <p>Deadline Cloud can't process your request right now. Try again later.</p>
142
+ *
143
+ * @throws {@link ThrottlingException} (client fault)
144
+ * <p>Your request exceeded a request rate quota.</p>
145
+ *
146
+ * @throws {@link ValidationException} (client fault)
147
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
148
+ *
149
+ * @throws {@link DeadlineServiceException}
150
+ * <p>Base exception class for all service exceptions from Deadline service.</p>
151
+ *
152
+ *
153
+ * @example Get multiple steps in a single request
154
+ * ```javascript
155
+ * //
156
+ * const input = {
157
+ * identifiers: [
158
+ * {
159
+ * farmId: "farm-1234567890abcdef1234567890abcdef",
160
+ * jobId: "job-1234567890abcdef1234567890abcdef",
161
+ * queueId: "queue-1234567890abcdef1234567890abcdef",
162
+ * stepId: "step-1234567890abcdef1234567890abcdef"
163
+ * },
164
+ * {
165
+ * farmId: "farm-1234567890abcdef1234567890abcdef",
166
+ * jobId: "job-1234567890abcdef1234567890abcdef",
167
+ * queueId: "queue-1234567890abcdef1234567890abcdef",
168
+ * stepId: "step-234567890abcdef1234567890abcdef1"
169
+ * }
170
+ * ]
171
+ * };
172
+ * const command = new BatchGetStepCommand(input);
173
+ * const response = await client.send(command);
174
+ * /* response is
175
+ * { /* metadata only *\/ }
176
+ * *\/
177
+ * ```
178
+ *
179
+ * @public
180
+ */
181
+ export declare class BatchGetStepCommand extends BatchGetStepCommand_base {
182
+ /** @internal type navigation helper, not in runtime. */
183
+ protected static __types: {
184
+ api: {
185
+ input: BatchGetStepRequest;
186
+ output: BatchGetStepResponse;
187
+ };
188
+ sdk: {
189
+ input: BatchGetStepCommandInput;
190
+ output: BatchGetStepCommandOutput;
191
+ };
192
+ };
193
+ }
@@ -0,0 +1,160 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DeadlineClient";
4
+ import type { BatchGetTaskRequest, BatchGetTaskResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link BatchGetTaskCommand}.
14
+ */
15
+ export interface BatchGetTaskCommandInput extends BatchGetTaskRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchGetTaskCommand}.
21
+ */
22
+ export interface BatchGetTaskCommandOutput extends BatchGetTaskResponse, __MetadataBearer {
23
+ }
24
+ declare const BatchGetTaskCommand_base: {
25
+ new (input: BatchGetTaskCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetTaskCommandInput, BatchGetTaskCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: BatchGetTaskCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetTaskCommandInput, BatchGetTaskCommandOutput, DeadlineClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves multiple tasks in a single request. This is a batch version of the <code>GetTask</code> API.</p> <p>The result of getting each task is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { DeadlineClient, BatchGetTaskCommand } from "@aws-sdk/client-deadline"; // ES Modules import
35
+ * // const { DeadlineClient, BatchGetTaskCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
36
+ * // import type { DeadlineClientConfig } from "@aws-sdk/client-deadline";
37
+ * const config = {}; // type is DeadlineClientConfig
38
+ * const client = new DeadlineClient(config);
39
+ * const input = { // BatchGetTaskRequest
40
+ * identifiers: [ // BatchGetTaskIdentifiers // required
41
+ * { // BatchGetTaskIdentifier
42
+ * farmId: "STRING_VALUE", // required
43
+ * queueId: "STRING_VALUE", // required
44
+ * jobId: "STRING_VALUE", // required
45
+ * stepId: "STRING_VALUE", // required
46
+ * taskId: "STRING_VALUE", // required
47
+ * },
48
+ * ],
49
+ * };
50
+ * const command = new BatchGetTaskCommand(input);
51
+ * const response = await client.send(command);
52
+ * // { // BatchGetTaskResponse
53
+ * // tasks: [ // BatchGetTaskItems // required
54
+ * // { // BatchGetTaskItem
55
+ * // farmId: "STRING_VALUE", // required
56
+ * // queueId: "STRING_VALUE", // required
57
+ * // jobId: "STRING_VALUE", // required
58
+ * // stepId: "STRING_VALUE", // required
59
+ * // taskId: "STRING_VALUE", // required
60
+ * // createdAt: new Date("TIMESTAMP"), // required
61
+ * // createdBy: "STRING_VALUE", // required
62
+ * // runStatus: "PENDING" || "READY" || "ASSIGNED" || "STARTING" || "SCHEDULED" || "INTERRUPTING" || "RUNNING" || "SUSPENDED" || "CANCELED" || "FAILED" || "SUCCEEDED" || "NOT_COMPATIBLE", // required
63
+ * // targetRunStatus: "READY" || "FAILED" || "SUCCEEDED" || "CANCELED" || "SUSPENDED" || "PENDING",
64
+ * // failureRetryCount: Number("int"),
65
+ * // startedAt: new Date("TIMESTAMP"),
66
+ * // endedAt: new Date("TIMESTAMP"),
67
+ * // updatedAt: new Date("TIMESTAMP"),
68
+ * // updatedBy: "STRING_VALUE",
69
+ * // latestSessionActionId: "STRING_VALUE",
70
+ * // parameters: { // TaskParameters
71
+ * // "<keys>": { // TaskParameterValue Union: only one key present
72
+ * // int: "STRING_VALUE",
73
+ * // float: "STRING_VALUE",
74
+ * // string: "STRING_VALUE",
75
+ * // path: "STRING_VALUE",
76
+ * // chunkInt: "STRING_VALUE",
77
+ * // },
78
+ * // },
79
+ * // },
80
+ * // ],
81
+ * // errors: [ // BatchGetTaskErrors // required
82
+ * // { // BatchGetTaskError
83
+ * // farmId: "STRING_VALUE", // required
84
+ * // queueId: "STRING_VALUE", // required
85
+ * // jobId: "STRING_VALUE", // required
86
+ * // stepId: "STRING_VALUE", // required
87
+ * // taskId: "STRING_VALUE", // required
88
+ * // code: "InternalServerErrorException" || "ResourceNotFoundException" || "ValidationException" || "AccessDeniedException" || "ThrottlingException", // required
89
+ * // message: "STRING_VALUE", // required
90
+ * // },
91
+ * // ],
92
+ * // };
93
+ *
94
+ * ```
95
+ *
96
+ * @param BatchGetTaskCommandInput - {@link BatchGetTaskCommandInput}
97
+ * @returns {@link BatchGetTaskCommandOutput}
98
+ * @see {@link BatchGetTaskCommandInput} for command's `input` shape.
99
+ * @see {@link BatchGetTaskCommandOutput} for command's `response` shape.
100
+ * @see {@link DeadlineClientResolvedConfig | config} for DeadlineClient's `config` shape.
101
+ *
102
+ * @throws {@link AccessDeniedException} (client fault)
103
+ * <p>You don't have permission to perform the action.</p>
104
+ *
105
+ * @throws {@link InternalServerErrorException} (server fault)
106
+ * <p>Deadline Cloud can't process your request right now. Try again later.</p>
107
+ *
108
+ * @throws {@link ThrottlingException} (client fault)
109
+ * <p>Your request exceeded a request rate quota.</p>
110
+ *
111
+ * @throws {@link ValidationException} (client fault)
112
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
113
+ *
114
+ * @throws {@link DeadlineServiceException}
115
+ * <p>Base exception class for all service exceptions from Deadline service.</p>
116
+ *
117
+ *
118
+ * @example Get multiple tasks in a single request
119
+ * ```javascript
120
+ * //
121
+ * const input = {
122
+ * identifiers: [
123
+ * {
124
+ * farmId: "farm-1234567890abcdef1234567890abcdef",
125
+ * jobId: "job-1234567890abcdef1234567890abcdef",
126
+ * queueId: "queue-1234567890abcdef1234567890abcdef",
127
+ * stepId: "step-1234567890abcdef1234567890abcdef",
128
+ * taskId: "task-1234567890abcdef1234567890abcdef-0"
129
+ * },
130
+ * {
131
+ * farmId: "farm-1234567890abcdef1234567890abcdef",
132
+ * jobId: "job-1234567890abcdef1234567890abcdef",
133
+ * queueId: "queue-1234567890abcdef1234567890abcdef",
134
+ * stepId: "step-1234567890abcdef1234567890abcdef",
135
+ * taskId: "task-1234567890abcdef1234567890abcdef-1"
136
+ * }
137
+ * ]
138
+ * };
139
+ * const command = new BatchGetTaskCommand(input);
140
+ * const response = await client.send(command);
141
+ * /* response is
142
+ * { /* metadata only *\/ }
143
+ * *\/
144
+ * ```
145
+ *
146
+ * @public
147
+ */
148
+ export declare class BatchGetTaskCommand extends BatchGetTaskCommand_base {
149
+ /** @internal type navigation helper, not in runtime. */
150
+ protected static __types: {
151
+ api: {
152
+ input: BatchGetTaskRequest;
153
+ output: BatchGetTaskResponse;
154
+ };
155
+ sdk: {
156
+ input: BatchGetTaskCommandInput;
157
+ output: BatchGetTaskCommandOutput;
158
+ };
159
+ };
160
+ }