@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.
Files changed (138) hide show
  1. package/README.md +1 -8
  2. package/dist-cjs/index.js +195 -15
  3. package/dist-es/models/enums.js +6 -0
  4. package/dist-es/schemas/schemas_0.js +28 -10
  5. package/dist-es/waiters/index.js +2 -0
  6. package/dist-es/waiters/waitForJobComplete.js +76 -0
  7. package/dist-es/waiters/waitForJobSucceeded.js +76 -0
  8. package/dist-types/Deadline.d.ts +1 -8
  9. package/dist-types/DeadlineClient.d.ts +1 -8
  10. package/dist-types/commands/AssociateMemberToFarmCommand.d.ts +2 -4
  11. package/dist-types/commands/AssociateMemberToFleetCommand.d.ts +2 -4
  12. package/dist-types/commands/AssociateMemberToJobCommand.d.ts +2 -4
  13. package/dist-types/commands/AssociateMemberToQueueCommand.d.ts +2 -4
  14. package/dist-types/commands/AssumeFleetRoleForReadCommand.d.ts +2 -4
  15. package/dist-types/commands/AssumeFleetRoleForWorkerCommand.d.ts +2 -4
  16. package/dist-types/commands/AssumeQueueRoleForReadCommand.d.ts +2 -4
  17. package/dist-types/commands/AssumeQueueRoleForUserCommand.d.ts +1 -2
  18. package/dist-types/commands/AssumeQueueRoleForWorkerCommand.d.ts +2 -4
  19. package/dist-types/commands/BatchGetJobEntityCommand.d.ts +1 -2
  20. package/dist-types/commands/CopyJobTemplateCommand.d.ts +1 -2
  21. package/dist-types/commands/CreateBudgetCommand.d.ts +5 -4
  22. package/dist-types/commands/CreateFarmCommand.d.ts +3 -8
  23. package/dist-types/commands/CreateFleetCommand.d.ts +3 -7
  24. package/dist-types/commands/CreateJobCommand.d.ts +3 -7
  25. package/dist-types/commands/CreateLicenseEndpointCommand.d.ts +4 -8
  26. package/dist-types/commands/CreateLimitCommand.d.ts +3 -9
  27. package/dist-types/commands/CreateMonitorCommand.d.ts +3 -7
  28. package/dist-types/commands/CreateQueueCommand.d.ts +3 -6
  29. package/dist-types/commands/CreateQueueEnvironmentCommand.d.ts +2 -4
  30. package/dist-types/commands/CreateQueueFleetAssociationCommand.d.ts +1 -2
  31. package/dist-types/commands/CreateQueueLimitAssociationCommand.d.ts +2 -6
  32. package/dist-types/commands/CreateStorageProfileCommand.d.ts +3 -6
  33. package/dist-types/commands/CreateWorkerCommand.d.ts +3 -15
  34. package/dist-types/commands/DeleteBudgetCommand.d.ts +1 -2
  35. package/dist-types/commands/DeleteFarmCommand.d.ts +1 -2
  36. package/dist-types/commands/DeleteFleetCommand.d.ts +2 -4
  37. package/dist-types/commands/DeleteLicenseEndpointCommand.d.ts +2 -4
  38. package/dist-types/commands/DeleteLimitCommand.d.ts +2 -5
  39. package/dist-types/commands/DeleteMeteredProductCommand.d.ts +1 -2
  40. package/dist-types/commands/DeleteMonitorCommand.d.ts +2 -4
  41. package/dist-types/commands/DeleteQueueCommand.d.ts +3 -9
  42. package/dist-types/commands/DeleteQueueEnvironmentCommand.d.ts +1 -2
  43. package/dist-types/commands/DeleteQueueFleetAssociationCommand.d.ts +2 -4
  44. package/dist-types/commands/DeleteQueueLimitAssociationCommand.d.ts +3 -10
  45. package/dist-types/commands/DeleteStorageProfileCommand.d.ts +1 -2
  46. package/dist-types/commands/DeleteWorkerCommand.d.ts +2 -4
  47. package/dist-types/commands/DisassociateMemberFromFarmCommand.d.ts +1 -2
  48. package/dist-types/commands/DisassociateMemberFromFleetCommand.d.ts +2 -4
  49. package/dist-types/commands/DisassociateMemberFromJobCommand.d.ts +1 -2
  50. package/dist-types/commands/DisassociateMemberFromQueueCommand.d.ts +2 -4
  51. package/dist-types/commands/GetBudgetCommand.d.ts +1 -2
  52. package/dist-types/commands/GetFarmCommand.d.ts +2 -3
  53. package/dist-types/commands/GetFleetCommand.d.ts +1 -2
  54. package/dist-types/commands/GetJobCommand.d.ts +1 -2
  55. package/dist-types/commands/GetLicenseEndpointCommand.d.ts +1 -2
  56. package/dist-types/commands/GetLimitCommand.d.ts +1 -2
  57. package/dist-types/commands/GetMonitorCommand.d.ts +1 -2
  58. package/dist-types/commands/GetQueueCommand.d.ts +1 -2
  59. package/dist-types/commands/GetQueueEnvironmentCommand.d.ts +1 -2
  60. package/dist-types/commands/GetQueueFleetAssociationCommand.d.ts +1 -2
  61. package/dist-types/commands/GetQueueLimitAssociationCommand.d.ts +1 -2
  62. package/dist-types/commands/GetSessionActionCommand.d.ts +1 -2
  63. package/dist-types/commands/GetSessionCommand.d.ts +1 -2
  64. package/dist-types/commands/GetSessionsStatisticsAggregationCommand.d.ts +2 -6
  65. package/dist-types/commands/GetStepCommand.d.ts +6 -2
  66. package/dist-types/commands/GetStorageProfileCommand.d.ts +1 -2
  67. package/dist-types/commands/GetStorageProfileForQueueCommand.d.ts +1 -2
  68. package/dist-types/commands/GetTaskCommand.d.ts +1 -2
  69. package/dist-types/commands/GetWorkerCommand.d.ts +1 -2
  70. package/dist-types/commands/ListBudgetsCommand.d.ts +1 -2
  71. package/dist-types/commands/ListFarmMembersCommand.d.ts +1 -2
  72. package/dist-types/commands/ListFarmsCommand.d.ts +1 -2
  73. package/dist-types/commands/ListFleetMembersCommand.d.ts +1 -2
  74. package/dist-types/commands/ListFleetsCommand.d.ts +1 -2
  75. package/dist-types/commands/ListJobMembersCommand.d.ts +1 -2
  76. package/dist-types/commands/ListJobParameterDefinitionsCommand.d.ts +1 -2
  77. package/dist-types/commands/ListJobsCommand.d.ts +1 -2
  78. package/dist-types/commands/ListLicenseEndpointsCommand.d.ts +1 -2
  79. package/dist-types/commands/ListLimitsCommand.d.ts +1 -2
  80. package/dist-types/commands/ListMeteredProductsCommand.d.ts +2 -4
  81. package/dist-types/commands/ListMonitorsCommand.d.ts +1 -2
  82. package/dist-types/commands/ListQueueEnvironmentsCommand.d.ts +1 -2
  83. package/dist-types/commands/ListQueueMembersCommand.d.ts +1 -2
  84. package/dist-types/commands/ListQueuesCommand.d.ts +1 -2
  85. package/dist-types/commands/ListSessionActionsCommand.d.ts +1 -2
  86. package/dist-types/commands/ListSessionsCommand.d.ts +1 -2
  87. package/dist-types/commands/ListSessionsForWorkerCommand.d.ts +1 -2
  88. package/dist-types/commands/ListStepConsumersCommand.d.ts +1 -2
  89. package/dist-types/commands/ListStepDependenciesCommand.d.ts +1 -2
  90. package/dist-types/commands/ListStepsCommand.d.ts +1 -2
  91. package/dist-types/commands/ListStorageProfilesCommand.d.ts +1 -2
  92. package/dist-types/commands/ListStorageProfilesForQueueCommand.d.ts +1 -2
  93. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -2
  94. package/dist-types/commands/ListTasksCommand.d.ts +1 -2
  95. package/dist-types/commands/ListWorkersCommand.d.ts +1 -2
  96. package/dist-types/commands/PutMeteredProductCommand.d.ts +1 -2
  97. package/dist-types/commands/SearchJobsCommand.d.ts +21 -8
  98. package/dist-types/commands/SearchStepsCommand.d.ts +26 -8
  99. package/dist-types/commands/SearchTasksCommand.d.ts +22 -8
  100. package/dist-types/commands/SearchWorkersCommand.d.ts +21 -8
  101. package/dist-types/commands/StartSessionsStatisticsAggregationCommand.d.ts +2 -9
  102. package/dist-types/commands/TagResourceCommand.d.ts +2 -4
  103. package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
  104. package/dist-types/commands/UpdateBudgetCommand.d.ts +1 -2
  105. package/dist-types/commands/UpdateFarmCommand.d.ts +1 -2
  106. package/dist-types/commands/UpdateFleetCommand.d.ts +2 -4
  107. package/dist-types/commands/UpdateJobCommand.d.ts +3 -11
  108. package/dist-types/commands/UpdateLimitCommand.d.ts +1 -2
  109. package/dist-types/commands/UpdateMonitorCommand.d.ts +2 -4
  110. package/dist-types/commands/UpdateQueueCommand.d.ts +1 -2
  111. package/dist-types/commands/UpdateQueueEnvironmentCommand.d.ts +1 -2
  112. package/dist-types/commands/UpdateQueueFleetAssociationCommand.d.ts +1 -2
  113. package/dist-types/commands/UpdateQueueLimitAssociationCommand.d.ts +2 -5
  114. package/dist-types/commands/UpdateSessionCommand.d.ts +2 -4
  115. package/dist-types/commands/UpdateStepCommand.d.ts +2 -4
  116. package/dist-types/commands/UpdateStorageProfileCommand.d.ts +1 -2
  117. package/dist-types/commands/UpdateTaskCommand.d.ts +2 -4
  118. package/dist-types/commands/UpdateWorkerCommand.d.ts +2 -4
  119. package/dist-types/commands/UpdateWorkerScheduleCommand.d.ts +2 -4
  120. package/dist-types/index.d.ts +1 -8
  121. package/dist-types/models/enums.d.ts +14 -0
  122. package/dist-types/models/errors.d.ts +3 -6
  123. package/dist-types/models/models_0.d.ts +196 -660
  124. package/dist-types/models/models_1.d.ts +118 -241
  125. package/dist-types/schemas/schemas_0.d.ts +2 -0
  126. package/dist-types/ts3.4/commands/ListMeteredProductsCommand.d.ts +4 -2
  127. package/dist-types/ts3.4/models/enums.d.ts +8 -0
  128. package/dist-types/ts3.4/models/models_0.d.ts +14 -11
  129. package/dist-types/ts3.4/models/models_1.d.ts +28 -0
  130. package/dist-types/ts3.4/schemas/schemas_0.d.ts +2 -0
  131. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  132. package/dist-types/ts3.4/waiters/waitForJobComplete.d.ts +11 -0
  133. package/dist-types/ts3.4/waiters/waitForJobSucceeded.d.ts +11 -0
  134. package/dist-types/waiters/index.d.ts +2 -0
  135. package/dist-types/waiters/waitForJobComplete.d.ts +14 -0
  136. package/dist-types/waiters/waitForJobCreateComplete.d.ts +2 -2
  137. package/dist-types/waiters/waitForJobSucceeded.d.ts +14 -0
  138. package/package.json +12 -12
