@aws-sdk/client-deadline 3.1155.0 → 3.1157.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 +3 -1
- package/dist-cjs/index.js +1 -1
- package/dist-types/Deadline.d.ts +4 -1
- package/dist-types/DeadlineClient.d.ts +4 -1
- package/dist-types/commands/AssociateMemberToFarmCommand.d.ts +7 -7
- package/dist-types/commands/AssociateMemberToFleetCommand.d.ts +7 -7
- package/dist-types/commands/AssociateMemberToJobCommand.d.ts +7 -7
- package/dist-types/commands/AssociateMemberToQueueCommand.d.ts +7 -7
- package/dist-types/commands/AssumeFleetRoleForReadCommand.d.ts +6 -6
- package/dist-types/commands/AssumeFleetRoleForWorkerCommand.d.ts +7 -7
- package/dist-types/commands/AssumeQueueRoleForReadCommand.d.ts +6 -6
- package/dist-types/commands/AssumeQueueRoleForUserCommand.d.ts +6 -6
- package/dist-types/commands/AssumeQueueRoleForWorkerCommand.d.ts +7 -7
- package/dist-types/commands/BatchGetJobCommand.d.ts +8 -5
- package/dist-types/commands/BatchGetJobEntityCommand.d.ts +6 -6
- package/dist-types/commands/BatchGetSessionActionCommand.d.ts +8 -5
- package/dist-types/commands/BatchGetSessionCommand.d.ts +8 -5
- package/dist-types/commands/BatchGetStepCommand.d.ts +8 -5
- package/dist-types/commands/BatchGetTaskCommand.d.ts +8 -5
- package/dist-types/commands/BatchGetWorkerCommand.d.ts +8 -5
- package/dist-types/commands/BatchUpdateJobCommand.d.ts +4 -4
- package/dist-types/commands/BatchUpdateTaskCommand.d.ts +8 -5
- package/dist-types/commands/CopyJobTemplateCommand.d.ts +6 -6
- package/dist-types/commands/CreateBudgetCommand.d.ts +7 -7
- package/dist-types/commands/CreateFarmCommand.d.ts +7 -7
- package/dist-types/commands/CreateFleetCommand.d.ts +7 -7
- package/dist-types/commands/CreateJobCommand.d.ts +7 -7
- package/dist-types/commands/CreateLicenseEndpointCommand.d.ts +7 -7
- package/dist-types/commands/CreateLimitCommand.d.ts +6 -6
- package/dist-types/commands/CreateMonitorCommand.d.ts +5 -5
- package/dist-types/commands/CreateQueueCommand.d.ts +7 -7
- package/dist-types/commands/CreateQueueEnvironmentCommand.d.ts +7 -7
- package/dist-types/commands/CreateQueueFleetAssociationCommand.d.ts +6 -6
- package/dist-types/commands/CreateQueueLimitAssociationCommand.d.ts +6 -6
- package/dist-types/commands/CreateStorageProfileCommand.d.ts +7 -7
- package/dist-types/commands/CreateWorkerCommand.d.ts +6 -6
- package/dist-types/commands/DeleteBudgetCommand.d.ts +6 -6
- package/dist-types/commands/DeleteFarmCommand.d.ts +6 -6
- package/dist-types/commands/DeleteFleetCommand.d.ts +7 -7
- package/dist-types/commands/DeleteLicenseEndpointCommand.d.ts +7 -7
- package/dist-types/commands/DeleteLimitCommand.d.ts +4 -4
- package/dist-types/commands/DeleteMeteredProductCommand.d.ts +6 -6
- package/dist-types/commands/DeleteMonitorCommand.d.ts +6 -6
- package/dist-types/commands/DeleteQueueCommand.d.ts +6 -6
- package/dist-types/commands/DeleteQueueEnvironmentCommand.d.ts +5 -5
- package/dist-types/commands/DeleteQueueFleetAssociationCommand.d.ts +7 -7
- package/dist-types/commands/DeleteQueueLimitAssociationCommand.d.ts +7 -7
- package/dist-types/commands/DeleteStorageProfileCommand.d.ts +5 -5
- package/dist-types/commands/DeleteVolumeCommand.d.ts +7 -7
- package/dist-types/commands/DeleteWorkerCommand.d.ts +7 -7
- package/dist-types/commands/DisassociateMemberFromFarmCommand.d.ts +6 -6
- package/dist-types/commands/DisassociateMemberFromFleetCommand.d.ts +7 -7
- package/dist-types/commands/DisassociateMemberFromJobCommand.d.ts +6 -6
- package/dist-types/commands/DisassociateMemberFromQueueCommand.d.ts +7 -7
- package/dist-types/commands/GetBudgetCommand.d.ts +6 -6
- package/dist-types/commands/GetFarmCommand.d.ts +6 -6
- package/dist-types/commands/GetFleetCommand.d.ts +6 -6
- package/dist-types/commands/GetJobCommand.d.ts +6 -6
- package/dist-types/commands/GetLicenseEndpointCommand.d.ts +6 -6
- package/dist-types/commands/GetLimitCommand.d.ts +6 -6
- package/dist-types/commands/GetMonitorCommand.d.ts +6 -6
- package/dist-types/commands/GetMonitorSettingsCommand.d.ts +6 -6
- package/dist-types/commands/GetQueueCommand.d.ts +6 -6
- package/dist-types/commands/GetQueueEnvironmentCommand.d.ts +6 -6
- package/dist-types/commands/GetQueueFleetAssociationCommand.d.ts +6 -6
- package/dist-types/commands/GetQueueLimitAssociationCommand.d.ts +6 -6
- package/dist-types/commands/GetSessionActionCommand.d.ts +6 -6
- package/dist-types/commands/GetSessionCommand.d.ts +6 -6
- package/dist-types/commands/GetSessionsStatisticsAggregationCommand.d.ts +6 -6
- package/dist-types/commands/GetStepCommand.d.ts +6 -6
- package/dist-types/commands/GetStorageProfileCommand.d.ts +6 -6
- package/dist-types/commands/GetStorageProfileForQueueCommand.d.ts +6 -6
- package/dist-types/commands/GetTaskCommand.d.ts +6 -6
- package/dist-types/commands/GetVolumeCommand.d.ts +6 -6
- package/dist-types/commands/GetWorkerCommand.d.ts +6 -6
- package/dist-types/commands/ListAvailableMeteredProductsCommand.d.ts +3 -3
- package/dist-types/commands/ListBudgetsCommand.d.ts +6 -6
- package/dist-types/commands/ListFarmMembersCommand.d.ts +6 -6
- package/dist-types/commands/ListFarmsCommand.d.ts +5 -5
- package/dist-types/commands/ListFleetMembersCommand.d.ts +6 -6
- package/dist-types/commands/ListFleetsCommand.d.ts +6 -6
- package/dist-types/commands/ListJobMembersCommand.d.ts +6 -6
- package/dist-types/commands/ListJobParameterDefinitionsCommand.d.ts +6 -6
- package/dist-types/commands/ListJobsCommand.d.ts +6 -6
- package/dist-types/commands/ListLicenseEndpointsCommand.d.ts +6 -6
- package/dist-types/commands/ListLimitsCommand.d.ts +6 -6
- package/dist-types/commands/ListMembershipsCommand.d.ts +6 -6
- package/dist-types/commands/ListMeteredProductsCommand.d.ts +6 -6
- package/dist-types/commands/ListMonitorsCommand.d.ts +5 -5
- package/dist-types/commands/ListQueueEnvironmentsCommand.d.ts +6 -6
- package/dist-types/commands/ListQueueFleetAssociationsCommand.d.ts +5 -5
- package/dist-types/commands/ListQueueLimitAssociationsCommand.d.ts +5 -5
- package/dist-types/commands/ListQueueMembersCommand.d.ts +6 -6
- package/dist-types/commands/ListQueuesCommand.d.ts +6 -6
- package/dist-types/commands/ListSessionActionsCommand.d.ts +6 -6
- package/dist-types/commands/ListSessionsCommand.d.ts +6 -6
- package/dist-types/commands/ListSessionsForWorkerCommand.d.ts +6 -6
- package/dist-types/commands/ListStepConsumersCommand.d.ts +6 -6
- package/dist-types/commands/ListStepDependenciesCommand.d.ts +6 -6
- package/dist-types/commands/ListStepsCommand.d.ts +6 -6
- package/dist-types/commands/ListStorageProfilesCommand.d.ts +6 -6
- package/dist-types/commands/ListStorageProfilesForQueueCommand.d.ts +6 -6
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -6
- package/dist-types/commands/ListTasksCommand.d.ts +6 -6
- package/dist-types/commands/ListVolumesCommand.d.ts +6 -6
- package/dist-types/commands/ListWorkersCommand.d.ts +6 -6
- package/dist-types/commands/PutMeteredProductCommand.d.ts +6 -6
- package/dist-types/commands/SearchJobsCommand.d.ts +6 -6
- package/dist-types/commands/SearchStepsCommand.d.ts +6 -6
- package/dist-types/commands/SearchTasksCommand.d.ts +6 -6
- package/dist-types/commands/SearchWorkersCommand.d.ts +6 -6
- package/dist-types/commands/StartSessionsStatisticsAggregationCommand.d.ts +6 -6
- package/dist-types/commands/TagResourceCommand.d.ts +7 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +7 -7
- package/dist-types/commands/UpdateBudgetCommand.d.ts +6 -6
- package/dist-types/commands/UpdateFarmCommand.d.ts +6 -6
- package/dist-types/commands/UpdateFleetCommand.d.ts +6 -6
- package/dist-types/commands/UpdateJobCommand.d.ts +6 -6
- package/dist-types/commands/UpdateLimitCommand.d.ts +5 -5
- package/dist-types/commands/UpdateMonitorCommand.d.ts +6 -6
- package/dist-types/commands/UpdateMonitorSettingsCommand.d.ts +6 -6
- package/dist-types/commands/UpdateQueueCommand.d.ts +6 -6
- package/dist-types/commands/UpdateQueueEnvironmentCommand.d.ts +6 -6
- package/dist-types/commands/UpdateQueueFleetAssociationCommand.d.ts +6 -6
- package/dist-types/commands/UpdateQueueLimitAssociationCommand.d.ts +5 -5
- package/dist-types/commands/UpdateSessionCommand.d.ts +7 -7
- package/dist-types/commands/UpdateStepCommand.d.ts +7 -7
- package/dist-types/commands/UpdateStorageProfileCommand.d.ts +6 -6
- package/dist-types/commands/UpdateTaskCommand.d.ts +7 -7
- package/dist-types/commands/UpdateWorkerCommand.d.ts +7 -7
- package/dist-types/commands/UpdateWorkerScheduleCommand.d.ts +7 -7
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/errors.d.ts +29 -29
- package/dist-types/models/models_0.d.ts +1312 -1376
- package/dist-types/models/models_1.d.ts +514 -537
- package/package.json +5 -5
|
@@ -5,64 +5,63 @@ import type { DateTimeFilterExpression, DependencyCounts, FarmMember, FileSystem
|
|
|
5
5
|
*/
|
|
6
6
|
export interface ListStepConsumersRequest {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* The farm ID for the list of step consumers.
|
|
9
9
|
* @public
|
|
10
10
|
*/
|
|
11
11
|
farmId: string | undefined;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* The queue ID for the step consumer.
|
|
14
14
|
* @public
|
|
15
15
|
*/
|
|
16
16
|
queueId: string | undefined;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* The job ID for the step consumer.
|
|
19
19
|
* @public
|
|
20
20
|
*/
|
|
21
21
|
jobId: string | undefined;
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* The step ID to include on the list.
|
|
24
24
|
* @public
|
|
25
25
|
*/
|
|
26
26
|
stepId: string | undefined;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
29
29
|
* @public
|
|
30
30
|
*/
|
|
31
31
|
nextToken?: string | undefined;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
34
34
|
* @public
|
|
35
35
|
*/
|
|
36
36
|
maxResults?: number | undefined;
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* The details of a step consumer.
|
|
40
40
|
* @public
|
|
41
41
|
*/
|
|
42
42
|
export interface StepConsumer {
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* The step ID.
|
|
45
45
|
* @public
|
|
46
46
|
*/
|
|
47
47
|
stepId: string | undefined;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* The step consumer status.
|
|
50
50
|
* @public
|
|
51
51
|
*/
|
|
52
52
|
status: DependencyConsumerResolutionStatus | undefined;
|
|
53
53
|
}
|
|
54
54
|
/**
|
|
55
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
56
55
|
* @public
|
|
57
56
|
*/
|
|
58
57
|
export interface ListStepConsumersResponse {
|
|
59
58
|
/**
|
|
60
|
-
*
|
|
59
|
+
* The consumers on the list.
|
|
61
60
|
* @public
|
|
62
61
|
*/
|
|
63
62
|
consumers: StepConsumer[] | undefined;
|
|
64
63
|
/**
|
|
65
|
-
*
|
|
64
|
+
* 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.
|
|
66
65
|
* @public
|
|
67
66
|
*/
|
|
68
67
|
nextToken?: string | undefined;
|
|
@@ -72,121 +71,119 @@ export interface ListStepConsumersResponse {
|
|
|
72
71
|
*/
|
|
73
72
|
export interface ListStepDependenciesRequest {
|
|
74
73
|
/**
|
|
75
|
-
*
|
|
74
|
+
* The farm ID for the step dependencies list.
|
|
76
75
|
* @public
|
|
77
76
|
*/
|
|
78
77
|
farmId: string | undefined;
|
|
79
78
|
/**
|
|
80
|
-
*
|
|
79
|
+
* The queue ID for the step dependencies list.
|
|
81
80
|
* @public
|
|
82
81
|
*/
|
|
83
82
|
queueId: string | undefined;
|
|
84
83
|
/**
|
|
85
|
-
*
|
|
84
|
+
* The job ID for the step dependencies list.
|
|
86
85
|
* @public
|
|
87
86
|
*/
|
|
88
87
|
jobId: string | undefined;
|
|
89
88
|
/**
|
|
90
|
-
*
|
|
89
|
+
* The step ID to include on the list.
|
|
91
90
|
* @public
|
|
92
91
|
*/
|
|
93
92
|
stepId: string | undefined;
|
|
94
93
|
/**
|
|
95
|
-
*
|
|
94
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
96
95
|
* @public
|
|
97
96
|
*/
|
|
98
97
|
nextToken?: string | undefined;
|
|
99
98
|
/**
|
|
100
|
-
*
|
|
99
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
101
100
|
* @public
|
|
102
101
|
*/
|
|
103
102
|
maxResults?: number | undefined;
|
|
104
103
|
}
|
|
105
104
|
/**
|
|
106
|
-
*
|
|
105
|
+
* The details of step dependency.
|
|
107
106
|
* @public
|
|
108
107
|
*/
|
|
109
108
|
export interface StepDependency {
|
|
110
109
|
/**
|
|
111
|
-
*
|
|
110
|
+
* The step ID.
|
|
112
111
|
* @public
|
|
113
112
|
*/
|
|
114
113
|
stepId: string | undefined;
|
|
115
114
|
/**
|
|
116
|
-
*
|
|
115
|
+
* The step dependency status.
|
|
117
116
|
* @public
|
|
118
117
|
*/
|
|
119
118
|
status: DependencyConsumerResolutionStatus | undefined;
|
|
120
119
|
}
|
|
121
120
|
/**
|
|
122
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
123
121
|
* @public
|
|
124
122
|
*/
|
|
125
123
|
export interface ListStepDependenciesResponse {
|
|
126
124
|
/**
|
|
127
|
-
*
|
|
125
|
+
* The dependencies on the list.
|
|
128
126
|
* @public
|
|
129
127
|
*/
|
|
130
128
|
dependencies: StepDependency[] | undefined;
|
|
131
129
|
/**
|
|
132
|
-
*
|
|
130
|
+
* 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.
|
|
133
131
|
* @public
|
|
134
132
|
*/
|
|
135
133
|
nextToken?: string | undefined;
|
|
136
134
|
}
|
|
137
135
|
/**
|
|
138
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
139
136
|
* @public
|
|
140
137
|
*/
|
|
141
138
|
export interface ListStepsRequest {
|
|
142
139
|
/**
|
|
143
|
-
*
|
|
140
|
+
* The farm ID to include on the list of steps.
|
|
144
141
|
* @public
|
|
145
142
|
*/
|
|
146
143
|
farmId: string | undefined;
|
|
147
144
|
/**
|
|
148
|
-
*
|
|
145
|
+
* The queue ID to include on the list of steps.
|
|
149
146
|
* @public
|
|
150
147
|
*/
|
|
151
148
|
queueId: string | undefined;
|
|
152
149
|
/**
|
|
153
|
-
*
|
|
150
|
+
* The job ID to include on the list of steps.
|
|
154
151
|
* @public
|
|
155
152
|
*/
|
|
156
153
|
jobId: string | undefined;
|
|
157
154
|
/**
|
|
158
|
-
*
|
|
155
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
159
156
|
* @public
|
|
160
157
|
*/
|
|
161
158
|
nextToken?: string | undefined;
|
|
162
159
|
/**
|
|
163
|
-
*
|
|
160
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
164
161
|
* @public
|
|
165
162
|
*/
|
|
166
163
|
maxResults?: number | undefined;
|
|
167
164
|
}
|
|
168
165
|
/**
|
|
169
|
-
*
|
|
166
|
+
* The details for a step.
|
|
170
167
|
* @public
|
|
171
168
|
*/
|
|
172
169
|
export interface StepSummary {
|
|
173
170
|
/**
|
|
174
|
-
*
|
|
171
|
+
* The step ID.
|
|
175
172
|
* @public
|
|
176
173
|
*/
|
|
177
174
|
stepId: string | undefined;
|
|
178
175
|
/**
|
|
179
|
-
*
|
|
176
|
+
* The name of the step.
|
|
180
177
|
* @public
|
|
181
178
|
*/
|
|
182
179
|
name: string | undefined;
|
|
183
180
|
/**
|
|
184
|
-
*
|
|
181
|
+
* The life cycle status.
|
|
185
182
|
* @public
|
|
186
183
|
*/
|
|
187
184
|
lifecycleStatus: StepLifecycleStatus | undefined;
|
|
188
185
|
/**
|
|
189
|
-
*
|
|
186
|
+
* A message that describes the lifecycle of the step.
|
|
190
187
|
* @public
|
|
191
188
|
*/
|
|
192
189
|
lifecycleStatusMessage?: string | undefined;
|
|
@@ -196,186 +193,183 @@ export interface StepSummary {
|
|
|
196
193
|
*/
|
|
197
194
|
taskRunStatus: TaskRunStatus | undefined;
|
|
198
195
|
/**
|
|
199
|
-
*
|
|
196
|
+
* The number of tasks running on the job.
|
|
200
197
|
* @public
|
|
201
198
|
*/
|
|
202
199
|
taskRunStatusCounts: Partial<Record<TaskRunStatus, number>> | undefined;
|
|
203
200
|
/**
|
|
204
|
-
*
|
|
201
|
+
* The total number of times tasks from the step failed and were retried.
|
|
205
202
|
* @public
|
|
206
203
|
*/
|
|
207
204
|
taskFailureRetryCount?: number | undefined;
|
|
208
205
|
/**
|
|
209
|
-
*
|
|
206
|
+
* The task status to update the job's tasks to.
|
|
210
207
|
* @public
|
|
211
208
|
*/
|
|
212
209
|
targetTaskRunStatus?: StepTargetTaskRunStatus | undefined;
|
|
213
210
|
/**
|
|
214
|
-
*
|
|
211
|
+
* The date and time the resource was created.
|
|
215
212
|
* @public
|
|
216
213
|
*/
|
|
217
214
|
createdAt: Date | undefined;
|
|
218
215
|
/**
|
|
219
|
-
*
|
|
216
|
+
* The user or system that created this resource.
|
|
220
217
|
* @public
|
|
221
218
|
*/
|
|
222
219
|
createdBy: string | undefined;
|
|
223
220
|
/**
|
|
224
|
-
*
|
|
221
|
+
* The date and time the resource was updated.
|
|
225
222
|
* @public
|
|
226
223
|
*/
|
|
227
224
|
updatedAt?: Date | undefined;
|
|
228
225
|
/**
|
|
229
|
-
*
|
|
226
|
+
* The user or system that updated this resource.
|
|
230
227
|
* @public
|
|
231
228
|
*/
|
|
232
229
|
updatedBy?: string | undefined;
|
|
233
230
|
/**
|
|
234
|
-
*
|
|
231
|
+
* The date and time the resource started running.
|
|
235
232
|
* @public
|
|
236
233
|
*/
|
|
237
234
|
startedAt?: Date | undefined;
|
|
238
235
|
/**
|
|
239
|
-
*
|
|
236
|
+
* The date and time the resource ended running.
|
|
240
237
|
* @public
|
|
241
238
|
*/
|
|
242
239
|
endedAt?: Date | undefined;
|
|
243
240
|
/**
|
|
244
|
-
*
|
|
241
|
+
* The number of dependencies for the step.
|
|
245
242
|
* @public
|
|
246
243
|
*/
|
|
247
244
|
dependencyCounts?: DependencyCounts | undefined;
|
|
248
245
|
}
|
|
249
246
|
/**
|
|
250
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
251
247
|
* @public
|
|
252
248
|
*/
|
|
253
249
|
export interface ListStepsResponse {
|
|
254
250
|
/**
|
|
255
|
-
*
|
|
251
|
+
* The steps on the list.
|
|
256
252
|
* @public
|
|
257
253
|
*/
|
|
258
254
|
steps: StepSummary[] | undefined;
|
|
259
255
|
/**
|
|
260
|
-
*
|
|
256
|
+
* 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.
|
|
261
257
|
* @public
|
|
262
258
|
*/
|
|
263
259
|
nextToken?: string | undefined;
|
|
264
260
|
}
|
|
265
261
|
/**
|
|
266
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
267
262
|
* @public
|
|
268
263
|
*/
|
|
269
264
|
export interface ListTasksRequest {
|
|
270
265
|
/**
|
|
271
|
-
*
|
|
266
|
+
* The farm ID connected to the tasks.
|
|
272
267
|
* @public
|
|
273
268
|
*/
|
|
274
269
|
farmId: string | undefined;
|
|
275
270
|
/**
|
|
276
|
-
*
|
|
271
|
+
* The queue ID connected to the tasks.
|
|
277
272
|
* @public
|
|
278
273
|
*/
|
|
279
274
|
queueId: string | undefined;
|
|
280
275
|
/**
|
|
281
|
-
*
|
|
276
|
+
* The job ID for the tasks.
|
|
282
277
|
* @public
|
|
283
278
|
*/
|
|
284
279
|
jobId: string | undefined;
|
|
285
280
|
/**
|
|
286
|
-
*
|
|
281
|
+
* The step ID for the tasks.
|
|
287
282
|
* @public
|
|
288
283
|
*/
|
|
289
284
|
stepId: string | undefined;
|
|
290
285
|
/**
|
|
291
|
-
*
|
|
286
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
292
287
|
* @public
|
|
293
288
|
*/
|
|
294
289
|
nextToken?: string | undefined;
|
|
295
290
|
/**
|
|
296
|
-
*
|
|
291
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
297
292
|
* @public
|
|
298
293
|
*/
|
|
299
294
|
maxResults?: number | undefined;
|
|
300
295
|
}
|
|
301
296
|
/**
|
|
302
|
-
*
|
|
297
|
+
* The details of a task.
|
|
303
298
|
* @public
|
|
304
299
|
*/
|
|
305
300
|
export interface TaskSummary {
|
|
306
301
|
/**
|
|
307
|
-
*
|
|
302
|
+
* The task ID.
|
|
308
303
|
* @public
|
|
309
304
|
*/
|
|
310
305
|
taskId: string | undefined;
|
|
311
306
|
/**
|
|
312
|
-
*
|
|
307
|
+
* The date and time the resource was created.
|
|
313
308
|
* @public
|
|
314
309
|
*/
|
|
315
310
|
createdAt: Date | undefined;
|
|
316
311
|
/**
|
|
317
|
-
*
|
|
312
|
+
* The user or system that created this resource.
|
|
318
313
|
* @public
|
|
319
314
|
*/
|
|
320
315
|
createdBy: string | undefined;
|
|
321
316
|
/**
|
|
322
|
-
*
|
|
317
|
+
* The run status of the task.
|
|
323
318
|
* @public
|
|
324
319
|
*/
|
|
325
320
|
runStatus: TaskRunStatus | undefined;
|
|
326
321
|
/**
|
|
327
|
-
*
|
|
322
|
+
* The run status on which the started.
|
|
328
323
|
* @public
|
|
329
324
|
*/
|
|
330
325
|
targetRunStatus?: TaskTargetRunStatus | undefined;
|
|
331
326
|
/**
|
|
332
|
-
*
|
|
327
|
+
* The number of times that the task failed and was retried.
|
|
333
328
|
* @public
|
|
334
329
|
*/
|
|
335
330
|
failureRetryCount?: number | undefined;
|
|
336
331
|
/**
|
|
337
|
-
*
|
|
332
|
+
* The date and time the resource started running.
|
|
338
333
|
* @public
|
|
339
334
|
*/
|
|
340
335
|
startedAt?: Date | undefined;
|
|
341
336
|
/**
|
|
342
|
-
*
|
|
337
|
+
* The date and time the resource ended running.
|
|
343
338
|
* @public
|
|
344
339
|
*/
|
|
345
340
|
endedAt?: Date | undefined;
|
|
346
341
|
/**
|
|
347
|
-
*
|
|
342
|
+
* The date and time the resource was updated.
|
|
348
343
|
* @public
|
|
349
344
|
*/
|
|
350
345
|
updatedAt?: Date | undefined;
|
|
351
346
|
/**
|
|
352
|
-
*
|
|
347
|
+
* The user or system that updated this resource.
|
|
353
348
|
* @public
|
|
354
349
|
*/
|
|
355
350
|
updatedBy?: string | undefined;
|
|
356
351
|
/**
|
|
357
|
-
*
|
|
352
|
+
* The latest session action ID for the task.
|
|
358
353
|
* @public
|
|
359
354
|
*/
|
|
360
355
|
latestSessionActionId?: string | undefined;
|
|
361
356
|
/**
|
|
362
|
-
*
|
|
357
|
+
* The task parameters.
|
|
363
358
|
* @public
|
|
364
359
|
*/
|
|
365
360
|
parameters?: Record<string, TaskParameterValue> | undefined;
|
|
366
361
|
}
|
|
367
362
|
/**
|
|
368
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
369
363
|
* @public
|
|
370
364
|
*/
|
|
371
365
|
export interface ListTasksResponse {
|
|
372
366
|
/**
|
|
373
|
-
*
|
|
367
|
+
* Tasks for the job.
|
|
374
368
|
* @public
|
|
375
369
|
*/
|
|
376
370
|
tasks: TaskSummary[] | undefined;
|
|
377
371
|
/**
|
|
378
|
-
*
|
|
372
|
+
* 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.
|
|
379
373
|
* @public
|
|
380
374
|
*/
|
|
381
375
|
nextToken?: string | undefined;
|
|
@@ -385,42 +379,42 @@ export interface ListTasksResponse {
|
|
|
385
379
|
*/
|
|
386
380
|
export interface UpdateJobRequest {
|
|
387
381
|
/**
|
|
388
|
-
*
|
|
382
|
+
* The farm ID of the job to update.
|
|
389
383
|
* @public
|
|
390
384
|
*/
|
|
391
385
|
farmId: string | undefined;
|
|
392
386
|
/**
|
|
393
|
-
*
|
|
387
|
+
* The queue ID of the job to update.
|
|
394
388
|
* @public
|
|
395
389
|
*/
|
|
396
390
|
queueId: string | undefined;
|
|
397
391
|
/**
|
|
398
|
-
*
|
|
392
|
+
* The job ID to update.
|
|
399
393
|
* @public
|
|
400
394
|
*/
|
|
401
395
|
jobId: string | undefined;
|
|
402
396
|
/**
|
|
403
|
-
*
|
|
397
|
+
* The unique token which the server uses to recognize retries of the same request.
|
|
404
398
|
* @public
|
|
405
399
|
*/
|
|
406
400
|
clientToken?: string | undefined;
|
|
407
401
|
/**
|
|
408
|
-
*
|
|
402
|
+
* The task status to update the job's tasks to.
|
|
409
403
|
* @public
|
|
410
404
|
*/
|
|
411
405
|
targetTaskRunStatus?: JobTargetTaskRunStatus | undefined;
|
|
412
406
|
/**
|
|
413
|
-
*
|
|
407
|
+
* The updated job priority.
|
|
414
408
|
* @public
|
|
415
409
|
*/
|
|
416
410
|
priority?: number | undefined;
|
|
417
411
|
/**
|
|
418
|
-
*
|
|
412
|
+
* The number of task failures before the job stops running and is marked as <code>FAILED</code>.
|
|
419
413
|
* @public
|
|
420
414
|
*/
|
|
421
415
|
maxFailedTasksCount?: number | undefined;
|
|
422
416
|
/**
|
|
423
|
-
*
|
|
417
|
+
* The maximum number of retries for a job.
|
|
424
418
|
* @public
|
|
425
419
|
*/
|
|
426
420
|
maxRetriesPerTask?: number | undefined;
|
|
@@ -430,17 +424,24 @@ export interface UpdateJobRequest {
|
|
|
430
424
|
*/
|
|
431
425
|
lifecycleStatus?: UpdateJobLifecycleStatus | undefined;
|
|
432
426
|
/**
|
|
433
|
-
*
|
|
427
|
+
* 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.
|
|
428
|
+
*
|
|
429
|
+
* You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.
|
|
430
|
+
*
|
|
431
|
+
* If you don't specify the <code>maxWorkerCount</code>, the default is -1.
|
|
432
|
+
*
|
|
433
|
+
* The maximum number of workers that can process tasks in the job.
|
|
434
|
+
*
|
|
434
435
|
* @public
|
|
435
436
|
*/
|
|
436
437
|
maxWorkerCount?: number | undefined;
|
|
437
438
|
/**
|
|
438
|
-
*
|
|
439
|
+
* The updated job name.
|
|
439
440
|
* @public
|
|
440
441
|
*/
|
|
441
442
|
name?: string | undefined;
|
|
442
443
|
/**
|
|
443
|
-
*
|
|
444
|
+
* The updated job description.
|
|
444
445
|
* @public
|
|
445
446
|
*/
|
|
446
447
|
description?: string | undefined;
|
|
@@ -455,32 +456,32 @@ export interface UpdateJobResponse {
|
|
|
455
456
|
*/
|
|
456
457
|
export interface UpdateSessionRequest {
|
|
457
458
|
/**
|
|
458
|
-
*
|
|
459
|
+
* The farm ID to update in the session.
|
|
459
460
|
* @public
|
|
460
461
|
*/
|
|
461
462
|
farmId: string | undefined;
|
|
462
463
|
/**
|
|
463
|
-
*
|
|
464
|
+
* The queue ID to update in the session.
|
|
464
465
|
* @public
|
|
465
466
|
*/
|
|
466
467
|
queueId: string | undefined;
|
|
467
468
|
/**
|
|
468
|
-
*
|
|
469
|
+
* The job ID to update in the session.
|
|
469
470
|
* @public
|
|
470
471
|
*/
|
|
471
472
|
jobId: string | undefined;
|
|
472
473
|
/**
|
|
473
|
-
*
|
|
474
|
+
* The session ID to update.
|
|
474
475
|
* @public
|
|
475
476
|
*/
|
|
476
477
|
sessionId: string | undefined;
|
|
477
478
|
/**
|
|
478
|
-
*
|
|
479
|
+
* The unique token which the server uses to recognize retries of the same request.
|
|
479
480
|
* @public
|
|
480
481
|
*/
|
|
481
482
|
clientToken?: string | undefined;
|
|
482
483
|
/**
|
|
483
|
-
*
|
|
484
|
+
* The life cycle status to update in the session.
|
|
484
485
|
* @public
|
|
485
486
|
*/
|
|
486
487
|
targetLifecycleStatus: SessionLifecycleTargetStatus | undefined;
|
|
@@ -495,32 +496,32 @@ export interface UpdateSessionResponse {
|
|
|
495
496
|
*/
|
|
496
497
|
export interface UpdateStepRequest {
|
|
497
498
|
/**
|
|
498
|
-
*
|
|
499
|
+
* The farm ID to update.
|
|
499
500
|
* @public
|
|
500
501
|
*/
|
|
501
502
|
farmId: string | undefined;
|
|
502
503
|
/**
|
|
503
|
-
*
|
|
504
|
+
* The queue ID to update.
|
|
504
505
|
* @public
|
|
505
506
|
*/
|
|
506
507
|
queueId: string | undefined;
|
|
507
508
|
/**
|
|
508
|
-
*
|
|
509
|
+
* The job ID to update.
|
|
509
510
|
* @public
|
|
510
511
|
*/
|
|
511
512
|
jobId: string | undefined;
|
|
512
513
|
/**
|
|
513
|
-
*
|
|
514
|
+
* The step ID to update.
|
|
514
515
|
* @public
|
|
515
516
|
*/
|
|
516
517
|
stepId: string | undefined;
|
|
517
518
|
/**
|
|
518
|
-
*
|
|
519
|
+
* The unique token which the server uses to recognize retries of the same request.
|
|
519
520
|
* @public
|
|
520
521
|
*/
|
|
521
522
|
clientToken?: string | undefined;
|
|
522
523
|
/**
|
|
523
|
-
*
|
|
524
|
+
* The task status to update the step's tasks to.
|
|
524
525
|
* @public
|
|
525
526
|
*/
|
|
526
527
|
targetTaskRunStatus: StepTargetTaskRunStatus | undefined;
|
|
@@ -535,37 +536,37 @@ export interface UpdateStepResponse {
|
|
|
535
536
|
*/
|
|
536
537
|
export interface UpdateTaskRequest {
|
|
537
538
|
/**
|
|
538
|
-
*
|
|
539
|
+
* The farm ID to update.
|
|
539
540
|
* @public
|
|
540
541
|
*/
|
|
541
542
|
farmId: string | undefined;
|
|
542
543
|
/**
|
|
543
|
-
*
|
|
544
|
+
* The queue ID to update.
|
|
544
545
|
* @public
|
|
545
546
|
*/
|
|
546
547
|
queueId: string | undefined;
|
|
547
548
|
/**
|
|
548
|
-
*
|
|
549
|
+
* The job ID to update.
|
|
549
550
|
* @public
|
|
550
551
|
*/
|
|
551
552
|
jobId: string | undefined;
|
|
552
553
|
/**
|
|
553
|
-
*
|
|
554
|
+
* The step ID to update.
|
|
554
555
|
* @public
|
|
555
556
|
*/
|
|
556
557
|
stepId: string | undefined;
|
|
557
558
|
/**
|
|
558
|
-
*
|
|
559
|
+
* The task ID to update.
|
|
559
560
|
* @public
|
|
560
561
|
*/
|
|
561
562
|
taskId: string | undefined;
|
|
562
563
|
/**
|
|
563
|
-
*
|
|
564
|
+
* The unique token which the server uses to recognize retries of the same request.
|
|
564
565
|
* @public
|
|
565
566
|
*/
|
|
566
567
|
clientToken?: string | undefined;
|
|
567
568
|
/**
|
|
568
|
-
*
|
|
569
|
+
* The run status with which to start the task.
|
|
569
570
|
* @public
|
|
570
571
|
*/
|
|
571
572
|
targetRunStatus: TaskTargetRunStatus | undefined;
|
|
@@ -576,168 +577,163 @@ export interface UpdateTaskRequest {
|
|
|
576
577
|
export interface UpdateTaskResponse {
|
|
577
578
|
}
|
|
578
579
|
/**
|
|
579
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
580
580
|
* @public
|
|
581
581
|
*/
|
|
582
582
|
export interface ListQueueEnvironmentsRequest {
|
|
583
583
|
/**
|
|
584
|
-
*
|
|
584
|
+
* The farm ID for the queue environment list.
|
|
585
585
|
* @public
|
|
586
586
|
*/
|
|
587
587
|
farmId: string | undefined;
|
|
588
588
|
/**
|
|
589
|
-
*
|
|
589
|
+
* The queue ID for the queue environment list.
|
|
590
590
|
* @public
|
|
591
591
|
*/
|
|
592
592
|
queueId: string | undefined;
|
|
593
593
|
/**
|
|
594
|
-
*
|
|
594
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
595
595
|
* @public
|
|
596
596
|
*/
|
|
597
597
|
nextToken?: string | undefined;
|
|
598
598
|
/**
|
|
599
|
-
*
|
|
599
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
600
600
|
* @public
|
|
601
601
|
*/
|
|
602
602
|
maxResults?: number | undefined;
|
|
603
603
|
}
|
|
604
604
|
/**
|
|
605
|
-
*
|
|
605
|
+
* The summary of a queue environment.
|
|
606
606
|
* @public
|
|
607
607
|
*/
|
|
608
608
|
export interface QueueEnvironmentSummary {
|
|
609
609
|
/**
|
|
610
|
-
*
|
|
610
|
+
* The queue environment ID.
|
|
611
611
|
* @public
|
|
612
612
|
*/
|
|
613
613
|
queueEnvironmentId: string | undefined;
|
|
614
614
|
/**
|
|
615
|
-
*
|
|
615
|
+
* The name of the queue environment.
|
|
616
616
|
* @public
|
|
617
617
|
*/
|
|
618
618
|
name: string | undefined;
|
|
619
619
|
/**
|
|
620
|
-
*
|
|
620
|
+
* The queue environment's priority.
|
|
621
621
|
* @public
|
|
622
622
|
*/
|
|
623
623
|
priority: number | undefined;
|
|
624
624
|
}
|
|
625
625
|
/**
|
|
626
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
627
626
|
* @public
|
|
628
627
|
*/
|
|
629
628
|
export interface ListQueueEnvironmentsResponse {
|
|
630
629
|
/**
|
|
631
|
-
*
|
|
630
|
+
* The environments to include in the queue environments list.
|
|
632
631
|
* @public
|
|
633
632
|
*/
|
|
634
633
|
environments: QueueEnvironmentSummary[] | undefined;
|
|
635
634
|
/**
|
|
636
|
-
*
|
|
635
|
+
* 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.
|
|
637
636
|
* @public
|
|
638
637
|
*/
|
|
639
638
|
nextToken?: string | undefined;
|
|
640
639
|
}
|
|
641
640
|
/**
|
|
642
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
643
641
|
* @public
|
|
644
642
|
*/
|
|
645
643
|
export interface ListQueueMembersRequest {
|
|
646
644
|
/**
|
|
647
|
-
*
|
|
645
|
+
* The farm ID for the queue.
|
|
648
646
|
* @public
|
|
649
647
|
*/
|
|
650
648
|
farmId: string | undefined;
|
|
651
649
|
/**
|
|
652
|
-
*
|
|
650
|
+
* The queue ID to include on the list.
|
|
653
651
|
* @public
|
|
654
652
|
*/
|
|
655
653
|
queueId: string | undefined;
|
|
656
654
|
/**
|
|
657
|
-
*
|
|
655
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
658
656
|
* @public
|
|
659
657
|
*/
|
|
660
658
|
nextToken?: string | undefined;
|
|
661
659
|
/**
|
|
662
|
-
*
|
|
660
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
663
661
|
* @public
|
|
664
662
|
*/
|
|
665
663
|
maxResults?: number | undefined;
|
|
666
664
|
}
|
|
667
665
|
/**
|
|
668
|
-
*
|
|
666
|
+
* The details of a queue member.
|
|
669
667
|
* @public
|
|
670
668
|
*/
|
|
671
669
|
export interface QueueMember {
|
|
672
670
|
/**
|
|
673
|
-
*
|
|
671
|
+
* The farm ID.
|
|
674
672
|
* @public
|
|
675
673
|
*/
|
|
676
674
|
farmId: string | undefined;
|
|
677
675
|
/**
|
|
678
|
-
*
|
|
676
|
+
* The queue ID.
|
|
679
677
|
* @public
|
|
680
678
|
*/
|
|
681
679
|
queueId: string | undefined;
|
|
682
680
|
/**
|
|
683
|
-
*
|
|
681
|
+
* The principal ID of the queue member.
|
|
684
682
|
* @public
|
|
685
683
|
*/
|
|
686
684
|
principalId: string | undefined;
|
|
687
685
|
/**
|
|
688
|
-
*
|
|
686
|
+
* The principal type of the queue member.
|
|
689
687
|
* @public
|
|
690
688
|
*/
|
|
691
689
|
principalType: DeadlinePrincipalType | undefined;
|
|
692
690
|
/**
|
|
693
|
-
*
|
|
691
|
+
* The identity store ID.
|
|
694
692
|
* @public
|
|
695
693
|
*/
|
|
696
694
|
identityStoreId: string | undefined;
|
|
697
695
|
/**
|
|
698
|
-
*
|
|
696
|
+
* The queue member's membership level.
|
|
699
697
|
* @public
|
|
700
698
|
*/
|
|
701
699
|
membershipLevel: MembershipLevel | undefined;
|
|
702
700
|
}
|
|
703
701
|
/**
|
|
704
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
705
702
|
* @public
|
|
706
703
|
*/
|
|
707
704
|
export interface ListQueueMembersResponse {
|
|
708
705
|
/**
|
|
709
|
-
*
|
|
706
|
+
* The members on the list.
|
|
710
707
|
* @public
|
|
711
708
|
*/
|
|
712
709
|
members: QueueMember[] | undefined;
|
|
713
710
|
/**
|
|
714
|
-
*
|
|
711
|
+
* 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.
|
|
715
712
|
* @public
|
|
716
713
|
*/
|
|
717
714
|
nextToken?: string | undefined;
|
|
718
715
|
}
|
|
719
716
|
/**
|
|
720
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
721
717
|
* @public
|
|
722
718
|
*/
|
|
723
719
|
export interface ListQueuesRequest {
|
|
724
720
|
/**
|
|
725
|
-
*
|
|
721
|
+
* The farm ID of the queue.
|
|
726
722
|
* @public
|
|
727
723
|
*/
|
|
728
724
|
farmId: string | undefined;
|
|
729
725
|
/**
|
|
730
|
-
*
|
|
726
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
731
727
|
* @public
|
|
732
728
|
*/
|
|
733
729
|
nextToken?: string | undefined;
|
|
734
730
|
/**
|
|
735
|
-
*
|
|
731
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
736
732
|
* @public
|
|
737
733
|
*/
|
|
738
734
|
maxResults?: number | undefined;
|
|
739
735
|
/**
|
|
740
|
-
*
|
|
736
|
+
* The principal IDs to include in the list of queues.
|
|
741
737
|
* @public
|
|
742
738
|
*/
|
|
743
739
|
principalId?: string | undefined;
|
|
@@ -748,17 +744,17 @@ export interface ListQueuesRequest {
|
|
|
748
744
|
status?: QueueStatus | undefined;
|
|
749
745
|
}
|
|
750
746
|
/**
|
|
751
|
-
*
|
|
747
|
+
* The details of a queue summary.
|
|
752
748
|
* @public
|
|
753
749
|
*/
|
|
754
750
|
export interface QueueSummary {
|
|
755
751
|
/**
|
|
756
|
-
*
|
|
752
|
+
* The farm ID.
|
|
757
753
|
* @public
|
|
758
754
|
*/
|
|
759
755
|
farmId: string | undefined;
|
|
760
756
|
/**
|
|
761
|
-
*
|
|
757
|
+
* The queue ID.
|
|
762
758
|
* @public
|
|
763
759
|
*/
|
|
764
760
|
queueId: string | undefined;
|
|
@@ -768,95 +764,92 @@ export interface QueueSummary {
|
|
|
768
764
|
*/
|
|
769
765
|
displayName: string | undefined;
|
|
770
766
|
/**
|
|
771
|
-
*
|
|
767
|
+
* That status of the queue.
|
|
772
768
|
* @public
|
|
773
769
|
*/
|
|
774
770
|
status: QueueStatus | undefined;
|
|
775
771
|
/**
|
|
776
|
-
*
|
|
772
|
+
* The default action taken on a queue summary if a budget wasn't configured.
|
|
777
773
|
* @public
|
|
778
774
|
*/
|
|
779
775
|
defaultBudgetAction: DefaultQueueBudgetAction | undefined;
|
|
780
776
|
/**
|
|
781
|
-
*
|
|
777
|
+
* The reason the queue is blocked, if applicable.
|
|
782
778
|
* @public
|
|
783
779
|
*/
|
|
784
780
|
blockedReason?: QueueBlockedReason | undefined;
|
|
785
781
|
/**
|
|
786
|
-
*
|
|
782
|
+
* The date and time the resource was created.
|
|
787
783
|
* @public
|
|
788
784
|
*/
|
|
789
785
|
createdAt: Date | undefined;
|
|
790
786
|
/**
|
|
791
|
-
*
|
|
787
|
+
* The user or system that created this resource.
|
|
792
788
|
* @public
|
|
793
789
|
*/
|
|
794
790
|
createdBy: string | undefined;
|
|
795
791
|
/**
|
|
796
|
-
*
|
|
792
|
+
* The date and time the resource was updated.
|
|
797
793
|
* @public
|
|
798
794
|
*/
|
|
799
795
|
updatedAt?: Date | undefined;
|
|
800
796
|
/**
|
|
801
|
-
*
|
|
797
|
+
* The user or system that updated this resource.
|
|
802
798
|
* @public
|
|
803
799
|
*/
|
|
804
800
|
updatedBy?: string | undefined;
|
|
805
801
|
}
|
|
806
802
|
/**
|
|
807
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
808
803
|
* @public
|
|
809
804
|
*/
|
|
810
805
|
export interface ListQueuesResponse {
|
|
811
806
|
/**
|
|
812
|
-
*
|
|
807
|
+
* The queues on the list.
|
|
813
808
|
* @public
|
|
814
809
|
*/
|
|
815
810
|
queues: QueueSummary[] | undefined;
|
|
816
811
|
/**
|
|
817
|
-
*
|
|
812
|
+
* 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.
|
|
818
813
|
* @public
|
|
819
814
|
*/
|
|
820
815
|
nextToken?: string | undefined;
|
|
821
816
|
}
|
|
822
817
|
/**
|
|
823
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
824
818
|
* @public
|
|
825
819
|
*/
|
|
826
820
|
export interface ListStorageProfilesForQueueRequest {
|
|
827
821
|
/**
|
|
828
|
-
*
|
|
822
|
+
* The farm ID of the queue's storage profile.
|
|
829
823
|
* @public
|
|
830
824
|
*/
|
|
831
825
|
farmId: string | undefined;
|
|
832
826
|
/**
|
|
833
|
-
*
|
|
827
|
+
* The queue ID for the storage profile.
|
|
834
828
|
* @public
|
|
835
829
|
*/
|
|
836
830
|
queueId: string | undefined;
|
|
837
831
|
/**
|
|
838
|
-
*
|
|
832
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
839
833
|
* @public
|
|
840
834
|
*/
|
|
841
835
|
nextToken?: string | undefined;
|
|
842
836
|
/**
|
|
843
|
-
*
|
|
837
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
844
838
|
* @public
|
|
845
839
|
*/
|
|
846
840
|
maxResults?: number | undefined;
|
|
847
841
|
}
|
|
848
842
|
/**
|
|
849
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
850
843
|
* @public
|
|
851
844
|
*/
|
|
852
845
|
export interface ListStorageProfilesForQueueResponse {
|
|
853
846
|
/**
|
|
854
|
-
*
|
|
847
|
+
* The storage profiles in the queue.
|
|
855
848
|
* @public
|
|
856
849
|
*/
|
|
857
850
|
storageProfiles: StorageProfileSummary[] | undefined;
|
|
858
851
|
/**
|
|
859
|
-
*
|
|
852
|
+
* 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.
|
|
860
853
|
* @public
|
|
861
854
|
*/
|
|
862
855
|
nextToken?: string | undefined;
|
|
@@ -866,17 +859,17 @@ export interface ListStorageProfilesForQueueResponse {
|
|
|
866
859
|
*/
|
|
867
860
|
export interface UpdateQueueRequest {
|
|
868
861
|
/**
|
|
869
|
-
*
|
|
862
|
+
* The farm ID to update in the queue.
|
|
870
863
|
* @public
|
|
871
864
|
*/
|
|
872
865
|
farmId: string | undefined;
|
|
873
866
|
/**
|
|
874
|
-
*
|
|
867
|
+
* The queue ID to update.
|
|
875
868
|
* @public
|
|
876
869
|
*/
|
|
877
870
|
queueId: string | undefined;
|
|
878
871
|
/**
|
|
879
|
-
*
|
|
872
|
+
* The idempotency token to update in the queue.
|
|
880
873
|
* @public
|
|
881
874
|
*/
|
|
882
875
|
clientToken?: string | undefined;
|
|
@@ -891,47 +884,52 @@ export interface UpdateQueueRequest {
|
|
|
891
884
|
*/
|
|
892
885
|
description?: string | undefined;
|
|
893
886
|
/**
|
|
894
|
-
*
|
|
887
|
+
* The default action to take for a queue update if a budget isn't configured.
|
|
895
888
|
* @public
|
|
896
889
|
*/
|
|
897
890
|
defaultBudgetAction?: DefaultQueueBudgetAction | undefined;
|
|
898
891
|
/**
|
|
899
|
-
*
|
|
892
|
+
* The job attachment settings to update for the queue.
|
|
900
893
|
* @public
|
|
901
894
|
*/
|
|
902
895
|
jobAttachmentSettings?: JobAttachmentSettings | undefined;
|
|
903
896
|
/**
|
|
904
|
-
*
|
|
897
|
+
* The IAM role ARN that's used to run jobs from this queue.
|
|
905
898
|
* @public
|
|
906
899
|
*/
|
|
907
900
|
roleArn?: string | undefined;
|
|
908
901
|
/**
|
|
909
|
-
*
|
|
902
|
+
* Update the jobs in the queue to run as a specified POSIX user.
|
|
910
903
|
* @public
|
|
911
904
|
*/
|
|
912
905
|
jobRunAsUser?: JobRunAsUser | undefined;
|
|
913
906
|
/**
|
|
914
|
-
*
|
|
907
|
+
* The required file system location names to add to the queue.
|
|
915
908
|
* @public
|
|
916
909
|
*/
|
|
917
910
|
requiredFileSystemLocationNamesToAdd?: string[] | undefined;
|
|
918
911
|
/**
|
|
919
|
-
*
|
|
912
|
+
* The required file system location names to remove from the queue.
|
|
920
913
|
* @public
|
|
921
914
|
*/
|
|
922
915
|
requiredFileSystemLocationNamesToRemove?: string[] | undefined;
|
|
923
916
|
/**
|
|
924
|
-
*
|
|
917
|
+
* The storage profile IDs to add.
|
|
925
918
|
* @public
|
|
926
919
|
*/
|
|
927
920
|
allowedStorageProfileIdsToAdd?: string[] | undefined;
|
|
928
921
|
/**
|
|
929
|
-
*
|
|
922
|
+
* The storage profile ID to remove.
|
|
930
923
|
* @public
|
|
931
924
|
*/
|
|
932
925
|
allowedStorageProfileIdsToRemove?: string[] | undefined;
|
|
933
926
|
/**
|
|
934
|
-
*
|
|
927
|
+
* The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.
|
|
928
|
+
*
|
|
929
|
+
* When updating the scheduling configuration, the entire configuration is replaced.
|
|
930
|
+
*
|
|
931
|
+
* In-progress tasks run to completion before the new scheduling configuration takes effect.
|
|
932
|
+
*
|
|
935
933
|
* @public
|
|
936
934
|
*/
|
|
937
935
|
schedulingConfiguration?: SchedulingConfiguration | undefined;
|
|
@@ -946,37 +944,37 @@ export interface UpdateQueueResponse {
|
|
|
946
944
|
*/
|
|
947
945
|
export interface UpdateQueueEnvironmentRequest {
|
|
948
946
|
/**
|
|
949
|
-
*
|
|
947
|
+
* The farm ID of the queue environment to update.
|
|
950
948
|
* @public
|
|
951
949
|
*/
|
|
952
950
|
farmId: string | undefined;
|
|
953
951
|
/**
|
|
954
|
-
*
|
|
952
|
+
* The queue ID of the queue environment to update.
|
|
955
953
|
* @public
|
|
956
954
|
*/
|
|
957
955
|
queueId: string | undefined;
|
|
958
956
|
/**
|
|
959
|
-
*
|
|
957
|
+
* The queue environment ID to update.
|
|
960
958
|
* @public
|
|
961
959
|
*/
|
|
962
960
|
queueEnvironmentId: string | undefined;
|
|
963
961
|
/**
|
|
964
|
-
*
|
|
962
|
+
* The unique token which the server uses to recognize retries of the same request.
|
|
965
963
|
* @public
|
|
966
964
|
*/
|
|
967
965
|
clientToken?: string | undefined;
|
|
968
966
|
/**
|
|
969
|
-
*
|
|
967
|
+
* The priority to update.
|
|
970
968
|
* @public
|
|
971
969
|
*/
|
|
972
970
|
priority?: number | undefined;
|
|
973
971
|
/**
|
|
974
|
-
*
|
|
972
|
+
* The template type to update.
|
|
975
973
|
* @public
|
|
976
974
|
*/
|
|
977
975
|
templateType?: EnvironmentTemplateType | undefined;
|
|
978
976
|
/**
|
|
979
|
-
*
|
|
977
|
+
* The template to update.
|
|
980
978
|
* @public
|
|
981
979
|
*/
|
|
982
980
|
template?: string | undefined;
|
|
@@ -991,7 +989,7 @@ export interface UpdateQueueEnvironmentResponse {
|
|
|
991
989
|
*/
|
|
992
990
|
export interface UpdateFarmRequest {
|
|
993
991
|
/**
|
|
994
|
-
*
|
|
992
|
+
* The farm ID to update.
|
|
995
993
|
* @public
|
|
996
994
|
*/
|
|
997
995
|
farmId: string | undefined;
|
|
@@ -1006,7 +1004,7 @@ export interface UpdateFarmRequest {
|
|
|
1006
1004
|
*/
|
|
1007
1005
|
description?: string | undefined;
|
|
1008
1006
|
/**
|
|
1009
|
-
*
|
|
1007
|
+
* 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.
|
|
1010
1008
|
* @public
|
|
1011
1009
|
*/
|
|
1012
1010
|
costScaleFactor?: number | undefined;
|
|
@@ -1021,12 +1019,12 @@ export interface UpdateFarmResponse {
|
|
|
1021
1019
|
*/
|
|
1022
1020
|
export interface UpdateLimitRequest {
|
|
1023
1021
|
/**
|
|
1024
|
-
*
|
|
1022
|
+
* The unique identifier of the farm that contains the limit.
|
|
1025
1023
|
* @public
|
|
1026
1024
|
*/
|
|
1027
1025
|
farmId: string | undefined;
|
|
1028
1026
|
/**
|
|
1029
|
-
*
|
|
1027
|
+
* The unique identifier of the limit to update.
|
|
1030
1028
|
* @public
|
|
1031
1029
|
*/
|
|
1032
1030
|
limitId: string | undefined;
|
|
@@ -1041,7 +1039,12 @@ export interface UpdateLimitRequest {
|
|
|
1041
1039
|
*/
|
|
1042
1040
|
description?: string | undefined;
|
|
1043
1041
|
/**
|
|
1044
|
-
*
|
|
1042
|
+
* 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.
|
|
1043
|
+
*
|
|
1044
|
+
* 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.
|
|
1045
|
+
*
|
|
1046
|
+
* 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.
|
|
1047
|
+
*
|
|
1045
1048
|
* @public
|
|
1046
1049
|
*/
|
|
1047
1050
|
maxCount?: number | undefined;
|
|
@@ -1056,17 +1059,17 @@ export interface UpdateLimitResponse {
|
|
|
1056
1059
|
*/
|
|
1057
1060
|
export interface UpdateStorageProfileRequest {
|
|
1058
1061
|
/**
|
|
1059
|
-
*
|
|
1062
|
+
* The farm ID to update.
|
|
1060
1063
|
* @public
|
|
1061
1064
|
*/
|
|
1062
1065
|
farmId: string | undefined;
|
|
1063
1066
|
/**
|
|
1064
|
-
*
|
|
1067
|
+
* The storage profile ID to update.
|
|
1065
1068
|
* @public
|
|
1066
1069
|
*/
|
|
1067
1070
|
storageProfileId: string | undefined;
|
|
1068
1071
|
/**
|
|
1069
|
-
*
|
|
1072
|
+
* The unique token which the server uses to recognize retries of the same request.
|
|
1070
1073
|
* @public
|
|
1071
1074
|
*/
|
|
1072
1075
|
clientToken?: string | undefined;
|
|
@@ -1076,17 +1079,17 @@ export interface UpdateStorageProfileRequest {
|
|
|
1076
1079
|
*/
|
|
1077
1080
|
displayName?: string | undefined;
|
|
1078
1081
|
/**
|
|
1079
|
-
*
|
|
1082
|
+
* The OS system to update.
|
|
1080
1083
|
* @public
|
|
1081
1084
|
*/
|
|
1082
1085
|
osFamily?: StorageProfileOperatingSystemFamily | undefined;
|
|
1083
1086
|
/**
|
|
1084
|
-
*
|
|
1087
|
+
* The file system location names to add.
|
|
1085
1088
|
* @public
|
|
1086
1089
|
*/
|
|
1087
1090
|
fileSystemLocationsToAdd?: FileSystemLocation[] | undefined;
|
|
1088
1091
|
/**
|
|
1089
|
-
*
|
|
1092
|
+
* The file system location names to remove.
|
|
1090
1093
|
* @public
|
|
1091
1094
|
*/
|
|
1092
1095
|
fileSystemLocationsToRemove?: FileSystemLocation[] | undefined;
|
|
@@ -1097,64 +1100,61 @@ export interface UpdateStorageProfileRequest {
|
|
|
1097
1100
|
export interface UpdateStorageProfileResponse {
|
|
1098
1101
|
}
|
|
1099
1102
|
/**
|
|
1100
|
-
* Identifier mixin for queue-fleet association operations.
|
|
1101
|
-
* Composes QueueIdentifierMixin (farmId + queueId) and adds fleetId.
|
|
1102
1103
|
* @public
|
|
1103
1104
|
*/
|
|
1104
1105
|
export interface GetQueueFleetAssociationRequest {
|
|
1105
1106
|
/**
|
|
1106
|
-
*
|
|
1107
|
+
* The farm ID of the farm that contains the queue-fleet association.
|
|
1107
1108
|
* @public
|
|
1108
1109
|
*/
|
|
1109
1110
|
farmId: string | undefined;
|
|
1110
1111
|
/**
|
|
1111
|
-
*
|
|
1112
|
+
* The queue ID for the queue-fleet association.
|
|
1112
1113
|
* @public
|
|
1113
1114
|
*/
|
|
1114
1115
|
queueId: string | undefined;
|
|
1115
1116
|
/**
|
|
1116
|
-
*
|
|
1117
|
+
* The fleet ID for the queue-fleet association.
|
|
1117
1118
|
* @public
|
|
1118
1119
|
*/
|
|
1119
1120
|
fleetId: string | undefined;
|
|
1120
1121
|
}
|
|
1121
1122
|
/**
|
|
1122
|
-
* Domain fields for QueueFleetAssociation summary/response shapes, ordered before timestamps.
|
|
1123
1123
|
* @public
|
|
1124
1124
|
*/
|
|
1125
1125
|
export interface GetQueueFleetAssociationResponse {
|
|
1126
1126
|
/**
|
|
1127
|
-
*
|
|
1127
|
+
* The queue ID for the queue-fleet association.
|
|
1128
1128
|
* @public
|
|
1129
1129
|
*/
|
|
1130
1130
|
queueId: string | undefined;
|
|
1131
1131
|
/**
|
|
1132
|
-
*
|
|
1132
|
+
* The fleet ID for the queue-fleet association.
|
|
1133
1133
|
* @public
|
|
1134
1134
|
*/
|
|
1135
1135
|
fleetId: string | undefined;
|
|
1136
1136
|
/**
|
|
1137
|
-
*
|
|
1137
|
+
* The status of the queue-fleet association.
|
|
1138
1138
|
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
status: QueueFleetAssociationStatus | undefined;
|
|
1141
1141
|
/**
|
|
1142
|
-
*
|
|
1142
|
+
* The date and time the resource was created.
|
|
1143
1143
|
* @public
|
|
1144
1144
|
*/
|
|
1145
1145
|
createdAt: Date | undefined;
|
|
1146
1146
|
/**
|
|
1147
|
-
*
|
|
1147
|
+
* The user or system that created this resource.
|
|
1148
1148
|
* @public
|
|
1149
1149
|
*/
|
|
1150
1150
|
createdBy: string | undefined;
|
|
1151
1151
|
/**
|
|
1152
|
-
*
|
|
1152
|
+
* The date and time the resource was updated.
|
|
1153
1153
|
* @public
|
|
1154
1154
|
*/
|
|
1155
1155
|
updatedAt?: Date | undefined;
|
|
1156
1156
|
/**
|
|
1157
|
-
*
|
|
1157
|
+
* The user or system that updated this resource.
|
|
1158
1158
|
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
updatedBy?: string | undefined;
|
|
@@ -1164,207 +1164,207 @@ export interface GetQueueFleetAssociationResponse {
|
|
|
1164
1164
|
*/
|
|
1165
1165
|
export interface GetQueueLimitAssociationRequest {
|
|
1166
1166
|
/**
|
|
1167
|
-
*
|
|
1167
|
+
* The unique identifier of the farm that contains the associated queue and limit.
|
|
1168
1168
|
* @public
|
|
1169
1169
|
*/
|
|
1170
1170
|
farmId: string | undefined;
|
|
1171
1171
|
/**
|
|
1172
|
-
*
|
|
1172
|
+
* The unique identifier of the queue associated with the limit.
|
|
1173
1173
|
* @public
|
|
1174
1174
|
*/
|
|
1175
1175
|
queueId: string | undefined;
|
|
1176
1176
|
/**
|
|
1177
|
-
*
|
|
1177
|
+
* The unique identifier of the limit associated with the queue.
|
|
1178
1178
|
* @public
|
|
1179
1179
|
*/
|
|
1180
1180
|
limitId: string | undefined;
|
|
1181
1181
|
}
|
|
1182
1182
|
/**
|
|
1183
|
-
* Domain fields for QueueLimitAssociation summary/response shapes, ordered before timestamps.
|
|
1184
1183
|
* @public
|
|
1185
1184
|
*/
|
|
1186
1185
|
export interface GetQueueLimitAssociationResponse {
|
|
1187
1186
|
/**
|
|
1188
|
-
*
|
|
1187
|
+
* The unique identifier of the queue associated with the limit.
|
|
1189
1188
|
* @public
|
|
1190
1189
|
*/
|
|
1191
1190
|
queueId: string | undefined;
|
|
1192
1191
|
/**
|
|
1193
|
-
*
|
|
1192
|
+
* The unique identifier of the limit associated with the queue.
|
|
1194
1193
|
* @public
|
|
1195
1194
|
*/
|
|
1196
1195
|
limitId: string | undefined;
|
|
1197
1196
|
/**
|
|
1198
|
-
*
|
|
1197
|
+
* The current status of the limit.
|
|
1199
1198
|
* @public
|
|
1200
1199
|
*/
|
|
1201
1200
|
status: QueueLimitAssociationStatus | undefined;
|
|
1202
1201
|
/**
|
|
1203
|
-
*
|
|
1202
|
+
* The Unix timestamp of the date and time that the association was created.
|
|
1204
1203
|
* @public
|
|
1205
1204
|
*/
|
|
1206
1205
|
createdAt: Date | undefined;
|
|
1207
1206
|
/**
|
|
1208
|
-
*
|
|
1207
|
+
* The user identifier of the person that created the association.
|
|
1209
1208
|
* @public
|
|
1210
1209
|
*/
|
|
1211
1210
|
createdBy: string | undefined;
|
|
1212
1211
|
/**
|
|
1213
|
-
*
|
|
1212
|
+
* The Unix timestamp of the date and time that the association was last updated.
|
|
1214
1213
|
* @public
|
|
1215
1214
|
*/
|
|
1216
1215
|
updatedAt?: Date | undefined;
|
|
1217
1216
|
/**
|
|
1218
|
-
*
|
|
1217
|
+
* The user identifier of the person that last updated the association.
|
|
1219
1218
|
* @public
|
|
1220
1219
|
*/
|
|
1221
1220
|
updatedBy?: string | undefined;
|
|
1222
1221
|
}
|
|
1223
1222
|
/**
|
|
1224
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
1225
1223
|
* @public
|
|
1226
1224
|
*/
|
|
1227
1225
|
export interface GetSessionsStatisticsAggregationRequest {
|
|
1228
1226
|
/**
|
|
1229
|
-
*
|
|
1227
|
+
* 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.
|
|
1230
1228
|
* @public
|
|
1231
1229
|
*/
|
|
1232
1230
|
farmId: string | undefined;
|
|
1233
1231
|
/**
|
|
1234
|
-
*
|
|
1232
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
1235
1233
|
* @public
|
|
1236
1234
|
*/
|
|
1237
1235
|
nextToken?: string | undefined;
|
|
1238
1236
|
/**
|
|
1239
|
-
*
|
|
1237
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
1240
1238
|
* @public
|
|
1241
1239
|
*/
|
|
1242
1240
|
maxResults?: number | undefined;
|
|
1243
1241
|
/**
|
|
1244
|
-
*
|
|
1242
|
+
* The identifier returned by the <code>StartSessionsStatisticsAggregation</code> operation that identifies the aggregated statistics.
|
|
1245
1243
|
* @public
|
|
1246
1244
|
*/
|
|
1247
1245
|
aggregationId: string | undefined;
|
|
1248
1246
|
}
|
|
1249
1247
|
/**
|
|
1250
|
-
*
|
|
1248
|
+
* The minimum, maximum, average, and sum.
|
|
1251
1249
|
* @public
|
|
1252
1250
|
*/
|
|
1253
1251
|
export interface Stats {
|
|
1254
1252
|
/**
|
|
1255
|
-
*
|
|
1253
|
+
* The minimum of the usage statistics.
|
|
1256
1254
|
* @public
|
|
1257
1255
|
*/
|
|
1258
1256
|
min?: number | undefined;
|
|
1259
1257
|
/**
|
|
1260
|
-
*
|
|
1258
|
+
* The maximum among the usage statistics.
|
|
1261
1259
|
* @public
|
|
1262
1260
|
*/
|
|
1263
1261
|
max?: number | undefined;
|
|
1264
1262
|
/**
|
|
1265
|
-
*
|
|
1263
|
+
* The average of the usage statistics.
|
|
1266
1264
|
* @public
|
|
1267
1265
|
*/
|
|
1268
1266
|
avg?: number | undefined;
|
|
1269
1267
|
/**
|
|
1270
|
-
*
|
|
1268
|
+
* The sum of the usage statistics.
|
|
1271
1269
|
* @public
|
|
1272
1270
|
*/
|
|
1273
1271
|
sum?: number | undefined;
|
|
1274
1272
|
}
|
|
1275
1273
|
/**
|
|
1276
|
-
*
|
|
1274
|
+
* A list of statistics for a session.
|
|
1277
1275
|
* @public
|
|
1278
1276
|
*/
|
|
1279
1277
|
export interface Statistics {
|
|
1280
1278
|
/**
|
|
1281
|
-
*
|
|
1279
|
+
* The queue ID.
|
|
1282
1280
|
* @public
|
|
1283
1281
|
*/
|
|
1284
1282
|
queueId?: string | undefined;
|
|
1285
1283
|
/**
|
|
1286
|
-
*
|
|
1284
|
+
* The fleet ID.
|
|
1287
1285
|
* @public
|
|
1288
1286
|
*/
|
|
1289
1287
|
fleetId?: string | undefined;
|
|
1290
1288
|
/**
|
|
1291
|
-
*
|
|
1289
|
+
* The job ID.
|
|
1292
1290
|
* @public
|
|
1293
1291
|
*/
|
|
1294
1292
|
jobId?: string | undefined;
|
|
1295
1293
|
/**
|
|
1296
|
-
*
|
|
1294
|
+
* The job name.
|
|
1297
1295
|
* @public
|
|
1298
1296
|
*/
|
|
1299
1297
|
jobName?: string | undefined;
|
|
1300
1298
|
/**
|
|
1301
|
-
*
|
|
1299
|
+
* The user ID.
|
|
1302
1300
|
* @public
|
|
1303
1301
|
*/
|
|
1304
1302
|
userId?: string | undefined;
|
|
1305
1303
|
/**
|
|
1306
|
-
*
|
|
1304
|
+
* The type of usage for the statistics.
|
|
1307
1305
|
* @public
|
|
1308
1306
|
*/
|
|
1309
1307
|
usageType?: UsageType | undefined;
|
|
1310
1308
|
/**
|
|
1311
|
-
*
|
|
1309
|
+
* The licensed product.
|
|
1312
1310
|
* @public
|
|
1313
1311
|
*/
|
|
1314
1312
|
licenseProduct?: string | undefined;
|
|
1315
1313
|
/**
|
|
1316
|
-
*
|
|
1314
|
+
* The type of instance.
|
|
1317
1315
|
* @public
|
|
1318
1316
|
*/
|
|
1319
1317
|
instanceType?: string | undefined;
|
|
1320
1318
|
/**
|
|
1321
|
-
*
|
|
1319
|
+
* The number of instances in a list of statistics.
|
|
1322
1320
|
* @public
|
|
1323
1321
|
*/
|
|
1324
1322
|
count: number | undefined;
|
|
1325
1323
|
/**
|
|
1326
|
-
*
|
|
1324
|
+
* How the statistics should appear in USD. Options include: minimum, maximum, average or sum.
|
|
1327
1325
|
* @public
|
|
1328
1326
|
*/
|
|
1329
1327
|
costInUsd: Stats | undefined;
|
|
1330
1328
|
/**
|
|
1331
|
-
*
|
|
1329
|
+
* The total aggregated runtime.
|
|
1332
1330
|
* @public
|
|
1333
1331
|
*/
|
|
1334
1332
|
runtimeInSeconds: Stats | undefined;
|
|
1335
1333
|
/**
|
|
1336
|
-
*
|
|
1334
|
+
* The start time for the aggregation.
|
|
1337
1335
|
* @public
|
|
1338
1336
|
*/
|
|
1339
1337
|
aggregationStartTime?: Date | undefined;
|
|
1340
1338
|
/**
|
|
1341
|
-
*
|
|
1339
|
+
* The end time for the aggregation.
|
|
1342
1340
|
* @public
|
|
1343
1341
|
*/
|
|
1344
1342
|
aggregationEndTime?: Date | undefined;
|
|
1345
1343
|
}
|
|
1346
1344
|
/**
|
|
1347
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
1348
1345
|
* @public
|
|
1349
1346
|
*/
|
|
1350
1347
|
export interface GetSessionsStatisticsAggregationResponse {
|
|
1351
1348
|
/**
|
|
1352
|
-
*
|
|
1349
|
+
* The statistics for the specified fleets or queues.
|
|
1353
1350
|
* @public
|
|
1354
1351
|
*/
|
|
1355
1352
|
statistics?: Statistics[] | undefined;
|
|
1356
1353
|
/**
|
|
1357
|
-
*
|
|
1354
|
+
* The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the <code>StartSessionsStatisticsAggregation</code> operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.
|
|
1355
|
+
*
|
|
1356
|
+
* If you call the <code>StartSessionsStatisticsAggregation </code> operation when the status is <code>IN_PROGRESS</code>, you will receive a <code>ThrottlingException</code>.
|
|
1357
|
+
*
|
|
1358
1358
|
* @public
|
|
1359
1359
|
*/
|
|
1360
1360
|
status: SessionsStatisticsAggregationStatus | undefined;
|
|
1361
1361
|
/**
|
|
1362
|
-
*
|
|
1362
|
+
* A message that describes the status.
|
|
1363
1363
|
* @public
|
|
1364
1364
|
*/
|
|
1365
1365
|
statusMessage?: string | undefined;
|
|
1366
1366
|
/**
|
|
1367
|
-
*
|
|
1367
|
+
* 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.
|
|
1368
1368
|
* @public
|
|
1369
1369
|
*/
|
|
1370
1370
|
nextToken?: string | undefined;
|
|
@@ -1374,7 +1374,7 @@ export interface GetSessionsStatisticsAggregationResponse {
|
|
|
1374
1374
|
*/
|
|
1375
1375
|
export interface DeleteLicenseEndpointRequest {
|
|
1376
1376
|
/**
|
|
1377
|
-
*
|
|
1377
|
+
* The license endpoint ID of the license endpoint to delete.
|
|
1378
1378
|
* @public
|
|
1379
1379
|
*/
|
|
1380
1380
|
licenseEndpointId: string | undefined;
|
|
@@ -1389,12 +1389,12 @@ export interface DeleteLicenseEndpointResponse {
|
|
|
1389
1389
|
*/
|
|
1390
1390
|
export interface DeleteMeteredProductRequest {
|
|
1391
1391
|
/**
|
|
1392
|
-
*
|
|
1392
|
+
* The ID of the license endpoint from which to remove the metered product.
|
|
1393
1393
|
* @public
|
|
1394
1394
|
*/
|
|
1395
1395
|
licenseEndpointId: string | undefined;
|
|
1396
1396
|
/**
|
|
1397
|
-
*
|
|
1397
|
+
* The product ID to remove from the license endpoint.
|
|
1398
1398
|
* @public
|
|
1399
1399
|
*/
|
|
1400
1400
|
productId: string | undefined;
|
|
@@ -1409,170 +1409,164 @@ export interface DeleteMeteredProductResponse {
|
|
|
1409
1409
|
*/
|
|
1410
1410
|
export interface GetLicenseEndpointRequest {
|
|
1411
1411
|
/**
|
|
1412
|
-
*
|
|
1412
|
+
* The license endpoint ID.
|
|
1413
1413
|
* @public
|
|
1414
1414
|
*/
|
|
1415
1415
|
licenseEndpointId: string | undefined;
|
|
1416
1416
|
}
|
|
1417
1417
|
/**
|
|
1418
|
-
* Mixin that adds an optional ARN field to response structures.
|
|
1419
|
-
* Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.
|
|
1420
1418
|
* @public
|
|
1421
1419
|
*/
|
|
1422
1420
|
export interface GetLicenseEndpointResponse {
|
|
1423
1421
|
/**
|
|
1424
|
-
*
|
|
1422
|
+
* The license endpoint ID.
|
|
1425
1423
|
* @public
|
|
1426
1424
|
*/
|
|
1427
1425
|
licenseEndpointId: string | undefined;
|
|
1428
1426
|
/**
|
|
1429
|
-
*
|
|
1427
|
+
* The status of the license endpoint.
|
|
1430
1428
|
* @public
|
|
1431
1429
|
*/
|
|
1432
1430
|
status: LicenseEndpointStatus | undefined;
|
|
1433
1431
|
/**
|
|
1434
|
-
*
|
|
1432
|
+
* The status message of the license endpoint.
|
|
1435
1433
|
* @public
|
|
1436
1434
|
*/
|
|
1437
1435
|
statusMessage: string | undefined;
|
|
1438
1436
|
/**
|
|
1439
|
-
*
|
|
1437
|
+
* The VPC (virtual private cloud) ID associated with the license endpoint.
|
|
1440
1438
|
* @public
|
|
1441
1439
|
*/
|
|
1442
1440
|
vpcId?: string | undefined;
|
|
1443
1441
|
/**
|
|
1444
|
-
*
|
|
1442
|
+
* The DNS name.
|
|
1445
1443
|
* @public
|
|
1446
1444
|
*/
|
|
1447
1445
|
dnsName?: string | undefined;
|
|
1448
1446
|
/**
|
|
1449
|
-
*
|
|
1447
|
+
* The subnet IDs.
|
|
1450
1448
|
* @public
|
|
1451
1449
|
*/
|
|
1452
1450
|
subnetIds?: string[] | undefined;
|
|
1453
1451
|
/**
|
|
1454
|
-
*
|
|
1452
|
+
* The security group IDs for the license endpoint.
|
|
1455
1453
|
* @public
|
|
1456
1454
|
*/
|
|
1457
1455
|
securityGroupIds?: string[] | undefined;
|
|
1458
1456
|
}
|
|
1459
1457
|
/**
|
|
1460
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
1461
1458
|
* @public
|
|
1462
1459
|
*/
|
|
1463
1460
|
export interface ListLicenseEndpointsRequest {
|
|
1464
1461
|
/**
|
|
1465
|
-
*
|
|
1462
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
1466
1463
|
* @public
|
|
1467
1464
|
*/
|
|
1468
1465
|
nextToken?: string | undefined;
|
|
1469
1466
|
/**
|
|
1470
|
-
*
|
|
1467
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
1471
1468
|
* @public
|
|
1472
1469
|
*/
|
|
1473
1470
|
maxResults?: number | undefined;
|
|
1474
1471
|
}
|
|
1475
1472
|
/**
|
|
1476
|
-
*
|
|
1473
|
+
* The details for a license endpoint.
|
|
1477
1474
|
* @public
|
|
1478
1475
|
*/
|
|
1479
1476
|
export interface LicenseEndpointSummary {
|
|
1480
1477
|
/**
|
|
1481
|
-
*
|
|
1478
|
+
* The license endpoint ID.
|
|
1482
1479
|
* @public
|
|
1483
1480
|
*/
|
|
1484
1481
|
licenseEndpointId?: string | undefined;
|
|
1485
1482
|
/**
|
|
1486
|
-
*
|
|
1483
|
+
* The status of the license endpoint.
|
|
1487
1484
|
* @public
|
|
1488
1485
|
*/
|
|
1489
1486
|
status?: LicenseEndpointStatus | undefined;
|
|
1490
1487
|
/**
|
|
1491
|
-
*
|
|
1488
|
+
* The status message of the license endpoint.
|
|
1492
1489
|
* @public
|
|
1493
1490
|
*/
|
|
1494
1491
|
statusMessage?: string | undefined;
|
|
1495
1492
|
/**
|
|
1496
|
-
*
|
|
1493
|
+
* The VPC (virtual private cloud) ID associated with the license endpoint.
|
|
1497
1494
|
* @public
|
|
1498
1495
|
*/
|
|
1499
1496
|
vpcId?: string | undefined;
|
|
1500
1497
|
}
|
|
1501
1498
|
/**
|
|
1502
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
1503
1499
|
* @public
|
|
1504
1500
|
*/
|
|
1505
1501
|
export interface ListLicenseEndpointsResponse {
|
|
1506
1502
|
/**
|
|
1507
|
-
*
|
|
1503
|
+
* The license endpoints.
|
|
1508
1504
|
* @public
|
|
1509
1505
|
*/
|
|
1510
1506
|
licenseEndpoints: LicenseEndpointSummary[] | undefined;
|
|
1511
1507
|
/**
|
|
1512
|
-
*
|
|
1508
|
+
* 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.
|
|
1513
1509
|
* @public
|
|
1514
1510
|
*/
|
|
1515
1511
|
nextToken?: string | undefined;
|
|
1516
1512
|
}
|
|
1517
1513
|
/**
|
|
1518
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
1519
1514
|
* @public
|
|
1520
1515
|
*/
|
|
1521
1516
|
export interface ListMeteredProductsRequest {
|
|
1522
1517
|
/**
|
|
1523
|
-
*
|
|
1518
|
+
* The license endpoint ID to include on the list of metered products.
|
|
1524
1519
|
* @public
|
|
1525
1520
|
*/
|
|
1526
1521
|
licenseEndpointId: string | undefined;
|
|
1527
1522
|
/**
|
|
1528
|
-
*
|
|
1523
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
1529
1524
|
* @public
|
|
1530
1525
|
*/
|
|
1531
1526
|
nextToken?: string | undefined;
|
|
1532
1527
|
/**
|
|
1533
|
-
*
|
|
1528
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
1534
1529
|
* @public
|
|
1535
1530
|
*/
|
|
1536
1531
|
maxResults?: number | undefined;
|
|
1537
1532
|
}
|
|
1538
1533
|
/**
|
|
1539
|
-
*
|
|
1534
|
+
* The details of a metered product.
|
|
1540
1535
|
* @public
|
|
1541
1536
|
*/
|
|
1542
1537
|
export interface MeteredProductSummary {
|
|
1543
1538
|
/**
|
|
1544
|
-
*
|
|
1539
|
+
* The product ID.
|
|
1545
1540
|
* @public
|
|
1546
1541
|
*/
|
|
1547
1542
|
productId: string | undefined;
|
|
1548
1543
|
/**
|
|
1549
|
-
*
|
|
1544
|
+
* The family to which the metered product belongs.
|
|
1550
1545
|
* @public
|
|
1551
1546
|
*/
|
|
1552
1547
|
family: string | undefined;
|
|
1553
1548
|
/**
|
|
1554
|
-
*
|
|
1549
|
+
* The vendor.
|
|
1555
1550
|
* @public
|
|
1556
1551
|
*/
|
|
1557
1552
|
vendor: string | undefined;
|
|
1558
1553
|
/**
|
|
1559
|
-
*
|
|
1554
|
+
* The port on which the metered product should run.
|
|
1560
1555
|
* @public
|
|
1561
1556
|
*/
|
|
1562
1557
|
port: number | undefined;
|
|
1563
1558
|
}
|
|
1564
1559
|
/**
|
|
1565
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
1566
1560
|
* @public
|
|
1567
1561
|
*/
|
|
1568
1562
|
export interface ListMeteredProductsResponse {
|
|
1569
1563
|
/**
|
|
1570
|
-
*
|
|
1564
|
+
* The metered products to list.
|
|
1571
1565
|
* @public
|
|
1572
1566
|
*/
|
|
1573
1567
|
meteredProducts: MeteredProductSummary[] | undefined;
|
|
1574
1568
|
/**
|
|
1575
|
-
*
|
|
1569
|
+
* 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.
|
|
1576
1570
|
* @public
|
|
1577
1571
|
*/
|
|
1578
1572
|
nextToken?: string | undefined;
|
|
@@ -1582,12 +1576,12 @@ export interface ListMeteredProductsResponse {
|
|
|
1582
1576
|
*/
|
|
1583
1577
|
export interface PutMeteredProductRequest {
|
|
1584
1578
|
/**
|
|
1585
|
-
*
|
|
1579
|
+
* The license endpoint ID to add to the metered product.
|
|
1586
1580
|
* @public
|
|
1587
1581
|
*/
|
|
1588
1582
|
licenseEndpointId: string | undefined;
|
|
1589
1583
|
/**
|
|
1590
|
-
*
|
|
1584
|
+
* The product ID to add to the metered product.
|
|
1591
1585
|
* @public
|
|
1592
1586
|
*/
|
|
1593
1587
|
productId: string | undefined;
|
|
@@ -1598,75 +1592,72 @@ export interface PutMeteredProductRequest {
|
|
|
1598
1592
|
export interface PutMeteredProductResponse {
|
|
1599
1593
|
}
|
|
1600
1594
|
/**
|
|
1601
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
1602
1595
|
* @public
|
|
1603
1596
|
*/
|
|
1604
1597
|
export interface ListAvailableMeteredProductsRequest {
|
|
1605
1598
|
/**
|
|
1606
|
-
*
|
|
1599
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
1607
1600
|
* @public
|
|
1608
1601
|
*/
|
|
1609
1602
|
nextToken?: string | undefined;
|
|
1610
1603
|
/**
|
|
1611
|
-
*
|
|
1604
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
1612
1605
|
* @public
|
|
1613
1606
|
*/
|
|
1614
1607
|
maxResults?: number | undefined;
|
|
1615
1608
|
}
|
|
1616
1609
|
/**
|
|
1617
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
1618
1610
|
* @public
|
|
1619
1611
|
*/
|
|
1620
1612
|
export interface ListAvailableMeteredProductsResponse {
|
|
1621
1613
|
/**
|
|
1622
|
-
*
|
|
1614
|
+
* The metered products.
|
|
1623
1615
|
* @public
|
|
1624
1616
|
*/
|
|
1625
1617
|
meteredProducts: MeteredProductSummary[] | undefined;
|
|
1626
1618
|
/**
|
|
1627
|
-
*
|
|
1619
|
+
* 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.
|
|
1628
1620
|
* @public
|
|
1629
1621
|
*/
|
|
1630
1622
|
nextToken?: string | undefined;
|
|
1631
1623
|
}
|
|
1632
1624
|
/**
|
|
1633
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
1634
1625
|
* @public
|
|
1635
1626
|
*/
|
|
1636
1627
|
export interface ListMembershipsRequest {
|
|
1637
1628
|
/**
|
|
1638
|
-
*
|
|
1629
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
1639
1630
|
* @public
|
|
1640
1631
|
*/
|
|
1641
1632
|
nextToken?: string | undefined;
|
|
1642
1633
|
/**
|
|
1643
|
-
*
|
|
1634
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
1644
1635
|
* @public
|
|
1645
1636
|
*/
|
|
1646
1637
|
maxResults?: number | undefined;
|
|
1647
1638
|
/**
|
|
1648
|
-
*
|
|
1639
|
+
* The ID of the IAM Identity Center principal whose Deadline Cloud resource memberships you want to list.
|
|
1649
1640
|
* @public
|
|
1650
1641
|
*/
|
|
1651
1642
|
principalId: string | undefined;
|
|
1652
1643
|
/**
|
|
1653
|
-
*
|
|
1644
|
+
* The identity store ID that contains the principal. This parameter is required for callers that do not use a monitor session.
|
|
1654
1645
|
* @public
|
|
1655
1646
|
*/
|
|
1656
1647
|
identityStoreId?: string | undefined;
|
|
1657
1648
|
/**
|
|
1658
|
-
*
|
|
1649
|
+
* The Region of the IAM Identity Center instance. If not provided, the service defaults to the Amazon Web Services Region in which you make the request.
|
|
1659
1650
|
* @public
|
|
1660
1651
|
*/
|
|
1661
1652
|
identityCenterRegion?: string | undefined;
|
|
1662
1653
|
/**
|
|
1663
|
-
*
|
|
1654
|
+
* The resource types to include when listing the principal's memberships. If not specified, memberships for all supported resource types are returned.
|
|
1664
1655
|
* @public
|
|
1665
1656
|
*/
|
|
1666
1657
|
resourceTypes?: MembershipResourceType[] | undefined;
|
|
1667
1658
|
}
|
|
1668
1659
|
/**
|
|
1669
|
-
*
|
|
1660
|
+
* A membership record for a principal on a single Deadline Cloud resource. The summary identifies the resource that the principal is a member of and the principal's membership level for that resource.
|
|
1670
1661
|
* @public
|
|
1671
1662
|
*/
|
|
1672
1663
|
export type MembershipSummary = MembershipSummary._FarmMember | MembershipSummary._FleetMember | MembershipSummary._JobMember | MembershipSummary._QueueMember | MembershipSummary.$UnknownMember;
|
|
@@ -1675,7 +1666,7 @@ export type MembershipSummary = MembershipSummary._FarmMember | MembershipSummar
|
|
|
1675
1666
|
*/
|
|
1676
1667
|
export declare namespace MembershipSummary {
|
|
1677
1668
|
/**
|
|
1678
|
-
*
|
|
1669
|
+
* A membership on a farm.
|
|
1679
1670
|
* @public
|
|
1680
1671
|
*/
|
|
1681
1672
|
interface _FarmMember {
|
|
@@ -1686,7 +1677,7 @@ export declare namespace MembershipSummary {
|
|
|
1686
1677
|
$unknown?: never;
|
|
1687
1678
|
}
|
|
1688
1679
|
/**
|
|
1689
|
-
*
|
|
1680
|
+
* A membership on a queue.
|
|
1690
1681
|
* @public
|
|
1691
1682
|
*/
|
|
1692
1683
|
interface _QueueMember {
|
|
@@ -1697,7 +1688,7 @@ export declare namespace MembershipSummary {
|
|
|
1697
1688
|
$unknown?: never;
|
|
1698
1689
|
}
|
|
1699
1690
|
/**
|
|
1700
|
-
*
|
|
1691
|
+
* A membership on a fleet.
|
|
1701
1692
|
* @public
|
|
1702
1693
|
*/
|
|
1703
1694
|
interface _FleetMember {
|
|
@@ -1708,7 +1699,7 @@ export declare namespace MembershipSummary {
|
|
|
1708
1699
|
$unknown?: never;
|
|
1709
1700
|
}
|
|
1710
1701
|
/**
|
|
1711
|
-
*
|
|
1702
|
+
* A membership on a job.
|
|
1712
1703
|
* @public
|
|
1713
1704
|
*/
|
|
1714
1705
|
interface _JobMember {
|
|
@@ -1741,64 +1732,62 @@ export declare namespace MembershipSummary {
|
|
|
1741
1732
|
}
|
|
1742
1733
|
}
|
|
1743
1734
|
/**
|
|
1744
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
1745
1735
|
* @public
|
|
1746
1736
|
*/
|
|
1747
1737
|
export interface ListMembershipsResponse {
|
|
1748
1738
|
/**
|
|
1749
|
-
*
|
|
1739
|
+
* The memberships associated with the specified principal.
|
|
1750
1740
|
* @public
|
|
1751
1741
|
*/
|
|
1752
1742
|
memberships: MembershipSummary[] | undefined;
|
|
1753
1743
|
/**
|
|
1754
|
-
*
|
|
1744
|
+
* 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.
|
|
1755
1745
|
* @public
|
|
1756
1746
|
*/
|
|
1757
1747
|
nextToken?: string | undefined;
|
|
1758
1748
|
}
|
|
1759
1749
|
/**
|
|
1760
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
1761
1750
|
* @public
|
|
1762
1751
|
*/
|
|
1763
1752
|
export interface ListQueueFleetAssociationsRequest {
|
|
1764
1753
|
/**
|
|
1765
|
-
*
|
|
1754
|
+
* The farm ID for the queue-fleet association list.
|
|
1766
1755
|
* @public
|
|
1767
1756
|
*/
|
|
1768
1757
|
farmId: string | undefined;
|
|
1769
1758
|
/**
|
|
1770
|
-
*
|
|
1759
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
1771
1760
|
* @public
|
|
1772
1761
|
*/
|
|
1773
1762
|
nextToken?: string | undefined;
|
|
1774
1763
|
/**
|
|
1775
|
-
*
|
|
1764
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
1776
1765
|
* @public
|
|
1777
1766
|
*/
|
|
1778
1767
|
maxResults?: number | undefined;
|
|
1779
1768
|
/**
|
|
1780
|
-
*
|
|
1769
|
+
* The queue ID for the queue-fleet association list.
|
|
1781
1770
|
* @public
|
|
1782
1771
|
*/
|
|
1783
1772
|
queueId?: string | undefined;
|
|
1784
1773
|
/**
|
|
1785
|
-
*
|
|
1774
|
+
* The fleet ID for the queue-fleet association list.
|
|
1786
1775
|
* @public
|
|
1787
1776
|
*/
|
|
1788
1777
|
fleetId?: string | undefined;
|
|
1789
1778
|
}
|
|
1790
1779
|
/**
|
|
1791
|
-
*
|
|
1780
|
+
* The details of a queue-fleet association.
|
|
1792
1781
|
* @public
|
|
1793
1782
|
*/
|
|
1794
1783
|
export interface QueueFleetAssociationSummary {
|
|
1795
1784
|
/**
|
|
1796
|
-
*
|
|
1785
|
+
* The queue ID.
|
|
1797
1786
|
* @public
|
|
1798
1787
|
*/
|
|
1799
1788
|
queueId: string | undefined;
|
|
1800
1789
|
/**
|
|
1801
|
-
*
|
|
1790
|
+
* The fleet ID.
|
|
1802
1791
|
* @public
|
|
1803
1792
|
*/
|
|
1804
1793
|
fleetId: string | undefined;
|
|
@@ -1808,85 +1797,83 @@ export interface QueueFleetAssociationSummary {
|
|
|
1808
1797
|
*/
|
|
1809
1798
|
status: QueueFleetAssociationStatus | undefined;
|
|
1810
1799
|
/**
|
|
1811
|
-
*
|
|
1800
|
+
* The date and time the resource was created.
|
|
1812
1801
|
* @public
|
|
1813
1802
|
*/
|
|
1814
1803
|
createdAt: Date | undefined;
|
|
1815
1804
|
/**
|
|
1816
|
-
*
|
|
1805
|
+
* The user or system that created this resource.
|
|
1817
1806
|
* @public
|
|
1818
1807
|
*/
|
|
1819
1808
|
createdBy: string | undefined;
|
|
1820
1809
|
/**
|
|
1821
|
-
*
|
|
1810
|
+
* The date and time the resource was updated.
|
|
1822
1811
|
* @public
|
|
1823
1812
|
*/
|
|
1824
1813
|
updatedAt?: Date | undefined;
|
|
1825
1814
|
/**
|
|
1826
|
-
*
|
|
1815
|
+
* The user or system that updated this resource.
|
|
1827
1816
|
* @public
|
|
1828
1817
|
*/
|
|
1829
1818
|
updatedBy?: string | undefined;
|
|
1830
1819
|
}
|
|
1831
1820
|
/**
|
|
1832
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
1833
1821
|
* @public
|
|
1834
1822
|
*/
|
|
1835
1823
|
export interface ListQueueFleetAssociationsResponse {
|
|
1836
1824
|
/**
|
|
1837
|
-
*
|
|
1825
|
+
* The queue-fleet associations on the list.
|
|
1838
1826
|
* @public
|
|
1839
1827
|
*/
|
|
1840
1828
|
queueFleetAssociations: QueueFleetAssociationSummary[] | undefined;
|
|
1841
1829
|
/**
|
|
1842
|
-
*
|
|
1830
|
+
* 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.
|
|
1843
1831
|
* @public
|
|
1844
1832
|
*/
|
|
1845
1833
|
nextToken?: string | undefined;
|
|
1846
1834
|
}
|
|
1847
1835
|
/**
|
|
1848
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
1849
1836
|
* @public
|
|
1850
1837
|
*/
|
|
1851
1838
|
export interface ListQueueLimitAssociationsRequest {
|
|
1852
1839
|
/**
|
|
1853
|
-
*
|
|
1840
|
+
* The unique identifier of the farm that contains the limits and associations.
|
|
1854
1841
|
* @public
|
|
1855
1842
|
*/
|
|
1856
1843
|
farmId: string | undefined;
|
|
1857
1844
|
/**
|
|
1858
|
-
*
|
|
1845
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
1859
1846
|
* @public
|
|
1860
1847
|
*/
|
|
1861
1848
|
nextToken?: string | undefined;
|
|
1862
1849
|
/**
|
|
1863
|
-
*
|
|
1850
|
+
* The maximum number of associations to return in each page of results.
|
|
1864
1851
|
* @public
|
|
1865
1852
|
*/
|
|
1866
1853
|
maxResults?: number | undefined;
|
|
1867
1854
|
/**
|
|
1868
|
-
*
|
|
1855
|
+
* Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the <code>queueId</code> and the <code>limitId</code>, only the specified limit is returned if it exists.
|
|
1869
1856
|
* @public
|
|
1870
1857
|
*/
|
|
1871
1858
|
queueId?: string | undefined;
|
|
1872
1859
|
/**
|
|
1873
|
-
*
|
|
1860
|
+
* Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the <code>queueId</code> and the <code>limitId</code>, only the specified limit is returned if it exists.
|
|
1874
1861
|
* @public
|
|
1875
1862
|
*/
|
|
1876
1863
|
limitId?: string | undefined;
|
|
1877
1864
|
}
|
|
1878
1865
|
/**
|
|
1879
|
-
*
|
|
1866
|
+
* Provides information about the association between a queue and a limit.
|
|
1880
1867
|
* @public
|
|
1881
1868
|
*/
|
|
1882
1869
|
export interface QueueLimitAssociationSummary {
|
|
1883
1870
|
/**
|
|
1884
|
-
*
|
|
1871
|
+
* The unique identifier of the queue in the association.
|
|
1885
1872
|
* @public
|
|
1886
1873
|
*/
|
|
1887
1874
|
queueId: string | undefined;
|
|
1888
1875
|
/**
|
|
1889
|
-
*
|
|
1876
|
+
* The unique identifier of the limit in the association.
|
|
1890
1877
|
* @public
|
|
1891
1878
|
*/
|
|
1892
1879
|
limitId: string | undefined;
|
|
@@ -1896,38 +1883,37 @@ export interface QueueLimitAssociationSummary {
|
|
|
1896
1883
|
*/
|
|
1897
1884
|
status: QueueLimitAssociationStatus | undefined;
|
|
1898
1885
|
/**
|
|
1899
|
-
*
|
|
1886
|
+
* The Unix timestamp of the date and time that the association was created.
|
|
1900
1887
|
* @public
|
|
1901
1888
|
*/
|
|
1902
1889
|
createdAt: Date | undefined;
|
|
1903
1890
|
/**
|
|
1904
|
-
*
|
|
1891
|
+
* The user identifier of the person that created the association.
|
|
1905
1892
|
* @public
|
|
1906
1893
|
*/
|
|
1907
1894
|
createdBy: string | undefined;
|
|
1908
1895
|
/**
|
|
1909
|
-
*
|
|
1896
|
+
* The Unix timestamp of the date and time that the association was last updated.
|
|
1910
1897
|
* @public
|
|
1911
1898
|
*/
|
|
1912
1899
|
updatedAt?: Date | undefined;
|
|
1913
1900
|
/**
|
|
1914
|
-
*
|
|
1901
|
+
* The user identifier of the person that updated the association.
|
|
1915
1902
|
* @public
|
|
1916
1903
|
*/
|
|
1917
1904
|
updatedBy?: string | undefined;
|
|
1918
1905
|
}
|
|
1919
1906
|
/**
|
|
1920
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
1921
1907
|
* @public
|
|
1922
1908
|
*/
|
|
1923
1909
|
export interface ListQueueLimitAssociationsResponse {
|
|
1924
1910
|
/**
|
|
1925
|
-
*
|
|
1911
|
+
* A list of associations between limits and queues in the farm specified in the request.
|
|
1926
1912
|
* @public
|
|
1927
1913
|
*/
|
|
1928
1914
|
queueLimitAssociations: QueueLimitAssociationSummary[] | undefined;
|
|
1929
1915
|
/**
|
|
1930
|
-
*
|
|
1916
|
+
* 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.
|
|
1931
1917
|
* @public
|
|
1932
1918
|
*/
|
|
1933
1919
|
nextToken?: string | undefined;
|
|
@@ -1937,7 +1923,7 @@ export interface ListQueueLimitAssociationsResponse {
|
|
|
1937
1923
|
*/
|
|
1938
1924
|
export interface ListTagsForResourceRequest {
|
|
1939
1925
|
/**
|
|
1940
|
-
*
|
|
1926
|
+
* The resource ARN to list tags for.
|
|
1941
1927
|
* @public
|
|
1942
1928
|
*/
|
|
1943
1929
|
resourceArn: string | undefined;
|
|
@@ -1947,7 +1933,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1947
1933
|
*/
|
|
1948
1934
|
export interface ListTagsForResourceResponse {
|
|
1949
1935
|
/**
|
|
1950
|
-
*
|
|
1936
|
+
* Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
|
|
1951
1937
|
* @public
|
|
1952
1938
|
*/
|
|
1953
1939
|
tags?: Record<string, string> | undefined;
|
|
@@ -1957,7 +1943,7 @@ export interface ListTagsForResourceResponse {
|
|
|
1957
1943
|
*/
|
|
1958
1944
|
export interface DeleteMonitorRequest {
|
|
1959
1945
|
/**
|
|
1960
|
-
*
|
|
1946
|
+
* The unique identifier of the monitor to delete. This ID is returned by the <code>CreateMonitor</code> operation, and is included in the response to the <code>GetMonitor</code> operation.
|
|
1961
1947
|
* @public
|
|
1962
1948
|
*/
|
|
1963
1949
|
monitorId: string | undefined;
|
|
@@ -1972,19 +1958,17 @@ export interface DeleteMonitorResponse {
|
|
|
1972
1958
|
*/
|
|
1973
1959
|
export interface GetMonitorRequest {
|
|
1974
1960
|
/**
|
|
1975
|
-
*
|
|
1961
|
+
* The unique identifier for the monitor. This ID is returned by the <code>CreateMonitor</code> operation.
|
|
1976
1962
|
* @public
|
|
1977
1963
|
*/
|
|
1978
1964
|
monitorId: string | undefined;
|
|
1979
1965
|
}
|
|
1980
1966
|
/**
|
|
1981
|
-
* Mixin that adds an optional ARN field to response structures.
|
|
1982
|
-
* Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.
|
|
1983
1967
|
* @public
|
|
1984
1968
|
*/
|
|
1985
1969
|
export interface GetMonitorResponse {
|
|
1986
1970
|
/**
|
|
1987
|
-
*
|
|
1971
|
+
* The unique identifier for the monitor.
|
|
1988
1972
|
* @public
|
|
1989
1973
|
*/
|
|
1990
1974
|
monitorId: string | undefined;
|
|
@@ -1994,52 +1978,52 @@ export interface GetMonitorResponse {
|
|
|
1994
1978
|
*/
|
|
1995
1979
|
displayName: string | undefined;
|
|
1996
1980
|
/**
|
|
1997
|
-
*
|
|
1981
|
+
* The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
|
|
1998
1982
|
* @public
|
|
1999
1983
|
*/
|
|
2000
1984
|
subdomain: string | undefined;
|
|
2001
1985
|
/**
|
|
2002
|
-
*
|
|
1986
|
+
* The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
|
|
2003
1987
|
* @public
|
|
2004
1988
|
*/
|
|
2005
1989
|
url: string | undefined;
|
|
2006
1990
|
/**
|
|
2007
|
-
*
|
|
1991
|
+
* The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
|
|
2008
1992
|
* @public
|
|
2009
1993
|
*/
|
|
2010
1994
|
roleArn: string | undefined;
|
|
2011
1995
|
/**
|
|
2012
|
-
*
|
|
1996
|
+
* The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.
|
|
2013
1997
|
* @public
|
|
2014
1998
|
*/
|
|
2015
1999
|
identityCenterInstanceArn: string | undefined;
|
|
2016
2000
|
/**
|
|
2017
|
-
*
|
|
2001
|
+
* The Region where IAM Identity Center is enabled.
|
|
2018
2002
|
* @public
|
|
2019
2003
|
*/
|
|
2020
2004
|
identityCenterRegion?: string | undefined;
|
|
2021
2005
|
/**
|
|
2022
|
-
*
|
|
2006
|
+
* The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.
|
|
2023
2007
|
* @public
|
|
2024
2008
|
*/
|
|
2025
2009
|
identityCenterApplicationArn: string | undefined;
|
|
2026
2010
|
/**
|
|
2027
|
-
*
|
|
2011
|
+
* The UNIX timestamp of the date and time that the monitor was created.
|
|
2028
2012
|
* @public
|
|
2029
2013
|
*/
|
|
2030
2014
|
createdAt: Date | undefined;
|
|
2031
2015
|
/**
|
|
2032
|
-
*
|
|
2016
|
+
* The user name of the person that created the monitor.
|
|
2033
2017
|
* @public
|
|
2034
2018
|
*/
|
|
2035
2019
|
createdBy: string | undefined;
|
|
2036
2020
|
/**
|
|
2037
|
-
*
|
|
2021
|
+
* The UNIX timestamp of the last date and time that the monitor was updated.
|
|
2038
2022
|
* @public
|
|
2039
2023
|
*/
|
|
2040
2024
|
updatedAt?: Date | undefined;
|
|
2041
2025
|
/**
|
|
2042
|
-
*
|
|
2026
|
+
* The user name of the person that last updated the monitor.
|
|
2043
2027
|
* @public
|
|
2044
2028
|
*/
|
|
2045
2029
|
updatedBy?: string | undefined;
|
|
@@ -2049,7 +2033,7 @@ export interface GetMonitorResponse {
|
|
|
2049
2033
|
*/
|
|
2050
2034
|
export interface GetMonitorSettingsRequest {
|
|
2051
2035
|
/**
|
|
2052
|
-
*
|
|
2036
|
+
* The unique identifier of the monitor. This ID is returned by the <code>CreateMonitor</code> operation, and is included in the response to the <code>ListMonitors</code> operation.
|
|
2053
2037
|
* @public
|
|
2054
2038
|
*/
|
|
2055
2039
|
monitorId: string | undefined;
|
|
@@ -2059,34 +2043,33 @@ export interface GetMonitorSettingsRequest {
|
|
|
2059
2043
|
*/
|
|
2060
2044
|
export interface GetMonitorSettingsResponse {
|
|
2061
2045
|
/**
|
|
2062
|
-
*
|
|
2046
|
+
* The monitor settings as key-value pairs.
|
|
2063
2047
|
* @public
|
|
2064
2048
|
*/
|
|
2065
2049
|
settings: Record<string, string> | undefined;
|
|
2066
2050
|
}
|
|
2067
2051
|
/**
|
|
2068
|
-
* Shared pagination fields for List operation inputs (nextToken + maxResults).
|
|
2069
2052
|
* @public
|
|
2070
2053
|
*/
|
|
2071
2054
|
export interface ListMonitorsRequest {
|
|
2072
2055
|
/**
|
|
2073
|
-
*
|
|
2056
|
+
* The token for the next set of results, or <code>null</code> to start from the beginning.
|
|
2074
2057
|
* @public
|
|
2075
2058
|
*/
|
|
2076
2059
|
nextToken?: string | undefined;
|
|
2077
2060
|
/**
|
|
2078
|
-
*
|
|
2061
|
+
* The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.
|
|
2079
2062
|
* @public
|
|
2080
2063
|
*/
|
|
2081
2064
|
maxResults?: number | undefined;
|
|
2082
2065
|
}
|
|
2083
2066
|
/**
|
|
2084
|
-
*
|
|
2067
|
+
* Provides information about a monitor in Deadline Cloud.
|
|
2085
2068
|
* @public
|
|
2086
2069
|
*/
|
|
2087
2070
|
export interface MonitorSummary {
|
|
2088
2071
|
/**
|
|
2089
|
-
*
|
|
2072
|
+
* The unique identifier for the monitor.
|
|
2090
2073
|
* @public
|
|
2091
2074
|
*/
|
|
2092
2075
|
monitorId: string | undefined;
|
|
@@ -2096,68 +2079,67 @@ export interface MonitorSummary {
|
|
|
2096
2079
|
*/
|
|
2097
2080
|
displayName: string | undefined;
|
|
2098
2081
|
/**
|
|
2099
|
-
*
|
|
2082
|
+
* The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
|
|
2100
2083
|
* @public
|
|
2101
2084
|
*/
|
|
2102
2085
|
subdomain: string | undefined;
|
|
2103
2086
|
/**
|
|
2104
|
-
*
|
|
2087
|
+
* The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
|
|
2105
2088
|
* @public
|
|
2106
2089
|
*/
|
|
2107
2090
|
url: string | undefined;
|
|
2108
2091
|
/**
|
|
2109
|
-
*
|
|
2092
|
+
* The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
|
|
2110
2093
|
* @public
|
|
2111
2094
|
*/
|
|
2112
2095
|
roleArn: string | undefined;
|
|
2113
2096
|
/**
|
|
2114
|
-
*
|
|
2097
|
+
* The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.
|
|
2115
2098
|
* @public
|
|
2116
2099
|
*/
|
|
2117
2100
|
identityCenterInstanceArn: string | undefined;
|
|
2118
2101
|
/**
|
|
2119
|
-
*
|
|
2102
|
+
* The Region where IAM Identity Center is enabled.
|
|
2120
2103
|
* @public
|
|
2121
2104
|
*/
|
|
2122
2105
|
identityCenterRegion?: string | undefined;
|
|
2123
2106
|
/**
|
|
2124
|
-
*
|
|
2107
|
+
* The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.
|
|
2125
2108
|
* @public
|
|
2126
2109
|
*/
|
|
2127
2110
|
identityCenterApplicationArn: string | undefined;
|
|
2128
2111
|
/**
|
|
2129
|
-
*
|
|
2112
|
+
* The UNIX timestamp of the date and time that the monitor was created.
|
|
2130
2113
|
* @public
|
|
2131
2114
|
*/
|
|
2132
2115
|
createdAt: Date | undefined;
|
|
2133
2116
|
/**
|
|
2134
|
-
*
|
|
2117
|
+
* The user name of the person that created the monitor.
|
|
2135
2118
|
* @public
|
|
2136
2119
|
*/
|
|
2137
2120
|
createdBy: string | undefined;
|
|
2138
2121
|
/**
|
|
2139
|
-
*
|
|
2122
|
+
* The UNIX timestamp of the date and time that the monitor was last updated.
|
|
2140
2123
|
* @public
|
|
2141
2124
|
*/
|
|
2142
2125
|
updatedAt?: Date | undefined;
|
|
2143
2126
|
/**
|
|
2144
|
-
*
|
|
2127
|
+
* The user name of the person that last updated the monitor.
|
|
2145
2128
|
* @public
|
|
2146
2129
|
*/
|
|
2147
2130
|
updatedBy?: string | undefined;
|
|
2148
2131
|
}
|
|
2149
2132
|
/**
|
|
2150
|
-
* Shared pagination field for List operation outputs (nextToken).
|
|
2151
2133
|
* @public
|
|
2152
2134
|
*/
|
|
2153
2135
|
export interface ListMonitorsResponse {
|
|
2154
2136
|
/**
|
|
2155
|
-
*
|
|
2137
|
+
* A list of <code>MonitorSummary</code> objects that describe your monitors in the Deadline Cloud.
|
|
2156
2138
|
* @public
|
|
2157
2139
|
*/
|
|
2158
2140
|
monitors: MonitorSummary[] | undefined;
|
|
2159
2141
|
/**
|
|
2160
|
-
*
|
|
2142
|
+
* 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.
|
|
2161
2143
|
* @public
|
|
2162
2144
|
*/
|
|
2163
2145
|
nextToken?: string | undefined;
|
|
@@ -2167,12 +2149,12 @@ export interface ListMonitorsResponse {
|
|
|
2167
2149
|
*/
|
|
2168
2150
|
export interface UpdateMonitorRequest {
|
|
2169
2151
|
/**
|
|
2170
|
-
*
|
|
2152
|
+
* The unique identifier of the monitor to update.
|
|
2171
2153
|
* @public
|
|
2172
2154
|
*/
|
|
2173
2155
|
monitorId: string | undefined;
|
|
2174
2156
|
/**
|
|
2175
|
-
*
|
|
2157
|
+
* The new value of the subdomain to use when forming the monitor URL.
|
|
2176
2158
|
* @public
|
|
2177
2159
|
*/
|
|
2178
2160
|
subdomain?: string | undefined;
|
|
@@ -2182,7 +2164,7 @@ export interface UpdateMonitorRequest {
|
|
|
2182
2164
|
*/
|
|
2183
2165
|
displayName?: string | undefined;
|
|
2184
2166
|
/**
|
|
2185
|
-
*
|
|
2167
|
+
* The Amazon Resource Name of the new IAM role to use with the monitor.
|
|
2186
2168
|
* @public
|
|
2187
2169
|
*/
|
|
2188
2170
|
roleArn?: string | undefined;
|
|
@@ -2197,12 +2179,12 @@ export interface UpdateMonitorResponse {
|
|
|
2197
2179
|
*/
|
|
2198
2180
|
export interface UpdateMonitorSettingsRequest {
|
|
2199
2181
|
/**
|
|
2200
|
-
*
|
|
2182
|
+
* The unique identifier of the monitor to update settings for.
|
|
2201
2183
|
* @public
|
|
2202
2184
|
*/
|
|
2203
2185
|
monitorId: string | undefined;
|
|
2204
2186
|
/**
|
|
2205
|
-
*
|
|
2187
|
+
* The monitor settings to update as key-value pairs. Keys present in the request are upserted; keys absent are left unchanged. Send an empty string value to delete a key.
|
|
2206
2188
|
* @public
|
|
2207
2189
|
*/
|
|
2208
2190
|
settings: Record<string, string> | undefined;
|
|
@@ -2213,33 +2195,33 @@ export interface UpdateMonitorSettingsRequest {
|
|
|
2213
2195
|
export interface UpdateMonitorSettingsResponse {
|
|
2214
2196
|
}
|
|
2215
2197
|
/**
|
|
2216
|
-
*
|
|
2198
|
+
* The details of a filtered search for parameters.
|
|
2217
2199
|
* @public
|
|
2218
2200
|
*/
|
|
2219
2201
|
export interface ParameterFilterExpression {
|
|
2220
2202
|
/**
|
|
2221
|
-
*
|
|
2203
|
+
* The name of the parameter to filter on.
|
|
2222
2204
|
* @public
|
|
2223
2205
|
*/
|
|
2224
2206
|
name: string | undefined;
|
|
2225
2207
|
/**
|
|
2226
|
-
*
|
|
2208
|
+
* The type of comparison to use to filter results.
|
|
2227
2209
|
* @public
|
|
2228
2210
|
*/
|
|
2229
2211
|
operator: ComparisonOperator | undefined;
|
|
2230
2212
|
/**
|
|
2231
|
-
*
|
|
2213
|
+
* The parameter's value.
|
|
2232
2214
|
* @public
|
|
2233
2215
|
*/
|
|
2234
2216
|
value: string | undefined;
|
|
2235
2217
|
}
|
|
2236
2218
|
/**
|
|
2237
|
-
*
|
|
2219
|
+
* Searches for a particular search term.
|
|
2238
2220
|
* @public
|
|
2239
2221
|
*/
|
|
2240
2222
|
export interface SearchTermFilterExpression {
|
|
2241
2223
|
/**
|
|
2242
|
-
*
|
|
2224
|
+
* The term to search for.
|
|
2243
2225
|
* @public
|
|
2244
2226
|
*/
|
|
2245
2227
|
searchTerm: string | undefined;
|
|
@@ -2250,92 +2232,92 @@ export interface SearchTermFilterExpression {
|
|
|
2250
2232
|
matchType?: SearchTermMatchingType | undefined;
|
|
2251
2233
|
}
|
|
2252
2234
|
/**
|
|
2253
|
-
*
|
|
2235
|
+
* Searches for a particular string.
|
|
2254
2236
|
* @public
|
|
2255
2237
|
*/
|
|
2256
2238
|
export interface StringFilterExpression {
|
|
2257
2239
|
/**
|
|
2258
|
-
*
|
|
2240
|
+
* The field name to search.
|
|
2259
2241
|
* @public
|
|
2260
2242
|
*/
|
|
2261
2243
|
name: string | undefined;
|
|
2262
2244
|
/**
|
|
2263
|
-
*
|
|
2245
|
+
* The type of comparison to use for this search.
|
|
2264
2246
|
* @public
|
|
2265
2247
|
*/
|
|
2266
2248
|
operator: ComparisonOperator | undefined;
|
|
2267
2249
|
/**
|
|
2268
|
-
*
|
|
2250
|
+
* The string to search for.
|
|
2269
2251
|
* @public
|
|
2270
2252
|
*/
|
|
2271
2253
|
value: string | undefined;
|
|
2272
2254
|
}
|
|
2273
2255
|
/**
|
|
2274
|
-
*
|
|
2256
|
+
* Searches for a particular list of strings.
|
|
2275
2257
|
* @public
|
|
2276
2258
|
*/
|
|
2277
2259
|
export interface StringListFilterExpression {
|
|
2278
2260
|
/**
|
|
2279
|
-
*
|
|
2261
|
+
* The field name to search.
|
|
2280
2262
|
* @public
|
|
2281
2263
|
*/
|
|
2282
2264
|
name: string | undefined;
|
|
2283
2265
|
/**
|
|
2284
|
-
*
|
|
2266
|
+
* The type of comparison to use for this search.
|
|
2285
2267
|
* @public
|
|
2286
2268
|
*/
|
|
2287
2269
|
operator: ComparisonOperator | undefined;
|
|
2288
2270
|
/**
|
|
2289
|
-
*
|
|
2271
|
+
* The list of string values to search for.
|
|
2290
2272
|
* @public
|
|
2291
2273
|
*/
|
|
2292
2274
|
values: string[] | undefined;
|
|
2293
2275
|
}
|
|
2294
2276
|
/**
|
|
2295
|
-
*
|
|
2277
|
+
* The field sorting order and name of the field.
|
|
2296
2278
|
* @public
|
|
2297
2279
|
*/
|
|
2298
2280
|
export interface FieldSortExpression {
|
|
2299
2281
|
/**
|
|
2300
|
-
*
|
|
2282
|
+
* The sort order for the field.
|
|
2301
2283
|
* @public
|
|
2302
2284
|
*/
|
|
2303
2285
|
sortOrder: SortOrder | undefined;
|
|
2304
2286
|
/**
|
|
2305
|
-
*
|
|
2287
|
+
* The name of the field.
|
|
2306
2288
|
* @public
|
|
2307
2289
|
*/
|
|
2308
2290
|
name: string | undefined;
|
|
2309
2291
|
}
|
|
2310
2292
|
/**
|
|
2311
|
-
*
|
|
2293
|
+
* Organizes parameters according to your specifications.
|
|
2312
2294
|
* @public
|
|
2313
2295
|
*/
|
|
2314
2296
|
export interface ParameterSortExpression {
|
|
2315
2297
|
/**
|
|
2316
|
-
*
|
|
2298
|
+
* The sort order for the parameter.
|
|
2317
2299
|
* @public
|
|
2318
2300
|
*/
|
|
2319
2301
|
sortOrder: SortOrder | undefined;
|
|
2320
2302
|
/**
|
|
2321
|
-
*
|
|
2303
|
+
* The parameter name to sort by.
|
|
2322
2304
|
* @public
|
|
2323
2305
|
*/
|
|
2324
2306
|
name: string | undefined;
|
|
2325
2307
|
}
|
|
2326
2308
|
/**
|
|
2327
|
-
*
|
|
2309
|
+
* Allows setting a specific user's job to run first.
|
|
2328
2310
|
* @public
|
|
2329
2311
|
*/
|
|
2330
2312
|
export interface UserJobsFirst {
|
|
2331
2313
|
/**
|
|
2332
|
-
*
|
|
2314
|
+
* The user's ID.
|
|
2333
2315
|
* @public
|
|
2334
2316
|
*/
|
|
2335
2317
|
userIdentityId: string | undefined;
|
|
2336
2318
|
}
|
|
2337
2319
|
/**
|
|
2338
|
-
*
|
|
2320
|
+
* The resources to search.
|
|
2339
2321
|
* @public
|
|
2340
2322
|
*/
|
|
2341
2323
|
export type SearchSortExpression = SearchSortExpression.FieldSortMember | SearchSortExpression.ParameterSortMember | SearchSortExpression.UserJobsFirstMember | SearchSortExpression.$UnknownMember;
|
|
@@ -2344,7 +2326,7 @@ export type SearchSortExpression = SearchSortExpression.FieldSortMember | Search
|
|
|
2344
2326
|
*/
|
|
2345
2327
|
export declare namespace SearchSortExpression {
|
|
2346
2328
|
/**
|
|
2347
|
-
*
|
|
2329
|
+
* Options for sorting a particular user's jobs first.
|
|
2348
2330
|
* @public
|
|
2349
2331
|
*/
|
|
2350
2332
|
interface UserJobsFirstMember {
|
|
@@ -2354,7 +2336,7 @@ export declare namespace SearchSortExpression {
|
|
|
2354
2336
|
$unknown?: never;
|
|
2355
2337
|
}
|
|
2356
2338
|
/**
|
|
2357
|
-
*
|
|
2339
|
+
* Options for sorting by a field.
|
|
2358
2340
|
* @public
|
|
2359
2341
|
*/
|
|
2360
2342
|
interface FieldSortMember {
|
|
@@ -2364,7 +2346,7 @@ export declare namespace SearchSortExpression {
|
|
|
2364
2346
|
$unknown?: never;
|
|
2365
2347
|
}
|
|
2366
2348
|
/**
|
|
2367
|
-
*
|
|
2349
|
+
* Options for sorting by a parameter.
|
|
2368
2350
|
* @public
|
|
2369
2351
|
*/
|
|
2370
2352
|
interface ParameterSortMember {
|
|
@@ -2394,32 +2376,32 @@ export declare namespace SearchSortExpression {
|
|
|
2394
2376
|
}
|
|
2395
2377
|
}
|
|
2396
2378
|
/**
|
|
2397
|
-
*
|
|
2379
|
+
* The details of a job search.
|
|
2398
2380
|
* @public
|
|
2399
2381
|
*/
|
|
2400
2382
|
export interface JobSearchSummary {
|
|
2401
2383
|
/**
|
|
2402
|
-
*
|
|
2384
|
+
* The job ID.
|
|
2403
2385
|
* @public
|
|
2404
2386
|
*/
|
|
2405
2387
|
jobId?: string | undefined;
|
|
2406
2388
|
/**
|
|
2407
|
-
*
|
|
2389
|
+
* The queue ID.
|
|
2408
2390
|
* @public
|
|
2409
2391
|
*/
|
|
2410
2392
|
queueId?: string | undefined;
|
|
2411
2393
|
/**
|
|
2412
|
-
*
|
|
2394
|
+
* The job name.
|
|
2413
2395
|
* @public
|
|
2414
2396
|
*/
|
|
2415
2397
|
name?: string | undefined;
|
|
2416
2398
|
/**
|
|
2417
|
-
*
|
|
2399
|
+
* The life cycle status.
|
|
2418
2400
|
* @public
|
|
2419
2401
|
*/
|
|
2420
2402
|
lifecycleStatus?: JobLifecycleStatus | undefined;
|
|
2421
2403
|
/**
|
|
2422
|
-
*
|
|
2404
|
+
* The life cycle status message.
|
|
2423
2405
|
* @public
|
|
2424
2406
|
*/
|
|
2425
2407
|
lifecycleStatusMessage?: string | undefined;
|
|
@@ -2429,134 +2411,138 @@ export interface JobSearchSummary {
|
|
|
2429
2411
|
*/
|
|
2430
2412
|
taskRunStatus?: TaskRunStatus | undefined;
|
|
2431
2413
|
/**
|
|
2432
|
-
*
|
|
2414
|
+
* The task status to update the job's tasks to.
|
|
2433
2415
|
* @public
|
|
2434
2416
|
*/
|
|
2435
2417
|
targetTaskRunStatus?: JobTargetTaskRunStatus | undefined;
|
|
2436
2418
|
/**
|
|
2437
|
-
*
|
|
2419
|
+
* The number of tasks running on the job.
|
|
2438
2420
|
* @public
|
|
2439
2421
|
*/
|
|
2440
2422
|
taskRunStatusCounts?: Partial<Record<TaskRunStatus, number>> | undefined;
|
|
2441
2423
|
/**
|
|
2442
|
-
*
|
|
2424
|
+
* The total number of times tasks from the job failed and were retried.
|
|
2443
2425
|
* @public
|
|
2444
2426
|
*/
|
|
2445
2427
|
taskFailureRetryCount?: number | undefined;
|
|
2446
2428
|
/**
|
|
2447
|
-
*
|
|
2429
|
+
* The job priority.
|
|
2448
2430
|
* @public
|
|
2449
2431
|
*/
|
|
2450
2432
|
priority?: number | undefined;
|
|
2451
2433
|
/**
|
|
2452
|
-
*
|
|
2434
|
+
* The number of task failures before the job stops running and is marked as <code>FAILED</code>.
|
|
2453
2435
|
* @public
|
|
2454
2436
|
*/
|
|
2455
2437
|
maxFailedTasksCount?: number | undefined;
|
|
2456
2438
|
/**
|
|
2457
|
-
*
|
|
2439
|
+
* The maximum number of retries for a job.
|
|
2458
2440
|
* @public
|
|
2459
2441
|
*/
|
|
2460
2442
|
maxRetriesPerTask?: number | undefined;
|
|
2461
2443
|
/**
|
|
2462
|
-
*
|
|
2444
|
+
* The user or system that created this resource.
|
|
2463
2445
|
* @public
|
|
2464
2446
|
*/
|
|
2465
2447
|
createdBy?: string | undefined;
|
|
2466
2448
|
/**
|
|
2467
|
-
*
|
|
2449
|
+
* The date and time the resource was created.
|
|
2468
2450
|
* @public
|
|
2469
2451
|
*/
|
|
2470
2452
|
createdAt?: Date | undefined;
|
|
2471
2453
|
/**
|
|
2472
|
-
*
|
|
2454
|
+
* The date and time the resource ended running.
|
|
2473
2455
|
* @public
|
|
2474
2456
|
*/
|
|
2475
2457
|
endedAt?: Date | undefined;
|
|
2476
2458
|
/**
|
|
2477
|
-
*
|
|
2459
|
+
* The date and time the resource started running.
|
|
2478
2460
|
* @public
|
|
2479
2461
|
*/
|
|
2480
2462
|
startedAt?: Date | undefined;
|
|
2481
2463
|
/**
|
|
2482
|
-
*
|
|
2464
|
+
* The date and time the resource was updated.
|
|
2483
2465
|
* @public
|
|
2484
2466
|
*/
|
|
2485
2467
|
updatedAt?: Date | undefined;
|
|
2486
2468
|
/**
|
|
2487
|
-
*
|
|
2469
|
+
* The user or system that updated this resource.
|
|
2488
2470
|
* @public
|
|
2489
2471
|
*/
|
|
2490
2472
|
updatedBy?: string | undefined;
|
|
2491
2473
|
/**
|
|
2492
|
-
*
|
|
2474
|
+
* The job parameters.
|
|
2493
2475
|
* @public
|
|
2494
2476
|
*/
|
|
2495
2477
|
jobParameters?: Record<string, JobParameter> | undefined;
|
|
2496
2478
|
/**
|
|
2497
|
-
*
|
|
2479
|
+
* 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.
|
|
2480
|
+
*
|
|
2481
|
+
* You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.
|
|
2482
|
+
*
|
|
2483
|
+
* If you don't specify the <code>maxWorkerCount</code>, the default is -1.
|
|
2484
|
+
*
|
|
2498
2485
|
* @public
|
|
2499
2486
|
*/
|
|
2500
2487
|
maxWorkerCount?: number | undefined;
|
|
2501
2488
|
/**
|
|
2502
|
-
*
|
|
2489
|
+
* The job ID for the source job.
|
|
2503
2490
|
* @public
|
|
2504
2491
|
*/
|
|
2505
2492
|
sourceJobId?: string | undefined;
|
|
2506
2493
|
}
|
|
2507
2494
|
/**
|
|
2508
|
-
* Shared output fields for all Search operations (nextItemOffset, totalResults).
|
|
2509
2495
|
* @public
|
|
2510
2496
|
*/
|
|
2511
2497
|
export interface SearchJobsResponse {
|
|
2512
2498
|
/**
|
|
2513
|
-
*
|
|
2499
|
+
* The jobs in the search.
|
|
2514
2500
|
* @public
|
|
2515
2501
|
*/
|
|
2516
2502
|
jobs: JobSearchSummary[] | undefined;
|
|
2517
2503
|
/**
|
|
2518
|
-
*
|
|
2504
|
+
* The next item offset for the search results.
|
|
2519
2505
|
* @public
|
|
2520
2506
|
*/
|
|
2521
2507
|
nextItemOffset?: number | undefined;
|
|
2522
2508
|
/**
|
|
2523
|
-
*
|
|
2509
|
+
* The total number of results in the search.
|
|
2524
2510
|
* @public
|
|
2525
2511
|
*/
|
|
2526
2512
|
totalResults: number | undefined;
|
|
2527
2513
|
}
|
|
2528
2514
|
/**
|
|
2529
|
-
*
|
|
2515
|
+
* The details of a step search.
|
|
2530
2516
|
* @public
|
|
2531
2517
|
*/
|
|
2532
2518
|
export interface StepSearchSummary {
|
|
2533
2519
|
/**
|
|
2534
|
-
*
|
|
2520
|
+
* The step ID.
|
|
2535
2521
|
* @public
|
|
2536
2522
|
*/
|
|
2537
2523
|
stepId?: string | undefined;
|
|
2538
2524
|
/**
|
|
2539
|
-
*
|
|
2525
|
+
* The job ID.
|
|
2540
2526
|
* @public
|
|
2541
2527
|
*/
|
|
2542
2528
|
jobId?: string | undefined;
|
|
2543
2529
|
/**
|
|
2544
|
-
*
|
|
2530
|
+
* The queue ID.
|
|
2545
2531
|
* @public
|
|
2546
2532
|
*/
|
|
2547
2533
|
queueId?: string | undefined;
|
|
2548
2534
|
/**
|
|
2549
|
-
*
|
|
2535
|
+
* The step name.
|
|
2550
2536
|
* @public
|
|
2551
2537
|
*/
|
|
2552
2538
|
name?: string | undefined;
|
|
2553
2539
|
/**
|
|
2554
|
-
*
|
|
2540
|
+
* The life cycle status.
|
|
2555
2541
|
* @public
|
|
2556
2542
|
*/
|
|
2557
2543
|
lifecycleStatus?: StepLifecycleStatus | undefined;
|
|
2558
2544
|
/**
|
|
2559
|
-
*
|
|
2545
|
+
* The life cycle status message.
|
|
2560
2546
|
* @public
|
|
2561
2547
|
*/
|
|
2562
2548
|
lifecycleStatusMessage?: string | undefined;
|
|
@@ -2566,238 +2552,235 @@ export interface StepSearchSummary {
|
|
|
2566
2552
|
*/
|
|
2567
2553
|
taskRunStatus?: TaskRunStatus | undefined;
|
|
2568
2554
|
/**
|
|
2569
|
-
*
|
|
2555
|
+
* The task status to update the job's tasks to.
|
|
2570
2556
|
* @public
|
|
2571
2557
|
*/
|
|
2572
2558
|
targetTaskRunStatus?: StepTargetTaskRunStatus | undefined;
|
|
2573
2559
|
/**
|
|
2574
|
-
*
|
|
2560
|
+
* The number of tasks running on the job.
|
|
2575
2561
|
* @public
|
|
2576
2562
|
*/
|
|
2577
2563
|
taskRunStatusCounts?: Partial<Record<TaskRunStatus, number>> | undefined;
|
|
2578
2564
|
/**
|
|
2579
|
-
*
|
|
2565
|
+
* The total number of times tasks from the step failed and were retried.
|
|
2580
2566
|
* @public
|
|
2581
2567
|
*/
|
|
2582
2568
|
taskFailureRetryCount?: number | undefined;
|
|
2583
2569
|
/**
|
|
2584
|
-
*
|
|
2570
|
+
* The date and time the resource was created.
|
|
2585
2571
|
* @public
|
|
2586
2572
|
*/
|
|
2587
2573
|
createdAt?: Date | undefined;
|
|
2588
2574
|
/**
|
|
2589
|
-
*
|
|
2575
|
+
* The user or system that created this resource.
|
|
2590
2576
|
* @public
|
|
2591
2577
|
*/
|
|
2592
2578
|
createdBy?: string | undefined;
|
|
2593
2579
|
/**
|
|
2594
|
-
*
|
|
2580
|
+
* The date and time the resource started running.
|
|
2595
2581
|
* @public
|
|
2596
2582
|
*/
|
|
2597
2583
|
startedAt?: Date | undefined;
|
|
2598
2584
|
/**
|
|
2599
|
-
*
|
|
2585
|
+
* The date and time the resource ended running.
|
|
2600
2586
|
* @public
|
|
2601
2587
|
*/
|
|
2602
2588
|
endedAt?: Date | undefined;
|
|
2603
2589
|
/**
|
|
2604
|
-
*
|
|
2590
|
+
* The date and time the resource was updated.
|
|
2605
2591
|
* @public
|
|
2606
2592
|
*/
|
|
2607
2593
|
updatedAt?: Date | undefined;
|
|
2608
2594
|
/**
|
|
2609
|
-
*
|
|
2595
|
+
* The user or system that updated this resource.
|
|
2610
2596
|
* @public
|
|
2611
2597
|
*/
|
|
2612
2598
|
updatedBy?: string | undefined;
|
|
2613
2599
|
/**
|
|
2614
|
-
*
|
|
2600
|
+
* The parameters and combination expressions for the search.
|
|
2615
2601
|
* @public
|
|
2616
2602
|
*/
|
|
2617
2603
|
parameterSpace?: ParameterSpace | undefined;
|
|
2618
2604
|
}
|
|
2619
2605
|
/**
|
|
2620
|
-
* Shared output fields for all Search operations (nextItemOffset, totalResults).
|
|
2621
2606
|
* @public
|
|
2622
2607
|
*/
|
|
2623
2608
|
export interface SearchStepsResponse {
|
|
2624
2609
|
/**
|
|
2625
|
-
*
|
|
2610
|
+
* The steps in the search.
|
|
2626
2611
|
* @public
|
|
2627
2612
|
*/
|
|
2628
2613
|
steps: StepSearchSummary[] | undefined;
|
|
2629
2614
|
/**
|
|
2630
|
-
*
|
|
2615
|
+
* The next item offset for the search results.
|
|
2631
2616
|
* @public
|
|
2632
2617
|
*/
|
|
2633
2618
|
nextItemOffset?: number | undefined;
|
|
2634
2619
|
/**
|
|
2635
|
-
*
|
|
2620
|
+
* The total number of results in the search.
|
|
2636
2621
|
* @public
|
|
2637
2622
|
*/
|
|
2638
2623
|
totalResults: number | undefined;
|
|
2639
2624
|
}
|
|
2640
2625
|
/**
|
|
2641
|
-
*
|
|
2626
|
+
* The details of a task search.
|
|
2642
2627
|
* @public
|
|
2643
2628
|
*/
|
|
2644
2629
|
export interface TaskSearchSummary {
|
|
2645
2630
|
/**
|
|
2646
|
-
*
|
|
2631
|
+
* The task ID.
|
|
2647
2632
|
* @public
|
|
2648
2633
|
*/
|
|
2649
2634
|
taskId?: string | undefined;
|
|
2650
2635
|
/**
|
|
2651
|
-
*
|
|
2636
|
+
* The step ID.
|
|
2652
2637
|
* @public
|
|
2653
2638
|
*/
|
|
2654
2639
|
stepId?: string | undefined;
|
|
2655
2640
|
/**
|
|
2656
|
-
*
|
|
2641
|
+
* The job ID.
|
|
2657
2642
|
* @public
|
|
2658
2643
|
*/
|
|
2659
2644
|
jobId?: string | undefined;
|
|
2660
2645
|
/**
|
|
2661
|
-
*
|
|
2646
|
+
* The queue ID.
|
|
2662
2647
|
* @public
|
|
2663
2648
|
*/
|
|
2664
2649
|
queueId?: string | undefined;
|
|
2665
2650
|
/**
|
|
2666
|
-
*
|
|
2651
|
+
* The run status of the task.
|
|
2667
2652
|
* @public
|
|
2668
2653
|
*/
|
|
2669
2654
|
runStatus?: TaskRunStatus | undefined;
|
|
2670
2655
|
/**
|
|
2671
|
-
*
|
|
2656
|
+
* The run status that the task is being updated to.
|
|
2672
2657
|
* @public
|
|
2673
2658
|
*/
|
|
2674
2659
|
targetRunStatus?: TaskTargetRunStatus | undefined;
|
|
2675
2660
|
/**
|
|
2676
|
-
*
|
|
2661
|
+
* The parameters to search for.
|
|
2677
2662
|
* @public
|
|
2678
2663
|
*/
|
|
2679
2664
|
parameters?: Record<string, TaskParameterValue> | undefined;
|
|
2680
2665
|
/**
|
|
2681
|
-
*
|
|
2666
|
+
* The number of times that the task failed and was retried.
|
|
2682
2667
|
* @public
|
|
2683
2668
|
*/
|
|
2684
2669
|
failureRetryCount?: number | undefined;
|
|
2685
2670
|
/**
|
|
2686
|
-
*
|
|
2671
|
+
* The date and time the resource started running.
|
|
2687
2672
|
* @public
|
|
2688
2673
|
*/
|
|
2689
2674
|
startedAt?: Date | undefined;
|
|
2690
2675
|
/**
|
|
2691
|
-
*
|
|
2676
|
+
* The date and time the resource ended running.
|
|
2692
2677
|
* @public
|
|
2693
2678
|
*/
|
|
2694
2679
|
endedAt?: Date | undefined;
|
|
2695
2680
|
/**
|
|
2696
|
-
*
|
|
2681
|
+
* The date and time the resource was updated.
|
|
2697
2682
|
* @public
|
|
2698
2683
|
*/
|
|
2699
2684
|
updatedAt?: Date | undefined;
|
|
2700
2685
|
/**
|
|
2701
|
-
*
|
|
2686
|
+
* The user or system that updated this resource.
|
|
2702
2687
|
* @public
|
|
2703
2688
|
*/
|
|
2704
2689
|
updatedBy?: string | undefined;
|
|
2705
2690
|
/**
|
|
2706
|
-
*
|
|
2691
|
+
* The latest session action ID for the task.
|
|
2707
2692
|
* @public
|
|
2708
2693
|
*/
|
|
2709
2694
|
latestSessionActionId?: string | undefined;
|
|
2710
2695
|
}
|
|
2711
2696
|
/**
|
|
2712
|
-
* Shared output fields for all Search operations (nextItemOffset, totalResults).
|
|
2713
2697
|
* @public
|
|
2714
2698
|
*/
|
|
2715
2699
|
export interface SearchTasksResponse {
|
|
2716
2700
|
/**
|
|
2717
|
-
*
|
|
2701
|
+
* Tasks in the search.
|
|
2718
2702
|
* @public
|
|
2719
2703
|
*/
|
|
2720
2704
|
tasks: TaskSearchSummary[] | undefined;
|
|
2721
2705
|
/**
|
|
2722
|
-
*
|
|
2706
|
+
* The next item offset for the search results.
|
|
2723
2707
|
* @public
|
|
2724
2708
|
*/
|
|
2725
2709
|
nextItemOffset?: number | undefined;
|
|
2726
2710
|
/**
|
|
2727
|
-
*
|
|
2711
|
+
* The total number of results in the search.
|
|
2728
2712
|
* @public
|
|
2729
2713
|
*/
|
|
2730
2714
|
totalResults: number | undefined;
|
|
2731
2715
|
}
|
|
2732
2716
|
/**
|
|
2733
|
-
*
|
|
2717
|
+
* The details of a worker search.
|
|
2734
2718
|
* @public
|
|
2735
2719
|
*/
|
|
2736
2720
|
export interface WorkerSearchSummary {
|
|
2737
2721
|
/**
|
|
2738
|
-
*
|
|
2722
|
+
* The fleet ID.
|
|
2739
2723
|
* @public
|
|
2740
2724
|
*/
|
|
2741
2725
|
fleetId?: string | undefined;
|
|
2742
2726
|
/**
|
|
2743
|
-
*
|
|
2727
|
+
* The worker ID.
|
|
2744
2728
|
* @public
|
|
2745
2729
|
*/
|
|
2746
2730
|
workerId?: string | undefined;
|
|
2747
2731
|
/**
|
|
2748
|
-
*
|
|
2732
|
+
* The status of the worker search.
|
|
2749
2733
|
* @public
|
|
2750
2734
|
*/
|
|
2751
2735
|
status?: WorkerStatus | undefined;
|
|
2752
2736
|
/**
|
|
2753
|
-
*
|
|
2737
|
+
* Provides the Amazon EC2 instance properties of the worker host.
|
|
2754
2738
|
* @public
|
|
2755
2739
|
*/
|
|
2756
2740
|
hostProperties?: HostPropertiesResponse | undefined;
|
|
2757
2741
|
/**
|
|
2758
|
-
*
|
|
2742
|
+
* The user or system that created this resource.
|
|
2759
2743
|
* @public
|
|
2760
2744
|
*/
|
|
2761
2745
|
createdBy?: string | undefined;
|
|
2762
2746
|
/**
|
|
2763
|
-
*
|
|
2747
|
+
* The date and time the resource was created.
|
|
2764
2748
|
* @public
|
|
2765
2749
|
*/
|
|
2766
2750
|
createdAt?: Date | undefined;
|
|
2767
2751
|
/**
|
|
2768
|
-
*
|
|
2752
|
+
* The user or system that updated this resource.
|
|
2769
2753
|
* @public
|
|
2770
2754
|
*/
|
|
2771
2755
|
updatedBy?: string | undefined;
|
|
2772
2756
|
/**
|
|
2773
|
-
*
|
|
2757
|
+
* The date and time the resource was updated.
|
|
2774
2758
|
* @public
|
|
2775
2759
|
*/
|
|
2776
2760
|
updatedAt?: Date | undefined;
|
|
2777
2761
|
}
|
|
2778
2762
|
/**
|
|
2779
|
-
* Shared output fields for all Search operations (nextItemOffset, totalResults).
|
|
2780
2763
|
* @public
|
|
2781
2764
|
*/
|
|
2782
2765
|
export interface SearchWorkersResponse {
|
|
2783
2766
|
/**
|
|
2784
|
-
*
|
|
2767
|
+
* The workers for the search.
|
|
2785
2768
|
* @public
|
|
2786
2769
|
*/
|
|
2787
2770
|
workers: WorkerSearchSummary[] | undefined;
|
|
2788
2771
|
/**
|
|
2789
|
-
*
|
|
2772
|
+
* The next item offset for the search results.
|
|
2790
2773
|
* @public
|
|
2791
2774
|
*/
|
|
2792
2775
|
nextItemOffset?: number | undefined;
|
|
2793
2776
|
/**
|
|
2794
|
-
*
|
|
2777
|
+
* The total number of results in the search.
|
|
2795
2778
|
* @public
|
|
2796
2779
|
*/
|
|
2797
2780
|
totalResults: number | undefined;
|
|
2798
2781
|
}
|
|
2799
2782
|
/**
|
|
2800
|
-
*
|
|
2783
|
+
* Specifies the fleet IDs or queue IDs to return statistics. You can specify only fleet IDs or queue IDS, not both.
|
|
2801
2784
|
* @public
|
|
2802
2785
|
*/
|
|
2803
2786
|
export type SessionsStatisticsResources = SessionsStatisticsResources.FleetIdsMember | SessionsStatisticsResources.QueueIdsMember | SessionsStatisticsResources.$UnknownMember;
|
|
@@ -2806,7 +2789,7 @@ export type SessionsStatisticsResources = SessionsStatisticsResources.FleetIdsMe
|
|
|
2806
2789
|
*/
|
|
2807
2790
|
export declare namespace SessionsStatisticsResources {
|
|
2808
2791
|
/**
|
|
2809
|
-
*
|
|
2792
|
+
* One to 10 queue IDs that specify the queues to return statistics for. If you specify the <code>queueIds</code> field, you can't specify the <code>fleetIds</code> field.
|
|
2810
2793
|
* @public
|
|
2811
2794
|
*/
|
|
2812
2795
|
interface QueueIdsMember {
|
|
@@ -2815,7 +2798,7 @@ export declare namespace SessionsStatisticsResources {
|
|
|
2815
2798
|
$unknown?: never;
|
|
2816
2799
|
}
|
|
2817
2800
|
/**
|
|
2818
|
-
*
|
|
2801
|
+
* One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the <code>fleetIds</code> field, you can't specify the <code>queueIds</code> field.
|
|
2819
2802
|
* @public
|
|
2820
2803
|
*/
|
|
2821
2804
|
interface FleetIdsMember {
|
|
@@ -2846,22 +2829,22 @@ export declare namespace SessionsStatisticsResources {
|
|
|
2846
2829
|
*/
|
|
2847
2830
|
export interface StartSessionsStatisticsAggregationRequest {
|
|
2848
2831
|
/**
|
|
2849
|
-
*
|
|
2832
|
+
* The identifier of the farm that contains queues or fleets to return statistics for.
|
|
2850
2833
|
* @public
|
|
2851
2834
|
*/
|
|
2852
2835
|
farmId: string | undefined;
|
|
2853
2836
|
/**
|
|
2854
|
-
*
|
|
2837
|
+
* A list of fleet IDs or queue IDs to gather statistics for.
|
|
2855
2838
|
* @public
|
|
2856
2839
|
*/
|
|
2857
2840
|
resourceIds: SessionsStatisticsResources | undefined;
|
|
2858
2841
|
/**
|
|
2859
|
-
*
|
|
2842
|
+
* The Linux timestamp of the date and time that the statistics start.
|
|
2860
2843
|
* @public
|
|
2861
2844
|
*/
|
|
2862
2845
|
startTime: Date | undefined;
|
|
2863
2846
|
/**
|
|
2864
|
-
*
|
|
2847
|
+
* The Linux timestamp of the date and time that the statistics end.
|
|
2865
2848
|
* @public
|
|
2866
2849
|
*/
|
|
2867
2850
|
endTime: Date | undefined;
|
|
@@ -2871,17 +2854,17 @@ export interface StartSessionsStatisticsAggregationRequest {
|
|
|
2871
2854
|
*/
|
|
2872
2855
|
timezone?: string | undefined;
|
|
2873
2856
|
/**
|
|
2874
|
-
*
|
|
2857
|
+
* The period to aggregate the statistics.
|
|
2875
2858
|
* @public
|
|
2876
2859
|
*/
|
|
2877
2860
|
period?: Period | undefined;
|
|
2878
2861
|
/**
|
|
2879
|
-
*
|
|
2862
|
+
* The field to use to group the statistics.
|
|
2880
2863
|
* @public
|
|
2881
2864
|
*/
|
|
2882
2865
|
groupBy: UsageGroupByField[] | undefined;
|
|
2883
2866
|
/**
|
|
2884
|
-
*
|
|
2867
|
+
* One to four statistics to return.
|
|
2885
2868
|
* @public
|
|
2886
2869
|
*/
|
|
2887
2870
|
statistics: UsageStatistic[] | undefined;
|
|
@@ -2891,7 +2874,7 @@ export interface StartSessionsStatisticsAggregationRequest {
|
|
|
2891
2874
|
*/
|
|
2892
2875
|
export interface StartSessionsStatisticsAggregationResponse {
|
|
2893
2876
|
/**
|
|
2894
|
-
*
|
|
2877
|
+
* A unique identifier for the aggregated statistics. Use this identifier with the <code>GetAggregatedStatisticsForSessions</code> operation to return the statistics.
|
|
2895
2878
|
* @public
|
|
2896
2879
|
*/
|
|
2897
2880
|
aggregationId: string | undefined;
|
|
@@ -2901,12 +2884,12 @@ export interface StartSessionsStatisticsAggregationResponse {
|
|
|
2901
2884
|
*/
|
|
2902
2885
|
export interface TagResourceRequest {
|
|
2903
2886
|
/**
|
|
2904
|
-
*
|
|
2887
|
+
* The ARN of the resource to apply tags to.
|
|
2905
2888
|
* @public
|
|
2906
2889
|
*/
|
|
2907
2890
|
resourceArn: string | undefined;
|
|
2908
2891
|
/**
|
|
2909
|
-
*
|
|
2892
|
+
* Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
|
|
2910
2893
|
* @public
|
|
2911
2894
|
*/
|
|
2912
2895
|
tags?: Record<string, string> | undefined;
|
|
@@ -2921,12 +2904,12 @@ export interface TagResourceResponse {
|
|
|
2921
2904
|
*/
|
|
2922
2905
|
export interface UntagResourceRequest {
|
|
2923
2906
|
/**
|
|
2924
|
-
*
|
|
2907
|
+
* The ARN of the resource to remove the tag from.
|
|
2925
2908
|
* @public
|
|
2926
2909
|
*/
|
|
2927
2910
|
resourceArn: string | undefined;
|
|
2928
2911
|
/**
|
|
2929
|
-
*
|
|
2912
|
+
* They keys of the tag.
|
|
2930
2913
|
* @public
|
|
2931
2914
|
*/
|
|
2932
2915
|
tagKeys: string[] | undefined;
|
|
@@ -2937,28 +2920,26 @@ export interface UntagResourceRequest {
|
|
|
2937
2920
|
export interface UntagResourceResponse {
|
|
2938
2921
|
}
|
|
2939
2922
|
/**
|
|
2940
|
-
* Identifier mixin for queue-fleet association operations.
|
|
2941
|
-
* Composes QueueIdentifierMixin (farmId + queueId) and adds fleetId.
|
|
2942
2923
|
* @public
|
|
2943
2924
|
*/
|
|
2944
2925
|
export interface UpdateQueueFleetAssociationRequest {
|
|
2945
2926
|
/**
|
|
2946
|
-
*
|
|
2927
|
+
* The farm ID to update.
|
|
2947
2928
|
* @public
|
|
2948
2929
|
*/
|
|
2949
2930
|
farmId: string | undefined;
|
|
2950
2931
|
/**
|
|
2951
|
-
*
|
|
2932
|
+
* The queue ID to update.
|
|
2952
2933
|
* @public
|
|
2953
2934
|
*/
|
|
2954
2935
|
queueId: string | undefined;
|
|
2955
2936
|
/**
|
|
2956
|
-
*
|
|
2937
|
+
* The fleet ID to update.
|
|
2957
2938
|
* @public
|
|
2958
2939
|
*/
|
|
2959
2940
|
fleetId: string | undefined;
|
|
2960
2941
|
/**
|
|
2961
|
-
*
|
|
2942
|
+
* The status to update.
|
|
2962
2943
|
* @public
|
|
2963
2944
|
*/
|
|
2964
2945
|
status: UpdateQueueFleetAssociationStatus | undefined;
|
|
@@ -2973,17 +2954,17 @@ export interface UpdateQueueFleetAssociationResponse {
|
|
|
2973
2954
|
*/
|
|
2974
2955
|
export interface UpdateQueueLimitAssociationRequest {
|
|
2975
2956
|
/**
|
|
2976
|
-
*
|
|
2957
|
+
* The unique identifier of the farm that contains the associated queues and limits.
|
|
2977
2958
|
* @public
|
|
2978
2959
|
*/
|
|
2979
2960
|
farmId: string | undefined;
|
|
2980
2961
|
/**
|
|
2981
|
-
*
|
|
2962
|
+
* The unique identifier of the queue associated to the limit.
|
|
2982
2963
|
* @public
|
|
2983
2964
|
*/
|
|
2984
2965
|
queueId: string | undefined;
|
|
2985
2966
|
/**
|
|
2986
|
-
*
|
|
2967
|
+
* The unique identifier of the limit associated to the queue.
|
|
2987
2968
|
* @public
|
|
2988
2969
|
*/
|
|
2989
2970
|
limitId: string | undefined;
|
|
@@ -2999,7 +2980,7 @@ export interface UpdateQueueLimitAssociationRequest {
|
|
|
2999
2980
|
export interface UpdateQueueLimitAssociationResponse {
|
|
3000
2981
|
}
|
|
3001
2982
|
/**
|
|
3002
|
-
*
|
|
2983
|
+
* The type of search filter to apply.
|
|
3003
2984
|
* @public
|
|
3004
2985
|
*/
|
|
3005
2986
|
export type SearchFilterExpression = SearchFilterExpression.DateTimeFilterMember | SearchFilterExpression.GroupFilterMember | SearchFilterExpression.ParameterFilterMember | SearchFilterExpression.SearchTermFilterMember | SearchFilterExpression.StringFilterMember | SearchFilterExpression.StringListFilterMember | SearchFilterExpression.$UnknownMember;
|
|
@@ -3008,7 +2989,7 @@ export type SearchFilterExpression = SearchFilterExpression.DateTimeFilterMember
|
|
|
3008
2989
|
*/
|
|
3009
2990
|
export declare namespace SearchFilterExpression {
|
|
3010
2991
|
/**
|
|
3011
|
-
*
|
|
2992
|
+
* Filters based on date and time.
|
|
3012
2993
|
* @public
|
|
3013
2994
|
*/
|
|
3014
2995
|
interface DateTimeFilterMember {
|
|
@@ -3021,7 +3002,7 @@ export declare namespace SearchFilterExpression {
|
|
|
3021
3002
|
$unknown?: never;
|
|
3022
3003
|
}
|
|
3023
3004
|
/**
|
|
3024
|
-
*
|
|
3005
|
+
* Filters by parameter.
|
|
3025
3006
|
* @public
|
|
3026
3007
|
*/
|
|
3027
3008
|
interface ParameterFilterMember {
|
|
@@ -3034,7 +3015,7 @@ export declare namespace SearchFilterExpression {
|
|
|
3034
3015
|
$unknown?: never;
|
|
3035
3016
|
}
|
|
3036
3017
|
/**
|
|
3037
|
-
*
|
|
3018
|
+
* Filters by a specified search term.
|
|
3038
3019
|
* @public
|
|
3039
3020
|
*/
|
|
3040
3021
|
interface SearchTermFilterMember {
|
|
@@ -3047,7 +3028,7 @@ export declare namespace SearchFilterExpression {
|
|
|
3047
3028
|
$unknown?: never;
|
|
3048
3029
|
}
|
|
3049
3030
|
/**
|
|
3050
|
-
*
|
|
3031
|
+
* Filters by a string.
|
|
3051
3032
|
* @public
|
|
3052
3033
|
*/
|
|
3053
3034
|
interface StringFilterMember {
|
|
@@ -3060,7 +3041,7 @@ export declare namespace SearchFilterExpression {
|
|
|
3060
3041
|
$unknown?: never;
|
|
3061
3042
|
}
|
|
3062
3043
|
/**
|
|
3063
|
-
*
|
|
3044
|
+
* Filters by a list of strings.
|
|
3064
3045
|
* @public
|
|
3065
3046
|
*/
|
|
3066
3047
|
interface StringListFilterMember {
|
|
@@ -3073,7 +3054,7 @@ export declare namespace SearchFilterExpression {
|
|
|
3073
3054
|
$unknown?: never;
|
|
3074
3055
|
}
|
|
3075
3056
|
/**
|
|
3076
|
-
*
|
|
3057
|
+
* Filters by group.
|
|
3077
3058
|
* @public
|
|
3078
3059
|
*/
|
|
3079
3060
|
interface GroupFilterMember {
|
|
@@ -3112,171 +3093,167 @@ export declare namespace SearchFilterExpression {
|
|
|
3112
3093
|
}
|
|
3113
3094
|
}
|
|
3114
3095
|
/**
|
|
3115
|
-
*
|
|
3096
|
+
* The search terms for a resource.
|
|
3116
3097
|
* @public
|
|
3117
3098
|
*/
|
|
3118
3099
|
export interface SearchGroupedFilterExpressions {
|
|
3119
3100
|
/**
|
|
3120
|
-
*
|
|
3101
|
+
* The filters to use for the search.
|
|
3121
3102
|
* @public
|
|
3122
3103
|
*/
|
|
3123
3104
|
filters: SearchFilterExpression[] | undefined;
|
|
3124
3105
|
/**
|
|
3125
|
-
*
|
|
3106
|
+
* The operators to include in the search.
|
|
3126
3107
|
* @public
|
|
3127
3108
|
*/
|
|
3128
3109
|
operator: LogicalOperator | undefined;
|
|
3129
3110
|
}
|
|
3130
3111
|
/**
|
|
3131
|
-
* Shared input fields for all Search operations (filterExpressions, sortExpressions, itemOffset, pageSize).
|
|
3132
3112
|
* @public
|
|
3133
3113
|
*/
|
|
3134
3114
|
export interface SearchJobsRequest {
|
|
3135
3115
|
/**
|
|
3136
|
-
*
|
|
3116
|
+
* The farm ID of the job.
|
|
3137
3117
|
* @public
|
|
3138
3118
|
*/
|
|
3139
3119
|
farmId: string | undefined;
|
|
3140
3120
|
/**
|
|
3141
|
-
*
|
|
3121
|
+
* The search terms for a resource.
|
|
3142
3122
|
* @public
|
|
3143
3123
|
*/
|
|
3144
3124
|
filterExpressions?: SearchGroupedFilterExpressions | undefined;
|
|
3145
3125
|
/**
|
|
3146
|
-
*
|
|
3126
|
+
* The search terms for a resource.
|
|
3147
3127
|
* @public
|
|
3148
3128
|
*/
|
|
3149
3129
|
sortExpressions?: SearchSortExpression[] | undefined;
|
|
3150
3130
|
/**
|
|
3151
|
-
*
|
|
3131
|
+
* The offset for the search results.
|
|
3152
3132
|
* @public
|
|
3153
3133
|
*/
|
|
3154
3134
|
itemOffset: number | undefined;
|
|
3155
3135
|
/**
|
|
3156
|
-
*
|
|
3136
|
+
* Specifies the number of results to return.
|
|
3157
3137
|
* @public
|
|
3158
3138
|
*/
|
|
3159
3139
|
pageSize?: number | undefined;
|
|
3160
3140
|
/**
|
|
3161
|
-
*
|
|
3141
|
+
* The queue ID to use in the job search.
|
|
3162
3142
|
* @public
|
|
3163
3143
|
*/
|
|
3164
3144
|
queueIds: string[] | undefined;
|
|
3165
3145
|
}
|
|
3166
3146
|
/**
|
|
3167
|
-
* Shared input fields for all Search operations (filterExpressions, sortExpressions, itemOffset, pageSize).
|
|
3168
3147
|
* @public
|
|
3169
3148
|
*/
|
|
3170
3149
|
export interface SearchStepsRequest {
|
|
3171
3150
|
/**
|
|
3172
|
-
*
|
|
3151
|
+
* The farm ID to use for the step search.
|
|
3173
3152
|
* @public
|
|
3174
3153
|
*/
|
|
3175
3154
|
farmId: string | undefined;
|
|
3176
3155
|
/**
|
|
3177
|
-
*
|
|
3156
|
+
* The search terms for a resource.
|
|
3178
3157
|
* @public
|
|
3179
3158
|
*/
|
|
3180
3159
|
filterExpressions?: SearchGroupedFilterExpressions | undefined;
|
|
3181
3160
|
/**
|
|
3182
|
-
*
|
|
3161
|
+
* The search terms for a resource.
|
|
3183
3162
|
* @public
|
|
3184
3163
|
*/
|
|
3185
3164
|
sortExpressions?: SearchSortExpression[] | undefined;
|
|
3186
3165
|
/**
|
|
3187
|
-
*
|
|
3166
|
+
* The offset for the search results.
|
|
3188
3167
|
* @public
|
|
3189
3168
|
*/
|
|
3190
3169
|
itemOffset: number | undefined;
|
|
3191
3170
|
/**
|
|
3192
|
-
*
|
|
3171
|
+
* Specifies the number of results to return.
|
|
3193
3172
|
* @public
|
|
3194
3173
|
*/
|
|
3195
3174
|
pageSize?: number | undefined;
|
|
3196
3175
|
/**
|
|
3197
|
-
*
|
|
3176
|
+
* The queue IDs in the step search.
|
|
3198
3177
|
* @public
|
|
3199
3178
|
*/
|
|
3200
3179
|
queueIds: string[] | undefined;
|
|
3201
3180
|
/**
|
|
3202
|
-
*
|
|
3181
|
+
* The job ID to use in the step search.
|
|
3203
3182
|
* @public
|
|
3204
3183
|
*/
|
|
3205
3184
|
jobId?: string | undefined;
|
|
3206
3185
|
}
|
|
3207
3186
|
/**
|
|
3208
|
-
* Shared input fields for all Search operations (filterExpressions, sortExpressions, itemOffset, pageSize).
|
|
3209
3187
|
* @public
|
|
3210
3188
|
*/
|
|
3211
3189
|
export interface SearchTasksRequest {
|
|
3212
3190
|
/**
|
|
3213
|
-
*
|
|
3191
|
+
* The farm ID of the task.
|
|
3214
3192
|
* @public
|
|
3215
3193
|
*/
|
|
3216
3194
|
farmId: string | undefined;
|
|
3217
3195
|
/**
|
|
3218
|
-
*
|
|
3196
|
+
* The search terms for a resource.
|
|
3219
3197
|
* @public
|
|
3220
3198
|
*/
|
|
3221
3199
|
filterExpressions?: SearchGroupedFilterExpressions | undefined;
|
|
3222
3200
|
/**
|
|
3223
|
-
*
|
|
3201
|
+
* The search terms for a resource.
|
|
3224
3202
|
* @public
|
|
3225
3203
|
*/
|
|
3226
3204
|
sortExpressions?: SearchSortExpression[] | undefined;
|
|
3227
3205
|
/**
|
|
3228
|
-
*
|
|
3206
|
+
* The offset for the search results.
|
|
3229
3207
|
* @public
|
|
3230
3208
|
*/
|
|
3231
3209
|
itemOffset: number | undefined;
|
|
3232
3210
|
/**
|
|
3233
|
-
*
|
|
3211
|
+
* Specifies the number of results to return.
|
|
3234
3212
|
* @public
|
|
3235
3213
|
*/
|
|
3236
3214
|
pageSize?: number | undefined;
|
|
3237
3215
|
/**
|
|
3238
|
-
*
|
|
3216
|
+
* The queue IDs to include in the search.
|
|
3239
3217
|
* @public
|
|
3240
3218
|
*/
|
|
3241
3219
|
queueIds: string[] | undefined;
|
|
3242
3220
|
/**
|
|
3243
|
-
*
|
|
3221
|
+
* The job ID for the task search.
|
|
3244
3222
|
* @public
|
|
3245
3223
|
*/
|
|
3246
3224
|
jobId?: string | undefined;
|
|
3247
3225
|
}
|
|
3248
3226
|
/**
|
|
3249
|
-
* Shared input fields for all Search operations (filterExpressions, sortExpressions, itemOffset, pageSize).
|
|
3250
3227
|
* @public
|
|
3251
3228
|
*/
|
|
3252
3229
|
export interface SearchWorkersRequest {
|
|
3253
3230
|
/**
|
|
3254
|
-
*
|
|
3231
|
+
* The farm ID in the workers search.
|
|
3255
3232
|
* @public
|
|
3256
3233
|
*/
|
|
3257
3234
|
farmId: string | undefined;
|
|
3258
3235
|
/**
|
|
3259
|
-
*
|
|
3236
|
+
* The search terms for a resource.
|
|
3260
3237
|
* @public
|
|
3261
3238
|
*/
|
|
3262
3239
|
filterExpressions?: SearchGroupedFilterExpressions | undefined;
|
|
3263
3240
|
/**
|
|
3264
|
-
*
|
|
3241
|
+
* The search terms for a resource.
|
|
3265
3242
|
* @public
|
|
3266
3243
|
*/
|
|
3267
3244
|
sortExpressions?: SearchSortExpression[] | undefined;
|
|
3268
3245
|
/**
|
|
3269
|
-
*
|
|
3246
|
+
* The offset for the search results.
|
|
3270
3247
|
* @public
|
|
3271
3248
|
*/
|
|
3272
3249
|
itemOffset: number | undefined;
|
|
3273
3250
|
/**
|
|
3274
|
-
*
|
|
3251
|
+
* Specifies the number of results to return.
|
|
3275
3252
|
* @public
|
|
3276
3253
|
*/
|
|
3277
3254
|
pageSize?: number | undefined;
|
|
3278
3255
|
/**
|
|
3279
|
-
*
|
|
3256
|
+
* The fleet ID of the workers to search for.
|
|
3280
3257
|
* @public
|
|
3281
3258
|
*/
|
|
3282
3259
|
fleetIds: string[] | undefined;
|