@aws-sdk/client-deadline 3.1023.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.
- package/README.md +56 -0
- package/dist-cjs/index.js +274 -102
- package/dist-cjs/schemas/schemas_0.js +399 -44
- package/dist-es/Deadline.js +16 -0
- package/dist-es/commands/BatchGetJobCommand.js +16 -0
- package/dist-es/commands/BatchGetSessionActionCommand.js +16 -0
- package/dist-es/commands/BatchGetSessionCommand.js +16 -0
- package/dist-es/commands/BatchGetStepCommand.js +16 -0
- package/dist-es/commands/BatchGetTaskCommand.js +16 -0
- package/dist-es/commands/BatchGetWorkerCommand.js +16 -0
- package/dist-es/commands/BatchUpdateJobCommand.js +16 -0
- package/dist-es/commands/BatchUpdateTaskCommand.js +16 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/enums.js +154 -102
- package/dist-es/schemas/schemas_0.js +388 -34
- package/dist-types/Deadline.d.ts +56 -0
- package/dist-types/DeadlineClient.d.ts +10 -2
- package/dist-types/commands/BatchGetJobCommand.d.ts +176 -0
- package/dist-types/commands/BatchGetSessionActionCommand.d.ts +180 -0
- package/dist-types/commands/BatchGetSessionCommand.d.ts +177 -0
- package/dist-types/commands/BatchGetStepCommand.d.ts +193 -0
- package/dist-types/commands/BatchGetTaskCommand.d.ts +160 -0
- package/dist-types/commands/BatchGetWorkerCommand.d.ts +159 -0
- package/dist-types/commands/BatchUpdateJobCommand.d.ts +135 -0
- package/dist-types/commands/BatchUpdateTaskCommand.d.ts +136 -0
- package/dist-types/commands/CreateMonitorCommand.d.ts +1 -0
- package/dist-types/commands/GetMonitorCommand.d.ts +1 -0
- package/dist-types/commands/GetQueueFleetAssociationCommand.d.ts +1 -1
- package/dist-types/commands/GetQueueLimitAssociationCommand.d.ts +1 -1
- package/dist-types/commands/GetSessionsStatisticsAggregationCommand.d.ts +1 -2
- package/dist-types/commands/ListMonitorsCommand.d.ts +1 -0
- package/dist-types/commands/ListQueueEnvironmentsCommand.d.ts +1 -1
- package/dist-types/commands/ListQueueMembersCommand.d.ts +1 -1
- package/dist-types/commands/ListQueuesCommand.d.ts +1 -1
- package/dist-types/commands/ListStorageProfilesForQueueCommand.d.ts +1 -1
- package/dist-types/commands/ListTasksCommand.d.ts +2 -1
- package/dist-types/commands/UpdateFarmCommand.d.ts +1 -1
- package/dist-types/commands/UpdateJobCommand.d.ts +1 -1
- package/dist-types/commands/UpdateLimitCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSessionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateStepCommand.d.ts +1 -1
- package/dist-types/commands/UpdateStorageProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTaskCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/enums.d.ts +310 -194
- package/dist-types/models/models_0.d.ts +3347 -3110
- package/dist-types/models/models_1.d.ts +1057 -2
- package/dist-types/schemas/schemas_0.d.ts +46 -0
- package/dist-types/ts3.4/Deadline.d.ts +136 -0
- package/dist-types/ts3.4/DeadlineClient.d.ts +48 -0
- package/dist-types/ts3.4/commands/BatchGetJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/BatchGetSessionActionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/BatchGetSessionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/BatchGetStepCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/BatchGetTaskCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/BatchGetWorkerCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/BatchUpdateJobCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/BatchUpdateTaskCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetQueueFleetAssociationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetQueueLimitAssociationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetSessionsStatisticsAggregationCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListQueueEnvironmentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListQueueMembersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListStorageProfilesForQueueCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTasksCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateFarmCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateLimitCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueEnvironmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateStepCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateStorageProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateTaskCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/enums.d.ts +194 -126
- package/dist-types/ts3.4/models/models_0.d.ts +583 -522
- package/dist-types/ts3.4/models/models_1.d.ts +251 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +46 -0
- package/package.json +1 -1
|
@@ -1,5 +1,1050 @@
|
|
|
1
|
-
import type { ComparisonOperator, JobLifecycleStatus, JobTargetTaskRunStatus, LicenseEndpointStatus, LogicalOperator, Period, QueueFleetAssociationStatus, QueueLimitAssociationStatus, SearchTermMatchingType, SessionsStatisticsAggregationStatus, SortOrder, StepLifecycleStatus, StepTargetTaskRunStatus, TaskRunStatus, TaskTargetRunStatus, UpdateQueueFleetAssociationStatus, UpdateQueueLimitAssociationStatus, UsageGroupByField, UsageStatistic, WorkerStatus } from "./enums";
|
|
2
|
-
import type { DateTimeFilterExpression, HostPropertiesResponse, JobParameter, ParameterSpace,
|
|
1
|
+
import type { ComparisonOperator, DeadlinePrincipalType, DefaultQueueBudgetAction, EnvironmentTemplateType, JobLifecycleStatus, JobTargetTaskRunStatus, LicenseEndpointStatus, LogicalOperator, MembershipLevel, Period, QueueBlockedReason, QueueFleetAssociationStatus, QueueLimitAssociationStatus, QueueStatus, SearchTermMatchingType, SessionLifecycleTargetStatus, SessionsStatisticsAggregationStatus, SortOrder, StepLifecycleStatus, StepTargetTaskRunStatus, StorageProfileOperatingSystemFamily, TaskRunStatus, TaskTargetRunStatus, UpdateJobLifecycleStatus, UpdateQueueFleetAssociationStatus, UpdateQueueLimitAssociationStatus, UsageGroupByField, UsageStatistic, UsageType, WorkerStatus } from "./enums";
|
|
2
|
+
import type { DateTimeFilterExpression, FileSystemLocation, HostPropertiesResponse, JobAttachmentSettings, JobParameter, JobRunAsUser, ParameterSpace, SchedulingConfiguration, StorageProfileSummary, TaskParameterValue } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* <p>The details of a task.</p>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface TaskSummary {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The task ID.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
taskId: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>The date and time the resource was created.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
createdAt: Date | undefined;
|
|
18
|
+
/**
|
|
19
|
+
* <p>The user or system that created this resource.</p>
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
createdBy: string | undefined;
|
|
23
|
+
/**
|
|
24
|
+
* <p>The run status of the task.</p>
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
runStatus: TaskRunStatus | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* <p>The run status on which the started.</p>
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
targetRunStatus?: TaskTargetRunStatus | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* <p>The number of times that the task failed and was retried.</p>
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
failureRetryCount?: number | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* <p>The date and time the resource started running.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
startedAt?: Date | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The date and time the resource ended running.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
endedAt?: Date | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The date and time the resource was updated.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
updatedAt?: Date | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <p>The user or system that updated this resource.</p>
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
updatedBy?: string | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* <p>The latest session action ID for the task.</p>
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
latestSessionActionId?: string | undefined;
|
|
63
|
+
/**
|
|
64
|
+
* <p>The task parameters.</p>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
parameters?: Record<string, TaskParameterValue> | undefined;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Shared pagination field for List operation outputs (nextToken).
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
export interface ListTasksResponse {
|
|
74
|
+
/**
|
|
75
|
+
* <p>Tasks for the job.</p>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
tasks: TaskSummary[] | undefined;
|
|
79
|
+
/**
|
|
80
|
+
* <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
nextToken?: string | undefined;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export interface UpdateJobRequest {
|
|
89
|
+
/**
|
|
90
|
+
* <p>The farm ID of the job to update.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
farmId: string | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* <p>The queue ID of the job to update.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
queueId: string | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <p>The job ID to update.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
jobId: string | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* <p>The unique token which the server uses to recognize retries of the same request.</p>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
clientToken?: string | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* <p>The task status to update the job's tasks to.</p>
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
targetTaskRunStatus?: JobTargetTaskRunStatus | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* <p>The updated job priority.</p>
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
priority?: number | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* <p>The number of task failures before the job stops running and is marked as <code>FAILED</code>.</p>
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
maxFailedTasksCount?: number | undefined;
|
|
124
|
+
/**
|
|
125
|
+
* <p>The maximum number of retries for a job.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
maxRetriesPerTask?: number | undefined;
|
|
129
|
+
/**
|
|
130
|
+
* <p>The status of a job in its lifecycle. When you change the status of the job to <code>ARCHIVED</code>, the job can't be scheduled or archived.</p> <important> <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.</p> </important>
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
lifecycleStatus?: UpdateJobLifecycleStatus | undefined;
|
|
134
|
+
/**
|
|
135
|
+
* <p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p> <p>The maximum number of workers that can process tasks in the job.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
maxWorkerCount?: number | undefined;
|
|
139
|
+
/**
|
|
140
|
+
* <p>The updated job name.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
name?: string | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* <p>The updated job description.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
description?: string | undefined;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export interface UpdateJobResponse {
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
export interface UpdateSessionRequest {
|
|
159
|
+
/**
|
|
160
|
+
* <p>The farm ID to update in the session.</p>
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
farmId: string | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* <p>The queue ID to update in the session.</p>
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
queueId: string | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* <p>The job ID to update in the session.</p>
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
jobId: string | undefined;
|
|
174
|
+
/**
|
|
175
|
+
* <p>The session ID to update.</p>
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
sessionId: string | undefined;
|
|
179
|
+
/**
|
|
180
|
+
* <p>The unique token which the server uses to recognize retries of the same request.</p>
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
clientToken?: string | undefined;
|
|
184
|
+
/**
|
|
185
|
+
* <p>The life cycle status to update in the session.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
targetLifecycleStatus: SessionLifecycleTargetStatus | undefined;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
export interface UpdateSessionResponse {
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
export interface UpdateStepRequest {
|
|
199
|
+
/**
|
|
200
|
+
* <p>The farm ID to update.</p>
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
farmId: string | undefined;
|
|
204
|
+
/**
|
|
205
|
+
* <p>The queue ID to update.</p>
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
queueId: string | undefined;
|
|
209
|
+
/**
|
|
210
|
+
* <p>The job ID to update.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
jobId: string | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The step ID to update.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
stepId: string | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <p>The unique token which the server uses to recognize retries of the same request.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
clientToken?: string | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <p>The task status to update the step's tasks to.</p>
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
targetTaskRunStatus: StepTargetTaskRunStatus | undefined;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
export interface UpdateStepResponse {
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
export interface UpdateTaskRequest {
|
|
239
|
+
/**
|
|
240
|
+
* <p>The farm ID to update.</p>
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
farmId: string | undefined;
|
|
244
|
+
/**
|
|
245
|
+
* <p>The queue ID to update.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
queueId: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <p>The job ID to update.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
jobId: string | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* <p>The step ID to update.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
stepId: string | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The task ID to update.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
taskId: string | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The unique token which the server uses to recognize retries of the same request.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
clientToken?: string | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>The run status with which to start the task.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
targetRunStatus: TaskTargetRunStatus | undefined;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
export interface UpdateTaskResponse {
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
282
|
+
* @public
|
|
283
|
+
*/
|
|
284
|
+
export interface ListQueueEnvironmentsRequest {
|
|
285
|
+
/**
|
|
286
|
+
* <p>The farm ID for the queue environment list.</p>
|
|
287
|
+
* @public
|
|
288
|
+
*/
|
|
289
|
+
farmId: string | undefined;
|
|
290
|
+
/**
|
|
291
|
+
* <p>The queue ID for the queue environment list.</p>
|
|
292
|
+
* @public
|
|
293
|
+
*/
|
|
294
|
+
queueId: string | undefined;
|
|
295
|
+
/**
|
|
296
|
+
* <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
|
|
297
|
+
* @public
|
|
298
|
+
*/
|
|
299
|
+
nextToken?: string | undefined;
|
|
300
|
+
/**
|
|
301
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
maxResults?: number | undefined;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* <p>The summary of a queue environment.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
export interface QueueEnvironmentSummary {
|
|
311
|
+
/**
|
|
312
|
+
* <p>The queue environment ID.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
queueEnvironmentId: string | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* <p>The name of the queue environment.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
name: string | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* <p>The queue environment's priority.</p>
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
priority: number | undefined;
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* Shared pagination field for List operation outputs (nextToken).
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
331
|
+
export interface ListQueueEnvironmentsResponse {
|
|
332
|
+
/**
|
|
333
|
+
* <p>The environments to include in the queue environments list.</p>
|
|
334
|
+
* @public
|
|
335
|
+
*/
|
|
336
|
+
environments: QueueEnvironmentSummary[] | undefined;
|
|
337
|
+
/**
|
|
338
|
+
* <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
nextToken?: string | undefined;
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
345
|
+
* @public
|
|
346
|
+
*/
|
|
347
|
+
export interface ListQueueMembersRequest {
|
|
348
|
+
/**
|
|
349
|
+
* <p>The farm ID for the queue.</p>
|
|
350
|
+
* @public
|
|
351
|
+
*/
|
|
352
|
+
farmId: string | undefined;
|
|
353
|
+
/**
|
|
354
|
+
* <p>The queue ID to include on the list.</p>
|
|
355
|
+
* @public
|
|
356
|
+
*/
|
|
357
|
+
queueId: string | undefined;
|
|
358
|
+
/**
|
|
359
|
+
* <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
nextToken?: string | undefined;
|
|
363
|
+
/**
|
|
364
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
maxResults?: number | undefined;
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* <p>The details of a queue member.</p>
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
373
|
+
export interface QueueMember {
|
|
374
|
+
/**
|
|
375
|
+
* <p>The farm ID.</p>
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
farmId: string | undefined;
|
|
379
|
+
/**
|
|
380
|
+
* <p>The queue ID.</p>
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
383
|
+
queueId: string | undefined;
|
|
384
|
+
/**
|
|
385
|
+
* <p>The principal ID of the queue member.</p>
|
|
386
|
+
* @public
|
|
387
|
+
*/
|
|
388
|
+
principalId: string | undefined;
|
|
389
|
+
/**
|
|
390
|
+
* <p>The principal type of the queue member.</p>
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
principalType: DeadlinePrincipalType | undefined;
|
|
394
|
+
/**
|
|
395
|
+
* <p>The identity store ID.</p>
|
|
396
|
+
* @public
|
|
397
|
+
*/
|
|
398
|
+
identityStoreId: string | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* <p>The queue member's membership level.</p>
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
membershipLevel: MembershipLevel | undefined;
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* Shared pagination field for List operation outputs (nextToken).
|
|
407
|
+
* @public
|
|
408
|
+
*/
|
|
409
|
+
export interface ListQueueMembersResponse {
|
|
410
|
+
/**
|
|
411
|
+
* <p>The members on the list.</p>
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
members: QueueMember[] | undefined;
|
|
415
|
+
/**
|
|
416
|
+
* <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
nextToken?: string | undefined;
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
export interface ListQueuesRequest {
|
|
426
|
+
/**
|
|
427
|
+
* <p>The farm ID of the queue.</p>
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
farmId: string | undefined;
|
|
431
|
+
/**
|
|
432
|
+
* <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
nextToken?: string | undefined;
|
|
436
|
+
/**
|
|
437
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
maxResults?: number | undefined;
|
|
441
|
+
/**
|
|
442
|
+
* <p>The principal IDs to include in the list of queues.</p>
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
principalId?: string | undefined;
|
|
446
|
+
/**
|
|
447
|
+
* <p>The status of the queues listed.</p> <ul> <li> <p> <code>ACTIVE</code>–The queues are active.</p> </li> <li> <p> <code>SCHEDULING</code>–The queues are scheduling.</p> </li> <li> <p> <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p> </li> </ul>
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
status?: QueueStatus | undefined;
|
|
451
|
+
}
|
|
452
|
+
/**
|
|
453
|
+
* <p>The details of a queue summary.</p>
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
456
|
+
export interface QueueSummary {
|
|
457
|
+
/**
|
|
458
|
+
* <p>The farm ID.</p>
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
farmId: string | undefined;
|
|
462
|
+
/**
|
|
463
|
+
* <p>The queue ID.</p>
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
queueId: string | undefined;
|
|
467
|
+
/**
|
|
468
|
+
* <p>The display name of the queue summary to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
displayName: string | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>That status of the queue.</p>
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
status: QueueStatus | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* <p>The default action taken on a queue summary if a budget wasn't configured.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
defaultBudgetAction: DefaultQueueBudgetAction | undefined;
|
|
482
|
+
/**
|
|
483
|
+
* <p>The reason the queue is blocked, if applicable.</p>
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
blockedReason?: QueueBlockedReason | undefined;
|
|
487
|
+
/**
|
|
488
|
+
* <p>The date and time the resource was created.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
createdAt: Date | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* <p>The user or system that created this resource.</p>
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
createdBy: string | undefined;
|
|
497
|
+
/**
|
|
498
|
+
* <p>The date and time the resource was updated.</p>
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
updatedAt?: Date | undefined;
|
|
502
|
+
/**
|
|
503
|
+
* <p>The user or system that updated this resource.</p>
|
|
504
|
+
* @public
|
|
505
|
+
*/
|
|
506
|
+
updatedBy?: string | undefined;
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* Shared pagination field for List operation outputs (nextToken).
|
|
510
|
+
* @public
|
|
511
|
+
*/
|
|
512
|
+
export interface ListQueuesResponse {
|
|
513
|
+
/**
|
|
514
|
+
* <p>The queues on the list.</p>
|
|
515
|
+
* @public
|
|
516
|
+
*/
|
|
517
|
+
queues: QueueSummary[] | undefined;
|
|
518
|
+
/**
|
|
519
|
+
* <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
nextToken?: string | undefined;
|
|
523
|
+
}
|
|
524
|
+
/**
|
|
525
|
+
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
526
|
+
* @public
|
|
527
|
+
*/
|
|
528
|
+
export interface ListStorageProfilesForQueueRequest {
|
|
529
|
+
/**
|
|
530
|
+
* <p>The farm ID of the queue's storage profile.</p>
|
|
531
|
+
* @public
|
|
532
|
+
*/
|
|
533
|
+
farmId: string | undefined;
|
|
534
|
+
/**
|
|
535
|
+
* <p>The queue ID for the storage profile.</p>
|
|
536
|
+
* @public
|
|
537
|
+
*/
|
|
538
|
+
queueId: string | undefined;
|
|
539
|
+
/**
|
|
540
|
+
* <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
|
|
541
|
+
* @public
|
|
542
|
+
*/
|
|
543
|
+
nextToken?: string | undefined;
|
|
544
|
+
/**
|
|
545
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
546
|
+
* @public
|
|
547
|
+
*/
|
|
548
|
+
maxResults?: number | undefined;
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* Shared pagination field for List operation outputs (nextToken).
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
export interface ListStorageProfilesForQueueResponse {
|
|
555
|
+
/**
|
|
556
|
+
* <p>The storage profiles in the queue.</p>
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
storageProfiles: StorageProfileSummary[] | undefined;
|
|
560
|
+
/**
|
|
561
|
+
* <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
nextToken?: string | undefined;
|
|
565
|
+
}
|
|
566
|
+
/**
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
569
|
+
export interface UpdateQueueRequest {
|
|
570
|
+
/**
|
|
571
|
+
* <p>The farm ID to update in the queue.</p>
|
|
572
|
+
* @public
|
|
573
|
+
*/
|
|
574
|
+
farmId: string | undefined;
|
|
575
|
+
/**
|
|
576
|
+
* <p>The queue ID to update.</p>
|
|
577
|
+
* @public
|
|
578
|
+
*/
|
|
579
|
+
queueId: string | undefined;
|
|
580
|
+
/**
|
|
581
|
+
* <p>The idempotency token to update in the queue.</p>
|
|
582
|
+
* @public
|
|
583
|
+
*/
|
|
584
|
+
clientToken?: string | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* <p>The display name of the queue to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
displayName?: string | undefined;
|
|
590
|
+
/**
|
|
591
|
+
* <p>The description of the queue to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
description?: string | undefined;
|
|
595
|
+
/**
|
|
596
|
+
* <p>The default action to take for a queue update if a budget isn't configured.</p>
|
|
597
|
+
* @public
|
|
598
|
+
*/
|
|
599
|
+
defaultBudgetAction?: DefaultQueueBudgetAction | undefined;
|
|
600
|
+
/**
|
|
601
|
+
* <p>The job attachment settings to update for the queue.</p>
|
|
602
|
+
* @public
|
|
603
|
+
*/
|
|
604
|
+
jobAttachmentSettings?: JobAttachmentSettings | undefined;
|
|
605
|
+
/**
|
|
606
|
+
* <p>The IAM role ARN that's used to run jobs from this queue.</p>
|
|
607
|
+
* @public
|
|
608
|
+
*/
|
|
609
|
+
roleArn?: string | undefined;
|
|
610
|
+
/**
|
|
611
|
+
* <p>Update the jobs in the queue to run as a specified POSIX user.</p>
|
|
612
|
+
* @public
|
|
613
|
+
*/
|
|
614
|
+
jobRunAsUser?: JobRunAsUser | undefined;
|
|
615
|
+
/**
|
|
616
|
+
* <p>The required file system location names to add to the queue.</p>
|
|
617
|
+
* @public
|
|
618
|
+
*/
|
|
619
|
+
requiredFileSystemLocationNamesToAdd?: string[] | undefined;
|
|
620
|
+
/**
|
|
621
|
+
* <p>The required file system location names to remove from the queue.</p>
|
|
622
|
+
* @public
|
|
623
|
+
*/
|
|
624
|
+
requiredFileSystemLocationNamesToRemove?: string[] | undefined;
|
|
625
|
+
/**
|
|
626
|
+
* <p>The storage profile IDs to add.</p>
|
|
627
|
+
* @public
|
|
628
|
+
*/
|
|
629
|
+
allowedStorageProfileIdsToAdd?: string[] | undefined;
|
|
630
|
+
/**
|
|
631
|
+
* <p>The storage profile ID to remove.</p>
|
|
632
|
+
* @public
|
|
633
|
+
*/
|
|
634
|
+
allowedStorageProfileIdsToRemove?: string[] | undefined;
|
|
635
|
+
/**
|
|
636
|
+
* <p>The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.</p> <p>When updating the scheduling configuration, the entire configuration is replaced.</p> <p>In-progress tasks run to completion before the new scheduling configuration takes effect.</p>
|
|
637
|
+
* @public
|
|
638
|
+
*/
|
|
639
|
+
schedulingConfiguration?: SchedulingConfiguration | undefined;
|
|
640
|
+
}
|
|
641
|
+
/**
|
|
642
|
+
* @public
|
|
643
|
+
*/
|
|
644
|
+
export interface UpdateQueueResponse {
|
|
645
|
+
}
|
|
646
|
+
/**
|
|
647
|
+
* @public
|
|
648
|
+
*/
|
|
649
|
+
export interface UpdateQueueEnvironmentRequest {
|
|
650
|
+
/**
|
|
651
|
+
* <p>The farm ID of the queue environment to update.</p>
|
|
652
|
+
* @public
|
|
653
|
+
*/
|
|
654
|
+
farmId: string | undefined;
|
|
655
|
+
/**
|
|
656
|
+
* <p>The queue ID of the queue environment to update.</p>
|
|
657
|
+
* @public
|
|
658
|
+
*/
|
|
659
|
+
queueId: string | undefined;
|
|
660
|
+
/**
|
|
661
|
+
* <p>The queue environment ID to update.</p>
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
664
|
+
queueEnvironmentId: string | undefined;
|
|
665
|
+
/**
|
|
666
|
+
* <p>The unique token which the server uses to recognize retries of the same request.</p>
|
|
667
|
+
* @public
|
|
668
|
+
*/
|
|
669
|
+
clientToken?: string | undefined;
|
|
670
|
+
/**
|
|
671
|
+
* <p>The priority to update.</p>
|
|
672
|
+
* @public
|
|
673
|
+
*/
|
|
674
|
+
priority?: number | undefined;
|
|
675
|
+
/**
|
|
676
|
+
* <p>The template type to update.</p>
|
|
677
|
+
* @public
|
|
678
|
+
*/
|
|
679
|
+
templateType?: EnvironmentTemplateType | undefined;
|
|
680
|
+
/**
|
|
681
|
+
* <p>The template to update.</p>
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
684
|
+
template?: string | undefined;
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* @public
|
|
688
|
+
*/
|
|
689
|
+
export interface UpdateQueueEnvironmentResponse {
|
|
690
|
+
}
|
|
691
|
+
/**
|
|
692
|
+
* @public
|
|
693
|
+
*/
|
|
694
|
+
export interface UpdateFarmRequest {
|
|
695
|
+
/**
|
|
696
|
+
* <p>The farm ID to update.</p>
|
|
697
|
+
* @public
|
|
698
|
+
*/
|
|
699
|
+
farmId: string | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* <p>The display name of the farm to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
displayName?: string | undefined;
|
|
705
|
+
/**
|
|
706
|
+
* <p>The description of the farm to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
707
|
+
* @public
|
|
708
|
+
*/
|
|
709
|
+
description?: string | undefined;
|
|
710
|
+
/**
|
|
711
|
+
* <p>A multiplier applied to the farm's calculated costs for usage data and budget tracking. A value less than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment.</p>
|
|
712
|
+
* @public
|
|
713
|
+
*/
|
|
714
|
+
costScaleFactor?: number | undefined;
|
|
715
|
+
}
|
|
716
|
+
/**
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
export interface UpdateFarmResponse {
|
|
720
|
+
}
|
|
721
|
+
/**
|
|
722
|
+
* @public
|
|
723
|
+
*/
|
|
724
|
+
export interface UpdateLimitRequest {
|
|
725
|
+
/**
|
|
726
|
+
* <p>The unique identifier of the farm that contains the limit.</p>
|
|
727
|
+
* @public
|
|
728
|
+
*/
|
|
729
|
+
farmId: string | undefined;
|
|
730
|
+
/**
|
|
731
|
+
* <p>The unique identifier of the limit to update.</p>
|
|
732
|
+
* @public
|
|
733
|
+
*/
|
|
734
|
+
limitId: string | undefined;
|
|
735
|
+
/**
|
|
736
|
+
* <p>The new display name of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
737
|
+
* @public
|
|
738
|
+
*/
|
|
739
|
+
displayName?: string | undefined;
|
|
740
|
+
/**
|
|
741
|
+
* <p>The new description of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
742
|
+
* @public
|
|
743
|
+
*/
|
|
744
|
+
description?: string | undefined;
|
|
745
|
+
/**
|
|
746
|
+
* <p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.</p> <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>
|
|
747
|
+
* @public
|
|
748
|
+
*/
|
|
749
|
+
maxCount?: number | undefined;
|
|
750
|
+
}
|
|
751
|
+
/**
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
export interface UpdateLimitResponse {
|
|
755
|
+
}
|
|
756
|
+
/**
|
|
757
|
+
* @public
|
|
758
|
+
*/
|
|
759
|
+
export interface UpdateStorageProfileRequest {
|
|
760
|
+
/**
|
|
761
|
+
* <p>The farm ID to update.</p>
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
farmId: string | undefined;
|
|
765
|
+
/**
|
|
766
|
+
* <p>The storage profile ID to update.</p>
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
storageProfileId: string | undefined;
|
|
770
|
+
/**
|
|
771
|
+
* <p>The unique token which the server uses to recognize retries of the same request.</p>
|
|
772
|
+
* @public
|
|
773
|
+
*/
|
|
774
|
+
clientToken?: string | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* <p>The display name of the storage profile to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
displayName?: string | undefined;
|
|
780
|
+
/**
|
|
781
|
+
* <p>The OS system to update.</p>
|
|
782
|
+
* @public
|
|
783
|
+
*/
|
|
784
|
+
osFamily?: StorageProfileOperatingSystemFamily | undefined;
|
|
785
|
+
/**
|
|
786
|
+
* <p>The file system location names to add.</p>
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
fileSystemLocationsToAdd?: FileSystemLocation[] | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* <p>The file system location names to remove.</p>
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
794
|
+
fileSystemLocationsToRemove?: FileSystemLocation[] | undefined;
|
|
795
|
+
}
|
|
796
|
+
/**
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
export interface UpdateStorageProfileResponse {
|
|
800
|
+
}
|
|
801
|
+
/**
|
|
802
|
+
* Identifier mixin for queue-fleet association operations.
|
|
803
|
+
* Composes QueueIdentifierMixin (farmId + queueId) and adds fleetId.
|
|
804
|
+
* @public
|
|
805
|
+
*/
|
|
806
|
+
export interface GetQueueFleetAssociationRequest {
|
|
807
|
+
/**
|
|
808
|
+
* <p>The farm ID of the farm that contains the queue-fleet association.</p>
|
|
809
|
+
* @public
|
|
810
|
+
*/
|
|
811
|
+
farmId: string | undefined;
|
|
812
|
+
/**
|
|
813
|
+
* <p>The queue ID for the queue-fleet association.</p>
|
|
814
|
+
* @public
|
|
815
|
+
*/
|
|
816
|
+
queueId: string | undefined;
|
|
817
|
+
/**
|
|
818
|
+
* <p>The fleet ID for the queue-fleet association.</p>
|
|
819
|
+
* @public
|
|
820
|
+
*/
|
|
821
|
+
fleetId: string | undefined;
|
|
822
|
+
}
|
|
823
|
+
/**
|
|
824
|
+
* Domain fields for QueueFleetAssociation summary/response shapes, ordered before timestamps.
|
|
825
|
+
* @public
|
|
826
|
+
*/
|
|
827
|
+
export interface GetQueueFleetAssociationResponse {
|
|
828
|
+
/**
|
|
829
|
+
* <p>The queue ID for the queue-fleet association.</p>
|
|
830
|
+
* @public
|
|
831
|
+
*/
|
|
832
|
+
queueId: string | undefined;
|
|
833
|
+
/**
|
|
834
|
+
* <p>The fleet ID for the queue-fleet association.</p>
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
837
|
+
fleetId: string | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* <p>The status of the queue-fleet association.</p>
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
842
|
+
status: QueueFleetAssociationStatus | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* <p>The date and time the resource was created.</p>
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
createdAt: Date | undefined;
|
|
848
|
+
/**
|
|
849
|
+
* <p>The user or system that created this resource.</p>
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
createdBy: string | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* <p>The date and time the resource was updated.</p>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
updatedAt?: Date | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* <p>The user or system that updated this resource.</p>
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
updatedBy?: string | undefined;
|
|
863
|
+
}
|
|
864
|
+
/**
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
export interface GetQueueLimitAssociationRequest {
|
|
868
|
+
/**
|
|
869
|
+
* <p>The unique identifier of the farm that contains the associated queue and limit.</p>
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
farmId: string | undefined;
|
|
873
|
+
/**
|
|
874
|
+
* <p>The unique identifier of the queue associated with the limit.</p>
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
queueId: string | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* <p>The unique identifier of the limit associated with the queue.</p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
limitId: string | undefined;
|
|
883
|
+
}
|
|
884
|
+
/**
|
|
885
|
+
* Domain fields for QueueLimitAssociation summary/response shapes, ordered before timestamps.
|
|
886
|
+
* @public
|
|
887
|
+
*/
|
|
888
|
+
export interface GetQueueLimitAssociationResponse {
|
|
889
|
+
/**
|
|
890
|
+
* <p>The unique identifier of the queue associated with the limit.</p>
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
queueId: string | undefined;
|
|
894
|
+
/**
|
|
895
|
+
* <p>The unique identifier of the limit associated with the queue.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
limitId: string | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* <p>The current status of the limit.</p>
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
status: QueueLimitAssociationStatus | undefined;
|
|
904
|
+
/**
|
|
905
|
+
* <p>The Unix timestamp of the date and time that the association was created.</p>
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
createdAt: Date | undefined;
|
|
909
|
+
/**
|
|
910
|
+
* <p>The user identifier of the person that created the association.</p>
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
createdBy: string | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* <p>The Unix timestamp of the date and time that the association was last updated.</p>
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
918
|
+
updatedAt?: Date | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* <p>The user identifier of the person that last updated the association.</p>
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
updatedBy?: string | undefined;
|
|
924
|
+
}
|
|
925
|
+
/**
|
|
926
|
+
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
export interface GetSessionsStatisticsAggregationRequest {
|
|
930
|
+
/**
|
|
931
|
+
* <p>The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the <code>StartSessionsStatisticsAggregation</code> operation.</p>
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
farmId: string | undefined;
|
|
935
|
+
/**
|
|
936
|
+
* <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
nextToken?: string | undefined;
|
|
940
|
+
/**
|
|
941
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
maxResults?: number | undefined;
|
|
945
|
+
/**
|
|
946
|
+
* <p>The identifier returned by the <code>StartSessionsStatisticsAggregation</code> operation that identifies the aggregated statistics.</p>
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
aggregationId: string | undefined;
|
|
950
|
+
}
|
|
951
|
+
/**
|
|
952
|
+
* <p>The minimum, maximum, average, and sum.</p>
|
|
953
|
+
* @public
|
|
954
|
+
*/
|
|
955
|
+
export interface Stats {
|
|
956
|
+
/**
|
|
957
|
+
* <p>The minimum of the usage statistics.</p>
|
|
958
|
+
* @public
|
|
959
|
+
*/
|
|
960
|
+
min?: number | undefined;
|
|
961
|
+
/**
|
|
962
|
+
* <p>The maximum among the usage statistics.</p>
|
|
963
|
+
* @public
|
|
964
|
+
*/
|
|
965
|
+
max?: number | undefined;
|
|
966
|
+
/**
|
|
967
|
+
* <p>The average of the usage statistics.</p>
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
avg?: number | undefined;
|
|
971
|
+
/**
|
|
972
|
+
* <p>The sum of the usage statistics.</p>
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
sum?: number | undefined;
|
|
976
|
+
}
|
|
977
|
+
/**
|
|
978
|
+
* <p>A list of statistics for a session.</p>
|
|
979
|
+
* @public
|
|
980
|
+
*/
|
|
981
|
+
export interface Statistics {
|
|
982
|
+
/**
|
|
983
|
+
* <p>The queue ID.</p>
|
|
984
|
+
* @public
|
|
985
|
+
*/
|
|
986
|
+
queueId?: string | undefined;
|
|
987
|
+
/**
|
|
988
|
+
* <p>The fleet ID.</p>
|
|
989
|
+
* @public
|
|
990
|
+
*/
|
|
991
|
+
fleetId?: string | undefined;
|
|
992
|
+
/**
|
|
993
|
+
* <p>The job ID.</p>
|
|
994
|
+
* @public
|
|
995
|
+
*/
|
|
996
|
+
jobId?: string | undefined;
|
|
997
|
+
/**
|
|
998
|
+
* <p>The job name.</p>
|
|
999
|
+
* @public
|
|
1000
|
+
*/
|
|
1001
|
+
jobName?: string | undefined;
|
|
1002
|
+
/**
|
|
1003
|
+
* <p>The user ID.</p>
|
|
1004
|
+
* @public
|
|
1005
|
+
*/
|
|
1006
|
+
userId?: string | undefined;
|
|
1007
|
+
/**
|
|
1008
|
+
* <p>The type of usage for the statistics.</p>
|
|
1009
|
+
* @public
|
|
1010
|
+
*/
|
|
1011
|
+
usageType?: UsageType | undefined;
|
|
1012
|
+
/**
|
|
1013
|
+
* <p>The licensed product.</p>
|
|
1014
|
+
* @public
|
|
1015
|
+
*/
|
|
1016
|
+
licenseProduct?: string | undefined;
|
|
1017
|
+
/**
|
|
1018
|
+
* <p>The type of instance.</p>
|
|
1019
|
+
* @public
|
|
1020
|
+
*/
|
|
1021
|
+
instanceType?: string | undefined;
|
|
1022
|
+
/**
|
|
1023
|
+
* <p>The number of instances in a list of statistics.</p>
|
|
1024
|
+
* @public
|
|
1025
|
+
*/
|
|
1026
|
+
count: number | undefined;
|
|
1027
|
+
/**
|
|
1028
|
+
* <p>How the statistics should appear in USD. Options include: minimum, maximum, average or sum.</p>
|
|
1029
|
+
* @public
|
|
1030
|
+
*/
|
|
1031
|
+
costInUsd: Stats | undefined;
|
|
1032
|
+
/**
|
|
1033
|
+
* <p>The total aggregated runtime.</p>
|
|
1034
|
+
* @public
|
|
1035
|
+
*/
|
|
1036
|
+
runtimeInSeconds: Stats | undefined;
|
|
1037
|
+
/**
|
|
1038
|
+
* <p>The start time for the aggregation.</p>
|
|
1039
|
+
* @public
|
|
1040
|
+
*/
|
|
1041
|
+
aggregationStartTime?: Date | undefined;
|
|
1042
|
+
/**
|
|
1043
|
+
* <p>The end time for the aggregation.</p>
|
|
1044
|
+
* @public
|
|
1045
|
+
*/
|
|
1046
|
+
aggregationEndTime?: Date | undefined;
|
|
1047
|
+
}
|
|
3
1048
|
/**
|
|
4
1049
|
* Shared pagination field for List operation outputs (nextToken).
|
|
5
1050
|
* @public
|
|
@@ -543,6 +1588,11 @@ export interface GetMonitorResponse {
|
|
|
543
1588
|
* @public
|
|
544
1589
|
*/
|
|
545
1590
|
identityCenterInstanceArn: string | undefined;
|
|
1591
|
+
/**
|
|
1592
|
+
* The AWS region where IAM Identity Center is enabled.
|
|
1593
|
+
* @public
|
|
1594
|
+
*/
|
|
1595
|
+
identityCenterRegion?: string | undefined;
|
|
546
1596
|
/**
|
|
547
1597
|
* <p>The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.</p>
|
|
548
1598
|
* @public
|
|
@@ -620,6 +1670,11 @@ export interface MonitorSummary {
|
|
|
620
1670
|
* @public
|
|
621
1671
|
*/
|
|
622
1672
|
identityCenterInstanceArn: string | undefined;
|
|
1673
|
+
/**
|
|
1674
|
+
* The AWS region where IAM Identity Center is enabled.
|
|
1675
|
+
* @public
|
|
1676
|
+
*/
|
|
1677
|
+
identityCenterRegion?: string | undefined;
|
|
623
1678
|
/**
|
|
624
1679
|
* <p>The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.</p>
|
|
625
1680
|
* @public
|