@@ -0,0 +1,76 @@
1
+ import { checkExceptions, createWaiter, WaiterState } from "@smithy/util-waiter";
2
+ import { GetJobCommand } from "../commands/GetJobCommand";
3
+ const checkState = async (client, input) => {
4
+ let reason;
5
+ try {
6
+ let result = await client.send(new GetJobCommand(input));
7
+ reason = result;
8
+ try {
9
+ const returnComparator = () => {
10
+ return result.taskRunStatus;
11
+ };
12
+ if (returnComparator() === "SUCCEEDED") {
13
+ return { state: WaiterState.SUCCESS, reason };
14
+ }
15
+ }
16
+ catch (e) { }
17
+ try {
18
+ const returnComparator = () => {
19
+ return result.taskRunStatus;
20
+ };
21
+ if (returnComparator() === "FAILED") {
22
+ return { state: WaiterState.FAILURE, reason };
23
+ }
24
+ }
25
+ catch (e) { }
26
+ try {
27
+ const returnComparator = () => {
28
+ return result.taskRunStatus;
29
+ };
30
+ if (returnComparator() === "CANCELED") {
31
+ return { state: WaiterState.FAILURE, reason };
32
+ }
33
+ }
34
+ catch (e) { }
35
+ try {
36
+ const returnComparator = () => {
37
+ return result.taskRunStatus;
38
+ };
39
+ if (returnComparator() === "SUSPENDED") {
40
+ return { state: WaiterState.FAILURE, reason };
41
+ }
42
+ }
43
+ catch (e) { }
44
+ try {
45
+ const returnComparator = () => {
46
+ return result.taskRunStatus;
47
+ };
48
+ if (returnComparator() === "NOT_COMPATIBLE") {
49
+ return { state: WaiterState.FAILURE, reason };
50
+ }
51
+ }
52
+ catch (e) { }
53
+ try {
54
+ const returnComparator = () => {
55
+ return result.lifecycleStatus;
56
+ };
57
+ if (returnComparator() === "ARCHIVED") {
58
+ return { state: WaiterState.FAILURE, reason };
59
+ }
60
+ }
61
+ catch (e) { }
62
+ }
63
+ catch (exception) {
64
+ reason = exception;
65
+ }
66
+ return { state: WaiterState.RETRY, reason };
67
+ };
68
+ export const waitForJobSucceeded = async (params, input) => {
69
+ const serviceDefaults = { minDelay: 15, maxDelay: 3600 };
70
+ return createWaiter({ ...serviceDefaults, ...params }, input, checkState);
71
+ };
72
+ export const waitUntilJobSucceeded = async (params, input) => {
73
+ const serviceDefaults = { minDelay: 15, maxDelay: 3600 };
74
+ const result = await createWaiter({ ...serviceDefaults, ...params }, input, checkState);
75
+ return checkExceptions(result);
76
+ };
@@ -798,14 +798,7 @@ export interface Deadline {
798
798
  updateWorkerSchedule(args: UpdateWorkerScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWorkerScheduleCommandOutput) => void): void;
