@aws-sdk/client-deadline 3.969.0 → 3.970.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 +1 -8
- package/dist-cjs/index.js +195 -15
- package/dist-es/models/enums.js +6 -0
- package/dist-es/schemas/schemas_0.js +28 -10
- package/dist-es/waiters/index.js +2 -0
- package/dist-es/waiters/waitForJobComplete.js +76 -0
- package/dist-es/waiters/waitForJobSucceeded.js +76 -0
- package/dist-types/Deadline.d.ts +1 -8
- package/dist-types/DeadlineClient.d.ts +1 -8
- package/dist-types/commands/AssociateMemberToFarmCommand.d.ts +2 -4
- package/dist-types/commands/AssociateMemberToFleetCommand.d.ts +2 -4
- package/dist-types/commands/AssociateMemberToJobCommand.d.ts +2 -4
- package/dist-types/commands/AssociateMemberToQueueCommand.d.ts +2 -4
- package/dist-types/commands/AssumeFleetRoleForReadCommand.d.ts +2 -4
- package/dist-types/commands/AssumeFleetRoleForWorkerCommand.d.ts +2 -4
- package/dist-types/commands/AssumeQueueRoleForReadCommand.d.ts +2 -4
- package/dist-types/commands/AssumeQueueRoleForUserCommand.d.ts +1 -2
- package/dist-types/commands/AssumeQueueRoleForWorkerCommand.d.ts +2 -4
- package/dist-types/commands/BatchGetJobEntityCommand.d.ts +1 -2
- package/dist-types/commands/CopyJobTemplateCommand.d.ts +1 -2
- package/dist-types/commands/CreateBudgetCommand.d.ts +5 -4
- package/dist-types/commands/CreateFarmCommand.d.ts +3 -8
- package/dist-types/commands/CreateFleetCommand.d.ts +3 -7
- package/dist-types/commands/CreateJobCommand.d.ts +3 -7
- package/dist-types/commands/CreateLicenseEndpointCommand.d.ts +4 -8
- package/dist-types/commands/CreateLimitCommand.d.ts +3 -9
- package/dist-types/commands/CreateMonitorCommand.d.ts +3 -7
- package/dist-types/commands/CreateQueueCommand.d.ts +3 -6
- package/dist-types/commands/CreateQueueEnvironmentCommand.d.ts +2 -4
- package/dist-types/commands/CreateQueueFleetAssociationCommand.d.ts +1 -2
- package/dist-types/commands/CreateQueueLimitAssociationCommand.d.ts +2 -6
- package/dist-types/commands/CreateStorageProfileCommand.d.ts +3 -6
- package/dist-types/commands/CreateWorkerCommand.d.ts +3 -15
- package/dist-types/commands/DeleteBudgetCommand.d.ts +1 -2
- package/dist-types/commands/DeleteFarmCommand.d.ts +1 -2
- package/dist-types/commands/DeleteFleetCommand.d.ts +2 -4
- package/dist-types/commands/DeleteLicenseEndpointCommand.d.ts +2 -4
- package/dist-types/commands/DeleteLimitCommand.d.ts +2 -5
- package/dist-types/commands/DeleteMeteredProductCommand.d.ts +1 -2
- package/dist-types/commands/DeleteMonitorCommand.d.ts +2 -4
- package/dist-types/commands/DeleteQueueCommand.d.ts +3 -9
- package/dist-types/commands/DeleteQueueEnvironmentCommand.d.ts +1 -2
- package/dist-types/commands/DeleteQueueFleetAssociationCommand.d.ts +2 -4
- package/dist-types/commands/DeleteQueueLimitAssociationCommand.d.ts +3 -10
- package/dist-types/commands/DeleteStorageProfileCommand.d.ts +1 -2
- package/dist-types/commands/DeleteWorkerCommand.d.ts +2 -4
- package/dist-types/commands/DisassociateMemberFromFarmCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateMemberFromFleetCommand.d.ts +2 -4
- package/dist-types/commands/DisassociateMemberFromJobCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateMemberFromQueueCommand.d.ts +2 -4
- package/dist-types/commands/GetBudgetCommand.d.ts +1 -2
- package/dist-types/commands/GetFarmCommand.d.ts +2 -3
- package/dist-types/commands/GetFleetCommand.d.ts +1 -2
- package/dist-types/commands/GetJobCommand.d.ts +1 -2
- package/dist-types/commands/GetLicenseEndpointCommand.d.ts +1 -2
- package/dist-types/commands/GetLimitCommand.d.ts +1 -2
- package/dist-types/commands/GetMonitorCommand.d.ts +1 -2
- package/dist-types/commands/GetQueueCommand.d.ts +1 -2
- package/dist-types/commands/GetQueueEnvironmentCommand.d.ts +1 -2
- package/dist-types/commands/GetQueueFleetAssociationCommand.d.ts +1 -2
- package/dist-types/commands/GetQueueLimitAssociationCommand.d.ts +1 -2
- package/dist-types/commands/GetSessionActionCommand.d.ts +1 -2
- package/dist-types/commands/GetSessionCommand.d.ts +1 -2
- package/dist-types/commands/GetSessionsStatisticsAggregationCommand.d.ts +2 -6
- package/dist-types/commands/GetStepCommand.d.ts +6 -2
- package/dist-types/commands/GetStorageProfileCommand.d.ts +1 -2
- package/dist-types/commands/GetStorageProfileForQueueCommand.d.ts +1 -2
- package/dist-types/commands/GetTaskCommand.d.ts +1 -2
- package/dist-types/commands/GetWorkerCommand.d.ts +1 -2
- package/dist-types/commands/ListBudgetsCommand.d.ts +1 -2
- package/dist-types/commands/ListFarmMembersCommand.d.ts +1 -2
- package/dist-types/commands/ListFarmsCommand.d.ts +1 -2
- package/dist-types/commands/ListFleetMembersCommand.d.ts +1 -2
- package/dist-types/commands/ListFleetsCommand.d.ts +1 -2
- package/dist-types/commands/ListJobMembersCommand.d.ts +1 -2
- package/dist-types/commands/ListJobParameterDefinitionsCommand.d.ts +1 -2
- package/dist-types/commands/ListJobsCommand.d.ts +1 -2
- package/dist-types/commands/ListLicenseEndpointsCommand.d.ts +1 -2
- package/dist-types/commands/ListLimitsCommand.d.ts +1 -2
- package/dist-types/commands/ListMeteredProductsCommand.d.ts +2 -4
- package/dist-types/commands/ListMonitorsCommand.d.ts +1 -2
- package/dist-types/commands/ListQueueEnvironmentsCommand.d.ts +1 -2
- package/dist-types/commands/ListQueueMembersCommand.d.ts +1 -2
- package/dist-types/commands/ListQueuesCommand.d.ts +1 -2
- package/dist-types/commands/ListSessionActionsCommand.d.ts +1 -2
- package/dist-types/commands/ListSessionsCommand.d.ts +1 -2
- package/dist-types/commands/ListSessionsForWorkerCommand.d.ts +1 -2
- package/dist-types/commands/ListStepConsumersCommand.d.ts +1 -2
- package/dist-types/commands/ListStepDependenciesCommand.d.ts +1 -2
- package/dist-types/commands/ListStepsCommand.d.ts +1 -2
- package/dist-types/commands/ListStorageProfilesCommand.d.ts +1 -2
- package/dist-types/commands/ListStorageProfilesForQueueCommand.d.ts +1 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
- package/dist-types/commands/ListTasksCommand.d.ts +1 -2
- package/dist-types/commands/ListWorkersCommand.d.ts +1 -2
- package/dist-types/commands/PutMeteredProductCommand.d.ts +1 -2
- package/dist-types/commands/SearchJobsCommand.d.ts +21 -8
- package/dist-types/commands/SearchStepsCommand.d.ts +26 -8
- package/dist-types/commands/SearchTasksCommand.d.ts +22 -8
- package/dist-types/commands/SearchWorkersCommand.d.ts +21 -8
- package/dist-types/commands/StartSessionsStatisticsAggregationCommand.d.ts +2 -9
- package/dist-types/commands/TagResourceCommand.d.ts +2 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
- package/dist-types/commands/UpdateBudgetCommand.d.ts +1 -2
- package/dist-types/commands/UpdateFarmCommand.d.ts +1 -2
- package/dist-types/commands/UpdateFleetCommand.d.ts +2 -4
- package/dist-types/commands/UpdateJobCommand.d.ts +3 -11
- package/dist-types/commands/UpdateLimitCommand.d.ts +1 -2
- package/dist-types/commands/UpdateMonitorCommand.d.ts +2 -4
- package/dist-types/commands/UpdateQueueCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueEnvironmentCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueFleetAssociationCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueLimitAssociationCommand.d.ts +2 -5
- package/dist-types/commands/UpdateSessionCommand.d.ts +2 -4
- package/dist-types/commands/UpdateStepCommand.d.ts +2 -4
- package/dist-types/commands/UpdateStorageProfileCommand.d.ts +1 -2
- package/dist-types/commands/UpdateTaskCommand.d.ts +2 -4
- package/dist-types/commands/UpdateWorkerCommand.d.ts +2 -4
- package/dist-types/commands/UpdateWorkerScheduleCommand.d.ts +2 -4
- package/dist-types/index.d.ts +1 -8
- package/dist-types/models/enums.d.ts +14 -0
- package/dist-types/models/errors.d.ts +3 -6
- package/dist-types/models/models_0.d.ts +196 -660
- package/dist-types/models/models_1.d.ts +118 -241
- package/dist-types/schemas/schemas_0.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListMeteredProductsCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/enums.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +14 -11
- package/dist-types/ts3.4/models/models_1.d.ts +28 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +2 -0
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForJobComplete.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForJobSucceeded.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +2 -0
- package/dist-types/waiters/waitForJobComplete.d.ts +14 -0
- package/dist-types/waiters/waitForJobCreateComplete.d.ts +2 -2
- package/dist-types/waiters/waitForJobSucceeded.d.ts +14 -0
- package/package.json +12 -12
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import { AcceleratorName, AcceleratorType, AutoScalingMode, AutoScalingStatus, BudgetActionType, BudgetStatus, ComparisonOperator, CompletedStatus, CpuArchitectureType, CreateJobTargetTaskRunStatus, CustomerManagedFleetOperatingSystemFamily, DeadlinePrincipalType, DefaultQueueBudgetAction, DependencyConsumerResolutionStatus, DesiredWorkerStatus, Ec2MarketType, EnvironmentTemplateType, FileSystemLocationType, FleetStatus, JobAttachmentsFileSystem, JobEntityErrorCode, JobLifecycleStatus, JobTargetTaskRunStatus, JobTemplateType, LicenseEndpointStatus, MembershipLevel, PathFormat, QueueBlockedReason, QueueFleetAssociationStatus, QueueLimitAssociationStatus, QueueStatus, RunAs, ServiceManagedFleetOperatingSystemFamily, SessionActionStatus, SessionLifecycleStatus, SessionLifecycleTargetStatus, SessionsStatisticsAggregationStatus, StepLifecycleStatus, StepParameterType, StepTargetTaskRunStatus, StorageProfileOperatingSystemFamily, TagPropagationMode, TaskRunStatus, TaskTargetRunStatus, UpdatedWorkerStatus, UpdateJobLifecycleStatus, UsageType, WorkerStatus } from "./enums";
|
|
2
|
+
import { AcceleratorName, AcceleratorType, AutoScalingMode, AutoScalingStatus, BudgetActionType, BudgetStatus, ComparisonOperator, CompletedStatus, CpuArchitectureType, CreateJobTargetTaskRunStatus, CustomerManagedFleetOperatingSystemFamily, DeadlinePrincipalType, DefaultQueueBudgetAction, DependencyConsumerResolutionStatus, DesiredWorkerStatus, Ec2MarketType, EnvironmentTemplateType, FileSystemLocationType, FleetStatus, JobAttachmentsFileSystem, JobEntityErrorCode, JobLifecycleStatus, JobTargetTaskRunStatus, JobTemplateType, LicenseEndpointStatus, MembershipLevel, PathFormat, QueueBlockedReason, QueueFleetAssociationStatus, QueueLimitAssociationStatus, QueueStatus, RangeConstraint, RunAs, ServiceManagedFleetOperatingSystemFamily, SessionActionStatus, SessionLifecycleStatus, SessionLifecycleTargetStatus, SessionsStatisticsAggregationStatus, StepLifecycleStatus, StepParameterType, StepTargetTaskRunStatus, StorageProfileOperatingSystemFamily, TagPropagationMode, TaskRunStatus, TaskTargetRunStatus, UpdatedWorkerStatus, UpdateJobLifecycleStatus, UsageType, WorkerStatus } from "./enums";
|
|
3
3
|
/**
|
|
4
|
-
* <p>Defines the maximum and minimum number of GPU accelerators required for a worker
|
|
5
|
-
* instance..</p>
|
|
4
|
+
* <p>Defines the maximum and minimum number of GPU accelerators required for a worker instance..</p>
|
|
6
5
|
* @public
|
|
7
6
|
*/
|
|
8
7
|
export interface AcceleratorCountRange {
|
|
@@ -23,83 +22,34 @@ export interface AcceleratorCountRange {
|
|
|
23
22
|
*/
|
|
24
23
|
export interface AcceleratorSelection {
|
|
25
24
|
/**
|
|
26
|
-
* <p>The name of the chip used by the GPU accelerator.</p>
|
|
27
|
-
* <p>If you specify <code>l4</code> as the name of the accelerator, you must specify
|
|
28
|
-
* <code>latest</code> or <code>grid:r570</code> as the runtime.</p>
|
|
29
|
-
* <p>The available GPU accelerators are:</p>
|
|
30
|
-
* <ul>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>
|
|
33
|
-
* <code>t4</code> - NVIDIA T4 Tensor Core GPU</p>
|
|
34
|
-
* </li>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>
|
|
37
|
-
* <code>a10g</code> - NVIDIA A10G Tensor Core GPU</p>
|
|
38
|
-
* </li>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* <code>l4</code> - NVIDIA L4 Tensor Core GPU</p>
|
|
42
|
-
* </li>
|
|
43
|
-
* <li>
|
|
44
|
-
* <p>
|
|
45
|
-
* <code>l40s</code> - NVIDIA L40S Tensor Core GPU</p>
|
|
46
|
-
* </li>
|
|
47
|
-
* </ul>
|
|
25
|
+
* <p>The name of the chip used by the GPU accelerator.</p> <p>The available GPU accelerators are:</p> <ul> <li> <p> <code>t4</code> - NVIDIA T4 Tensor Core GPU (16 GiB memory)</p> </li> <li> <p> <code>a10g</code> - NVIDIA A10G Tensor Core GPU (24 GiB memory)</p> </li> <li> <p> <code>l4</code> - NVIDIA L4 Tensor Core GPU (24 GiB memory)</p> </li> <li> <p> <code>l40s</code> - NVIDIA L40S Tensor Core GPU (48 GiB memory)</p> </li> </ul>
|
|
48
26
|
* @public
|
|
49
27
|
*/
|
|
50
28
|
name: AcceleratorName | undefined;
|
|
51
29
|
/**
|
|
52
|
-
* <p>Specifies the runtime driver to use for the GPU accelerator. You must use the same
|
|
53
|
-
* runtime for all GPUs. </p>
|
|
54
|
-
* <p>You can choose from the following runtimes:</p>
|
|
55
|
-
* <ul>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>
|
|
58
|
-
* <code>latest</code> - Use the latest runtime available for the chip. If you
|
|
59
|
-
* specify <code>latest</code> and a new version of the runtime is released, the new
|
|
60
|
-
* version of the runtime is used.</p>
|
|
61
|
-
* </li>
|
|
62
|
-
* <li>
|
|
63
|
-
* <p>
|
|
64
|
-
* <code>grid:r570</code> - <a href="https://docs.nvidia.com/vgpu/18.0/index.html">NVIDIA vGPU software 18</a>
|
|
65
|
-
* </p>
|
|
66
|
-
* </li>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>
|
|
69
|
-
* <code>grid:r535</code> - <a href="https://docs.nvidia.com/vgpu/16.0/index.html">NVIDIA vGPU software 16</a>
|
|
70
|
-
* </p>
|
|
71
|
-
* </li>
|
|
72
|
-
* </ul>
|
|
73
|
-
* <p>If you don't specify a runtime, Deadline Cloud uses <code>latest</code> as the default. However,
|
|
74
|
-
* if you have multiple accelerators and specify <code>latest</code> for some and leave others
|
|
75
|
-
* blank, Deadline Cloud raises an exception.</p>
|
|
30
|
+
* <p>Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs in a fleet. </p> <p>You can choose from the following runtimes:</p> <ul> <li> <p> <code>latest</code> - Use the latest runtime available for the chip. If you specify <code>latest</code> and a new version of the runtime is released, the new version of the runtime is used.</p> </li> <li> <p> <code>grid:r570</code> - <a href="https://docs.nvidia.com/vgpu/18.0/index.html">NVIDIA vGPU software 18</a> </p> </li> <li> <p> <code>grid:r535</code> - <a href="https://docs.nvidia.com/vgpu/16.0/index.html">NVIDIA vGPU software 16</a> </p> </li> </ul> <p>If you don't specify a runtime, Amazon Web Services Deadline Cloud uses <code>latest</code> as the default. However, if you have multiple accelerators and specify <code>latest</code> for some and leave others blank, Amazon Web Services Deadline Cloud raises an exception.</p> <important> <p>Not all runtimes are compatible with all accelerator types:</p> <ul> <li> <p> <code>t4</code> and <code>a10g</code>: Support all runtimes (<code>grid:r570</code>, <code>grid:r535</code>)</p> </li> <li> <p> <code>l4</code> and <code>l40s</code>: Only support <code>grid:r570</code> and newer</p> </li> </ul> <p>All accelerators in a fleet must use the same runtime version. You cannot mix different runtime versions within a single fleet.</p> </important> <note> <p>When you specify <code>latest</code>, it resolves to <code>grid:r570</code> for all currently supported accelerators.</p> </note>
|
|
76
31
|
* @public
|
|
77
32
|
*/
|
|
78
33
|
runtime?: string | undefined;
|
|
79
34
|
}
|
|
80
35
|
/**
|
|
81
|
-
* <p>Provides information about the GPU accelerators used for jobs processed by a
|
|
82
|
-
* fleet.</p>
|
|
36
|
+
* <p>Provides information about the GPU accelerators used for jobs processed by a fleet.</p> <important> <p>Accelerator capabilities cannot be used with wait-and-save fleets. If you specify accelerator capabilities, you must use either spot or on-demand instance market options.</p> </important> <note> <p>Each accelerator type maps to specific EC2 instance families:</p> <ul> <li> <p> <code>t4</code>: Uses G4dn instance family</p> </li> <li> <p> <code>a10g</code>: Uses G5 instance family</p> </li> <li> <p> <code>l4</code>: Uses G6 and Gr6 instance families</p> </li> <li> <p> <code>l40s</code>: Uses G6e instance family</p> </li> </ul> </note>
|
|
83
37
|
* @public
|
|
84
38
|
*/
|
|
85
39
|
export interface AcceleratorCapabilities {
|
|
86
40
|
/**
|
|
87
|
-
* <p>A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances
|
|
88
|
-
* that provide these capabilities will be used. For example, if you specify both L4 and T4
|
|
89
|
-
* chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip
|
|
90
|
-
* installed.</p>
|
|
41
|
+
* <p>A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Amazon Web Services Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.</p> <important> <ul> <li> <p>You must specify at least one accelerator selection.</p> </li> <li> <p>You cannot specify the same accelerator name multiple times in the selections list.</p> </li> <li> <p>All accelerators in the selections must use the same runtime version.</p> </li> </ul> </important>
|
|
91
42
|
* @public
|
|
92
43
|
*/
|
|
93
44
|
selections: AcceleratorSelection[] | undefined;
|
|
94
45
|
/**
|
|
95
|
-
* <p>The number of GPU accelerators specified for worker hosts in this fleet. </p>
|
|
46
|
+
* <p>The number of GPU accelerators specified for worker hosts in this fleet.</p> <important> <p>You must specify either <code>acceleratorCapabilities.count.max</code> or <code>allowedInstanceTypes</code> when using accelerator capabilities. If you don't specify a maximum count, Amazon Web Services Deadline Cloud uses the instance types you specify in <code>allowedInstanceTypes</code> to determine the maximum number of accelerators.</p> </important>
|
|
96
47
|
* @public
|
|
97
48
|
*/
|
|
98
49
|
count?: AcceleratorCountRange | undefined;
|
|
99
50
|
}
|
|
100
51
|
/**
|
|
101
|
-
* <p>Defines the maximum and minimum amount of memory, in MiB, to use for the
|
|
102
|
-
* accelerator.</p>
|
|
52
|
+
* <p>Defines the maximum and minimum amount of memory, in MiB, to use for the accelerator.</p>
|
|
103
53
|
* @public
|
|
104
54
|
*/
|
|
105
55
|
export interface AcceleratorTotalMemoryMiBRange {
|
|
@@ -179,12 +129,12 @@ export interface LogConfiguration {
|
|
|
179
129
|
error?: string | undefined;
|
|
180
130
|
}
|
|
181
131
|
/**
|
|
182
|
-
* <p>The
|
|
132
|
+
* <p>The assigned session action definition for syncing input job attachments.</p>
|
|
183
133
|
* @public
|
|
184
134
|
*/
|
|
185
135
|
export interface AssignedSyncInputJobAttachmentsSessionActionDefinition {
|
|
186
136
|
/**
|
|
187
|
-
* <p>The step ID.</p>
|
|
137
|
+
* <p>The step ID for the assigned sync input job attachments session action.</p>
|
|
188
138
|
* @public
|
|
189
139
|
*/
|
|
190
140
|
stepId?: string | undefined;
|
|
@@ -346,7 +296,7 @@ export declare namespace AssignedSessionActionDefinition {
|
|
|
346
296
|
$unknown?: never;
|
|
347
297
|
}
|
|
348
298
|
/**
|
|
349
|
-
* <p>The job
|
|
299
|
+
* <p>The job attachments to sync for the assigned session action.</p>
|
|
350
300
|
* @public
|
|
351
301
|
*/
|
|
352
302
|
interface SyncInputJobAttachmentsMember {
|
|
@@ -799,17 +749,17 @@ export interface ManifestProperties {
|
|
|
799
749
|
inputManifestHash?: string | undefined;
|
|
800
750
|
}
|
|
801
751
|
/**
|
|
802
|
-
* <p>The attachments
|
|
752
|
+
* <p>The job attachments.</p>
|
|
803
753
|
* @public
|
|
804
754
|
*/
|
|
805
755
|
export interface Attachments {
|
|
806
756
|
/**
|
|
807
|
-
* <p>
|
|
757
|
+
* <p>The manifest properties for the attachments.</p>
|
|
808
758
|
* @public
|
|
809
759
|
*/
|
|
810
760
|
manifests: ManifestProperties[] | undefined;
|
|
811
761
|
/**
|
|
812
|
-
* <p>The file system.</p>
|
|
762
|
+
* <p>The file system location for the attachments.</p>
|
|
813
763
|
* @public
|
|
814
764
|
*/
|
|
815
765
|
fileSystem?: JobAttachmentsFileSystem | undefined;
|
|
@@ -948,14 +898,12 @@ export declare namespace JobEntityIdentifiersUnion {
|
|
|
948
898
|
*/
|
|
949
899
|
export interface BatchGetJobEntityRequest {
|
|
950
900
|
/**
|
|
951
|
-
* <p>The farm ID of the worker that's fetching job details. The worker must have an
|
|
952
|
-
* assignment on a job to fetch job details.</p>
|
|
901
|
+
* <p>The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.</p>
|
|
953
902
|
* @public
|
|
954
903
|
*/
|
|
955
904
|
farmId: string | undefined;
|
|
956
905
|
/**
|
|
957
|
-
* <p>The fleet ID of the worker that's fetching job details. The worker must have an
|
|
958
|
-
* assignment on a job to fetch job details.</p>
|
|
906
|
+
* <p>The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.</p>
|
|
959
907
|
* @public
|
|
960
908
|
*/
|
|
961
909
|
fleetId: string | undefined;
|
|
@@ -1076,8 +1024,7 @@ export interface JobRunAsUser {
|
|
|
1076
1024
|
*/
|
|
1077
1025
|
windows?: WindowsUser | undefined;
|
|
1078
1026
|
/**
|
|
1079
|
-
* <p>Specifies whether the job should run using the queue's system user or if the job should
|
|
1080
|
-
* run using the worker agent system user.</p>
|
|
1027
|
+
* <p>Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.</p>
|
|
1081
1028
|
* @public
|
|
1082
1029
|
*/
|
|
1083
1030
|
runAs: RunAs | undefined;
|
|
@@ -1530,10 +1477,7 @@ export interface BudgetActionToAdd {
|
|
|
1530
1477
|
*/
|
|
1531
1478
|
thresholdPercentage: number | undefined;
|
|
1532
1479
|
/**
|
|
1533
|
-
* <p>A description for the budget action to add.</p>
|
|
1534
|
-
* <important>
|
|
1535
|
-
* <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>
|
|
1536
|
-
* </important>
|
|
1480
|
+
* <p>A description for the budget action to add.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
1537
1481
|
* @public
|
|
1538
1482
|
*/
|
|
1539
1483
|
description?: string | undefined;
|
|
@@ -1656,18 +1600,12 @@ export interface CreateBudgetRequest {
|
|
|
1656
1600
|
*/
|
|
1657
1601
|
usageTrackingResource: UsageTrackingResource | undefined;
|
|
1658
1602
|
/**
|
|
1659
|
-
* <p>The display name of the budget.</p>
|
|
1660
|
-
* <important>
|
|
1661
|
-
* <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>
|
|
1662
|
-
* </important>
|
|
1603
|
+
* <p>The display name of the budget.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
1663
1604
|
* @public
|
|
1664
1605
|
*/
|
|
1665
1606
|
displayName: string | undefined;
|
|
1666
1607
|
/**
|
|
1667
|
-
* <p>The description of the budget.</p>
|
|
1668
|
-
* <important>
|
|
1669
|
-
* <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>
|
|
1670
|
-
* </important>
|
|
1608
|
+
* <p>The description of the budget.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
1671
1609
|
* @public
|
|
1672
1610
|
*/
|
|
1673
1611
|
description?: string | undefined;
|
|
@@ -1686,6 +1624,11 @@ export interface CreateBudgetRequest {
|
|
|
1686
1624
|
* @public
|
|
1687
1625
|
*/
|
|
1688
1626
|
schedule: BudgetSchedule | undefined;
|
|
1627
|
+
/**
|
|
1628
|
+
* <p>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.</p>
|
|
1629
|
+
* @public
|
|
1630
|
+
*/
|
|
1631
|
+
tags?: Record<string, string> | undefined;
|
|
1689
1632
|
}
|
|
1690
1633
|
/**
|
|
1691
1634
|
* @public
|
|
@@ -1748,10 +1691,7 @@ export interface ResponseBudgetAction {
|
|
|
1748
1691
|
*/
|
|
1749
1692
|
thresholdPercentage: number | undefined;
|
|
1750
1693
|
/**
|
|
1751
|
-
* <p>The budget action description.</p>
|
|
1752
|
-
* <important>
|
|
1753
|
-
* <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>
|
|
1754
|
-
* </important>
|
|
1694
|
+
* <p>The budget action description.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
1755
1695
|
* @public
|
|
1756
1696
|
*/
|
|
1757
1697
|
description?: string | undefined;
|
|
@@ -1782,34 +1722,17 @@ export interface GetBudgetResponse {
|
|
|
1782
1722
|
*/
|
|
1783
1723
|
usageTrackingResource: UsageTrackingResource | undefined;
|
|
1784
1724
|
/**
|
|
1785
|
-
* <p>The status of the budget.</p>
|
|
1786
|
-
* <ul>
|
|
1787
|
-
* <li>
|
|
1788
|
-
* <p>
|
|
1789
|
-
* <code>ACTIVE</code>–Get a budget being evaluated.</p>
|
|
1790
|
-
* </li>
|
|
1791
|
-
* <li>
|
|
1792
|
-
* <p>
|
|
1793
|
-
* <code>INACTIVE</code>–Get an inactive budget. This can include expired,
|
|
1794
|
-
* canceled, or deleted statuses.</p>
|
|
1795
|
-
* </li>
|
|
1796
|
-
* </ul>
|
|
1725
|
+
* <p>The status of the budget.</p> <ul> <li> <p> <code>ACTIVE</code>–Get a budget being evaluated.</p> </li> <li> <p> <code>INACTIVE</code>–Get an inactive budget. This can include expired, canceled, or deleted statuses.</p> </li> </ul>
|
|
1797
1726
|
* @public
|
|
1798
1727
|
*/
|
|
1799
1728
|
status: BudgetStatus | undefined;
|
|
1800
1729
|
/**
|
|
1801
|
-
* <p>The display name of the budget.</p>
|
|
1802
|
-
* <important>
|
|
1803
|
-
* <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>
|
|
1804
|
-
* </important>
|
|
1730
|
+
* <p>The display name of the budget.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
1805
1731
|
* @public
|
|
1806
1732
|
*/
|
|
1807
1733
|
displayName: string | undefined;
|
|
1808
1734
|
/**
|
|
1809
|
-
* <p>The description of the budget.</p>
|
|
1810
|
-
* <important>
|
|
1811
|
-
* <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>
|
|
1812
|
-
* </important>
|
|
1735
|
+
* <p>The description of the budget.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
1813
1736
|
* @public
|
|
1814
1737
|
*/
|
|
1815
1738
|
description?: string | undefined;
|
|
@@ -1900,34 +1823,17 @@ export interface BudgetSummary {
|
|
|
1900
1823
|
*/
|
|
1901
1824
|
usageTrackingResource: UsageTrackingResource | undefined;
|
|
1902
1825
|
/**
|
|
1903
|
-
* <p>The status of the budget.</p>
|
|
1904
|
-
* <ul>
|
|
1905
|
-
* <li>
|
|
1906
|
-
* <p>
|
|
1907
|
-
* <code>ACTIVE</code>–The budget is being evaluated.</p>
|
|
1908
|
-
* </li>
|
|
1909
|
-
* <li>
|
|
1910
|
-
* <p>
|
|
1911
|
-
* <code>INACTIVE</code>–The budget is inactive. This can include Expired,
|
|
1912
|
-
* Canceled, or deleted Deleted statuses.</p>
|
|
1913
|
-
* </li>
|
|
1914
|
-
* </ul>
|
|
1826
|
+
* <p>The status of the budget.</p> <ul> <li> <p> <code>ACTIVE</code>–The budget is being evaluated.</p> </li> <li> <p> <code>INACTIVE</code>–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.</p> </li> </ul>
|
|
1915
1827
|
* @public
|
|
1916
1828
|
*/
|
|
1917
1829
|
status: BudgetStatus | undefined;
|
|
1918
1830
|
/**
|
|
1919
|
-
* <p>The display name of the budget summary to update.</p>
|
|
1920
|
-
* <important>
|
|
1921
|
-
* <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>
|
|
1922
|
-
* </important>
|
|
1831
|
+
* <p>The display name of the budget summary to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
1923
1832
|
* @public
|
|
1924
1833
|
*/
|
|
1925
1834
|
displayName: string | undefined;
|
|
1926
1835
|
/**
|
|
1927
|
-
* <p>The description of the budget summary.</p>
|
|
1928
|
-
* <important>
|
|
1929
|
-
* <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>
|
|
1930
|
-
* </important>
|
|
1836
|
+
* <p>The description of the budget summary.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
1931
1837
|
*
|
|
1932
1838
|
* @deprecated ListBudgets no longer supports description. Use GetBudget if description is needed.
|
|
1933
1839
|
* @public
|
|
@@ -1999,34 +1905,17 @@ export interface UpdateBudgetRequest {
|
|
|
1999
1905
|
*/
|
|
2000
1906
|
budgetId: string | undefined;
|
|
2001
1907
|
/**
|
|
2002
|
-
* <p>The display name of the budget to update.</p>
|
|
2003
|
-
* <important>
|
|
2004
|
-
* <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>
|
|
2005
|
-
* </important>
|
|
1908
|
+
* <p>The display name of the budget to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2006
1909
|
* @public
|
|
2007
1910
|
*/
|
|
2008
1911
|
displayName?: string | undefined;
|
|
2009
1912
|
/**
|
|
2010
|
-
* <p>The description of the budget to update.</p>
|
|
2011
|
-
* <important>
|
|
2012
|
-
* <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>
|
|
2013
|
-
* </important>
|
|
1913
|
+
* <p>The description of the budget to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2014
1914
|
* @public
|
|
2015
1915
|
*/
|
|
2016
1916
|
description?: string | undefined;
|
|
2017
1917
|
/**
|
|
2018
|
-
* <p>Updates the status of the budget.</p>
|
|
2019
|
-
* <ul>
|
|
2020
|
-
* <li>
|
|
2021
|
-
* <p>
|
|
2022
|
-
* <code>ACTIVE</code>–The budget is being evaluated.</p>
|
|
2023
|
-
* </li>
|
|
2024
|
-
* <li>
|
|
2025
|
-
* <p>
|
|
2026
|
-
* <code>INACTIVE</code>–The budget is inactive. This can include Expired,
|
|
2027
|
-
* Canceled, or deleted Deleted statuses.</p>
|
|
2028
|
-
* </li>
|
|
2029
|
-
* </ul>
|
|
1918
|
+
* <p>Updates the status of the budget.</p> <ul> <li> <p> <code>ACTIVE</code>–The budget is being evaluated.</p> </li> <li> <p> <code>INACTIVE</code>–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.</p> </li> </ul>
|
|
2030
1919
|
* @public
|
|
2031
1920
|
*/
|
|
2032
1921
|
status?: BudgetStatus | undefined;
|
|
@@ -2036,8 +1925,7 @@ export interface UpdateBudgetRequest {
|
|
|
2036
1925
|
*/
|
|
2037
1926
|
approximateDollarLimit?: number | undefined;
|
|
2038
1927
|
/**
|
|
2039
|
-
* <p>The budget actions to add. Budget actions specify what happens when the budget runs
|
|
2040
|
-
* out.</p>
|
|
1928
|
+
* <p>The budget actions to add. Budget actions specify what happens when the budget runs out.</p>
|
|
2041
1929
|
* @public
|
|
2042
1930
|
*/
|
|
2043
1931
|
actionsToAdd?: BudgetActionToAdd[] | undefined;
|
|
@@ -2093,8 +1981,7 @@ export interface CopyJobTemplateRequest {
|
|
|
2093
1981
|
*/
|
|
2094
1982
|
queueId: string | undefined;
|
|
2095
1983
|
/**
|
|
2096
|
-
* <p>The Amazon S3 bucket name and key where you would like to add a copy of the job
|
|
2097
|
-
* template.</p>
|
|
1984
|
+
* <p>The Amazon S3 bucket name and key where you would like to add a copy of the job template.</p>
|
|
2098
1985
|
* @public
|
|
2099
1986
|
*/
|
|
2100
1987
|
targetS3Location: S3Location | undefined;
|
|
@@ -2119,18 +2006,12 @@ export interface CreateFarmRequest {
|
|
|
2119
2006
|
*/
|
|
2120
2007
|
clientToken?: string | undefined;
|
|
2121
2008
|
/**
|
|
2122
|
-
* <p>The display name of the farm.</p>
|
|
2123
|
-
* <important>
|
|
2124
|
-
* <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>
|
|
2125
|
-
* </important>
|
|
2009
|
+
* <p>The display name of the farm.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2126
2010
|
* @public
|
|
2127
2011
|
*/
|
|
2128
2012
|
displayName: string | undefined;
|
|
2129
2013
|
/**
|
|
2130
|
-
* <p>The description of the farm.</p>
|
|
2131
|
-
* <important>
|
|
2132
|
-
* <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>
|
|
2133
|
-
* </important>
|
|
2014
|
+
* <p>The description of the farm.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2134
2015
|
* @public
|
|
2135
2016
|
*/
|
|
2136
2017
|
description?: string | undefined;
|
|
@@ -2276,34 +2157,27 @@ export interface CustomerManagedWorkerCapabilities {
|
|
|
2276
2157
|
customAttributes?: FleetAttributeCapability[] | undefined;
|
|
2277
2158
|
}
|
|
2278
2159
|
/**
|
|
2279
|
-
* <p>The details
|
|
2160
|
+
* <p>The configuration details for a customer managed fleet.</p>
|
|
2280
2161
|
* @public
|
|
2281
2162
|
*/
|
|
2282
2163
|
export interface CustomerManagedFleetConfiguration {
|
|
2283
2164
|
/**
|
|
2284
|
-
* <p>The Auto Scaling mode for the customer managed fleet
|
|
2165
|
+
* <p>The Auto Scaling mode for the customer managed fleet.</p>
|
|
2285
2166
|
* @public
|
|
2286
2167
|
*/
|
|
2287
2168
|
mode: AutoScalingMode | undefined;
|
|
2288
2169
|
/**
|
|
2289
|
-
* <p>The worker capabilities for
|
|
2170
|
+
* <p>The worker capabilities for the customer managed fleet.</p>
|
|
2290
2171
|
* @public
|
|
2291
2172
|
*/
|
|
2292
2173
|
workerCapabilities: CustomerManagedWorkerCapabilities | undefined;
|
|
2293
2174
|
/**
|
|
2294
|
-
* <p>The storage profile ID.</p>
|
|
2175
|
+
* <p>The storage profile ID for the customer managed fleet.</p>
|
|
2295
2176
|
* @public
|
|
2296
2177
|
*/
|
|
2297
2178
|
storageProfileId?: string | undefined;
|
|
2298
2179
|
/**
|
|
2299
|
-
* <p>
|
|
2300
|
-
* is launched. </p>
|
|
2301
|
-
* <p>When the <code>tagPropagationMode</code> is set to
|
|
2302
|
-
* <code>PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH</code> any tag associated with a fleet is
|
|
2303
|
-
* attached to workers when they launch. If the tags for a fleet change, the tags associated
|
|
2304
|
-
* with running workers <b>do not</b> change.</p>
|
|
2305
|
-
* <p>If you don't specify <code>tagPropagationMode</code>, the default is
|
|
2306
|
-
* <code>NO_PROPAGATION</code>.</p>
|
|
2180
|
+
* <p>The tag propagation mode for the customer managed fleet.</p>
|
|
2307
2181
|
* @public
|
|
2308
2182
|
*/
|
|
2309
2183
|
tagPropagationMode?: TagPropagationMode | undefined;
|
|
@@ -2360,8 +2234,7 @@ export interface ServiceManagedEc2InstanceCapabilities {
|
|
|
2360
2234
|
*/
|
|
2361
2235
|
rootEbsVolume?: Ec2EbsVolume | undefined;
|
|
2362
2236
|
/**
|
|
2363
|
-
* <p>Describes the GPU accelerator capabilities required for worker host instances in this
|
|
2364
|
-
* fleet.</p>
|
|
2237
|
+
* <p>Describes the GPU accelerator capabilities required for worker host instances in this fleet.</p>
|
|
2365
2238
|
* @public
|
|
2366
2239
|
*/
|
|
2367
2240
|
acceleratorCapabilities?: AcceleratorCapabilities | undefined;
|
|
@@ -2409,27 +2282,27 @@ export interface VpcConfiguration {
|
|
|
2409
2282
|
resourceConfigurationArns?: string[] | undefined;
|
|
2410
2283
|
}
|
|
2411
2284
|
/**
|
|
2412
|
-
* <p>The configuration details for a service managed
|
|
2285
|
+
* <p>The configuration details for a service managed EC2 fleet.</p>
|
|
2413
2286
|
* @public
|
|
2414
2287
|
*/
|
|
2415
2288
|
export interface ServiceManagedEc2FleetConfiguration {
|
|
2416
2289
|
/**
|
|
2417
|
-
* <p>The
|
|
2290
|
+
* <p>The instance capabilities for the service managed EC2 fleet.</p>
|
|
2418
2291
|
* @public
|
|
2419
2292
|
*/
|
|
2420
2293
|
instanceCapabilities: ServiceManagedEc2InstanceCapabilities | undefined;
|
|
2421
2294
|
/**
|
|
2422
|
-
* <p>The
|
|
2295
|
+
* <p>The instance market options for the service managed EC2 fleet.</p>
|
|
2423
2296
|
* @public
|
|
2424
2297
|
*/
|
|
2425
2298
|
instanceMarketOptions: ServiceManagedEc2InstanceMarketOptions | undefined;
|
|
2426
2299
|
/**
|
|
2427
|
-
* <p>The VPC configuration
|
|
2300
|
+
* <p>The VPC configuration for the service managed EC2 fleet.</p>
|
|
2428
2301
|
* @public
|
|
2429
2302
|
*/
|
|
2430
2303
|
vpcConfiguration?: VpcConfiguration | undefined;
|
|
2431
2304
|
/**
|
|
2432
|
-
* <p>The storage profile ID.</p>
|
|
2305
|
+
* <p>The storage profile ID for the service managed EC2 fleet.</p>
|
|
2433
2306
|
* @public
|
|
2434
2307
|
*/
|
|
2435
2308
|
storageProfileId?: string | undefined;
|
|
@@ -2480,37 +2353,17 @@ export declare namespace FleetConfiguration {
|
|
|
2480
2353
|
}
|
|
2481
2354
|
}
|
|
2482
2355
|
/**
|
|
2483
|
-
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
2484
|
-
* additional configuration for workers in your fleet. </p>
|
|
2485
|
-
* <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>
|
|
2486
|
-
* operation with the <code>hostConfiguration</code>
|
|
2487
|
-
* <code>scriptBody</code> parameter set to an empty string ("").</p>
|
|
2356
|
+
* <p>Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. </p> <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> operation with the <code>hostConfiguration</code> <code>scriptBody</code> parameter set to an empty string ("").</p>
|
|
2488
2357
|
* @public
|
|
2489
2358
|
*/
|
|
2490
2359
|
export interface HostConfiguration {
|
|
2491
2360
|
/**
|
|
2492
|
-
* <p>The text of the script that runs as a worker is starting up that you can use to provide
|
|
2493
|
-
* additional configuration for workers in your fleet. The script runs after a worker enters
|
|
2494
|
-
* the <code>STARTING</code> state and before the worker processes tasks.</p>
|
|
2495
|
-
* <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
|
|
2496
|
-
* administrator to configure workers</a> in the <i>Deadline Cloud Developer
|
|
2497
|
-
* Guide</i>. </p>
|
|
2498
|
-
* <important>
|
|
2499
|
-
* <p>The script runs as an administrative user (<code>sudo root</code> on Linux, as an
|
|
2500
|
-
* Administrator on Windows). </p>
|
|
2501
|
-
* </important>
|
|
2361
|
+
* <p>The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the <code>STARTING</code> state and before the worker processes tasks.</p> <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 administrator to configure workers</a> in the <i>Deadline Cloud Developer Guide</i>. </p> <important> <p>The script runs as an administrative user (<code>sudo root</code> on Linux, as an Administrator on Windows). </p> </important>
|
|
2502
2362
|
* @public
|
|
2503
2363
|
*/
|
|
2504
2364
|
scriptBody: string | undefined;
|
|
2505
2365
|
/**
|
|
2506
|
-
* <p>The maximum time that the host configuration can run. If the timeout expires, the worker
|
|
2507
|
-
* enters the <code>NOT RESPONDING</code> state and shuts down. You are charged for the time
|
|
2508
|
-
* that the worker is running the host configuration script.</p>
|
|
2509
|
-
* <note>
|
|
2510
|
-
* <p>You should configure your fleet for a maximum of one worker while testing your host
|
|
2511
|
-
* configuration script to avoid starting additional workers.</p>
|
|
2512
|
-
* </note>
|
|
2513
|
-
* <p>The default is 300 seconds (5 minutes).</p>
|
|
2366
|
+
* <p>The maximum time that the host configuration can run. If the timeout expires, the worker enters the <code>NOT RESPONDING</code> state and shuts down. You are charged for the time that the worker is running the host configuration script.</p> <note> <p>You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.</p> </note> <p>The default is 300 seconds (5 minutes).</p>
|
|
2514
2367
|
* @public
|
|
2515
2368
|
*/
|
|
2516
2369
|
scriptTimeoutSeconds?: number | undefined;
|
|
@@ -2530,18 +2383,12 @@ export interface CreateFleetRequest {
|
|
|
2530
2383
|
*/
|
|
2531
2384
|
farmId: string | undefined;
|
|
2532
2385
|
/**
|
|
2533
|
-
* <p>The display name of the fleet.</p>
|
|
2534
|
-
* <important>
|
|
2535
|
-
* <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>
|
|
2536
|
-
* </important>
|
|
2386
|
+
* <p>The display name of the fleet.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2537
2387
|
* @public
|
|
2538
2388
|
*/
|
|
2539
2389
|
displayName: string | undefined;
|
|
2540
2390
|
/**
|
|
2541
|
-
* <p>The description of the fleet.</p>
|
|
2542
|
-
* <important>
|
|
2543
|
-
* <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>
|
|
2544
|
-
* </important>
|
|
2391
|
+
* <p>The description of the fleet.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2545
2392
|
* @public
|
|
2546
2393
|
*/
|
|
2547
2394
|
description?: string | undefined;
|
|
@@ -2556,20 +2403,12 @@ export interface CreateFleetRequest {
|
|
|
2556
2403
|
*/
|
|
2557
2404
|
minWorkerCount?: number | undefined;
|
|
2558
2405
|
/**
|
|
2559
|
-
* <p>The maximum number of workers for the fleet.</p>
|
|
2560
|
-
* <p>Deadline Cloud limits the number of workers to less than or equal to the fleet's
|
|
2561
|
-
* maximum worker count. The service maintains eventual consistency for the worker count. If
|
|
2562
|
-
* you make multiple rapid calls to <code>CreateWorker</code> before the field updates, you
|
|
2563
|
-
* might exceed your fleet's maximum worker count. For example, if your
|
|
2564
|
-
* <code>maxWorkerCount</code> is 10 and you currently have 9 workers, making two quick
|
|
2565
|
-
* <code>CreateWorker</code> calls might successfully create 2 workers instead of 1,
|
|
2566
|
-
* resulting in 11 total workers.</p>
|
|
2406
|
+
* <p>The maximum number of workers for the fleet.</p> <p>Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to <code>CreateWorker</code> before the field updates, you might exceed your fleet's maximum worker count. For example, if your <code>maxWorkerCount</code> is 10 and you currently have 9 workers, making two quick <code>CreateWorker</code> calls might successfully create 2 workers instead of 1, resulting in 11 total workers.</p>
|
|
2567
2407
|
* @public
|
|
2568
2408
|
*/
|
|
2569
2409
|
maxWorkerCount: number | undefined;
|
|
2570
2410
|
/**
|
|
2571
|
-
* <p>The configuration settings for the fleet. Customer managed fleets are self-managed.
|
|
2572
|
-
* Service managed Amazon EC2 fleets are managed by Deadline Cloud.</p>
|
|
2411
|
+
* <p>The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.</p>
|
|
2573
2412
|
* @public
|
|
2574
2413
|
*/
|
|
2575
2414
|
configuration: FleetConfiguration | undefined;
|
|
@@ -2579,8 +2418,7 @@ export interface CreateFleetRequest {
|
|
|
2579
2418
|
*/
|
|
2580
2419
|
tags?: Record<string, string> | undefined;
|
|
2581
2420
|
/**
|
|
2582
|
-
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
2583
|
-
* additional configuration for workers in your fleet.</p>
|
|
2421
|
+
* <p>Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.</p>
|
|
2584
2422
|
* @public
|
|
2585
2423
|
*/
|
|
2586
2424
|
hostConfiguration?: HostConfiguration | undefined;
|
|
@@ -2625,8 +2463,7 @@ export interface CreateJobRequest {
|
|
|
2625
2463
|
*/
|
|
2626
2464
|
templateType?: JobTemplateType | undefined;
|
|
2627
2465
|
/**
|
|
2628
|
-
* <p>The priority of the job. The highest priority (first scheduled) is 100. When two jobs
|
|
2629
|
-
* have the same priority, the oldest job is scheduled first.</p>
|
|
2466
|
+
* <p>The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.</p>
|
|
2630
2467
|
* @public
|
|
2631
2468
|
*/
|
|
2632
2469
|
priority: number | undefined;
|
|
@@ -2636,8 +2473,7 @@ export interface CreateJobRequest {
|
|
|
2636
2473
|
*/
|
|
2637
2474
|
parameters?: Record<string, JobParameter> | undefined;
|
|
2638
2475
|
/**
|
|
2639
|
-
* <p>The attachments for the job. Attach files required for the job to run to a render
|
|
2640
|
-
* job.</p>
|
|
2476
|
+
* <p>The attachments for the job. Attach files required for the job to run to a render job.</p>
|
|
2641
2477
|
* @public
|
|
2642
2478
|
*/
|
|
2643
2479
|
attachments?: Attachments | undefined;
|
|
@@ -2647,8 +2483,7 @@ export interface CreateJobRequest {
|
|
|
2647
2483
|
*/
|
|
2648
2484
|
storageProfileId?: string | undefined;
|
|
2649
2485
|
/**
|
|
2650
|
-
* <p>The initial job status when it is created. Jobs that are created with a
|
|
2651
|
-
* <code>SUSPENDED</code> status will not run until manually requeued.</p>
|
|
2486
|
+
* <p>The initial job status when it is created. Jobs that are created with a <code>SUSPENDED</code> status will not run until manually requeued.</p>
|
|
2652
2487
|
* @public
|
|
2653
2488
|
*/
|
|
2654
2489
|
targetTaskRunStatus?: CreateJobTargetTaskRunStatus | undefined;
|
|
@@ -2663,13 +2498,7 @@ export interface CreateJobRequest {
|
|
|
2663
2498
|
*/
|
|
2664
2499
|
maxRetriesPerTask?: number | undefined;
|
|
2665
2500
|
/**
|
|
2666
|
-
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
2667
|
-
* <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
|
|
2668
|
-
* job, even if the fleets assigned to the job's queue has available workers.</p>
|
|
2669
|
-
* <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no
|
|
2670
|
-
* maximum number of workers.</p>
|
|
2671
|
-
* <p>If you don't specify the <code>maxWorkerCount</code>, Deadline Cloud won't throttle
|
|
2672
|
-
* the number of workers used to process the job.</p>
|
|
2501
|
+
* <p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, Deadline Cloud won't throttle the number of workers used to process the job.</p>
|
|
2673
2502
|
* @public
|
|
2674
2503
|
*/
|
|
2675
2504
|
maxWorkerCount?: number | undefined;
|
|
@@ -2739,26 +2568,17 @@ export interface CreateLimitRequest {
|
|
|
2739
2568
|
*/
|
|
2740
2569
|
clientToken?: string | undefined;
|
|
2741
2570
|
/**
|
|
2742
|
-
* <p>The display name of the limit.</p>
|
|
2743
|
-
* <important>
|
|
2744
|
-
* <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>
|
|
2745
|
-
* </important>
|
|
2571
|
+
* <p>The display name of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2746
2572
|
* @public
|
|
2747
2573
|
*/
|
|
2748
2574
|
displayName: string | undefined;
|
|
2749
2575
|
/**
|
|
2750
|
-
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
2751
|
-
* the <code>hostRequirements</code> in a step of a job template to declare the limit
|
|
2752
|
-
* requirement.</p>
|
|
2576
|
+
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of the <code>hostRequirements</code> in a step of a job template to declare the limit requirement.</p>
|
|
2753
2577
|
* @public
|
|
2754
2578
|
*/
|
|
2755
2579
|
amountRequirementName: string | undefined;
|
|
2756
2580
|
/**
|
|
2757
|
-
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
2758
|
-
* in use, steps that require the limit won't be scheduled until the resource is
|
|
2759
|
-
* available.</p>
|
|
2760
|
-
* <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on
|
|
2761
|
-
* the number of resources that can be acquired for this limit.</p>
|
|
2581
|
+
* <p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>
|
|
2762
2582
|
* @public
|
|
2763
2583
|
*/
|
|
2764
2584
|
maxCount: number | undefined;
|
|
@@ -2768,11 +2588,7 @@ export interface CreateLimitRequest {
|
|
|
2768
2588
|
*/
|
|
2769
2589
|
farmId: string | undefined;
|
|
2770
2590
|
/**
|
|
2771
|
-
* <p>A description of the limit. A description helps you identify the purpose of the
|
|
2772
|
-
* limit.</p>
|
|
2773
|
-
* <important>
|
|
2774
|
-
* <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>
|
|
2775
|
-
* </important>
|
|
2591
|
+
* <p>A description of the limit. A description helps you identify the purpose of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2776
2592
|
* @public
|
|
2777
2593
|
*/
|
|
2778
2594
|
description?: string | undefined;
|
|
@@ -2782,8 +2598,7 @@ export interface CreateLimitRequest {
|
|
|
2782
2598
|
*/
|
|
2783
2599
|
export interface CreateLimitResponse {
|
|
2784
2600
|
/**
|
|
2785
|
-
* <p>A unique identifier for the limit. Use this identifier in other operations, such as
|
|
2786
|
-
* <code>CreateQueueLimitAssociation</code> and <code>DeleteLimit</code>.</p>
|
|
2601
|
+
* <p>A unique identifier for the limit. Use this identifier in other operations, such as <code>CreateQueueLimitAssociation</code> and <code>DeleteLimit</code>.</p>
|
|
2787
2602
|
* @public
|
|
2788
2603
|
*/
|
|
2789
2604
|
limitId: string | undefined;
|
|
@@ -2798,28 +2613,22 @@ export interface CreateMonitorRequest {
|
|
|
2798
2613
|
*/
|
|
2799
2614
|
clientToken?: string | undefined;
|
|
2800
2615
|
/**
|
|
2801
|
-
* <p>The name that you give the monitor that is displayed in the Deadline Cloud console.</p>
|
|
2802
|
-
* <important>
|
|
2803
|
-
* <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>
|
|
2804
|
-
* </important>
|
|
2616
|
+
* <p>The name that you give the monitor that is displayed in the Deadline Cloud console.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2805
2617
|
* @public
|
|
2806
2618
|
*/
|
|
2807
2619
|
displayName: string | undefined;
|
|
2808
2620
|
/**
|
|
2809
|
-
* <p>The Amazon Resource Name
|
|
2621
|
+
* <p>The Amazon Resource Name of the IAM Identity Center instance that authenticates monitor users.</p>
|
|
2810
2622
|
* @public
|
|
2811
2623
|
*/
|
|
2812
2624
|
identityCenterInstanceArn: string | undefined;
|
|
2813
2625
|
/**
|
|
2814
|
-
* <p>The subdomain to use when creating the monitor URL. The full URL of the monitor is
|
|
2815
|
-
* subdomain.Region.deadlinecloud.amazonaws.com.</p>
|
|
2626
|
+
* <p>The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.</p>
|
|
2816
2627
|
* @public
|
|
2817
2628
|
*/
|
|
2818
2629
|
subdomain: string | undefined;
|
|
2819
2630
|
/**
|
|
2820
|
-
* <p>The Amazon Resource Name
|
|
2821
|
-
* that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud
|
|
2822
|
-
* resources.</p>
|
|
2631
|
+
* <p>The Amazon Resource Name of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.</p>
|
|
2823
2632
|
* @public
|
|
2824
2633
|
*/
|
|
2825
2634
|
roleArn: string | undefined;
|
|
@@ -2839,7 +2648,7 @@ export interface CreateMonitorResponse {
|
|
|
2839
2648
|
*/
|
|
2840
2649
|
monitorId: string | undefined;
|
|
2841
2650
|
/**
|
|
2842
|
-
* <p>The Amazon Resource Name
|
|
2651
|
+
* <p>The Amazon Resource Name that IAM Identity Center assigns to the monitor.</p>
|
|
2843
2652
|
* @public
|
|
2844
2653
|
*/
|
|
2845
2654
|
identityCenterApplicationArn: string | undefined;
|
|
@@ -2859,18 +2668,12 @@ export interface CreateQueueRequest {
|
|
|
2859
2668
|
*/
|
|
2860
2669
|
farmId: string | undefined;
|
|
2861
2670
|
/**
|
|
2862
|
-
* <p>The display name of the queue.</p>
|
|
2863
|
-
* <important>
|
|
2864
|
-
* <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>
|
|
2865
|
-
* </important>
|
|
2671
|
+
* <p>The display name of the queue.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2866
2672
|
* @public
|
|
2867
2673
|
*/
|
|
2868
2674
|
displayName: string | undefined;
|
|
2869
2675
|
/**
|
|
2870
|
-
* <p>The description of the queue.</p>
|
|
2871
|
-
* <important>
|
|
2872
|
-
* <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>
|
|
2873
|
-
* </important>
|
|
2676
|
+
* <p>The description of the queue.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
2874
2677
|
* @public
|
|
2875
2678
|
*/
|
|
2876
2679
|
description?: string | undefined;
|
|
@@ -2880,8 +2683,7 @@ export interface CreateQueueRequest {
|
|
|
2880
2683
|
*/
|
|
2881
2684
|
defaultBudgetAction?: DefaultQueueBudgetAction | undefined;
|
|
2882
2685
|
/**
|
|
2883
|
-
* <p>The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3
|
|
2884
|
-
* prefix.</p>
|
|
2686
|
+
* <p>The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.</p>
|
|
2885
2687
|
* @public
|
|
2886
2688
|
*/
|
|
2887
2689
|
jobAttachmentSettings?: JobAttachmentSettings | undefined;
|
|
@@ -2941,9 +2743,7 @@ export interface CreateQueueEnvironmentRequest {
|
|
|
2941
2743
|
*/
|
|
2942
2744
|
queueId: string | undefined;
|
|
2943
2745
|
/**
|
|
2944
|
-
* <p>Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the
|
|
2945
|
-
* highest priority (activated first and deactivated last). If two environments share the same
|
|
2946
|
-
* priority value, the environment created first takes higher priority.</p>
|
|
2746
|
+
* <p>Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.</p>
|
|
2947
2747
|
* @public
|
|
2948
2748
|
*/
|
|
2949
2749
|
priority: number | undefined;
|
|
@@ -3054,10 +2854,7 @@ export interface CreateStorageProfileRequest {
|
|
|
3054
2854
|
*/
|
|
3055
2855
|
farmId: string | undefined;
|
|
3056
2856
|
/**
|
|
3057
|
-
* <p>The display name of the storage profile.</p>
|
|
3058
|
-
* <important>
|
|
3059
|
-
* <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>
|
|
3060
|
-
* </important>
|
|
2857
|
+
* <p>The display name of the storage profile.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
3061
2858
|
* @public
|
|
3062
2859
|
*/
|
|
3063
2860
|
displayName: string | undefined;
|
|
@@ -3205,8 +3002,7 @@ export interface DeleteQueueFleetAssociationResponse {
|
|
|
3205
3002
|
*/
|
|
3206
3003
|
export interface DeleteQueueLimitAssociationRequest {
|
|
3207
3004
|
/**
|
|
3208
|
-
* <p>The unique identifier of the farm that contains the queue and limit to
|
|
3209
|
-
* disassociate.</p>
|
|
3005
|
+
* <p>The unique identifier of the farm that contains the queue and limit to disassociate.</p>
|
|
3210
3006
|
* @public
|
|
3211
3007
|
*/
|
|
3212
3008
|
farmId: string | undefined;
|
|
@@ -3397,18 +3193,12 @@ export interface GetFleetResponse {
|
|
|
3397
3193
|
*/
|
|
3398
3194
|
farmId: string | undefined;
|
|
3399
3195
|
/**
|
|
3400
|
-
* <p>The display name of the fleet.</p>
|
|
3401
|
-
* <important>
|
|
3402
|
-
* <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>
|
|
3403
|
-
* </important>
|
|
3196
|
+
* <p>The display name of the fleet.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
3404
3197
|
* @public
|
|
3405
3198
|
*/
|
|
3406
3199
|
displayName: string | undefined;
|
|
3407
3200
|
/**
|
|
3408
|
-
* <p>The description of the fleet.</p>
|
|
3409
|
-
* <important>
|
|
3410
|
-
* <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>
|
|
3411
|
-
* </important>
|
|
3201
|
+
* <p>The description of the fleet.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
3412
3202
|
* @public
|
|
3413
3203
|
*/
|
|
3414
3204
|
description?: string | undefined;
|
|
@@ -3423,8 +3213,7 @@ export interface GetFleetResponse {
|
|
|
3423
3213
|
*/
|
|
3424
3214
|
statusMessage?: string | undefined;
|
|
3425
3215
|
/**
|
|
3426
|
-
* <p>The Auto Scaling status of the fleet. Either <code>GROWING</code>, <code>STEADY</code>, or
|
|
3427
|
-
* <code>SHRINKING</code>.</p>
|
|
3216
|
+
* <p>The Auto Scaling status of the fleet. Either <code>GROWING</code>, <code>STEADY</code>, or <code>SHRINKING</code>.</p>
|
|
3428
3217
|
* @public
|
|
3429
3218
|
*/
|
|
3430
3219
|
autoScalingStatus?: AutoScalingStatus | undefined;
|
|
@@ -3454,14 +3243,12 @@ export interface GetFleetResponse {
|
|
|
3454
3243
|
*/
|
|
3455
3244
|
configuration: FleetConfiguration | undefined;
|
|
3456
3245
|
/**
|
|
3457
|
-
* <p>The script that runs as a worker is starting up that you can use to provide additional
|
|
3458
|
-
* configuration for workers in your fleet.</p>
|
|
3246
|
+
* <p>The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.</p>
|
|
3459
3247
|
* @public
|
|
3460
3248
|
*/
|
|
3461
3249
|
hostConfiguration?: HostConfiguration | undefined;
|
|
3462
3250
|
/**
|
|
3463
|
-
* <p>Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to
|
|
3464
|
-
* attribute names and values.</p>
|
|
3251
|
+
* <p>Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.</p>
|
|
3465
3252
|
* @public
|
|
3466
3253
|
*/
|
|
3467
3254
|
capabilities?: FleetCapabilities | undefined;
|
|
@@ -3582,10 +3369,7 @@ export interface ListFleetsRequest {
|
|
|
3582
3369
|
*/
|
|
3583
3370
|
principalId?: string | undefined;
|
|
3584
3371
|
/**
|
|
3585
|
-
* <p>The display names of a list of fleets.</p>
|
|
3586
|
-
* <important>
|
|
3587
|
-
* <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>
|
|
3588
|
-
* </important>
|
|
3372
|
+
* <p>The display names of a list of fleets.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
3589
3373
|
* @public
|
|
3590
3374
|
*/
|
|
3591
3375
|
displayName?: string | undefined;
|
|
@@ -3621,10 +3405,7 @@ export interface FleetSummary {
|
|
|
3621
3405
|
*/
|
|
3622
3406
|
farmId: string | undefined;
|
|
3623
3407
|
/**
|
|
3624
|
-
* <p>The display name of the fleet summary to update.</p>
|
|
3625
|
-
* <important>
|
|
3626
|
-
* <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>
|
|
3627
|
-
* </important>
|
|
3408
|
+
* <p>The display name of the fleet summary to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
3628
3409
|
* @public
|
|
3629
3410
|
*/
|
|
3630
3411
|
displayName: string | undefined;
|
|
@@ -3724,18 +3505,12 @@ export interface UpdateFleetRequest {
|
|
|
3724
3505
|
*/
|
|
3725
3506
|
fleetId: string | undefined;
|
|
3726
3507
|
/**
|
|
3727
|
-
* <p>The display name of the fleet to update.</p>
|
|
3728
|
-
* <important>
|
|
3729
|
-
* <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>
|
|
3730
|
-
* </important>
|
|
3508
|
+
* <p>The display name of the fleet to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
3731
3509
|
* @public
|
|
3732
3510
|
*/
|
|
3733
3511
|
displayName?: string | undefined;
|
|
3734
3512
|
/**
|
|
3735
|
-
* <p>The description of the fleet to update.</p>
|
|
3736
|
-
* <important>
|
|
3737
|
-
* <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>
|
|
3738
|
-
* </important>
|
|
3513
|
+
* <p>The description of the fleet to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
3739
3514
|
* @public
|
|
3740
3515
|
*/
|
|
3741
3516
|
description?: string | undefined;
|
|
@@ -3750,14 +3525,7 @@ export interface UpdateFleetRequest {
|
|
|
3750
3525
|
*/
|
|
3751
3526
|
minWorkerCount?: number | undefined;
|
|
3752
3527
|
/**
|
|
3753
|
-
* <p>The maximum number of workers in the fleet.</p>
|
|
3754
|
-
* <p>Deadline Cloud limits the number of workers to less than or equal to the fleet's
|
|
3755
|
-
* maximum worker count. The service maintains eventual consistency for the worker count. If
|
|
3756
|
-
* you make multiple rapid calls to <code>CreateWorker</code> before the field updates, you
|
|
3757
|
-
* might exceed your fleet's maximum worker count. For example, if your
|
|
3758
|
-
* <code>maxWorkerCount</code> is 10 and you currently have 9 workers, making two quick
|
|
3759
|
-
* <code>CreateWorker</code> calls might successfully create 2 workers instead of 1,
|
|
3760
|
-
* resulting in 11 total workers.</p>
|
|
3528
|
+
* <p>The maximum number of workers in the fleet.</p> <p>Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to <code>CreateWorker</code> before the field updates, you might exceed your fleet's maximum worker count. For example, if your <code>maxWorkerCount</code> is 10 and you currently have 9 workers, making two quick <code>CreateWorker</code> calls might successfully create 2 workers instead of 1, resulting in 11 total workers.</p>
|
|
3761
3529
|
* @public
|
|
3762
3530
|
*/
|
|
3763
3531
|
maxWorkerCount?: number | undefined;
|
|
@@ -3767,8 +3535,7 @@ export interface UpdateFleetRequest {
|
|
|
3767
3535
|
*/
|
|
3768
3536
|
configuration?: FleetConfiguration | undefined;
|
|
3769
3537
|
/**
|
|
3770
|
-
* <p>Provides a script that runs as a worker is starting up that you can use to provide
|
|
3771
|
-
* additional configuration for workers in your fleet.</p>
|
|
3538
|
+
* <p>Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.</p>
|
|
3772
3539
|
* @public
|
|
3773
3540
|
*/
|
|
3774
3541
|
hostConfiguration?: HostConfiguration | undefined;
|
|
@@ -4179,8 +3946,7 @@ export interface UpdateWorkerResponse {
|
|
|
4179
3946
|
*/
|
|
4180
3947
|
log?: LogConfiguration | undefined;
|
|
4181
3948
|
/**
|
|
4182
|
-
* <p>The script that runs as a worker is starting up that you can use to provide additional
|
|
4183
|
-
* configuration for workers in your fleet.</p>
|
|
3949
|
+
* <p>The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.</p>
|
|
4184
3950
|
* @public
|
|
4185
3951
|
*/
|
|
4186
3952
|
hostConfiguration?: HostConfiguration | undefined;
|
|
@@ -4202,8 +3968,7 @@ export interface TaskRunManifestPropertiesRequest {
|
|
|
4202
3968
|
outputManifestHash?: string | undefined;
|
|
4203
3969
|
}
|
|
4204
3970
|
/**
|
|
4205
|
-
* <p>The updated session action information as it relates to completion and progress of the
|
|
4206
|
-
* session.</p>
|
|
3971
|
+
* <p>The updated session action information as it relates to completion and progress of the session.</p>
|
|
4207
3972
|
* @public
|
|
4208
3973
|
*/
|
|
4209
3974
|
export interface UpdatedSessionActionInfo {
|
|
@@ -4213,8 +3978,7 @@ export interface UpdatedSessionActionInfo {
|
|
|
4213
3978
|
*/
|
|
4214
3979
|
completedStatus?: CompletedStatus | undefined;
|
|
4215
3980
|
/**
|
|
4216
|
-
* <p>The process exit code. The default Deadline Cloud worker agent converts unsigned
|
|
4217
|
-
* 32-bit exit codes to signed 32-bit exit codes.</p>
|
|
3981
|
+
* <p>The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.</p>
|
|
4218
3982
|
* @public
|
|
4219
3983
|
*/
|
|
4220
3984
|
processExitCode?: number | undefined;
|
|
@@ -4244,8 +4008,7 @@ export interface UpdatedSessionActionInfo {
|
|
|
4244
4008
|
*/
|
|
4245
4009
|
progressPercent?: number | undefined;
|
|
4246
4010
|
/**
|
|
4247
|
-
* <p>A list of output manifest properties reported by the worker
|
|
4248
|
-
* agent, with each entry corresponding to a manifest property in the job.</p>
|
|
4011
|
+
* <p>A list of output manifest properties reported by the worker agent, with each entry corresponding to a manifest property in the job.</p>
|
|
4249
4012
|
* @public
|
|
4250
4013
|
*/
|
|
4251
4014
|
manifests?: TaskRunManifestPropertiesRequest[] | undefined;
|
|
@@ -4320,18 +4083,12 @@ export interface GetFarmResponse {
|
|
|
4320
4083
|
*/
|
|
4321
4084
|
farmId: string | undefined;
|
|
4322
4085
|
/**
|
|
4323
|
-
* <p>The display name of the farm.</p>
|
|
4324
|
-
* <important>
|
|
4325
|
-
* <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>
|
|
4326
|
-
* </important>
|
|
4086
|
+
* <p>The display name of the farm.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4327
4087
|
* @public
|
|
4328
4088
|
*/
|
|
4329
4089
|
displayName: string | undefined;
|
|
4330
4090
|
/**
|
|
4331
|
-
* <p>The description of the farm.</p>
|
|
4332
|
-
* <important>
|
|
4333
|
-
* <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>
|
|
4334
|
-
* </important>
|
|
4091
|
+
* <p>The description of the farm.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4335
4092
|
* @public
|
|
4336
4093
|
*/
|
|
4337
4094
|
description?: string | undefined;
|
|
@@ -4339,7 +4096,7 @@ export interface GetFarmResponse {
|
|
|
4339
4096
|
* <p>The ARN of the KMS key used on the farm.</p>
|
|
4340
4097
|
* @public
|
|
4341
4098
|
*/
|
|
4342
|
-
kmsKeyArn
|
|
4099
|
+
kmsKeyArn?: string | undefined;
|
|
4343
4100
|
/**
|
|
4344
4101
|
* <p>The date and time the resource was created.</p>
|
|
4345
4102
|
* @public
|
|
@@ -4381,26 +4138,17 @@ export interface GetLimitRequest {
|
|
|
4381
4138
|
*/
|
|
4382
4139
|
export interface GetLimitResponse {
|
|
4383
4140
|
/**
|
|
4384
|
-
* <p>The display name of the limit.</p>
|
|
4385
|
-
* <important>
|
|
4386
|
-
* <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>
|
|
4387
|
-
* </important>
|
|
4141
|
+
* <p>The display name of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4388
4142
|
* @public
|
|
4389
4143
|
*/
|
|
4390
4144
|
displayName: string | undefined;
|
|
4391
4145
|
/**
|
|
4392
|
-
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
4393
|
-
* the <code>hostRequirements</code> in a step of a job template to declare the limit
|
|
4394
|
-
* requirement.</p>
|
|
4146
|
+
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of the <code>hostRequirements</code> in a step of a job template to declare the limit requirement.</p>
|
|
4395
4147
|
* @public
|
|
4396
4148
|
*/
|
|
4397
4149
|
amountRequirementName: string | undefined;
|
|
4398
4150
|
/**
|
|
4399
|
-
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
4400
|
-
* in use, steps that require the limit won't be scheduled until the resource is
|
|
4401
|
-
* available.</p>
|
|
4402
|
-
* <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on
|
|
4403
|
-
* the number of resources that can be acquired for this limit.</p>
|
|
4151
|
+
* <p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>
|
|
4404
4152
|
* @public
|
|
4405
4153
|
*/
|
|
4406
4154
|
maxCount: number | undefined;
|
|
@@ -4435,16 +4183,12 @@ export interface GetLimitResponse {
|
|
|
4435
4183
|
*/
|
|
4436
4184
|
limitId: string | undefined;
|
|
4437
4185
|
/**
|
|
4438
|
-
* <p>The number of resources from the limit that are being used by jobs. The result is
|
|
4439
|
-
* delayed and may not be the count at the time that you called the operation.</p>
|
|
4186
|
+
* <p>The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.</p>
|
|
4440
4187
|
* @public
|
|
4441
4188
|
*/
|
|
4442
4189
|
currentCount: number | undefined;
|
|
4443
4190
|
/**
|
|
4444
|
-
* <p>The description of the limit that helps identify what the limit is used for.</p>
|
|
4445
|
-
* <important>
|
|
4446
|
-
* <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>
|
|
4447
|
-
* </important>
|
|
4191
|
+
* <p>The description of the limit that helps identify what the limit is used for.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4448
4192
|
* @public
|
|
4449
4193
|
*/
|
|
4450
4194
|
description?: string | undefined;
|
|
@@ -4474,10 +4218,7 @@ export interface GetStorageProfileResponse {
|
|
|
4474
4218
|
*/
|
|
4475
4219
|
storageProfileId: string | undefined;
|
|
4476
4220
|
/**
|
|
4477
|
-
* <p>The display name of the storage profile.</p>
|
|
4478
|
-
* <important>
|
|
4479
|
-
* <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>
|
|
4480
|
-
* </important>
|
|
4221
|
+
* <p>The display name of the storage profile.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4481
4222
|
* @public
|
|
4482
4223
|
*/
|
|
4483
4224
|
displayName: string | undefined;
|
|
@@ -4609,10 +4350,7 @@ export interface FarmSummary {
|
|
|
4609
4350
|
*/
|
|
4610
4351
|
farmId: string | undefined;
|
|
4611
4352
|
/**
|
|
4612
|
-
* <p>The display name of the farm.</p>
|
|
4613
|
-
* <important>
|
|
4614
|
-
* <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>
|
|
4615
|
-
* </important>
|
|
4353
|
+
* <p>The display name of the farm.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4616
4354
|
* @public
|
|
4617
4355
|
*/
|
|
4618
4356
|
displayName: string | undefined;
|
|
@@ -4683,26 +4421,17 @@ export interface ListLimitsRequest {
|
|
|
4683
4421
|
*/
|
|
4684
4422
|
export interface LimitSummary {
|
|
4685
4423
|
/**
|
|
4686
|
-
* <p>The name of the limit used in lists to identify the limit.</p>
|
|
4687
|
-
* <important>
|
|
4688
|
-
* <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>
|
|
4689
|
-
* </important>
|
|
4424
|
+
* <p>The name of the limit used in lists to identify the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4690
4425
|
* @public
|
|
4691
4426
|
*/
|
|
4692
4427
|
displayName: string | undefined;
|
|
4693
4428
|
/**
|
|
4694
|
-
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of
|
|
4695
|
-
* the <code>hostRequirements</code> in a step of a job template to declare the limit
|
|
4696
|
-
* requirement.</p>
|
|
4429
|
+
* <p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of the <code>hostRequirements</code> in a step of a job template to declare the limit requirement.</p>
|
|
4697
4430
|
* @public
|
|
4698
4431
|
*/
|
|
4699
4432
|
amountRequirementName: string | undefined;
|
|
4700
4433
|
/**
|
|
4701
|
-
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
4702
|
-
* in use, steps that require the limit won't be scheduled until the resource is
|
|
4703
|
-
* available.</p>
|
|
4704
|
-
* <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on
|
|
4705
|
-
* the number of resources that can be acquired for this limit.</p>
|
|
4434
|
+
* <p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>
|
|
4706
4435
|
* @public
|
|
4707
4436
|
*/
|
|
4708
4437
|
maxCount: number | undefined;
|
|
@@ -4737,8 +4466,7 @@ export interface LimitSummary {
|
|
|
4737
4466
|
*/
|
|
4738
4467
|
limitId: string | undefined;
|
|
4739
4468
|
/**
|
|
4740
|
-
* <p>The number of resources from the limit that are being used by jobs. The result is
|
|
4741
|
-
* delayed and may not be the count at the time that you called the operation.</p>
|
|
4469
|
+
* <p>The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.</p>
|
|
4742
4470
|
* @public
|
|
4743
4471
|
*/
|
|
4744
4472
|
currentCount: number | undefined;
|
|
@@ -4789,10 +4517,7 @@ export interface StorageProfileSummary {
|
|
|
4789
4517
|
*/
|
|
4790
4518
|
storageProfileId: string | undefined;
|
|
4791
4519
|
/**
|
|
4792
|
-
* <p>The display name of the storage profile summary to update.</p>
|
|
4793
|
-
* <important>
|
|
4794
|
-
* <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>
|
|
4795
|
-
* </important>
|
|
4520
|
+
* <p>The display name of the storage profile summary to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4796
4521
|
* @public
|
|
4797
4522
|
*/
|
|
4798
4523
|
displayName: string | undefined;
|
|
@@ -4912,18 +4637,12 @@ export interface GetQueueResponse {
|
|
|
4912
4637
|
*/
|
|
4913
4638
|
queueId: string | undefined;
|
|
4914
4639
|
/**
|
|
4915
|
-
* <p>The display name of the queue.</p>
|
|
4916
|
-
* <important>
|
|
4917
|
-
* <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>
|
|
4918
|
-
* </important>
|
|
4640
|
+
* <p>The display name of the queue.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4919
4641
|
* @public
|
|
4920
4642
|
*/
|
|
4921
4643
|
displayName: string | undefined;
|
|
4922
4644
|
/**
|
|
4923
|
-
* <p>The description of the queue.</p>
|
|
4924
|
-
* <important>
|
|
4925
|
-
* <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>
|
|
4926
|
-
* </important>
|
|
4645
|
+
* <p>The description of the queue.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
4927
4646
|
* @public
|
|
4928
4647
|
*/
|
|
4929
4648
|
description?: string | undefined;
|
|
@@ -4933,22 +4652,7 @@ export interface GetQueueResponse {
|
|
|
4933
4652
|
*/
|
|
4934
4653
|
farmId: string | undefined;
|
|
4935
4654
|
/**
|
|
4936
|
-
* <p>The status of the queue.</p>
|
|
4937
|
-
* <ul>
|
|
4938
|
-
* <li>
|
|
4939
|
-
* <p>
|
|
4940
|
-
* <code>ACTIVE</code>–The queue is active.</p>
|
|
4941
|
-
* </li>
|
|
4942
|
-
* <li>
|
|
4943
|
-
* <p>
|
|
4944
|
-
* <code>SCHEDULING</code>–The queue is scheduling.</p>
|
|
4945
|
-
* </li>
|
|
4946
|
-
* <li>
|
|
4947
|
-
* <p>
|
|
4948
|
-
* <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked. See the
|
|
4949
|
-
* provided reason.</p>
|
|
4950
|
-
* </li>
|
|
4951
|
-
* </ul>
|
|
4655
|
+
* <p>The status of the queue.</p> <ul> <li> <p> <code>ACTIVE</code>–The queue is active.</p> </li> <li> <p> <code>SCHEDULING</code>–The queue is scheduling.</p> </li> <li> <p> <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked. See the provided reason.</p> </li> </ul>
|
|
4952
4656
|
* @public
|
|
4953
4657
|
*/
|
|
4954
4658
|
status: QueueStatus | undefined;
|
|
@@ -5108,10 +4812,7 @@ export interface GetStorageProfileForQueueResponse {
|
|
|
5108
4812
|
*/
|
|
5109
4813
|
storageProfileId: string | undefined;
|
|
5110
4814
|
/**
|
|
5111
|
-
* <p>The display name of the storage profile connected to a queue.</p>
|
|
5112
|
-
* <important>
|
|
5113
|
-
* <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>
|
|
5114
|
-
* </important>
|
|
4815
|
+
* <p>The display name of the storage profile connected to a queue.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
5115
4816
|
* @public
|
|
5116
4817
|
*/
|
|
5117
4818
|
displayName: string | undefined;
|
|
@@ -5281,19 +4982,12 @@ export interface GetJobResponse {
|
|
|
5281
4982
|
*/
|
|
5282
4983
|
attachments?: Attachments | undefined;
|
|
5283
4984
|
/**
|
|
5284
|
-
* <p>The description of the job.</p>
|
|
5285
|
-
* <important>
|
|
5286
|
-
* <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>
|
|
5287
|
-
* </important>
|
|
4985
|
+
* <p>The description of the job.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
5288
4986
|
* @public
|
|
5289
4987
|
*/
|
|
5290
4988
|
description?: string | undefined;
|
|
5291
4989
|
/**
|
|
5292
|
-
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
5293
|
-
* <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
|
|
5294
|
-
* job, even if the fleets assigned to the job's queue has available workers.</p>
|
|
5295
|
-
* <p>If you don't set the <code>maxWorkerCount</code> when you create a job, this value is
|
|
5296
|
-
* not returned in the response.</p>
|
|
4990
|
+
* <p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>If you don't set the <code>maxWorkerCount</code> when you create a job, this value is not returned in the response.</p>
|
|
5297
4991
|
* @public
|
|
5298
4992
|
*/
|
|
5299
4993
|
maxWorkerCount?: number | undefined;
|
|
@@ -5441,12 +5135,12 @@ export interface EnvironmentExitSessionActionDefinition {
|
|
|
5441
5135
|
environmentId: string | undefined;
|
|
5442
5136
|
}
|
|
5443
5137
|
/**
|
|
5444
|
-
* <p>The
|
|
5138
|
+
* <p>The session action definition for syncing input job attachments.</p>
|
|
5445
5139
|
* @public
|
|
5446
5140
|
*/
|
|
5447
5141
|
export interface SyncInputJobAttachmentsSessionActionDefinition {
|
|
5448
5142
|
/**
|
|
5449
|
-
* <p>The step ID for the
|
|
5143
|
+
* <p>The step ID for the sync input job attachments session action.</p>
|
|
5450
5144
|
* @public
|
|
5451
5145
|
*/
|
|
5452
5146
|
stepId?: string | undefined;
|
|
@@ -5515,7 +5209,7 @@ export declare namespace SessionActionDefinition {
|
|
|
5515
5209
|
$unknown?: never;
|
|
5516
5210
|
}
|
|
5517
5211
|
/**
|
|
5518
|
-
* <p>The
|
|
5212
|
+
* <p>The session action definition for syncing input job attachments.</p>
|
|
5519
5213
|
* @public
|
|
5520
5214
|
*/
|
|
5521
5215
|
interface SyncInputJobAttachmentsMember {
|
|
@@ -5603,8 +5297,7 @@ export interface GetSessionActionResponse {
|
|
|
5603
5297
|
*/
|
|
5604
5298
|
sessionId: string | undefined;
|
|
5605
5299
|
/**
|
|
5606
|
-
* <p>The process exit code. The default Deadline Cloud worker agent converts unsigned
|
|
5607
|
-
* 32-bit exit codes to signed 32-bit exit codes.</p>
|
|
5300
|
+
* <p>The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.</p>
|
|
5608
5301
|
* @public
|
|
5609
5302
|
*/
|
|
5610
5303
|
processExitCode?: number | undefined;
|
|
@@ -5619,8 +5312,7 @@ export interface GetSessionActionResponse {
|
|
|
5619
5312
|
*/
|
|
5620
5313
|
definition: SessionActionDefinition | undefined;
|
|
5621
5314
|
/**
|
|
5622
|
-
* <p>The limits and their amounts acquired during a session action. If no limits were
|
|
5623
|
-
* acquired during the session, this field isn't returned.</p>
|
|
5315
|
+
* <p>The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.</p>
|
|
5624
5316
|
* @public
|
|
5625
5317
|
*/
|
|
5626
5318
|
acquiredLimits?: AcquiredLimit[] | undefined;
|
|
@@ -5681,6 +5373,27 @@ export interface DependencyCounts {
|
|
|
5681
5373
|
*/
|
|
5682
5374
|
consumersUnresolved: number | undefined;
|
|
5683
5375
|
}
|
|
5376
|
+
/**
|
|
5377
|
+
* <p>Defines how a step parameter range should be divided into chunks.</p>
|
|
5378
|
+
* @public
|
|
5379
|
+
*/
|
|
5380
|
+
export interface StepParameterChunks {
|
|
5381
|
+
/**
|
|
5382
|
+
* <p>The number of tasks to combine into a single chunk by default.</p>
|
|
5383
|
+
* @public
|
|
5384
|
+
*/
|
|
5385
|
+
defaultTaskCount: number | undefined;
|
|
5386
|
+
/**
|
|
5387
|
+
* <p>The number of seconds to aim for when forming chunks.</p>
|
|
5388
|
+
* @public
|
|
5389
|
+
*/
|
|
5390
|
+
targetRuntimeSeconds?: number | undefined;
|
|
5391
|
+
/**
|
|
5392
|
+
* <p>Specifies whether the chunked ranges must be contiguous or can have gaps between them.</p>
|
|
5393
|
+
* @public
|
|
5394
|
+
*/
|
|
5395
|
+
rangeConstraint: RangeConstraint | undefined;
|
|
5396
|
+
}
|
|
5684
5397
|
/**
|
|
5685
5398
|
* <p>The details of a step parameter.</p>
|
|
5686
5399
|
* @public
|
|
@@ -5696,6 +5409,11 @@ export interface StepParameter {
|
|
|
5696
5409
|
* @public
|
|
5697
5410
|
*/
|
|
5698
5411
|
type: StepParameterType | undefined;
|
|
5412
|
+
/**
|
|
5413
|
+
* <p>The configuration for task chunking.</p>
|
|
5414
|
+
* @public
|
|
5415
|
+
*/
|
|
5416
|
+
chunks?: StepParameterChunks | undefined;
|
|
5699
5417
|
}
|
|
5700
5418
|
/**
|
|
5701
5419
|
* <p>The details of a search for two or more step parameters.</p>
|
|
@@ -5866,10 +5584,7 @@ export interface GetStepResponse {
|
|
|
5866
5584
|
*/
|
|
5867
5585
|
parameterSpace?: ParameterSpace | undefined;
|
|
5868
5586
|
/**
|
|
5869
|
-
* <p>The description of the step.</p>
|
|
5870
|
-
* <important>
|
|
5871
|
-
* <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>
|
|
5872
|
-
* </important>
|
|
5587
|
+
* <p>The description of the step.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
5873
5588
|
* @public
|
|
5874
5589
|
*/
|
|
5875
5590
|
description?: string | undefined;
|
|
@@ -5964,7 +5679,7 @@ export interface GetTaskResponse {
|
|
|
5964
5679
|
*/
|
|
5965
5680
|
updatedBy?: string | undefined;
|
|
5966
5681
|
/**
|
|
5967
|
-
* <p>The latest session ID for the task.</p>
|
|
5682
|
+
* <p>The latest session action ID for the task.</p>
|
|
5968
5683
|
* @public
|
|
5969
5684
|
*/
|
|
5970
5685
|
latestSessionActionId?: string | undefined;
|
|
@@ -6191,54 +5906,12 @@ export interface JobSummary {
|
|
|
6191
5906
|
*/
|
|
6192
5907
|
endedAt?: Date | undefined;
|
|
6193
5908
|
/**
|
|
6194
|
-
* <p>The task run status for the job.</p>
|
|
6195
|
-
* <ul>
|
|
6196
|
-
* <li>
|
|
6197
|
-
* <p>
|
|
6198
|
-
* <code>PENDING</code>–pending and waiting for resources.</p>
|
|
6199
|
-
* </li>
|
|
6200
|
-
* <li>
|
|
6201
|
-
* <p>
|
|
6202
|
-
* <code>READY</code>–ready to be processed.</p>
|
|
6203
|
-
* </li>
|
|
6204
|
-
* <li>
|
|
6205
|
-
* <p>
|
|
6206
|
-
* <code>ASSIGNED</code>–assigned and will run next on a worker.</p>
|
|
6207
|
-
* </li>
|
|
6208
|
-
* <li>
|
|
6209
|
-
* <p>
|
|
6210
|
-
* <code>SCHEDULED</code>–scheduled to be run on a worker.</p>
|
|
6211
|
-
* </li>
|
|
6212
|
-
* <li>
|
|
6213
|
-
* <p>
|
|
6214
|
-
* <code>INTERRUPTING</code>–being interrupted.</p>
|
|
6215
|
-
* </li>
|
|
6216
|
-
* <li>
|
|
6217
|
-
* <p>
|
|
6218
|
-
* <code>RUNNING</code>–running on a worker.</p>
|
|
6219
|
-
* </li>
|
|
6220
|
-
* <li>
|
|
6221
|
-
* <p>
|
|
6222
|
-
* <code>SUSPENDED</code>–the task is suspended.</p>
|
|
6223
|
-
* </li>
|
|
6224
|
-
* <li>
|
|
6225
|
-
* <p>
|
|
6226
|
-
* <code>CANCELED</code>–the task has been canceled.</p>
|
|
6227
|
-
* </li>
|
|
6228
|
-
* <li>
|
|
6229
|
-
* <p>
|
|
6230
|
-
* <code>FAILED</code>–the task has failed.</p>
|
|
6231
|
-
* </li>
|
|
6232
|
-
* <li>
|
|
6233
|
-
* <p>
|
|
6234
|
-
* <code>SUCCEEDED</code>–the task has succeeded.</p>
|
|
6235
|
-
* </li>
|
|
6236
|
-
* </ul>
|
|
5909
|
+
* <p>The task run status for the job.</p> <ul> <li> <p> <code>PENDING</code>–pending and waiting for resources.</p> </li> <li> <p> <code>READY</code>–ready to be processed.</p> </li> <li> <p> <code>ASSIGNED</code>–assigned and will run next on a worker.</p> </li> <li> <p> <code>SCHEDULED</code>–scheduled to be run on a worker.</p> </li> <li> <p> <code>INTERRUPTING</code>–being interrupted.</p> </li> <li> <p> <code>RUNNING</code>–running on a worker.</p> </li> <li> <p> <code>SUSPENDED</code>–the task is suspended.</p> </li> <li> <p> <code>CANCELED</code>–the task has been canceled.</p> </li> <li> <p> <code>FAILED</code>–the task has failed.</p> </li> <li> <p> <code>SUCCEEDED</code>–the task has succeeded.</p> </li> </ul>
|
|
6237
5910
|
* @public
|
|
6238
5911
|
*/
|
|
6239
5912
|
taskRunStatus?: TaskRunStatus | undefined;
|
|
6240
5913
|
/**
|
|
6241
|
-
* <p>The task status to
|
|
5914
|
+
* <p>The task status to update the job's tasks to.</p>
|
|
6242
5915
|
* @public
|
|
6243
5916
|
*/
|
|
6244
5917
|
targetTaskRunStatus?: JobTargetTaskRunStatus | undefined;
|
|
@@ -6263,12 +5936,7 @@ export interface JobSummary {
|
|
|
6263
5936
|
*/
|
|
6264
5937
|
maxRetriesPerTask?: number | undefined;
|
|
6265
5938
|
/**
|
|
6266
|
-
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
6267
|
-
* <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
|
|
6268
|
-
* job, even if the fleets assigned to the job's queue has available workers.</p>
|
|
6269
|
-
* <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no
|
|
6270
|
-
* maximum number of workers.</p>
|
|
6271
|
-
* <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p>
|
|
5939
|
+
* <p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p>
|
|
6272
5940
|
* @public
|
|
6273
5941
|
*/
|
|
6274
5942
|
maxWorkerCount?: number | undefined;
|
|
@@ -6356,12 +6024,12 @@ export interface EnvironmentExitSessionActionDefinitionSummary {
|
|
|
6356
6024
|
environmentId: string | undefined;
|
|
6357
6025
|
}
|
|
6358
6026
|
/**
|
|
6359
|
-
* <p>The
|
|
6027
|
+
* <p>The summary of the session action definition for syncing input job attachments.</p>
|
|
6360
6028
|
* @public
|
|
6361
6029
|
*/
|
|
6362
6030
|
export interface SyncInputJobAttachmentsSessionActionDefinitionSummary {
|
|
6363
6031
|
/**
|
|
6364
|
-
* <p>The step ID
|
|
6032
|
+
* <p>The step ID for the sync input job attachments session action summary.</p>
|
|
6365
6033
|
* @public
|
|
6366
6034
|
*/
|
|
6367
6035
|
stepId?: string | undefined;
|
|
@@ -6430,7 +6098,7 @@ export declare namespace SessionActionDefinitionSummary {
|
|
|
6430
6098
|
$unknown?: never;
|
|
6431
6099
|
}
|
|
6432
6100
|
/**
|
|
6433
|
-
* <p>The
|
|
6101
|
+
* <p>The session action definition summary for syncing input job attachments.</p>
|
|
6434
6102
|
* @public
|
|
6435
6103
|
*/
|
|
6436
6104
|
interface SyncInputJobAttachmentsMember {
|
|
@@ -6488,8 +6156,7 @@ export interface SessionActionSummary {
|
|
|
6488
6156
|
*/
|
|
6489
6157
|
endedAt?: Date | undefined;
|
|
6490
6158
|
/**
|
|
6491
|
-
* <p>The Linux timestamp of the last date and time that the session action was
|
|
6492
|
-
* updated.</p>
|
|
6159
|
+
* <p>The Linux timestamp of the last date and time that the session action was updated.</p>
|
|
6493
6160
|
* @public
|
|
6494
6161
|
*/
|
|
6495
6162
|
workerUpdatedAt?: Date | undefined;
|
|
@@ -6808,49 +6475,7 @@ export interface StepSummary {
|
|
|
6808
6475
|
*/
|
|
6809
6476
|
lifecycleStatusMessage?: string | undefined;
|
|
6810
6477
|
/**
|
|
6811
|
-
* <p>The task run status for the job.</p>
|
|
6812
|
-
* <ul>
|
|
6813
|
-
* <li>
|
|
6814
|
-
* <p>
|
|
6815
|
-
* <code>PENDING</code>–pending and waiting for resources.</p>
|
|
6816
|
-
* </li>
|
|
6817
|
-
* <li>
|
|
6818
|
-
* <p>
|
|
6819
|
-
* <code>READY</code>–ready to process.</p>
|
|
6820
|
-
* </li>
|
|
6821
|
-
* <li>
|
|
6822
|
-
* <p>
|
|
6823
|
-
* <code>ASSIGNED</code>–assigned and will run next on a worker.</p>
|
|
6824
|
-
* </li>
|
|
6825
|
-
* <li>
|
|
6826
|
-
* <p>
|
|
6827
|
-
* <code>SCHEDULED</code>–scheduled to run on a worker.</p>
|
|
6828
|
-
* </li>
|
|
6829
|
-
* <li>
|
|
6830
|
-
* <p>
|
|
6831
|
-
* <code>INTERRUPTING</code>–being interrupted.</p>
|
|
6832
|
-
* </li>
|
|
6833
|
-
* <li>
|
|
6834
|
-
* <p>
|
|
6835
|
-
* <code>RUNNING</code>–running on a worker.</p>
|
|
6836
|
-
* </li>
|
|
6837
|
-
* <li>
|
|
6838
|
-
* <p>
|
|
6839
|
-
* <code>SUSPENDED</code>–the task is suspended.</p>
|
|
6840
|
-
* </li>
|
|
6841
|
-
* <li>
|
|
6842
|
-
* <p>
|
|
6843
|
-
* <code>CANCELED</code>–the task has been canceled.</p>
|
|
6844
|
-
* </li>
|
|
6845
|
-
* <li>
|
|
6846
|
-
* <p>
|
|
6847
|
-
* <code>FAILED</code>–the task has failed.</p>
|
|
6848
|
-
* </li>
|
|
6849
|
-
* <li>
|
|
6850
|
-
* <p>
|
|
6851
|
-
* <code>SUCCEEDED</code>–the task has succeeded.</p>
|
|
6852
|
-
* </li>
|
|
6853
|
-
* </ul>
|
|
6478
|
+
* <p>The task run status for the job.</p> <ul> <li> <p> <code>PENDING</code>–pending and waiting for resources.</p> </li> <li> <p> <code>READY</code>–ready to process.</p> </li> <li> <p> <code>ASSIGNED</code>–assigned and will run next on a worker.</p> </li> <li> <p> <code>SCHEDULED</code>–scheduled to run on a worker.</p> </li> <li> <p> <code>INTERRUPTING</code>–being interrupted.</p> </li> <li> <p> <code>RUNNING</code>–running on a worker.</p> </li> <li> <p> <code>SUSPENDED</code>–the task is suspended.</p> </li> <li> <p> <code>CANCELED</code>–the task has been canceled.</p> </li> <li> <p> <code>FAILED</code>–the task has failed.</p> </li> <li> <p> <code>SUCCEEDED</code>–the task has succeeded.</p> </li> </ul>
|
|
6854
6479
|
* @public
|
|
6855
6480
|
*/
|
|
6856
6481
|
taskRunStatus: TaskRunStatus | undefined;
|
|
@@ -6865,7 +6490,7 @@ export interface StepSummary {
|
|
|
6865
6490
|
*/
|
|
6866
6491
|
taskFailureRetryCount?: number | undefined;
|
|
6867
6492
|
/**
|
|
6868
|
-
* <p>The task status to
|
|
6493
|
+
* <p>The task status to update the job's tasks to.</p>
|
|
6869
6494
|
* @public
|
|
6870
6495
|
*/
|
|
6871
6496
|
targetTaskRunStatus?: StepTargetTaskRunStatus | undefined;
|
|
@@ -7016,7 +6641,7 @@ export interface TaskSummary {
|
|
|
7016
6641
|
*/
|
|
7017
6642
|
updatedBy?: string | undefined;
|
|
7018
6643
|
/**
|
|
7019
|
-
* <p>The latest session action for the task.</p>
|
|
6644
|
+
* <p>The latest session action ID for the task.</p>
|
|
7020
6645
|
* @public
|
|
7021
6646
|
*/
|
|
7022
6647
|
latestSessionActionId?: string | undefined;
|
|
@@ -7066,23 +6691,12 @@ export interface UpdateJobRequest {
|
|
|
7066
6691
|
*/
|
|
7067
6692
|
maxRetriesPerTask?: number | undefined;
|
|
7068
6693
|
/**
|
|
7069
|
-
* <p>The status of a job in its lifecycle. When you change the status of the job to
|
|
7070
|
-
* <code>ARCHIVED</code>, the job can't be scheduled or archived.</p>
|
|
7071
|
-
* <important>
|
|
7072
|
-
* <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be
|
|
7073
|
-
* recovered.</p>
|
|
7074
|
-
* </important>
|
|
6694
|
+
* <p>The status of a job in its lifecycle. When you change the status of the job to <code>ARCHIVED</code>, the job can't be scheduled or archived.</p> <important> <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.</p> </important>
|
|
7075
6695
|
* @public
|
|
7076
6696
|
*/
|
|
7077
6697
|
lifecycleStatus?: UpdateJobLifecycleStatus | undefined;
|
|
7078
6698
|
/**
|
|
7079
|
-
* <p>The maximum number of worker hosts that can concurrently process a job. When the
|
|
7080
|
-
* <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
|
|
7081
|
-
* job, even if the fleets assigned to the job's queue has available workers.</p>
|
|
7082
|
-
* <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no
|
|
7083
|
-
* maximum number of workers.</p>
|
|
7084
|
-
* <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p>
|
|
7085
|
-
* <p>The maximum number of workers that can process tasks in the job.</p>
|
|
6699
|
+
* <p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p> <p>The maximum number of workers that can process tasks in the job.</p>
|
|
7086
6700
|
* @public
|
|
7087
6701
|
*/
|
|
7088
6702
|
maxWorkerCount?: number | undefined;
|
|
@@ -7384,22 +6998,7 @@ export interface ListQueuesRequest {
|
|
|
7384
6998
|
*/
|
|
7385
6999
|
principalId?: string | undefined;
|
|
7386
7000
|
/**
|
|
7387
|
-
* <p>The status of the queues listed.</p>
|
|
7388
|
-
* <ul>
|
|
7389
|
-
* <li>
|
|
7390
|
-
* <p>
|
|
7391
|
-
* <code>ACTIVE</code>–The queues are active.</p>
|
|
7392
|
-
* </li>
|
|
7393
|
-
* <li>
|
|
7394
|
-
* <p>
|
|
7395
|
-
* <code>SCHEDULING</code>–The queues are scheduling.</p>
|
|
7396
|
-
* </li>
|
|
7397
|
-
* <li>
|
|
7398
|
-
* <p>
|
|
7399
|
-
* <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these
|
|
7400
|
-
* queues.</p>
|
|
7401
|
-
* </li>
|
|
7402
|
-
* </ul>
|
|
7001
|
+
* <p>The status of the queues listed.</p> <ul> <li> <p> <code>ACTIVE</code>–The queues are active.</p> </li> <li> <p> <code>SCHEDULING</code>–The queues are scheduling.</p> </li> <li> <p> <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p> </li> </ul>
|
|
7403
7002
|
* @public
|
|
7404
7003
|
*/
|
|
7405
7004
|
status?: QueueStatus | undefined;
|
|
@@ -7430,10 +7029,7 @@ export interface QueueSummary {
|
|
|
7430
7029
|
*/
|
|
7431
7030
|
queueId: string | undefined;
|
|
7432
7031
|
/**
|
|
7433
|
-
* <p>The display name of the queue summary to update.</p>
|
|
7434
|
-
* <important>
|
|
7435
|
-
* <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>
|
|
7436
|
-
* </important>
|
|
7032
|
+
* <p>The display name of the queue summary to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
7437
7033
|
* @public
|
|
7438
7034
|
*/
|
|
7439
7035
|
displayName: string | undefined;
|
|
@@ -7548,18 +7144,12 @@ export interface UpdateQueueRequest {
|
|
|
7548
7144
|
*/
|
|
7549
7145
|
queueId: string | undefined;
|
|
7550
7146
|
/**
|
|
7551
|
-
* <p>The display name of the queue to update.</p>
|
|
7552
|
-
* <important>
|
|
7553
|
-
* <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>
|
|
7554
|
-
* </important>
|
|
7147
|
+
* <p>The display name of the queue to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
7555
7148
|
* @public
|
|
7556
7149
|
*/
|
|
7557
7150
|
displayName?: string | undefined;
|
|
7558
7151
|
/**
|
|
7559
|
-
* <p>The description of the queue to update.</p>
|
|
7560
|
-
* <important>
|
|
7561
|
-
* <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>
|
|
7562
|
-
* </important>
|
|
7152
|
+
* <p>The description of the queue to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
7563
7153
|
* @public
|
|
7564
7154
|
*/
|
|
7565
7155
|
description?: string | undefined;
|
|
@@ -7569,8 +7159,7 @@ export interface UpdateQueueRequest {
|
|
|
7569
7159
|
*/
|
|
7570
7160
|
defaultBudgetAction?: DefaultQueueBudgetAction | undefined;
|
|
7571
7161
|
/**
|
|
7572
|
-
* <p>The job attachment settings to update for the
|
|
7573
|
-
* queue.</p>
|
|
7162
|
+
* <p>The job attachment settings to update for the queue.</p>
|
|
7574
7163
|
* @public
|
|
7575
7164
|
*/
|
|
7576
7165
|
jobAttachmentSettings?: JobAttachmentSettings | undefined;
|
|
@@ -7665,18 +7254,12 @@ export interface UpdateFarmRequest {
|
|
|
7665
7254
|
*/
|
|
7666
7255
|
farmId: string | undefined;
|
|
7667
7256
|
/**
|
|
7668
|
-
* <p>The display name of the farm to update.</p>
|
|
7669
|
-
* <important>
|
|
7670
|
-
* <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>
|
|
7671
|
-
* </important>
|
|
7257
|
+
* <p>The display name of the farm to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
7672
7258
|
* @public
|
|
7673
7259
|
*/
|
|
7674
7260
|
displayName?: string | undefined;
|
|
7675
7261
|
/**
|
|
7676
|
-
* <p>The description of the farm to update.</p>
|
|
7677
|
-
* <important>
|
|
7678
|
-
* <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>
|
|
7679
|
-
* </important>
|
|
7262
|
+
* <p>The description of the farm to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
7680
7263
|
* @public
|
|
7681
7264
|
*/
|
|
7682
7265
|
description?: string | undefined;
|
|
@@ -7701,30 +7284,17 @@ export interface UpdateLimitRequest {
|
|
|
7701
7284
|
*/
|
|
7702
7285
|
limitId: string | undefined;
|
|
7703
7286
|
/**
|
|
7704
|
-
* <p>The new display name of the limit.</p>
|
|
7705
|
-
* <important>
|
|
7706
|
-
* <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>
|
|
7707
|
-
* </important>
|
|
7287
|
+
* <p>The new display name of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
7708
7288
|
* @public
|
|
7709
7289
|
*/
|
|
7710
7290
|
displayName?: string | undefined;
|
|
7711
7291
|
/**
|
|
7712
|
-
* <p>The new description of the limit.</p>
|
|
7713
|
-
* <important>
|
|
7714
|
-
* <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>
|
|
7715
|
-
* </important>
|
|
7292
|
+
* <p>The new description of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
7716
7293
|
* @public
|
|
7717
7294
|
*/
|
|
7718
7295
|
description?: string | undefined;
|
|
7719
7296
|
/**
|
|
7720
|
-
* <p>The maximum number of resources constrained by this limit. When all of the resources are
|
|
7721
|
-
* in use, steps that require the limit won't be scheduled until the resource is
|
|
7722
|
-
* available.</p>
|
|
7723
|
-
* <p>If more than the new maximum number is currently in use, running jobs finish but no new
|
|
7724
|
-
* jobs are started until the number of resources in use is below the new maximum
|
|
7725
|
-
* number.</p>
|
|
7726
|
-
* <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on
|
|
7727
|
-
* the number of resources that can be acquired for this limit.</p>
|
|
7297
|
+
* <p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.</p> <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>
|
|
7728
7298
|
* @public
|
|
7729
7299
|
*/
|
|
7730
7300
|
maxCount?: number | undefined;
|
|
@@ -7754,10 +7324,7 @@ export interface UpdateStorageProfileRequest {
|
|
|
7754
7324
|
*/
|
|
7755
7325
|
storageProfileId: string | undefined;
|
|
7756
7326
|
/**
|
|
7757
|
-
* <p>The display name of the storage profile to update.</p>
|
|
7758
|
-
* <important>
|
|
7759
|
-
* <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>
|
|
7760
|
-
* </important>
|
|
7327
|
+
* <p>The display name of the storage profile to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
|
|
7761
7328
|
* @public
|
|
7762
7329
|
*/
|
|
7763
7330
|
displayName?: string | undefined;
|
|
@@ -7907,15 +7474,12 @@ export interface GetQueueLimitAssociationResponse {
|
|
|
7907
7474
|
*/
|
|
7908
7475
|
export interface GetSessionsStatisticsAggregationRequest {
|
|
7909
7476
|
/**
|
|
7910
|
-
* <p>The identifier of the farm to include in the statistics. This should be the same as the
|
|
7911
|
-
* farm ID used in the call to the <code>StartSessionsStatisticsAggregation</code>
|
|
7912
|
-
* operation.</p>
|
|
7477
|
+
* <p>The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the <code>StartSessionsStatisticsAggregation</code> operation.</p>
|
|
7913
7478
|
* @public
|
|
7914
7479
|
*/
|
|
7915
7480
|
farmId: string | undefined;
|
|
7916
7481
|
/**
|
|
7917
|
-
* <p>The identifier returned by the <code>StartSessionsStatisticsAggregation</code> operation
|
|
7918
|
-
* that identifies the aggregated statistics.</p>
|
|
7482
|
+
* <p>The identifier returned by the <code>StartSessionsStatisticsAggregation</code> operation that identifies the aggregated statistics.</p>
|
|
7919
7483
|
* @public
|
|
7920
7484
|
*/
|
|
7921
7485
|
aggregationId: string | undefined;
|
|
@@ -8007,8 +7571,7 @@ export interface Statistics {
|
|
|
8007
7571
|
*/
|
|
8008
7572
|
count: number | undefined;
|
|
8009
7573
|
/**
|
|
8010
|
-
* <p>How the statistics should appear in USD. Options include: minimum, maximum, average or
|
|
8011
|
-
* sum.</p>
|
|
7574
|
+
* <p>How the statistics should appear in USD. Options include: minimum, maximum, average or sum.</p>
|
|
8012
7575
|
* @public
|
|
8013
7576
|
*/
|
|
8014
7577
|
costInUsd: Stats | undefined;
|
|
@@ -8043,14 +7606,7 @@ export interface GetSessionsStatisticsAggregationResponse {
|
|
|
8043
7606
|
*/
|
|
8044
7607
|
nextToken?: string | undefined;
|
|
8045
7608
|
/**
|
|
8046
|
-
* <p>The status of the aggregated results. An aggregation may fail or time out if the results
|
|
8047
|
-
* are too large. If this happens, you can call the
|
|
8048
|
-
* <code>StartSessionsStatisticsAggregation</code> operation after you reduce the
|
|
8049
|
-
* aggregation time frame, reduce the number of queues or fleets in the aggregation, or
|
|
8050
|
-
* increase the period length.</p>
|
|
8051
|
-
* <p>If you call the <code>StartSessionsStatisticsAggregation </code> operation when the
|
|
8052
|
-
* status is <code>IN_PROGRESS</code>, you will receive a
|
|
8053
|
-
* <code>ThrottlingException</code>.</p>
|
|
7609
|
+
* <p>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.</p> <p>If you call the <code>StartSessionsStatisticsAggregation </code> operation when the status is <code>IN_PROGRESS</code>, you will receive a <code>ThrottlingException</code>.</p>
|
|
8054
7610
|
* @public
|
|
8055
7611
|
*/
|
|
8056
7612
|
status: SessionsStatisticsAggregationStatus | undefined;
|
|
@@ -8075,6 +7631,26 @@ export interface DeleteLicenseEndpointRequest {
|
|
|
8075
7631
|
*/
|
|
8076
7632
|
export interface DeleteLicenseEndpointResponse {
|
|
8077
7633
|
}
|
|
7634
|
+
/**
|
|
7635
|
+
* @public
|
|
7636
|
+
*/
|
|
7637
|
+
export interface DeleteMeteredProductRequest {
|
|
7638
|
+
/**
|
|
7639
|
+
* <p>The ID of the license endpoint from which to remove the metered product.</p>
|
|
7640
|
+
* @public
|
|
7641
|
+
*/
|
|
7642
|
+
licenseEndpointId: string | undefined;
|
|
7643
|
+
/**
|
|
7644
|
+
* <p>The product ID to remove from the license endpoint.</p>
|
|
7645
|
+
* @public
|
|
7646
|
+
*/
|
|
7647
|
+
productId: string | undefined;
|
|
7648
|
+
}
|
|
7649
|
+
/**
|
|
7650
|
+
* @public
|
|
7651
|
+
*/
|
|
7652
|
+
export interface DeleteMeteredProductResponse {
|
|
7653
|
+
}
|
|
8078
7654
|
/**
|
|
8079
7655
|
* @public
|
|
8080
7656
|
*/
|
|
@@ -8105,7 +7681,7 @@ export interface GetLicenseEndpointResponse {
|
|
|
8105
7681
|
*/
|
|
8106
7682
|
statusMessage: string | undefined;
|
|
8107
7683
|
/**
|
|
8108
|
-
* <p>The
|
|
7684
|
+
* <p>The VPC (virtual private cloud) ID associated with the license endpoint.</p>
|
|
8109
7685
|
* @public
|
|
8110
7686
|
*/
|
|
8111
7687
|
vpcId?: string | undefined;
|
|
@@ -8161,7 +7737,7 @@ export interface LicenseEndpointSummary {
|
|
|
8161
7737
|
*/
|
|
8162
7738
|
statusMessage?: string | undefined;
|
|
8163
7739
|
/**
|
|
8164
|
-
* <p>The
|
|
7740
|
+
* <p>The VPC (virtual private cloud) ID associated with the license endpoint.</p>
|
|
8165
7741
|
* @public
|
|
8166
7742
|
*/
|
|
8167
7743
|
vpcId?: string | undefined;
|
|
@@ -8181,43 +7757,3 @@ export interface ListLicenseEndpointsResponse {
|
|
|
8181
7757
|
*/
|
|
8182
7758
|
nextToken?: string | undefined;
|
|
8183
7759
|
}
|
|
8184
|
-
/**
|
|
8185
|
-
* @public
|
|
8186
|
-
*/
|
|
8187
|
-
export interface DeleteMeteredProductRequest {
|
|
8188
|
-
/**
|
|
8189
|
-
* <p>The ID of the license endpoint from which to remove the metered product.</p>
|
|
8190
|
-
* @public
|
|
8191
|
-
*/
|
|
8192
|
-
licenseEndpointId: string | undefined;
|
|
8193
|
-
/**
|
|
8194
|
-
* <p>The product ID to remove from the license endpoint.</p>
|
|
8195
|
-
* @public
|
|
8196
|
-
*/
|
|
8197
|
-
productId: string | undefined;
|
|
8198
|
-
}
|
|
8199
|
-
/**
|
|
8200
|
-
* @public
|
|
8201
|
-
*/
|
|
8202
|
-
export interface DeleteMeteredProductResponse {
|
|
8203
|
-
}
|
|
8204
|
-
/**
|
|
8205
|
-
* @public
|
|
8206
|
-
*/
|
|
8207
|
-
export interface ListMeteredProductsRequest {
|
|
8208
|
-
/**
|
|
8209
|
-
* <p>The license endpoint ID to include on the list of metered products.</p>
|
|
8210
|
-
* @public
|
|
8211
|
-
*/
|
|
8212
|
-
licenseEndpointId: string | undefined;
|
|
8213
|
-
/**
|
|
8214
|
-
* <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
|
|
8215
|
-
* @public
|
|
8216
|
-
*/
|
|
8217
|
-
nextToken?: string | undefined;
|
|
8218
|
-
/**
|
|
8219
|
-
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
8220
|
-
* @public
|
|
8221
|
-
*/
|
|
8222
|
-
maxResults?: number | undefined;
|
|
8223
|
-
}
|