@aws-sdk/client-deadline 3.864.0 → 3.865.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 +8 -1
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +2 -0
- package/dist-es/models/models_0.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +2 -0
- package/dist-types/Deadline.d.ts +8 -1
- package/dist-types/DeadlineClient.d.ts +8 -1
- package/dist-types/commands/AssociateMemberToFarmCommand.d.ts +4 -2
- package/dist-types/commands/AssociateMemberToFleetCommand.d.ts +4 -2
- package/dist-types/commands/AssociateMemberToJobCommand.d.ts +4 -2
- package/dist-types/commands/AssociateMemberToQueueCommand.d.ts +4 -2
- package/dist-types/commands/AssumeFleetRoleForReadCommand.d.ts +4 -2
- package/dist-types/commands/AssumeFleetRoleForWorkerCommand.d.ts +4 -2
- package/dist-types/commands/AssumeQueueRoleForReadCommand.d.ts +4 -2
- package/dist-types/commands/AssumeQueueRoleForUserCommand.d.ts +2 -1
- package/dist-types/commands/AssumeQueueRoleForWorkerCommand.d.ts +4 -2
- package/dist-types/commands/BatchGetJobEntityCommand.d.ts +2 -1
- package/dist-types/commands/CopyJobTemplateCommand.d.ts +2 -1
- package/dist-types/commands/CreateBudgetCommand.d.ts +4 -2
- package/dist-types/commands/CreateFarmCommand.d.ts +8 -3
- package/dist-types/commands/CreateFleetCommand.d.ts +8 -4
- package/dist-types/commands/CreateJobCommand.d.ts +7 -3
- package/dist-types/commands/CreateLicenseEndpointCommand.d.ts +8 -4
- package/dist-types/commands/CreateLimitCommand.d.ts +9 -3
- package/dist-types/commands/CreateMonitorCommand.d.ts +7 -3
- package/dist-types/commands/CreateQueueCommand.d.ts +6 -3
- package/dist-types/commands/CreateQueueEnvironmentCommand.d.ts +4 -2
- package/dist-types/commands/CreateQueueFleetAssociationCommand.d.ts +2 -1
- package/dist-types/commands/CreateQueueLimitAssociationCommand.d.ts +6 -2
- package/dist-types/commands/CreateStorageProfileCommand.d.ts +6 -3
- package/dist-types/commands/CreateWorkerCommand.d.ts +15 -3
- package/dist-types/commands/DeleteBudgetCommand.d.ts +2 -1
- package/dist-types/commands/DeleteFarmCommand.d.ts +2 -1
- package/dist-types/commands/DeleteFleetCommand.d.ts +4 -2
- package/dist-types/commands/DeleteLicenseEndpointCommand.d.ts +4 -2
- package/dist-types/commands/DeleteLimitCommand.d.ts +5 -2
- package/dist-types/commands/DeleteMeteredProductCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMonitorCommand.d.ts +4 -2
- package/dist-types/commands/DeleteQueueCommand.d.ts +9 -3
- package/dist-types/commands/DeleteQueueEnvironmentCommand.d.ts +2 -1
- package/dist-types/commands/DeleteQueueFleetAssociationCommand.d.ts +4 -2
- package/dist-types/commands/DeleteQueueLimitAssociationCommand.d.ts +10 -3
- package/dist-types/commands/DeleteStorageProfileCommand.d.ts +2 -1
- package/dist-types/commands/DeleteWorkerCommand.d.ts +4 -2
- package/dist-types/commands/DisassociateMemberFromFarmCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateMemberFromFleetCommand.d.ts +4 -2
- package/dist-types/commands/DisassociateMemberFromJobCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateMemberFromQueueCommand.d.ts +4 -2
- package/dist-types/commands/GetBudgetCommand.d.ts +2 -1
- package/dist-types/commands/GetFarmCommand.d.ts +2 -1
- package/dist-types/commands/GetFleetCommand.d.ts +5 -3
- package/dist-types/commands/GetJobCommand.d.ts +2 -1
- package/dist-types/commands/GetLicenseEndpointCommand.d.ts +2 -1
- package/dist-types/commands/GetLimitCommand.d.ts +2 -1
- package/dist-types/commands/GetMonitorCommand.d.ts +2 -1
- package/dist-types/commands/GetQueueCommand.d.ts +2 -1
- package/dist-types/commands/GetQueueEnvironmentCommand.d.ts +2 -1
- package/dist-types/commands/GetQueueFleetAssociationCommand.d.ts +2 -1
- package/dist-types/commands/GetQueueLimitAssociationCommand.d.ts +2 -1
- package/dist-types/commands/GetSessionActionCommand.d.ts +2 -1
- package/dist-types/commands/GetSessionCommand.d.ts +2 -1
- package/dist-types/commands/GetSessionsStatisticsAggregationCommand.d.ts +6 -2
- package/dist-types/commands/GetStepCommand.d.ts +2 -1
- package/dist-types/commands/GetStorageProfileCommand.d.ts +2 -1
- package/dist-types/commands/GetStorageProfileForQueueCommand.d.ts +2 -1
- package/dist-types/commands/GetTaskCommand.d.ts +2 -1
- package/dist-types/commands/GetWorkerCommand.d.ts +2 -1
- package/dist-types/commands/ListBudgetsCommand.d.ts +2 -1
- package/dist-types/commands/ListFarmMembersCommand.d.ts +2 -1
- package/dist-types/commands/ListFarmsCommand.d.ts +2 -1
- package/dist-types/commands/ListFleetMembersCommand.d.ts +2 -1
- package/dist-types/commands/ListFleetsCommand.d.ts +6 -4
- package/dist-types/commands/ListJobMembersCommand.d.ts +2 -1
- package/dist-types/commands/ListJobParameterDefinitionsCommand.d.ts +2 -1
- package/dist-types/commands/ListJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListLicenseEndpointsCommand.d.ts +2 -1
- package/dist-types/commands/ListLimitsCommand.d.ts +2 -1
- package/dist-types/commands/ListMeteredProductsCommand.d.ts +2 -1
- package/dist-types/commands/ListMonitorsCommand.d.ts +2 -1
- package/dist-types/commands/ListQueueEnvironmentsCommand.d.ts +2 -1
- package/dist-types/commands/ListQueueMembersCommand.d.ts +2 -1
- package/dist-types/commands/ListQueuesCommand.d.ts +2 -1
- package/dist-types/commands/ListSessionActionsCommand.d.ts +2 -1
- package/dist-types/commands/ListSessionsCommand.d.ts +2 -1
- package/dist-types/commands/ListSessionsForWorkerCommand.d.ts +2 -1
- package/dist-types/commands/ListStepConsumersCommand.d.ts +2 -1
- package/dist-types/commands/ListStepDependenciesCommand.d.ts +2 -1
- package/dist-types/commands/ListStepsCommand.d.ts +2 -1
- package/dist-types/commands/ListStorageProfilesCommand.d.ts +2 -1
- package/dist-types/commands/ListStorageProfilesForQueueCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListTasksCommand.d.ts +2 -1
- package/dist-types/commands/ListWorkersCommand.d.ts +2 -1
- package/dist-types/commands/PutMeteredProductCommand.d.ts +2 -1
- package/dist-types/commands/SearchJobsCommand.d.ts +2 -1
- package/dist-types/commands/SearchStepsCommand.d.ts +2 -1
- package/dist-types/commands/SearchTasksCommand.d.ts +2 -1
- package/dist-types/commands/SearchWorkersCommand.d.ts +2 -1
- package/dist-types/commands/StartSessionsStatisticsAggregationCommand.d.ts +9 -2
- package/dist-types/commands/TagResourceCommand.d.ts +4 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -2
- package/dist-types/commands/UpdateBudgetCommand.d.ts +2 -1
- package/dist-types/commands/UpdateFarmCommand.d.ts +2 -1
- package/dist-types/commands/UpdateFleetCommand.d.ts +5 -3
- package/dist-types/commands/UpdateJobCommand.d.ts +11 -3
- package/dist-types/commands/UpdateLimitCommand.d.ts +2 -1
- package/dist-types/commands/UpdateMonitorCommand.d.ts +4 -2
- package/dist-types/commands/UpdateQueueCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueEnvironmentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueFleetAssociationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQueueLimitAssociationCommand.d.ts +5 -2
- package/dist-types/commands/UpdateSessionCommand.d.ts +4 -2
- package/dist-types/commands/UpdateStepCommand.d.ts +4 -2
- package/dist-types/commands/UpdateStorageProfileCommand.d.ts +2 -1
- package/dist-types/commands/UpdateTaskCommand.d.ts +4 -2
- package/dist-types/commands/UpdateWorkerCommand.d.ts +4 -2
- package/dist-types/commands/UpdateWorkerScheduleCommand.d.ts +4 -2
- package/dist-types/index.d.ts +8 -1
- package/dist-types/models/models_0.d.ts +477 -98
- package/dist-types/models/models_1.d.ts +350 -50
- package/dist-types/ts3.4/models/models_0.d.ts +4 -0
- package/package.json +1 -1
|
@@ -2,7 +2,8 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
3
|
import { DeadlineServiceException as __BaseException } from "./DeadlineServiceException";
|
|
4
4
|
/**
|
|
5
|
-
* <p>Defines the maximum and minimum number of GPU accelerators required for a worker
|
|
5
|
+
* <p>Defines the maximum and minimum number of GPU accelerators required for a worker
|
|
6
|
+
* instance..</p>
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
8
9
|
export interface AcceleratorCountRange {
|
|
@@ -37,23 +38,71 @@ export type AcceleratorName = (typeof AcceleratorName)[keyof typeof AcceleratorN
|
|
|
37
38
|
*/
|
|
38
39
|
export interface AcceleratorSelection {
|
|
39
40
|
/**
|
|
40
|
-
* <p>The name of the chip used by the GPU accelerator.</p>
|
|
41
|
+
* <p>The name of the chip used by the GPU accelerator.</p>
|
|
42
|
+
* <p>If you specify <code>l4</code> as the name of the accelerator, you must specify
|
|
43
|
+
* <code>latest</code> or <code>grid:r570</code> as the runtime.</p>
|
|
44
|
+
* <p>The available GPU accelerators are:</p>
|
|
45
|
+
* <ul>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <code>t4</code> - NVIDIA T4 Tensor Core GPU</p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <code>a10g</code> - NVIDIA A10G Tensor Core GPU</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>
|
|
56
|
+
* <code>l4</code> - NVIDIA L4 Tensor Core GPU</p>
|
|
57
|
+
* </li>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>
|
|
60
|
+
* <code>l40s</code> - NVIDIA L40S Tensor Core GPU</p>
|
|
61
|
+
* </li>
|
|
62
|
+
* </ul>
|
|
41
63
|
* @public
|
|
42
64
|
*/
|
|
43
65
|
name: AcceleratorName | undefined;
|
|
44
66
|
/**
|
|
45
|
-
* <p>Specifies the runtime driver to use for the GPU accelerator. You must use the same
|
|
67
|
+
* <p>Specifies the runtime driver to use for the GPU accelerator. You must use the same
|
|
68
|
+
* runtime for all GPUs. </p>
|
|
69
|
+
* <p>You can choose from the following runtimes:</p>
|
|
70
|
+
* <ul>
|
|
71
|
+
* <li>
|
|
72
|
+
* <p>
|
|
73
|
+
* <code>latest</code> - Use the latest runtime available for the chip. If you
|
|
74
|
+
* specify <code>latest</code> and a new version of the runtime is released, the new
|
|
75
|
+
* version of the runtime is used.</p>
|
|
76
|
+
* </li>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>
|
|
79
|
+
* <code>grid:r570</code> - <a href="https://docs.nvidia.com/vgpu/18.0/index.html">NVIDIA vGPU software 18</a>
|
|
80
|
+
* </p>
|
|
81
|
+
* </li>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>
|
|
84
|
+
* <code>grid:r535</code> - <a href="https://docs.nvidia.com/vgpu/16.0/index.html">NVIDIA vGPU software 16</a>
|
|
85
|
+
* </p>
|
|
86
|
+
* </li>
|
|
87
|
+
* </ul>
|
|
88
|
+
* <p>If you don't specify a runtime, Deadline Cloud uses <code>latest</code> as the default. However,
|
|
89
|
+
* if you have multiple accelerators and specify <code>latest</code> for some and leave others
|
|
90
|
+
* blank, Deadline Cloud raises an exception.</p>
|
|
46
91
|
* @public
|
|
47
92
|
*/
|
|
48
93
|
runtime?: string | undefined;
|
|
49
94
|
}
|
|
50
95
|
/**
|
|
51
|
-
* <p>Provides information about the GPU accelerators used for jobs processed by a
|
|
96
|
+
* <p>Provides information about the GPU accelerators used for jobs processed by a
|
|
97
|
+
* fleet.</p>
|
|
52
98
|
* @public
|
|
53
99
|
*/
|
|
54
100
|
export interface AcceleratorCapabilities {
|
|
55
101
|
/**
|
|
56
|
-
* <p>A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances
|
|
102
|
+
* <p>A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances
|
|
103
|
+
* that provide these capabilities will be used. For example, if you specify both L4 and T4
|
|
104
|
+
* chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip
|
|
105
|
+
* installed.</p>
|
|
57
106
|
* @public
|
|
58
107
|
*/
|
|
59
108
|
selections: AcceleratorSelection[] | undefined;
|
|
@@ -64,7 +113,8 @@ export interface AcceleratorCapabilities {
|
|
|
64
113
|
count?: AcceleratorCountRange | undefined;
|
|
65
114
|
}
|
|
66
115
|
/**
|
|
67
|
-
* <p>Defines the maximum and minimum amount of memory, in MiB, to use for the
|
|
116
|
+
* <p>Defines the maximum and minimum amount of memory, in MiB, to use for the
|
|
117
|
+
* accelerator.</p>
|
|
68
118
|
* @public
|
|
69
119
|
*/
|
|
70
120
|
export interface AcceleratorTotalMemoryMiBRange {
|
|
@@ -530,7 +580,8 @@ export declare const ServiceQuotaExceededExceptionReason: {
|
|
|
530
580
|
*/
|
|
531
581
|
export type ServiceQuotaExceededExceptionReason = (typeof ServiceQuotaExceededExceptionReason)[keyof typeof ServiceQuotaExceededExceptionReason];
|
|
532
582
|
/**
|
|
533
|
-
* <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
|
|
583
|
+
* <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
|
|
584
|
+
* maximum number of service resources or operations for your Amazon Web Services account.</p>
|
|
534
585
|
* @public
|
|
535
586
|
*/
|
|
536
587
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
@@ -637,7 +688,8 @@ export declare const ValidationExceptionReason: {
|
|
|
637
688
|
*/
|
|
638
689
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
639
690
|
/**
|
|
640
|
-
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
691
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
692
|
+
* unsupported characters.</p>
|
|
641
693
|
* @public
|
|
642
694
|
*/
|
|
643
695
|
export declare class ValidationException extends __BaseException {
|
|
@@ -885,7 +937,8 @@ export declare const ConflictExceptionReason: {
|
|
|
885
937
|
*/
|
|
886
938
|
export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
|
|
887
939
|
/**
|
|
888
|
-
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
940
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
941
|
+
* than one operation on the same resource at the same time.</p>
|
|
889
942
|
* @public
|
|
890
943
|
*/
|
|
891
944
|
export declare class ConflictException extends __BaseException {
|
|
@@ -1233,12 +1286,14 @@ export declare namespace JobEntityIdentifiersUnion {
|
|
|
1233
1286
|
*/
|
|
1234
1287
|
export interface BatchGetJobEntityRequest {
|
|
1235
1288
|
/**
|
|
1236
|
-
* <p>The farm ID of the worker that's fetching job details. The worker must have an
|
|
1289
|
+
* <p>The farm ID of the worker that's fetching job details. The worker must have an
|
|
1290
|
+
* assignment on a job to fetch job details.</p>
|
|
1237
1291
|
* @public
|
|
1238
1292
|
*/
|
|
1239
1293
|
farmId: string | undefined;
|
|
1240
1294
|
/**
|
|
1241
|
-
* <p>The fleet ID of the worker that's fetching job details. The worker must have an
|
|
1295
|
+
* <p>The fleet ID of the worker that's fetching job details. The worker must have an
|
|
1296
|
+
* assignment on a job to fetch job details.</p>
|
|
1242
1297
|
* @public
|
|
1243
1298
|
*/
|
|
1244
1299
|
fleetId: string | undefined;
|
|
@@ -1371,7 +1426,8 @@ export interface JobRunAsUser {
|
|
|
1371
1426
|
*/
|
|
1372
1427
|
windows?: WindowsUser | undefined;
|
|
1373
1428
|
/**
|
|
1374
|
-
* <p>Specifies whether the job should run using the queue's system user or if the job should
|
|
1429
|
+
* <p>Specifies whether the job should run using the queue's system user or if the job should
|
|
1430
|
+
* run using the worker agent system user.</p>
|
|
1375
1431
|
* @public
|
|
1376
1432
|
*/
|
|
1377
1433
|
runAs: RunAs | undefined;
|
|
@@ -1843,7 +1899,10 @@ export interface BudgetActionToAdd {
|
|
|
1843
1899
|
*/
|
|
1844
1900
|
thresholdPercentage: number | undefined;
|
|
1845
1901
|
/**
|
|
1846
|
-
* <p>A description for the budget action to add.</p>
|
|
1902
|
+
* <p>A description for the budget action to add.</p>
|
|
1903
|
+
* <important>
|
|
1904
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
1905
|
+
* </important>
|
|
1847
1906
|
* @public
|
|
1848
1907
|
*/
|
|
1849
1908
|
description?: string | undefined;
|
|
@@ -1960,12 +2019,18 @@ export interface CreateBudgetRequest {
|
|
|
1960
2019
|
*/
|
|
1961
2020
|
usageTrackingResource: UsageTrackingResource | undefined;
|
|
1962
2021
|
/**
|
|
1963
|
-
* <p>The display name of the budget.</p>
|
|
2022
|
+
* <p>The display name of the budget.</p>
|
|
2023
|
+
* <important>
|
|
2024
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2025
|
+
* </important>
|
|
1964
2026
|
* @public
|
|
1965
2027
|
*/
|
|
1966
2028
|
displayName: string | undefined;
|
|
1967
2029
|
/**
|
|
1968
|
-
* <p>The description of the budget.</p>
|
|
2030
|
+
* <p>The description of the budget.</p>
|
|
2031
|
+
* <important>
|
|
2032
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2033
|
+
* </important>
|
|
1969
2034
|
* @public
|
|
1970
2035
|
*/
|
|
1971
2036
|
description?: string | undefined;
|
|
@@ -2046,7 +2111,10 @@ export interface ResponseBudgetAction {
|
|
|
2046
2111
|
*/
|
|
2047
2112
|
thresholdPercentage: number | undefined;
|
|
2048
2113
|
/**
|
|
2049
|
-
* <p>The budget action description.</p>
|
|
2114
|
+
* <p>The budget action description.</p>
|
|
2115
|
+
* <important>
|
|
2116
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2117
|
+
* </important>
|
|
2050
2118
|
* @public
|
|
2051
2119
|
*/
|
|
2052
2120
|
description?: string | undefined;
|
|
@@ -2089,17 +2157,34 @@ export interface GetBudgetResponse {
|
|
|
2089
2157
|
*/
|
|
2090
2158
|
usageTrackingResource: UsageTrackingResource | undefined;
|
|
2091
2159
|
/**
|
|
2092
|
-
* <p>The status of the budget.</p>
|
|
2160
|
+
* <p>The status of the budget.</p>
|
|
2161
|
+
* <ul>
|
|
2162
|
+
* <li>
|
|
2163
|
+
* <p>
|
|
2164
|
+
* <code>ACTIVE</code>–Get a budget being evaluated.</p>
|
|
2165
|
+
* </li>
|
|
2166
|
+
* <li>
|
|
2167
|
+
* <p>
|
|
2168
|
+
* <code>INACTIVE</code>–Get an inactive budget. This can include expired,
|
|
2169
|
+
* canceled, or deleted statuses.</p>
|
|
2170
|
+
* </li>
|
|
2171
|
+
* </ul>
|
|
2093
2172
|
* @public
|
|
2094
2173
|
*/
|
|
2095
2174
|
status: BudgetStatus | undefined;
|
|
2096
2175
|
/**
|
|
2097
|
-
* <p>The display name of the budget.</p>
|
|
2176
|
+
* <p>The display name of the budget.</p>
|
|
2177
|
+
* <important>
|
|
2178
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2179
|
+
* </important>
|
|
2098
2180
|
* @public
|
|
2099
2181
|
*/
|
|
2100
2182
|
displayName: string | undefined;
|
|
2101
2183
|
/**
|
|
2102
|
-
* <p>The description of the budget.</p>
|
|
2184
|
+
* <p>The description of the budget.</p>
|
|
2185
|
+
* <important>
|
|
2186
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2187
|
+
* </important>
|
|
2103
2188
|
* @public
|
|
2104
2189
|
*/
|
|
2105
2190
|
description?: string | undefined;
|
|
@@ -2190,17 +2275,34 @@ export interface BudgetSummary {
|
|
|
2190
2275
|
*/
|
|
2191
2276
|
usageTrackingResource: UsageTrackingResource | undefined;
|
|
2192
2277
|
/**
|
|
2193
|
-
* <p>The status of the budget.</p>
|
|
2278
|
+
* <p>The status of the budget.</p>
|
|
2279
|
+
* <ul>
|
|
2280
|
+
* <li>
|
|
2281
|
+
* <p>
|
|
2282
|
+
* <code>ACTIVE</code>–The budget is being evaluated.</p>
|
|
2283
|
+
* </li>
|
|
2284
|
+
* <li>
|
|
2285
|
+
* <p>
|
|
2286
|
+
* <code>INACTIVE</code>–The budget is inactive. This can include Expired,
|
|
2287
|
+
* Canceled, or deleted Deleted statuses.</p>
|
|
2288
|
+
* </li>
|
|
2289
|
+
* </ul>
|
|
2194
2290
|
* @public
|
|
2195
2291
|
*/
|
|
2196
2292
|
status: BudgetStatus | undefined;
|
|
2197
2293
|
/**
|
|
2198
|
-
* <p>The display name of the budget summary to update.</p>
|
|
2294
|
+
* <p>The display name of the budget summary to update.</p>
|
|
2295
|
+
* <important>
|
|
2296
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2297
|
+
* </important>
|
|
2199
2298
|
* @public
|
|
2200
2299
|
*/
|
|
2201
2300
|
displayName: string | undefined;
|
|
2202
2301
|
/**
|
|
2203
|
-
* <p>The description of the budget summary.</p>
|
|
2302
|
+
* <p>The description of the budget summary.</p>
|
|
2303
|
+
* <important>
|
|
2304
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2305
|
+
* </important>
|
|
2204
2306
|
*
|
|
2205
2307
|
* @deprecated
|
|
2206
2308
|
* @public
|
|
@@ -2272,17 +2374,34 @@ export interface UpdateBudgetRequest {
|
|
|
2272
2374
|
*/
|
|
2273
2375
|
budgetId: string | undefined;
|
|
2274
2376
|
/**
|
|
2275
|
-
* <p>The display name of the budget to update.</p>
|
|
2377
|
+
* <p>The display name of the budget to update.</p>
|
|
2378
|
+
* <important>
|
|
2379
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2380
|
+
* </important>
|
|
2276
2381
|
* @public
|
|
2277
2382
|
*/
|
|
2278
2383
|
displayName?: string | undefined;
|
|
2279
2384
|
/**
|
|
2280
|
-
* <p>The description of the budget to update.</p>
|
|
2385
|
+
* <p>The description of the budget to update.</p>
|
|
2386
|
+
* <important>
|
|
2387
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2388
|
+
* </important>
|
|
2281
2389
|
* @public
|
|
2282
2390
|
*/
|
|
2283
2391
|
description?: string | undefined;
|
|
2284
2392
|
/**
|
|
2285
|
-
* <p>Updates the status of the budget.</p>
|
|
2393
|
+
* <p>Updates the status of the budget.</p>
|
|
2394
|
+
* <ul>
|
|
2395
|
+
* <li>
|
|
2396
|
+
* <p>
|
|
2397
|
+
* <code>ACTIVE</code>–The budget is being evaluated.</p>
|
|
2398
|
+
* </li>
|
|
2399
|
+
* <li>
|
|
2400
|
+
* <p>
|
|
2401
|
+
* <code>INACTIVE</code>–The budget is inactive. This can include Expired,
|
|
2402
|
+
* Canceled, or deleted Deleted statuses.</p>
|
|
2403
|
+
* </li>
|
|
2404
|
+
* </ul>
|
|
2286
2405
|
* @public
|
|
2287
2406
|
*/
|
|
2288
2407
|
status?: BudgetStatus | undefined;
|
|
@@ -2292,7 +2411,8 @@ export interface UpdateBudgetRequest {
|
|
|
2292
2411
|
*/
|
|
2293
2412
|
approximateDollarLimit?: number | undefined;
|
|
2294
2413
|
/**
|
|
2295
|
-
* <p>The budget actions to add. Budget actions specify what happens when the budget runs
|
|
2414
|
+
* <p>The budget actions to add. Budget actions specify what happens when the budget runs
|
|
2415
|
+
* out.</p>
|
|
2296
2416
|
* @public
|
|
2297
2417
|
*/
|
|
2298
2418
|
actionsToAdd?: BudgetActionToAdd[] | undefined;
|
|
@@ -2379,7 +2499,8 @@ export interface CopyJobTemplateRequest {
|
|
|
2379
2499
|
*/
|
|
2380
2500
|
queueId: string | undefined;
|
|
2381
2501
|
/**
|
|
2382
|
-
* <p>The Amazon S3 bucket name and key where you would like to add a copy of the job
|
|
2502
|
+
* <p>The Amazon S3 bucket name and key where you would like to add a copy of the job
|
|
2503
|
+
* template.</p>
|
|
2383
2504
|
* @public
|
|
2384
2505
|
*/
|
|
2385
2506
|
targetS3Location: S3Location | undefined;
|
|
@@ -2428,12 +2549,18 @@ export interface CreateFarmRequest {
|
|
|
2428
2549
|
*/
|
|
2429
2550
|
clientToken?: string | undefined;
|
|
2430
2551
|
/**
|
|
2431
|
-
* <p>The display name of the farm.</p>
|
|
2552
|
+
* <p>The display name of the farm.</p>
|
|
2553
|
+
* <important>
|
|
2554
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2555
|
+
* </important>
|
|
2432
2556
|
* @public
|
|
2433
2557
|
*/
|
|
2434
2558
|
displayName: string | undefined;
|
|
2435
2559
|
/**
|
|
2436
|
-
* <p>The description of the farm.</p>
|
|
2560
|
+
* <p>The description of the farm.</p>
|
|
2561
|
+
* <important>
|
|
2562
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
2563
|
+
* </important>
|
|
2437
2564
|
* @public
|
|
2438
2565
|
*/
|
|
2439
2566
|
description?: string | undefined;
|
|
@@ -2624,7 +2751,14 @@ export interface CustomerManagedFleetConfiguration {
|
|
|
2624
2751
|
*/
|
|
2625
2752
|
storageProfileId?: string | undefined;
|
|
2626
2753
|
/**
|
|
2627
|
-
* <p>Specifies whether tags associated with a fleet are attached to workers when the worker
|
|
2754
|
+
* <p>Specifies whether tags associated with a fleet are attached to workers when the worker
|
|
2755
|
+
* is launched. </p>
|
|
2756
|
+
* <p>When the <code>tagPropagationMode</code> is set to
|
|
2757
|
+
* <code>PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH</code> any tag associated with a fleet is
|
|
2758
|
+
* attached to workers when they launch. If the tags for a fleet change, the tags associated
|
|
2759
|
+
* with running workers <b>do not</b> change.</p>
|
|
2760
|
+
* <p>If you don't specify <code>tagPropagationMode</code>, the default is
|
|
2761
|
+
* <code>NO_PROPAGATION</code>.</p>
|
|
2628
2762
|
* @public
|
|
2629
2763
|
*/
|
|
2630
2764
|
tagPropagationMode?: TagPropagationMode | undefined;
|
|
@@ -2693,7 +2827,8 @@ export interface ServiceManagedEc2InstanceCapabilities {
|
|
|
2693
2827
|
*/
|
|
2694
2828
|
rootEbsVolume?: Ec2EbsVolume | undefined;
|
|
2695
2829
|
/**
|
|
2696
|
-
* <p>Describes the GPU accelerator capabilities required for worker host instances in this
|
|
2830
|
+
* <p>Describes the GPU accelerator capabilities required for worker host instances in this
|
|
2831
|
+
* fleet.</p>
|
|
2697
2832
|
* @public
|
|
2698
2833
|
*/
|
|
2699
2834
|
acceleratorCapabilities?: AcceleratorCapabilities | undefined;
|
|
@@ -2725,6 +2860,7 @@ export interface ServiceManagedEc2InstanceCapabilities {
|
|
|
2725
2860
|
export declare const Ec2MarketType: {
|
|
2726
2861
|
readonly ON_DEMAND: "on-demand";
|
|
2727
2862
|
readonly SPOT: "spot";
|
|
2863
|
+
readonly WAIT_AND_SAVE: "wait-and-save";
|
|
2728
2864
|
};
|
|
2729
2865
|
/**
|
|
2730
2866
|
* @public
|
|
@@ -2821,17 +2957,37 @@ export declare namespace FleetConfiguration {
|
|
|
2821
2957
|
const visit: <T>(value: FleetConfiguration, visitor: Visitor<T>) => T;
|
|
2822
2958
|
}
|
|
2823
2959
|
/**
|
|
2824
|
-
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
2960
|
+
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
2961
|
+
* additional configuration for workers in your fleet. </p>
|
|
2962
|
+
* <p>To remove a script from a fleet, use the <a href="https://docs.aws.amazon.com/deadline-cloud/latest/APIReference/API_UpdateFleet.html">UpdateFleet</a>
|
|
2963
|
+
* operation with the <code>hostConfiguration</code>
|
|
2964
|
+
* <code>scriptBody</code> parameter set to an empty string ("").</p>
|
|
2825
2965
|
* @public
|
|
2826
2966
|
*/
|
|
2827
2967
|
export interface HostConfiguration {
|
|
2828
2968
|
/**
|
|
2829
|
-
* <p>The text of the script that runs as a worker is starting up that you can use to provide
|
|
2969
|
+
* <p>The text of the script that runs as a worker is starting up that you can use to provide
|
|
2970
|
+
* additional configuration for workers in your fleet. The script runs after a worker enters
|
|
2971
|
+
* the <code>STARTING</code> state and before the worker processes tasks.</p>
|
|
2972
|
+
* <p>For more information about using the script, see <a href="https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/smf-admin.html">Run scripts as an
|
|
2973
|
+
* administrator to configure workers</a> in the <i>Deadline Cloud Developer
|
|
2974
|
+
* Guide</i>. </p>
|
|
2975
|
+
* <important>
|
|
2976
|
+
* <p>The script runs as an administrative user (<code>sudo root</code> on Linux, as an
|
|
2977
|
+
* Administrator on Windows). </p>
|
|
2978
|
+
* </important>
|
|
2830
2979
|
* @public
|
|
2831
2980
|
*/
|
|
2832
2981
|
scriptBody: string | undefined;
|
|
2833
2982
|
/**
|
|
2834
|
-
* <p>The maximum time that the host configuration can run. If the timeout expires, the worker
|
|
2983
|
+
* <p>The maximum time that the host configuration can run. If the timeout expires, the worker
|
|
2984
|
+
* enters the <code>NOT RESPONDING</code> state and shuts down. You are charged for the time
|
|
2985
|
+
* that the worker is running the host configuration script.</p>
|
|
2986
|
+
* <note>
|
|
2987
|
+
* <p>You should configure your fleet for a maximum of one worker while testing your host
|
|
2988
|
+
* configuration script to avoid starting additional workers.</p>
|
|
2989
|
+
* </note>
|
|
2990
|
+
* <p>The default is 300 seconds (5 minutes).</p>
|
|
2835
2991
|
* @public
|
|
2836
2992
|
*/
|
|
2837
2993
|
scriptTimeoutSeconds?: number | undefined;
|
|
@@ -2851,12 +3007,18 @@ export interface CreateFleetRequest {
|
|
|
2851
3007
|
*/
|
|
2852
3008
|
farmId: string | undefined;
|
|
2853
3009
|
/**
|
|
2854
|
-
* <p>The display name of the fleet.</p>
|
|
3010
|
+
* <p>The display name of the fleet.</p>
|
|
3011
|
+
* <important>
|
|
3012
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3013
|
+
* </important>
|
|
2855
3014
|
* @public
|
|
2856
3015
|
*/
|
|
2857
3016
|
displayName: string | undefined;
|
|
2858
3017
|
/**
|
|
2859
|
-
* <p>The description of the fleet.</p>
|
|
3018
|
+
* <p>The description of the fleet.</p>
|
|
3019
|
+
* <important>
|
|
3020
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3021
|
+
* </important>
|
|
2860
3022
|
* @public
|
|
2861
3023
|
*/
|
|
2862
3024
|
description?: string | undefined;
|
|
@@ -2871,12 +3033,20 @@ export interface CreateFleetRequest {
|
|
|
2871
3033
|
*/
|
|
2872
3034
|
minWorkerCount?: number | undefined;
|
|
2873
3035
|
/**
|
|
2874
|
-
* <p>The maximum number of workers for the fleet.</p>
|
|
3036
|
+
* <p>The maximum number of workers for the fleet.</p>
|
|
3037
|
+
* <p>Deadline Cloud limits the number of workers to less than or equal to the fleet's
|
|
3038
|
+
* maximum worker count. The service maintains eventual consistency for the worker count. If
|
|
3039
|
+
* you make multiple rapid calls to <code>CreateWorker</code> before the field updates, you
|
|
3040
|
+
* might exceed your fleet's maximum worker count. For example, if your
|
|
3041
|
+
* <code>maxWorkerCount</code> is 10 and you currently have 9 workers, making two quick
|
|
3042
|
+
* <code>CreateWorker</code> calls might successfully create 2 workers instead of 1,
|
|
3043
|
+
* resulting in 11 total workers.</p>
|
|
2875
3044
|
* @public
|
|
2876
3045
|
*/
|
|
2877
3046
|
maxWorkerCount: number | undefined;
|
|
2878
3047
|
/**
|
|
2879
|
-
* <p>The configuration settings for the fleet. Customer managed fleets are self-managed.
|
|
3048
|
+
* <p>The configuration settings for the fleet. Customer managed fleets are self-managed.
|
|
3049
|
+
* Service managed Amazon EC2 fleets are managed by Deadline Cloud.</p>
|
|
2880
3050
|
* @public
|
|
2881
3051
|
*/
|
|
2882
3052
|
configuration: FleetConfiguration | undefined;
|
|
@@ -2886,7 +3056,8 @@ export interface CreateFleetRequest {
|
|
|
2886
3056
|
*/
|
|
2887
3057
|
tags?: Record<string, string> | undefined;
|
|
2888
3058
|
/**
|
|
2889
|
-
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
3059
|
+
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
3060
|
+
* additional configuration for workers in your fleet.</p>
|
|
2890
3061
|
* @public
|
|
2891
3062
|
*/
|
|
2892
3063
|
hostConfiguration?: HostConfiguration | undefined;
|
|
@@ -2943,7 +3114,8 @@ export interface CreateJobRequest {
|
|
|
2943
3114
|
*/
|
|
2944
3115
|
templateType?: JobTemplateType | undefined;
|
|
2945
3116
|
/**
|
|
2946
|
-
* <p>The priority of the job. The highest priority (first scheduled) is 100. When two jobs
|
|
3117
|
+
* <p>The priority of the job. The highest priority (first scheduled) is 100. When two jobs
|
|
3118
|
+
* have the same priority, the oldest job is scheduled first.</p>
|
|
2947
3119
|
* @public
|
|
2948
3120
|
*/
|
|
2949
3121
|
priority: number | undefined;
|
|
@@ -2953,7 +3125,8 @@ export interface CreateJobRequest {
|
|
|
2953
3125
|
*/
|
|
2954
3126
|
parameters?: Record<string, JobParameter> | undefined;
|
|
2955
3127
|
/**
|
|
2956
|
-
* <p>The attachments for the job. Attach files required for the job to run to a render
|
|
3128
|
+
* <p>The attachments for the job. Attach files required for the job to run to a render
|
|
3129
|
+
* job.</p>
|
|
2957
3130
|
* @public
|
|
2958
3131
|
*/
|
|
2959
3132
|
attachments?: Attachments | undefined;
|
|
@@ -2963,7 +3136,8 @@ export interface CreateJobRequest {
|
|
|
2963
3136
|
*/
|
|
2964
3137
|
storageProfileId?: string | undefined;
|
|
2965
3138
|
/**
|
|
2966
|
-
* <p>The initial job status when it is created. Jobs that are created with a
|
|
3139
|
+
* <p>The initial job status when it is created. Jobs that are created with a
|
|
3140
|
+
* <code>SUSPENDED</code> status will not run until manually requeued.</p>
|
|
2967
3141
|
* @public
|
|
2968
3142
|
*/
|
|
2969
3143
|
targetTaskRunStatus?: CreateJobTargetTaskRunStatus | undefined;
|
|
@@ -2978,7 +3152,13 @@ export interface CreateJobRequest {
|
|
|
2978
3152
|
*/
|
|
2979
3153
|
maxRetriesPerTask?: number | undefined;
|
|
2980
3154
|
/**
|
|
2981
|
-
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
3155
|
+
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
3156
|
+
* <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
|
|
3157
|
+
* job, even if the fleets assigned to the job's queue has available workers.</p>
|
|
3158
|
+
* <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no
|
|
3159
|
+
* maximum number of workers.</p>
|
|
3160
|
+
* <p>If you don't specify the <code>maxWorkerCount</code>, Deadline Cloud won't throttle
|
|
3161
|
+
* the number of workers used to process the job.</p>
|
|
2982
3162
|
* @public
|
|
2983
3163
|
*/
|
|
2984
3164
|
maxWorkerCount?: number | undefined;
|
|
@@ -3048,17 +3228,26 @@ export interface CreateLimitRequest {
|
|
|
3048
3228
|
*/
|
|
3049
3229
|
clientToken?: string | undefined;
|
|
3050
3230
|
/**
|
|
3051
|
-
* <p>The display name of the limit.</p>
|
|
3231
|
+
* <p>The display name of the limit.</p>
|
|
3232
|
+
* <important>
|
|
3233
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3234
|
+
* </important>
|
|
3052
3235
|
* @public
|
|
3053
3236
|
*/
|
|
3054
3237
|
displayName: string | undefined;
|
|
3055
3238
|
/**
|
|
3056
|
-
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
3239
|
+
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
3240
|
+
* the <code>hostRequirements</code> in a step of a job template to declare the limit
|
|
3241
|
+
* requirement.</p>
|
|
3057
3242
|
* @public
|
|
3058
3243
|
*/
|
|
3059
3244
|
amountRequirementName: string | undefined;
|
|
3060
3245
|
/**
|
|
3061
|
-
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
3246
|
+
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
3247
|
+
* in use, steps that require the limit won't be scheduled until the resource is
|
|
3248
|
+
* available.</p>
|
|
3249
|
+
* <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on
|
|
3250
|
+
* the number of resources that can be acquired for this limit.</p>
|
|
3062
3251
|
* @public
|
|
3063
3252
|
*/
|
|
3064
3253
|
maxCount: number | undefined;
|
|
@@ -3068,7 +3257,11 @@ export interface CreateLimitRequest {
|
|
|
3068
3257
|
*/
|
|
3069
3258
|
farmId: string | undefined;
|
|
3070
3259
|
/**
|
|
3071
|
-
* <p>A description of the limit. A description helps you identify the purpose of the
|
|
3260
|
+
* <p>A description of the limit. A description helps you identify the purpose of the
|
|
3261
|
+
* limit.</p>
|
|
3262
|
+
* <important>
|
|
3263
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3264
|
+
* </important>
|
|
3072
3265
|
* @public
|
|
3073
3266
|
*/
|
|
3074
3267
|
description?: string | undefined;
|
|
@@ -3078,7 +3271,8 @@ export interface CreateLimitRequest {
|
|
|
3078
3271
|
*/
|
|
3079
3272
|
export interface CreateLimitResponse {
|
|
3080
3273
|
/**
|
|
3081
|
-
* <p>A unique identifier for the limit. Use this identifier in other operations, such as
|
|
3274
|
+
* <p>A unique identifier for the limit. Use this identifier in other operations, such as
|
|
3275
|
+
* <code>CreateQueueLimitAssociation</code> and <code>DeleteLimit</code>.</p>
|
|
3082
3276
|
* @public
|
|
3083
3277
|
*/
|
|
3084
3278
|
limitId: string | undefined;
|
|
@@ -3093,7 +3287,10 @@ export interface CreateMonitorRequest {
|
|
|
3093
3287
|
*/
|
|
3094
3288
|
clientToken?: string | undefined;
|
|
3095
3289
|
/**
|
|
3096
|
-
* <p>The name that you give the monitor that is displayed in the Deadline Cloud console.</p>
|
|
3290
|
+
* <p>The name that you give the monitor that is displayed in the Deadline Cloud console.</p>
|
|
3291
|
+
* <important>
|
|
3292
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3293
|
+
* </important>
|
|
3097
3294
|
* @public
|
|
3098
3295
|
*/
|
|
3099
3296
|
displayName: string | undefined;
|
|
@@ -3103,12 +3300,15 @@ export interface CreateMonitorRequest {
|
|
|
3103
3300
|
*/
|
|
3104
3301
|
identityCenterInstanceArn: string | undefined;
|
|
3105
3302
|
/**
|
|
3106
|
-
* <p>The subdomain to use when creating the monitor URL. The full URL of the monitor is
|
|
3303
|
+
* <p>The subdomain to use when creating the monitor URL. The full URL of the monitor is
|
|
3304
|
+
* subdomain.Region.deadlinecloud.amazonaws.com.</p>
|
|
3107
3305
|
* @public
|
|
3108
3306
|
*/
|
|
3109
3307
|
subdomain: string | undefined;
|
|
3110
3308
|
/**
|
|
3111
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user
|
|
3309
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user
|
|
3310
|
+
* that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud
|
|
3311
|
+
* resources.</p>
|
|
3112
3312
|
* @public
|
|
3113
3313
|
*/
|
|
3114
3314
|
roleArn: string | undefined;
|
|
@@ -3161,12 +3361,18 @@ export interface CreateQueueRequest {
|
|
|
3161
3361
|
*/
|
|
3162
3362
|
farmId: string | undefined;
|
|
3163
3363
|
/**
|
|
3164
|
-
* <p>The display name of the queue.</p>
|
|
3364
|
+
* <p>The display name of the queue.</p>
|
|
3365
|
+
* <important>
|
|
3366
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3367
|
+
* </important>
|
|
3165
3368
|
* @public
|
|
3166
3369
|
*/
|
|
3167
3370
|
displayName: string | undefined;
|
|
3168
3371
|
/**
|
|
3169
|
-
* <p>The description of the queue.</p>
|
|
3372
|
+
* <p>The description of the queue.</p>
|
|
3373
|
+
* <important>
|
|
3374
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3375
|
+
* </important>
|
|
3170
3376
|
* @public
|
|
3171
3377
|
*/
|
|
3172
3378
|
description?: string | undefined;
|
|
@@ -3176,7 +3382,8 @@ export interface CreateQueueRequest {
|
|
|
3176
3382
|
*/
|
|
3177
3383
|
defaultBudgetAction?: DefaultQueueBudgetAction | undefined;
|
|
3178
3384
|
/**
|
|
3179
|
-
* <p>The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3
|
|
3385
|
+
* <p>The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3
|
|
3386
|
+
* prefix.</p>
|
|
3180
3387
|
* @public
|
|
3181
3388
|
*/
|
|
3182
3389
|
jobAttachmentSettings?: JobAttachmentSettings | undefined;
|
|
@@ -3248,7 +3455,9 @@ export interface CreateQueueEnvironmentRequest {
|
|
|
3248
3455
|
*/
|
|
3249
3456
|
queueId: string | undefined;
|
|
3250
3457
|
/**
|
|
3251
|
-
* <p>Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the
|
|
3458
|
+
* <p>Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the
|
|
3459
|
+
* highest priority (activated first and deactivated last). If two environments share the same
|
|
3460
|
+
* priority value, the environment created first takes higher priority.</p>
|
|
3252
3461
|
* @public
|
|
3253
3462
|
*/
|
|
3254
3463
|
priority: number | undefined;
|
|
@@ -3384,7 +3593,10 @@ export interface CreateStorageProfileRequest {
|
|
|
3384
3593
|
*/
|
|
3385
3594
|
farmId: string | undefined;
|
|
3386
3595
|
/**
|
|
3387
|
-
* <p>The display name of the storage profile.</p>
|
|
3596
|
+
* <p>The display name of the storage profile.</p>
|
|
3597
|
+
* <important>
|
|
3598
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3599
|
+
* </important>
|
|
3388
3600
|
* @public
|
|
3389
3601
|
*/
|
|
3390
3602
|
displayName: string | undefined;
|
|
@@ -3532,7 +3744,8 @@ export interface DeleteQueueFleetAssociationResponse {
|
|
|
3532
3744
|
*/
|
|
3533
3745
|
export interface DeleteQueueLimitAssociationRequest {
|
|
3534
3746
|
/**
|
|
3535
|
-
* <p>The unique identifier of the farm that contains the queue and limit to
|
|
3747
|
+
* <p>The unique identifier of the farm that contains the queue and limit to
|
|
3748
|
+
* disassociate.</p>
|
|
3536
3749
|
* @public
|
|
3537
3750
|
*/
|
|
3538
3751
|
farmId: string | undefined;
|
|
@@ -3716,6 +3929,7 @@ export declare const FleetStatus: {
|
|
|
3716
3929
|
readonly ACTIVE: "ACTIVE";
|
|
3717
3930
|
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
3718
3931
|
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
3932
|
+
readonly SUSPENDED: "SUSPENDED";
|
|
3719
3933
|
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
3720
3934
|
readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
|
|
3721
3935
|
};
|
|
@@ -3738,12 +3952,18 @@ export interface GetFleetResponse {
|
|
|
3738
3952
|
*/
|
|
3739
3953
|
farmId: string | undefined;
|
|
3740
3954
|
/**
|
|
3741
|
-
* <p>The display name of the fleet.</p>
|
|
3955
|
+
* <p>The display name of the fleet.</p>
|
|
3956
|
+
* <important>
|
|
3957
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3958
|
+
* </important>
|
|
3742
3959
|
* @public
|
|
3743
3960
|
*/
|
|
3744
3961
|
displayName: string | undefined;
|
|
3745
3962
|
/**
|
|
3746
|
-
* <p>The description of the fleet.</p>
|
|
3963
|
+
* <p>The description of the fleet.</p>
|
|
3964
|
+
* <important>
|
|
3965
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
3966
|
+
* </important>
|
|
3747
3967
|
* @public
|
|
3748
3968
|
*/
|
|
3749
3969
|
description?: string | undefined;
|
|
@@ -3753,7 +3973,13 @@ export interface GetFleetResponse {
|
|
|
3753
3973
|
*/
|
|
3754
3974
|
status: FleetStatus | undefined;
|
|
3755
3975
|
/**
|
|
3756
|
-
* <p>
|
|
3976
|
+
* <p>A message that communicates a suspended status of the fleet.</p>
|
|
3977
|
+
* @public
|
|
3978
|
+
*/
|
|
3979
|
+
statusMessage?: string | undefined;
|
|
3980
|
+
/**
|
|
3981
|
+
* <p>The Auto Scaling status of the fleet. Either <code>GROWING</code>, <code>STEADY</code>, or
|
|
3982
|
+
* <code>SHRINKING</code>.</p>
|
|
3757
3983
|
* @public
|
|
3758
3984
|
*/
|
|
3759
3985
|
autoScalingStatus?: AutoScalingStatus | undefined;
|
|
@@ -3783,12 +4009,14 @@ export interface GetFleetResponse {
|
|
|
3783
4009
|
*/
|
|
3784
4010
|
configuration: FleetConfiguration | undefined;
|
|
3785
4011
|
/**
|
|
3786
|
-
* <p>The script that runs as a worker is starting up that you can use to provide additional
|
|
4012
|
+
* <p>The script that runs as a worker is starting up that you can use to provide additional
|
|
4013
|
+
* configuration for workers in your fleet.</p>
|
|
3787
4014
|
* @public
|
|
3788
4015
|
*/
|
|
3789
4016
|
hostConfiguration?: HostConfiguration | undefined;
|
|
3790
4017
|
/**
|
|
3791
|
-
* <p>Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to
|
|
4018
|
+
* <p>Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to
|
|
4019
|
+
* attribute names and values.</p>
|
|
3792
4020
|
* @public
|
|
3793
4021
|
*/
|
|
3794
4022
|
capabilities?: FleetCapabilities | undefined;
|
|
@@ -3909,7 +4137,10 @@ export interface ListFleetsRequest {
|
|
|
3909
4137
|
*/
|
|
3910
4138
|
principalId?: string | undefined;
|
|
3911
4139
|
/**
|
|
3912
|
-
* <p>The display names of a list of fleets.</p>
|
|
4140
|
+
* <p>The display names of a list of fleets.</p>
|
|
4141
|
+
* <important>
|
|
4142
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
4143
|
+
* </important>
|
|
3913
4144
|
* @public
|
|
3914
4145
|
*/
|
|
3915
4146
|
displayName?: string | undefined;
|
|
@@ -3945,7 +4176,10 @@ export interface FleetSummary {
|
|
|
3945
4176
|
*/
|
|
3946
4177
|
farmId: string | undefined;
|
|
3947
4178
|
/**
|
|
3948
|
-
* <p>The display name of the fleet summary to update.</p>
|
|
4179
|
+
* <p>The display name of the fleet summary to update.</p>
|
|
4180
|
+
* <important>
|
|
4181
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
4182
|
+
* </important>
|
|
3949
4183
|
* @public
|
|
3950
4184
|
*/
|
|
3951
4185
|
displayName: string | undefined;
|
|
@@ -3954,6 +4188,11 @@ export interface FleetSummary {
|
|
|
3954
4188
|
* @public
|
|
3955
4189
|
*/
|
|
3956
4190
|
status: FleetStatus | undefined;
|
|
4191
|
+
/**
|
|
4192
|
+
* <p>A message that communicates a suspended status of the fleet.</p>
|
|
4193
|
+
* @public
|
|
4194
|
+
*/
|
|
4195
|
+
statusMessage?: string | undefined;
|
|
3957
4196
|
/**
|
|
3958
4197
|
* <p>The Auto Scaling status of a fleet.</p>
|
|
3959
4198
|
* @public
|
|
@@ -4040,12 +4279,18 @@ export interface UpdateFleetRequest {
|
|
|
4040
4279
|
*/
|
|
4041
4280
|
fleetId: string | undefined;
|
|
4042
4281
|
/**
|
|
4043
|
-
* <p>The display name of the fleet to update.</p>
|
|
4282
|
+
* <p>The display name of the fleet to update.</p>
|
|
4283
|
+
* <important>
|
|
4284
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
4285
|
+
* </important>
|
|
4044
4286
|
* @public
|
|
4045
4287
|
*/
|
|
4046
4288
|
displayName?: string | undefined;
|
|
4047
4289
|
/**
|
|
4048
|
-
* <p>The description of the fleet to update.</p>
|
|
4290
|
+
* <p>The description of the fleet to update.</p>
|
|
4291
|
+
* <important>
|
|
4292
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
4293
|
+
* </important>
|
|
4049
4294
|
* @public
|
|
4050
4295
|
*/
|
|
4051
4296
|
description?: string | undefined;
|
|
@@ -4060,7 +4305,14 @@ export interface UpdateFleetRequest {
|
|
|
4060
4305
|
*/
|
|
4061
4306
|
minWorkerCount?: number | undefined;
|
|
4062
4307
|
/**
|
|
4063
|
-
* <p>The maximum number of workers in the fleet.</p>
|
|
4308
|
+
* <p>The maximum number of workers in the fleet.</p>
|
|
4309
|
+
* <p>Deadline Cloud limits the number of workers to less than or equal to the fleet's
|
|
4310
|
+
* maximum worker count. The service maintains eventual consistency for the worker count. If
|
|
4311
|
+
* you make multiple rapid calls to <code>CreateWorker</code> before the field updates, you
|
|
4312
|
+
* might exceed your fleet's maximum worker count. For example, if your
|
|
4313
|
+
* <code>maxWorkerCount</code> is 10 and you currently have 9 workers, making two quick
|
|
4314
|
+
* <code>CreateWorker</code> calls might successfully create 2 workers instead of 1,
|
|
4315
|
+
* resulting in 11 total workers.</p>
|
|
4064
4316
|
* @public
|
|
4065
4317
|
*/
|
|
4066
4318
|
maxWorkerCount?: number | undefined;
|
|
@@ -4070,7 +4322,8 @@ export interface UpdateFleetRequest {
|
|
|
4070
4322
|
*/
|
|
4071
4323
|
configuration?: FleetConfiguration | undefined;
|
|
4072
4324
|
/**
|
|
4073
|
-
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
4325
|
+
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
4326
|
+
* additional configuration for workers in your fleet.</p>
|
|
4074
4327
|
* @public
|
|
4075
4328
|
*/
|
|
4076
4329
|
hostConfiguration?: HostConfiguration | undefined;
|
|
@@ -4538,7 +4791,8 @@ export interface UpdateWorkerResponse {
|
|
|
4538
4791
|
*/
|
|
4539
4792
|
log?: LogConfiguration | undefined;
|
|
4540
4793
|
/**
|
|
4541
|
-
* <p>The script that runs as a worker is starting up that you can use to provide additional
|
|
4794
|
+
* <p>The script that runs as a worker is starting up that you can use to provide additional
|
|
4795
|
+
* configuration for workers in your fleet.</p>
|
|
4542
4796
|
* @public
|
|
4543
4797
|
*/
|
|
4544
4798
|
hostConfiguration?: HostConfiguration | undefined;
|
|
@@ -4560,7 +4814,8 @@ export interface TaskRunManifestPropertiesRequest {
|
|
|
4560
4814
|
outputManifestHash?: string | undefined;
|
|
4561
4815
|
}
|
|
4562
4816
|
/**
|
|
4563
|
-
* <p>The updated session action information as it relates to completion and progress of the
|
|
4817
|
+
* <p>The updated session action information as it relates to completion and progress of the
|
|
4818
|
+
* session.</p>
|
|
4564
4819
|
* @public
|
|
4565
4820
|
*/
|
|
4566
4821
|
export interface UpdatedSessionActionInfo {
|
|
@@ -4570,7 +4825,8 @@ export interface UpdatedSessionActionInfo {
|
|
|
4570
4825
|
*/
|
|
4571
4826
|
completedStatus?: CompletedStatus | undefined;
|
|
4572
4827
|
/**
|
|
4573
|
-
* <p>The process exit code. The default Deadline Cloud worker agent converts unsigned
|
|
4828
|
+
* <p>The process exit code. The default Deadline Cloud worker agent converts unsigned
|
|
4829
|
+
* 32-bit exit codes to signed 32-bit exit codes.</p>
|
|
4574
4830
|
* @public
|
|
4575
4831
|
*/
|
|
4576
4832
|
processExitCode?: number | undefined;
|
|
@@ -4600,7 +4856,8 @@ export interface UpdatedSessionActionInfo {
|
|
|
4600
4856
|
*/
|
|
4601
4857
|
progressPercent?: number | undefined;
|
|
4602
4858
|
/**
|
|
4603
|
-
* <p>A list of output manifest properties reported by the worker
|
|
4859
|
+
* <p>A list of output manifest properties reported by the worker
|
|
4860
|
+
* agent, with each entry corresponding to a manifest property in the job.</p>
|
|
4604
4861
|
* @public
|
|
4605
4862
|
*/
|
|
4606
4863
|
manifests?: TaskRunManifestPropertiesRequest[] | undefined;
|
|
@@ -4686,12 +4943,18 @@ export interface GetFarmResponse {
|
|
|
4686
4943
|
*/
|
|
4687
4944
|
farmId: string | undefined;
|
|
4688
4945
|
/**
|
|
4689
|
-
* <p>The display name of the farm.</p>
|
|
4946
|
+
* <p>The display name of the farm.</p>
|
|
4947
|
+
* <important>
|
|
4948
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
4949
|
+
* </important>
|
|
4690
4950
|
* @public
|
|
4691
4951
|
*/
|
|
4692
4952
|
displayName: string | undefined;
|
|
4693
4953
|
/**
|
|
4694
|
-
* <p>The description of the farm.</p>
|
|
4954
|
+
* <p>The description of the farm.</p>
|
|
4955
|
+
* <important>
|
|
4956
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
4957
|
+
* </important>
|
|
4695
4958
|
* @public
|
|
4696
4959
|
*/
|
|
4697
4960
|
description?: string | undefined;
|
|
@@ -4741,17 +5004,26 @@ export interface GetLimitRequest {
|
|
|
4741
5004
|
*/
|
|
4742
5005
|
export interface GetLimitResponse {
|
|
4743
5006
|
/**
|
|
4744
|
-
* <p>The display name of the limit.</p>
|
|
5007
|
+
* <p>The display name of the limit.</p>
|
|
5008
|
+
* <important>
|
|
5009
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5010
|
+
* </important>
|
|
4745
5011
|
* @public
|
|
4746
5012
|
*/
|
|
4747
5013
|
displayName: string | undefined;
|
|
4748
5014
|
/**
|
|
4749
|
-
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
5015
|
+
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
5016
|
+
* the <code>hostRequirements</code> in a step of a job template to declare the limit
|
|
5017
|
+
* requirement.</p>
|
|
4750
5018
|
* @public
|
|
4751
5019
|
*/
|
|
4752
5020
|
amountRequirementName: string | undefined;
|
|
4753
5021
|
/**
|
|
4754
|
-
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
5022
|
+
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
5023
|
+
* in use, steps that require the limit won't be scheduled until the resource is
|
|
5024
|
+
* available.</p>
|
|
5025
|
+
* <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on
|
|
5026
|
+
* the number of resources that can be acquired for this limit.</p>
|
|
4755
5027
|
* @public
|
|
4756
5028
|
*/
|
|
4757
5029
|
maxCount: number | undefined;
|
|
@@ -4786,12 +5058,16 @@ export interface GetLimitResponse {
|
|
|
4786
5058
|
*/
|
|
4787
5059
|
limitId: string | undefined;
|
|
4788
5060
|
/**
|
|
4789
|
-
* <p>The number of resources from the limit that are being used by jobs. The result is
|
|
5061
|
+
* <p>The number of resources from the limit that are being used by jobs. The result is
|
|
5062
|
+
* delayed and may not be the count at the time that you called the operation.</p>
|
|
4790
5063
|
* @public
|
|
4791
5064
|
*/
|
|
4792
5065
|
currentCount: number | undefined;
|
|
4793
5066
|
/**
|
|
4794
|
-
* <p>The description of the limit that helps identify what the limit is used for.</p>
|
|
5067
|
+
* <p>The description of the limit that helps identify what the limit is used for.</p>
|
|
5068
|
+
* <important>
|
|
5069
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5070
|
+
* </important>
|
|
4795
5071
|
* @public
|
|
4796
5072
|
*/
|
|
4797
5073
|
description?: string | undefined;
|
|
@@ -4821,7 +5097,10 @@ export interface GetStorageProfileResponse {
|
|
|
4821
5097
|
*/
|
|
4822
5098
|
storageProfileId: string | undefined;
|
|
4823
5099
|
/**
|
|
4824
|
-
* <p>The display name of the storage profile.</p>
|
|
5100
|
+
* <p>The display name of the storage profile.</p>
|
|
5101
|
+
* <important>
|
|
5102
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5103
|
+
* </important>
|
|
4825
5104
|
* @public
|
|
4826
5105
|
*/
|
|
4827
5106
|
displayName: string | undefined;
|
|
@@ -4953,7 +5232,10 @@ export interface FarmSummary {
|
|
|
4953
5232
|
*/
|
|
4954
5233
|
farmId: string | undefined;
|
|
4955
5234
|
/**
|
|
4956
|
-
* <p>The display name of the farm.</p>
|
|
5235
|
+
* <p>The display name of the farm.</p>
|
|
5236
|
+
* <important>
|
|
5237
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5238
|
+
* </important>
|
|
4957
5239
|
* @public
|
|
4958
5240
|
*/
|
|
4959
5241
|
displayName: string | undefined;
|
|
@@ -5024,17 +5306,26 @@ export interface ListLimitsRequest {
|
|
|
5024
5306
|
*/
|
|
5025
5307
|
export interface LimitSummary {
|
|
5026
5308
|
/**
|
|
5027
|
-
* <p>The name of the limit used in lists to identify the limit.</p>
|
|
5309
|
+
* <p>The name of the limit used in lists to identify the limit.</p>
|
|
5310
|
+
* <important>
|
|
5311
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5312
|
+
* </important>
|
|
5028
5313
|
* @public
|
|
5029
5314
|
*/
|
|
5030
5315
|
displayName: string | undefined;
|
|
5031
5316
|
/**
|
|
5032
|
-
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
5317
|
+
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
5318
|
+
* the <code>hostRequirements</code> in a step of a job template to declare the limit
|
|
5319
|
+
* requirement.</p>
|
|
5033
5320
|
* @public
|
|
5034
5321
|
*/
|
|
5035
5322
|
amountRequirementName: string | undefined;
|
|
5036
5323
|
/**
|
|
5037
|
-
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
5324
|
+
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
5325
|
+
* in use, steps that require the limit won't be scheduled until the resource is
|
|
5326
|
+
* available.</p>
|
|
5327
|
+
* <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on
|
|
5328
|
+
* the number of resources that can be acquired for this limit.</p>
|
|
5038
5329
|
* @public
|
|
5039
5330
|
*/
|
|
5040
5331
|
maxCount: number | undefined;
|
|
@@ -5069,7 +5360,8 @@ export interface LimitSummary {
|
|
|
5069
5360
|
*/
|
|
5070
5361
|
limitId: string | undefined;
|
|
5071
5362
|
/**
|
|
5072
|
-
* <p>The number of resources from the limit that are being used by jobs. The result is
|
|
5363
|
+
* <p>The number of resources from the limit that are being used by jobs. The result is
|
|
5364
|
+
* delayed and may not be the count at the time that you called the operation.</p>
|
|
5073
5365
|
* @public
|
|
5074
5366
|
*/
|
|
5075
5367
|
currentCount: number | undefined;
|
|
@@ -5120,7 +5412,10 @@ export interface StorageProfileSummary {
|
|
|
5120
5412
|
*/
|
|
5121
5413
|
storageProfileId: string | undefined;
|
|
5122
5414
|
/**
|
|
5123
|
-
* <p>The display name of the storage profile summary to update.</p>
|
|
5415
|
+
* <p>The display name of the storage profile summary to update.</p>
|
|
5416
|
+
* <important>
|
|
5417
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5418
|
+
* </important>
|
|
5124
5419
|
* @public
|
|
5125
5420
|
*/
|
|
5126
5421
|
displayName: string | undefined;
|
|
@@ -5265,12 +5560,18 @@ export interface GetQueueResponse {
|
|
|
5265
5560
|
*/
|
|
5266
5561
|
queueId: string | undefined;
|
|
5267
5562
|
/**
|
|
5268
|
-
* <p>The display name of the queue.</p>
|
|
5563
|
+
* <p>The display name of the queue.</p>
|
|
5564
|
+
* <important>
|
|
5565
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5566
|
+
* </important>
|
|
5269
5567
|
* @public
|
|
5270
5568
|
*/
|
|
5271
5569
|
displayName: string | undefined;
|
|
5272
5570
|
/**
|
|
5273
|
-
* <p>The description of the queue.</p>
|
|
5571
|
+
* <p>The description of the queue.</p>
|
|
5572
|
+
* <important>
|
|
5573
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5574
|
+
* </important>
|
|
5274
5575
|
* @public
|
|
5275
5576
|
*/
|
|
5276
5577
|
description?: string | undefined;
|
|
@@ -5280,7 +5581,22 @@ export interface GetQueueResponse {
|
|
|
5280
5581
|
*/
|
|
5281
5582
|
farmId: string | undefined;
|
|
5282
5583
|
/**
|
|
5283
|
-
* <p>The status of the queue.</p>
|
|
5584
|
+
* <p>The status of the queue.</p>
|
|
5585
|
+
* <ul>
|
|
5586
|
+
* <li>
|
|
5587
|
+
* <p>
|
|
5588
|
+
* <code>ACTIVE</code>–The queue is active.</p>
|
|
5589
|
+
* </li>
|
|
5590
|
+
* <li>
|
|
5591
|
+
* <p>
|
|
5592
|
+
* <code>SCHEDULING</code>–The queue is scheduling.</p>
|
|
5593
|
+
* </li>
|
|
5594
|
+
* <li>
|
|
5595
|
+
* <p>
|
|
5596
|
+
* <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked. See the
|
|
5597
|
+
* provided reason.</p>
|
|
5598
|
+
* </li>
|
|
5599
|
+
* </ul>
|
|
5284
5600
|
* @public
|
|
5285
5601
|
*/
|
|
5286
5602
|
status: QueueStatus | undefined;
|
|
@@ -5440,7 +5756,10 @@ export interface GetStorageProfileForQueueResponse {
|
|
|
5440
5756
|
*/
|
|
5441
5757
|
storageProfileId: string | undefined;
|
|
5442
5758
|
/**
|
|
5443
|
-
* <p>The display name of the storage profile connected to a queue.</p>
|
|
5759
|
+
* <p>The display name of the storage profile connected to a queue.</p>
|
|
5760
|
+
* <important>
|
|
5761
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5762
|
+
* </important>
|
|
5444
5763
|
* @public
|
|
5445
5764
|
*/
|
|
5446
5765
|
displayName: string | undefined;
|
|
@@ -5667,12 +5986,19 @@ export interface GetJobResponse {
|
|
|
5667
5986
|
*/
|
|
5668
5987
|
attachments?: Attachments | undefined;
|
|
5669
5988
|
/**
|
|
5670
|
-
* <p>The description of the job.</p>
|
|
5989
|
+
* <p>The description of the job.</p>
|
|
5990
|
+
* <important>
|
|
5991
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
5992
|
+
* </important>
|
|
5671
5993
|
* @public
|
|
5672
5994
|
*/
|
|
5673
5995
|
description?: string | undefined;
|
|
5674
5996
|
/**
|
|
5675
|
-
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
5997
|
+
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
5998
|
+
* <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
|
|
5999
|
+
* job, even if the fleets assigned to the job's queue has available workers.</p>
|
|
6000
|
+
* <p>If you don't set the <code>maxWorkerCount</code> when you create a job, this value is
|
|
6001
|
+
* not returned in the response.</p>
|
|
5676
6002
|
* @public
|
|
5677
6003
|
*/
|
|
5678
6004
|
maxWorkerCount?: number | undefined;
|
|
@@ -6000,7 +6326,8 @@ export interface GetSessionActionResponse {
|
|
|
6000
6326
|
*/
|
|
6001
6327
|
sessionId: string | undefined;
|
|
6002
6328
|
/**
|
|
6003
|
-
* <p>The process exit code. The default Deadline Cloud worker agent converts unsigned
|
|
6329
|
+
* <p>The process exit code. The default Deadline Cloud worker agent converts unsigned
|
|
6330
|
+
* 32-bit exit codes to signed 32-bit exit codes.</p>
|
|
6004
6331
|
* @public
|
|
6005
6332
|
*/
|
|
6006
6333
|
processExitCode?: number | undefined;
|
|
@@ -6015,7 +6342,8 @@ export interface GetSessionActionResponse {
|
|
|
6015
6342
|
*/
|
|
6016
6343
|
definition: SessionActionDefinition | undefined;
|
|
6017
6344
|
/**
|
|
6018
|
-
* <p>The limits and their amounts acquired during a session action. If no limits were
|
|
6345
|
+
* <p>The limits and their amounts acquired during a session action. If no limits were
|
|
6346
|
+
* acquired during the session, this field isn't returned.</p>
|
|
6019
6347
|
* @public
|
|
6020
6348
|
*/
|
|
6021
6349
|
acquiredLimits?: AcquiredLimit[] | undefined;
|
|
@@ -6306,7 +6634,10 @@ export interface GetStepResponse {
|
|
|
6306
6634
|
*/
|
|
6307
6635
|
parameterSpace?: ParameterSpace | undefined;
|
|
6308
6636
|
/**
|
|
6309
|
-
* <p>The description of the step.</p>
|
|
6637
|
+
* <p>The description of the step.</p>
|
|
6638
|
+
* <important>
|
|
6639
|
+
* <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
|
|
6640
|
+
* </important>
|
|
6310
6641
|
* @public
|
|
6311
6642
|
*/
|
|
6312
6643
|
description?: string | undefined;
|
|
@@ -6644,7 +6975,49 @@ export interface JobSummary {
|
|
|
6644
6975
|
*/
|
|
6645
6976
|
endedAt?: Date | undefined;
|
|
6646
6977
|
/**
|
|
6647
|
-
* <p>The task run status for the job.</p>
|
|
6978
|
+
* <p>The task run status for the job.</p>
|
|
6979
|
+
* <ul>
|
|
6980
|
+
* <li>
|
|
6981
|
+
* <p>
|
|
6982
|
+
* <code>PENDING</code>–pending and waiting for resources.</p>
|
|
6983
|
+
* </li>
|
|
6984
|
+
* <li>
|
|
6985
|
+
* <p>
|
|
6986
|
+
* <code>READY</code>–ready to be processed.</p>
|
|
6987
|
+
* </li>
|
|
6988
|
+
* <li>
|
|
6989
|
+
* <p>
|
|
6990
|
+
* <code>ASSIGNED</code>–assigned and will run next on a worker.</p>
|
|
6991
|
+
* </li>
|
|
6992
|
+
* <li>
|
|
6993
|
+
* <p>
|
|
6994
|
+
* <code>SCHEDULED</code>–scheduled to be run on a worker.</p>
|
|
6995
|
+
* </li>
|
|
6996
|
+
* <li>
|
|
6997
|
+
* <p>
|
|
6998
|
+
* <code>INTERRUPTING</code>–being interrupted.</p>
|
|
6999
|
+
* </li>
|
|
7000
|
+
* <li>
|
|
7001
|
+
* <p>
|
|
7002
|
+
* <code>RUNNING</code>–running on a worker.</p>
|
|
7003
|
+
* </li>
|
|
7004
|
+
* <li>
|
|
7005
|
+
* <p>
|
|
7006
|
+
* <code>SUSPENDED</code>–the task is suspended.</p>
|
|
7007
|
+
* </li>
|
|
7008
|
+
* <li>
|
|
7009
|
+
* <p>
|
|
7010
|
+
* <code>CANCELED</code>–the task has been canceled.</p>
|
|
7011
|
+
* </li>
|
|
7012
|
+
* <li>
|
|
7013
|
+
* <p>
|
|
7014
|
+
* <code>FAILED</code>–the task has failed.</p>
|
|
7015
|
+
* </li>
|
|
7016
|
+
* <li>
|
|
7017
|
+
* <p>
|
|
7018
|
+
* <code>SUCCEEDED</code>–the task has succeeded.</p>
|
|
7019
|
+
* </li>
|
|
7020
|
+
* </ul>
|
|
6648
7021
|
* @public
|
|
6649
7022
|
*/
|
|
6650
7023
|
taskRunStatus?: TaskRunStatus | undefined;
|
|
@@ -6674,7 +7047,12 @@ export interface JobSummary {
|
|
|
6674
7047
|
*/
|
|
6675
7048
|
maxRetriesPerTask?: number | undefined;
|
|
6676
7049
|
/**
|
|
6677
|
-
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
7050
|
+
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
7051
|
+
* <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
|
|
7052
|
+
* job, even if the fleets assigned to the job's queue has available workers.</p>
|
|
7053
|
+
* <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no
|
|
7054
|
+
* maximum number of workers.</p>
|
|
7055
|
+
* <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p>
|
|
6678
7056
|
* @public
|
|
6679
7057
|
*/
|
|
6680
7058
|
maxWorkerCount?: number | undefined;
|
|
@@ -6891,7 +7269,8 @@ export interface SessionActionSummary {
|
|
|
6891
7269
|
*/
|
|
6892
7270
|
endedAt?: Date | undefined;
|
|
6893
7271
|
/**
|
|
6894
|
-
* <p>The Linux timestamp of the last date and time that the session action was
|
|
7272
|
+
* <p>The Linux timestamp of the last date and time that the session action was
|
|
7273
|
+
* updated.</p>
|
|
6895
7274
|
* @public
|
|
6896
7275
|
*/
|
|
6897
7276
|
workerUpdatedAt?: Date | undefined;
|