799
799
  }
800
800
  /**
801
- * <p>The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your
802
- * projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions
803
- * specific to their job function.</p>
804
- * <p>With Deadline Cloud, content production teams can deploy resources for their workforce
805
- * securely in the cloud, reducing the costs of added physical infrastructure. Keep your
806
- * content production operations secure, while allowing your contributors to access the tools
807
- * they need, such as scalable high-speed storage, licenses, and cost management
808
- * services.</p>
801
+ * <p>The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.</p> <p>With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.</p>
809
802
  * @public
810
803
  */
811
804
  export declare class Deadline extends DeadlineClient implements Deadline {
@@ -282,14 +282,7 @@ export type DeadlineClientResolvedConfigType = __SmithyResolvedConfiguration<__H
282
282
  export interface DeadlineClientResolvedConfig extends DeadlineClientResolvedConfigType {
283
283
  }
284
284
  /**
285
- * <p>The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your
286
- * projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions
287
- * specific to their job function.</p>
288
- * <p>With Deadline Cloud, content production teams can deploy resources for their workforce
289
- * securely in the cloud, reducing the costs of added physical infrastructure. Keep your
290
- * content production operations secure, while allowing your contributors to access the tools
291
- * they need, such as scalable high-speed storage, licenses, and cost management
292
- * services.</p>
285
+ * <p>The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.</p> <p>With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.</p>
293
286
  * @public
294
287
  */
295
288
  export declare class DeadlineClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DeadlineClientResolvedConfig> {
@@ -65,15 +65,13 @@ declare const AssociateMemberToFarmCommand_base: {
65
65
  * <p>The requested resource can't be found.</p>
66
66
  *
67
67
  * @throws {@link ServiceQuotaExceededException} (client fault)
68
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
69
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
68
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
70
69
  *
71
70
  * @throws {@link ThrottlingException} (client fault)
72
71
  * <p>Your request exceeded a request rate quota.</p>
73
72
  *
74
73
  * @throws {@link ValidationException} (client fault)
75
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
76
- * unsupported characters.</p>
74
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
77
75
  *
78
76
  * @throws {@link DeadlineServiceException}
79
77
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -66,15 +66,13 @@ declare const AssociateMemberToFleetCommand_base: {
66
66
  * <p>The requested resource can't be found.</p>
67
67
  *
68
68
  * @throws {@link ServiceQuotaExceededException} (client fault)
69
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
70
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
69
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
71
70
  *
72
71
  * @throws {@link ThrottlingException} (client fault)
73
72
  * <p>Your request exceeded a request rate quota.</p>
74
73
  *
75
74
  * @throws {@link ValidationException} (client fault)
76
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
77
- * unsupported characters.</p>
75
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
78
76
  *
79
77
  * @throws {@link DeadlineServiceException}
80
78
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -67,15 +67,13 @@ declare const AssociateMemberToJobCommand_base: {
67
67
  * <p>The requested resource can't be found.</p>
68
68
  *
69
69
  * @throws {@link ServiceQuotaExceededException} (client fault)
70
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
71
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
70
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
72
71
  *
73
72
  * @throws {@link ThrottlingException} (client fault)
74
73
  * <p>Your request exceeded a request rate quota.</p>
75
74
  *
76
75
  * @throws {@link ValidationException} (client fault)
77
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
78
- * unsupported characters.</p>
76
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
79
77
  *
80
78
  * @throws {@link DeadlineServiceException}
81
79
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -66,15 +66,13 @@ declare const AssociateMemberToQueueCommand_base: {
66
66
  * <p>The requested resource can't be found.</p>
67
67
  *
68
68
  * @throws {@link ServiceQuotaExceededException} (client fault)
69
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
70
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
69
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
71
70
  *
72
71
  * @throws {@link ThrottlingException} (client fault)
73
72
  * <p>Your request exceeded a request rate quota.</p>
74
73
  *
75
74
  * @throws {@link ValidationException} (client fault)
76
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
77
- * unsupported characters.</p>
75
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
78
76
  *
79
77
  * @throws {@link DeadlineServiceException}
80
78
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,8 +27,7 @@ declare const AssumeFleetRoleForReadCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are
31
- * scoped down to have read-only access.</p>
30
+ * <p>Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -73,8 +72,7 @@ declare const AssumeFleetRoleForReadCommand_base: {
73
72
  * <p>Your request exceeded a request rate quota.</p>
74
73
  *
75
74
  * @throws {@link ValidationException} (client fault)
76
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
77
- * unsupported characters.</p>
75
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
78
76
  *
79
77
  * @throws {@link DeadlineServiceException}
80
78
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -64,8 +64,7 @@ declare const AssumeFleetRoleForWorkerCommand_base: {
64
64
  * <p>You don't have permission to perform the action.</p>
65
65
  *
66
66
  * @throws {@link ConflictException} (client fault)
67
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
68
- * than one operation on the same resource at the same time.</p>
67
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
69
68
  *
70
69
  * @throws {@link InternalServerErrorException} (server fault)
71
70
  * <p>Deadline Cloud can't process your request right now. Try again later.</p>
@@ -77,8 +76,7 @@ declare const AssumeFleetRoleForWorkerCommand_base: {
77
76
  * <p>Your request exceeded a request rate quota.</p>
78
77
  *
79
78
  * @throws {@link ValidationException} (client fault)
80
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
81
- * unsupported characters.</p>
79
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
82
80
  *
83
81
  * @throws {@link DeadlineServiceException}
84
82
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,8 +27,7 @@ declare const AssumeQueueRoleForReadCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are
31
- * scoped down to have read-only access.</p>
30
+ * <p>Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -73,8 +72,7 @@ declare const AssumeQueueRoleForReadCommand_base: {
73
72
  * <p>Your request exceeded a request rate quota.</p>
74
73
  *
75
74
  * @throws {@link ValidationException} (client fault)
76
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
77
- * unsupported characters.</p>
75
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
78
76
  *
79
77
  * @throws {@link DeadlineServiceException}
80
78
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -72,8 +72,7 @@ declare const AssumeQueueRoleForUserCommand_base: {
72
72
  * <p>Your request exceeded a request rate quota.</p>
73
73
  *
74
74
  * @throws {@link ValidationException} (client fault)
75
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
76
- * unsupported characters.</p>
75
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
77
76
  *
78
77
  * @throws {@link DeadlineServiceException}
79
78
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -65,8 +65,7 @@ declare const AssumeQueueRoleForWorkerCommand_base: {
65
65
  * <p>You don't have permission to perform the action.</p>
66
66
  *
67
67
  * @throws {@link ConflictException} (client fault)
68
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
69
- * than one operation on the same resource at the same time.</p>
68
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
70
69
  *
71
70
  * @throws {@link InternalServerErrorException} (server fault)
72
71
  * <p>Deadline Cloud can't process your request right now. Try again later.</p>
@@ -78,8 +77,7 @@ declare const AssumeQueueRoleForWorkerCommand_base: {
78
77
  * <p>Your request exceeded a request rate quota.</p>
79
78
  *
80
79
  * @throws {@link ValidationException} (client fault)
81
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
82
- * unsupported characters.</p>
80
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
83
81
  *
84
82
  * @throws {@link DeadlineServiceException}
85
83
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -184,8 +184,7 @@ declare const BatchGetJobEntityCommand_base: {
184
184
  * <p>Your request exceeded a request rate quota.</p>
185
185
  *
186
186
  * @throws {@link ValidationException} (client fault)
187
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
188
- * unsupported characters.</p>
187
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
189
188
  *
190
189
  * @throws {@link DeadlineServiceException}
191
190
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -72,8 +72,7 @@ declare const CopyJobTemplateCommand_base: {
72
72
  * <p>Your request exceeded a request rate quota.</p>
73
73
  *
74
74
  * @throws {@link ValidationException} (client fault)
75
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
76
- * unsupported characters.</p>
75
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
77
76
  *
78
77
  * @throws {@link DeadlineServiceException}
79
78
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -58,6 +58,9 @@ declare const CreateBudgetCommand_base: {
58
58
  * endTime: new Date("TIMESTAMP"), // required
59
59
  * },
60
60
  * },
61
+ * tags: { // Tags
62
+ * "<keys>": "STRING_VALUE",
63
+ * },
61
64
  * };
62
65
  * const command = new CreateBudgetCommand(input);
63
66
  * const response = await client.send(command);
@@ -83,15 +86,13 @@ declare const CreateBudgetCommand_base: {
83
86
  * <p>The requested resource can't be found.</p>
84
87
  *
85
88
  * @throws {@link ServiceQuotaExceededException} (client fault)
86
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
87
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
89
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
88
90
  *
89
91
  * @throws {@link ThrottlingException} (client fault)
90
92
  * <p>Your request exceeded a request rate quota.</p>
91
93
  *
92
94
  * @throws {@link ValidationException} (client fault)
93
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
94
- * unsupported characters.</p>
95
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
95
96
  *
96
97
  * @throws {@link DeadlineServiceException}
97
98
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,10 +27,7 @@ declare const CreateFarmCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a farm to allow space for queues and fleets. Farms are the space where the
31
- * components of your renders gather and are pieced together in the cloud. Farms contain
32
- * budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for
33
- * large projects.</p>
30
+ * <p>Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.</p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -72,15 +69,13 @@ declare const CreateFarmCommand_base: {
72
69
  * <p>The requested resource can't be found.</p>
73
70
  *
74
71
  * @throws {@link ServiceQuotaExceededException} (client fault)
75
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
76
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
72
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
77
73
  *
78
74
  * @throws {@link ThrottlingException} (client fault)
79
75
  * <p>Your request exceeded a request rate quota.</p>
80
76
  *
81
77
  * @throws {@link ValidationException} (client fault)
82
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
83
- * unsupported characters.</p>
78
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
84
79
  *
85
80
  * @throws {@link DeadlineServiceException}
86
81
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,9 +27,7 @@ declare const CreateFleetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a fleet. Fleets gather information relating to compute, or capacity, for renders
31
- * within your farms. You can choose to manage your own capacity or opt to have fleets fully
32
- * managed by Deadline Cloud.</p>
30
+ * <p>Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -184,15 +182,13 @@ declare const CreateFleetCommand_base: {
184
182
  * <p>The requested resource can't be found.</p>
185
183
  *
186
184
  * @throws {@link ServiceQuotaExceededException} (client fault)
187
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
188
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
185
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
189
186
  *
190
187
  * @throws {@link ThrottlingException} (client fault)
191
188
  * <p>Your request exceeded a request rate quota.</p>
192
189
  *
193
190
  * @throws {@link ValidationException} (client fault)
194
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
195
- * unsupported characters.</p>
191
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
196
192
  *
197
193
  * @throws {@link DeadlineServiceException}
198
194
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,9 +27,7 @@ declare const CreateJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule
31
- * and run work on available workers. For more information, see <a href="https://docs.aws.amazon.com/deadline-cloud/latest/userguide/deadline-cloud-jobs.html">Deadline Cloud
32
- * jobs</a>.</p>
30
+ * <p>Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see <a href="https://docs.aws.amazon.com/deadline-cloud/latest/userguide/deadline-cloud-jobs.html">Deadline Cloud jobs</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -99,15 +97,13 @@ declare const CreateJobCommand_base: {
99
97
  * <p>The requested resource can't be found.</p>
100
98
  *
101
99
  * @throws {@link ServiceQuotaExceededException} (client fault)
102
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
103
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
100
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
104
101
  *
105
102
  * @throws {@link ThrottlingException} (client fault)
106
103
  * <p>Your request exceeded a request rate quota.</p>
107
104
  *
108
105
  * @throws {@link ValidationException} (client fault)
109
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
110
- * unsupported characters.</p>
106
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
111
107
  *
112
108
  * @throws {@link DeadlineServiceException}
113
109
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,8 +27,7 @@ declare const CreateLicenseEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a license endpoint to integrate your various licensed software used for
31
- * rendering on Deadline Cloud.</p>
30
+ * <p>Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -68,22 +67,19 @@ declare const CreateLicenseEndpointCommand_base: {
68
67
  * <p>You don't have permission to perform the action.</p>
69
68
  *
70
69
  * @throws {@link ConflictException} (client fault)
71
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
72
- * than one operation on the same resource at the same time.</p>
70
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
73
71
  *
74
72
  * @throws {@link InternalServerErrorException} (server fault)
75
73
  * <p>Deadline Cloud can't process your request right now. Try again later.</p>
76
74
  *
77
75
  * @throws {@link ServiceQuotaExceededException} (client fault)
78
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
79
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
76
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
80
77
  *
81
78
  * @throws {@link ThrottlingException} (client fault)
82
79
  * <p>Your request exceeded a request rate quota.</p>
83
80
  *
84
81
  * @throws {@link ValidationException} (client fault)
85
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
86
- * unsupported characters.</p>
82
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
87
83
  *
88
84
  * @throws {@link DeadlineServiceException}
89
85
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,11 +27,7 @@ declare const CreateLimitCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a limit that manages the distribution of shared resources, such as floating
31
- * licenses. A limit can throttle work assignments, help manage workloads, and track current
32
- * usage. Before you use a limit, you must associate the limit with one or more queues. </p>
33
- * <p>You must add the <code>amountRequirementName</code> to a step in a job template to
34
- * declare the limit requirement.</p>
30
+ * <p>Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues. </p> <p>You must add the <code>amountRequirementName</code> to a step in a job template to declare the limit requirement.</p>
35
31
  * @example
36
32
  * Use a bare-bones client and the command you need to make an API call.
37
33
  * ```javascript
@@ -72,15 +68,13 @@ declare const CreateLimitCommand_base: {
72
68
  * <p>The requested resource can't be found.</p>
73
69
  *
74
70
  * @throws {@link ServiceQuotaExceededException} (client fault)
75
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
76
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
71
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
77
72
  *
78
73
  * @throws {@link ThrottlingException} (client fault)
79
74
  * <p>Your request exceeded a request rate quota.</p>
80
75
  *
81
76
  * @throws {@link ValidationException} (client fault)
82
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
83
- * unsupported characters.</p>
77
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
84
78
  *
85
79
  * @throws {@link DeadlineServiceException}
86
80
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,9 +27,7 @@ declare const CreateMonitorCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and
31
- * fleets. After you submit a job, you can track the progress of the tasks and steps that make
32
- * up the job, and then download the job's results. </p>
30
+ * <p>Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results. </p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -70,15 +68,13 @@ declare const CreateMonitorCommand_base: {
70
68
  * <p>Deadline Cloud can't process your request right now. Try again later.</p>
71
69
  *
72
70
  * @throws {@link ServiceQuotaExceededException} (client fault)
73
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
74
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
71
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
75
72
  *
76
73
  * @throws {@link ThrottlingException} (client fault)
77
74
  * <p>Your request exceeded a request rate quota.</p>
78
75
  *
79
76
  * @throws {@link ValidationException} (client fault)
80
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
81
- * unsupported characters.</p>
77
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
82
78
  *
83
79
  * @throws {@link DeadlineServiceException}
84
80
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,8 +27,7 @@ declare const CreateQueueCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a queue to coordinate the order in which jobs run on a farm. A queue can also
31
- * specify where to pull resources and indicate where to output completed jobs.</p>
30
+ * <p>Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -93,15 +92,13 @@ declare const CreateQueueCommand_base: {
93
92
  * <p>The requested resource can't be found.</p>
94
93
  *
95
94
  * @throws {@link ServiceQuotaExceededException} (client fault)
96
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
97
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
95
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
98
96
  *
99
97
  * @throws {@link ThrottlingException} (client fault)
100
98
  * <p>Your request exceeded a request rate quota.</p>
101
99
  *
102
100
  * @throws {@link ValidationException} (client fault)
103
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
104
- * unsupported characters.</p>
101
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
105
102
  *
106
103
  * @throws {@link DeadlineServiceException}
107
104
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -68,15 +68,13 @@ declare const CreateQueueEnvironmentCommand_base: {
68
68
  * <p>The requested resource can't be found.</p>
69
69
  *
70
70
  * @throws {@link ServiceQuotaExceededException} (client fault)
71
- * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
72
- * maximum number of service resources or operations for your Amazon Web Services account.</p>
71
+ * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
73
72
  *
74
73
  * @throws {@link ThrottlingException} (client fault)
75
74
  * <p>Your request exceeded a request rate quota.</p>
76
75
  *
77
76
  * @throws {@link ValidationException} (client fault)
78
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
79
- * unsupported characters.</p>
77
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
80
78
  *
81
79
  * @throws {@link DeadlineServiceException}
82
80
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -66,8 +66,7 @@ declare const CreateQueueFleetAssociationCommand_base: {
66
66
  * <p>Your request exceeded a request rate quota.</p>
67
67
  *
68
68
  * @throws {@link ValidationException} (client fault)
69
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
70
- * unsupported characters.</p>
69
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
71
70
  *
72
71
  * @throws {@link DeadlineServiceException}
73
72
  * <p>Base exception class for all service exceptions from Deadline service.</p>
@@ -27,10 +27,7 @@ declare const CreateQueueLimitAssociationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Associates a limit with a particular queue. After the limit is associated, all workers
31
- * for jobs that specify the limit associated with the queue are subject to the limit. You
32
- * can't associate two limits with the same <code>amountRequirementName</code> to the same
33
- * queue.</p>
30
+ * <p>Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same <code>amountRequirementName</code> to the same queue.</p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -69,8 +66,7 @@ declare const CreateQueueLimitAssociationCommand_base: {
69
66
  * <p>Your request exceeded a request rate quota.</p>
70
67
  *
71
68
  * @throws {@link ValidationException} (client fault)
72
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
73
- * unsupported characters.</p>
69
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
74
70
  *
75
71
  * @throws {@link DeadlineServiceException}
76
72
  * <p>Base exception class for all service exceptions from Deadline service.</p>