@aws-sdk/client-deadline 3.631.0 → 3.634.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 CHANGED
@@ -9,10 +9,11 @@ AWS SDK for JavaScript Deadline Client for Node.js, Browser and React Native.
9
9
  <p>The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your
10
10
  projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions
11
11
  specific to their job function.</p>
12
- <p>With Deadline Cloud, content production teams can deploy resources for their workforce securely
13
- in the cloud, reducing the costs of added physical infrastructure. Keep your content
14
- production operations secure, while allowing your contributors to access the tools they
15
- need, such as scalable high-speed storage, licenses, and cost management services.</p>
12
+ <p>With Deadline Cloud, content production teams can deploy resources for their workforce
13
+ securely in the cloud, reducing the costs of added physical infrastructure. Keep your
14
+ content production operations secure, while allowing your contributors to access the tools
15
+ they need, such as scalable high-speed storage, licenses, and cost management
16
+ services.</p>
16
17
 
17
18
  ## Installing
18
19
 
@@ -724,10 +724,11 @@ export interface Deadline {
724
724
  * <p>The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your
725
725
  * projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions
726
726
  * specific to their job function.</p>
727
- * <p>With Deadline Cloud, content production teams can deploy resources for their workforce securely
728
- * in the cloud, reducing the costs of added physical infrastructure. Keep your content
729
- * production operations secure, while allowing your contributors to access the tools they
730
- * need, such as scalable high-speed storage, licenses, and cost management services.</p>
727
+ * <p>With Deadline Cloud, content production teams can deploy resources for their workforce
728
+ * securely in the cloud, reducing the costs of added physical infrastructure. Keep your
729
+ * content production operations secure, while allowing your contributors to access the tools
730
+ * they need, such as scalable high-speed storage, licenses, and cost management
731
+ * services.</p>
731
732
  * @public
732
733
  */
733
734
  export declare class Deadline extends DeadlineClient implements Deadline {
@@ -256,10 +256,11 @@ export interface DeadlineClientResolvedConfig extends DeadlineClientResolvedConf
256
256
  * <p>The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your
257
257
  * projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions
258
258
  * specific to their job function.</p>
259
- * <p>With Deadline Cloud, content production teams can deploy resources for their workforce securely
260
- * in the cloud, reducing the costs of added physical infrastructure. Keep your content
261
- * production operations secure, while allowing your contributors to access the tools they
262
- * need, such as scalable high-speed storage, licenses, and cost management services.</p>
259
+ * <p>With Deadline Cloud, content production teams can deploy resources for their workforce
260
+ * securely in the cloud, reducing the costs of added physical infrastructure. Keep your
261
+ * content production operations secure, while allowing your contributors to access the tools
262
+ * they need, such as scalable high-speed storage, licenses, and cost management
263
+ * services.</p>
263
264
  * @public
264
265
  */
265
266
  export declare class DeadlineClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DeadlineClientResolvedConfig> {
@@ -27,8 +27,9 @@ 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 render submission submitted by a user. It contains specific
31
- * job properties outlined as steps and tasks.</p>
30
+ * <p>Creates a job. A job is a set of instructions that AWS 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>
32
33
  * @example
33
34
  * Use a bare-bones client and the command you need to make an API call.
34
35
  * ```javascript
@@ -28,6 +28,10 @@ declare const DeleteQueueCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Deletes a queue.</p>
31
+ * <important>
32
+ * <p>You can't recover the jobs in a queue if you delete the queue. Deleting the queue
33
+ * also deletes the jobs in that queue.</p>
34
+ * </important>
31
35
  * @example
32
36
  * Use a bare-bones client and the command you need to make an API call.
33
37
  * ```javascript
@@ -28,9 +28,12 @@ declare const StartSessionsStatisticsAggregationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Starts an asynchronous request for getting aggregated statistics about queues and farms.
31
- * Get the statistics using the <code>GetSessionsStatisticsAggregation</code> operation.
32
- * Statistics are available for 1 hour after you call the
33
- * <code>StartSessionsStatisticsAggregation</code> operation.</p>
31
+ * Get the statistics using the <code>GetSessionsStatisticsAggregation</code> operation. You
32
+ * can only have one running aggregation for your Deadline Cloud farm. Call the
33
+ * <code>GetSessionsStatisticsAggregation</code> operation and check the
34
+ * <code>status</code> field to see if an aggregation is running. Statistics are available
35
+ * for 1 hour after you call the <code>StartSessionsStatisticsAggregation</code>
36
+ * operation.</p>
34
37
  * @example
35
38
  * Use a bare-bones client and the command you need to make an API call.
36
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const UpdateJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates a job.</p>
30
+ * <p>Updates a job. </p>
31
+ * <p>When you change the status of the job to <code>ARCHIVED</code>, the job can't be
32
+ * scheduled or archived.</p>
33
+ * <important>
34
+ * <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be
35
+ * recovered.</p>
36
+ * </important>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -2,10 +2,11 @@
2
2
  * <p>The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your
3
3
  * projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions
4
4
  * specific to their job function.</p>
5
- * <p>With Deadline Cloud, content production teams can deploy resources for their workforce securely
6
- * in the cloud, reducing the costs of added physical infrastructure. Keep your content
7
- * production operations secure, while allowing your contributors to access the tools they
8
- * need, such as scalable high-speed storage, licenses, and cost management services.</p>
5
+ * <p>With Deadline Cloud, content production teams can deploy resources for their workforce
6
+ * securely in the cloud, reducing the costs of added physical infrastructure. Keep your
7
+ * content production operations secure, while allowing your contributors to access the tools
8
+ * they need, such as scalable high-speed storage, licenses, and cost management
9
+ * services.</p>
9
10
  *
10
11
  * @packageDocumentation
11
12
  */
@@ -1769,6 +1769,9 @@ export interface BudgetActionToAdd {
1769
1769
  thresholdPercentage: number | undefined;
1770
1770
  /**
1771
1771
  * <p>A description for the budget action to add.</p>
1772
+ * <important>
1773
+ * <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>
1774
+ * </important>
1772
1775
  * @public
1773
1776
  */
1774
1777
  description?: string;
@@ -1886,11 +1889,17 @@ export interface CreateBudgetRequest {
1886
1889
  usageTrackingResource: UsageTrackingResource | undefined;
1887
1890
  /**
1888
1891
  * <p>The display name of the budget.</p>
1892
+ * <important>
1893
+ * <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>
1894
+ * </important>
1889
1895
  * @public
1890
1896
  */
1891
1897
  displayName: string | undefined;
1892
1898
  /**
1893
1899
  * <p>The description of the budget.</p>
1900
+ * <important>
1901
+ * <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>
1902
+ * </important>
1894
1903
  * @public
1895
1904
  */
1896
1905
  description?: string;
@@ -1972,6 +1981,9 @@ export interface ResponseBudgetAction {
1972
1981
  thresholdPercentage: number | undefined;
1973
1982
  /**
1974
1983
  * <p>The budget action description.</p>
1984
+ * <important>
1985
+ * <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>
1986
+ * </important>
1975
1987
  * @public
1976
1988
  */
1977
1989
  description?: string;
@@ -2031,11 +2043,17 @@ export interface GetBudgetResponse {
2031
2043
  status: BudgetStatus | undefined;
2032
2044
  /**
2033
2045
  * <p>The display name of the budget.</p>
2046
+ * <important>
2047
+ * <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>
2048
+ * </important>
2034
2049
  * @public
2035
2050
  */
2036
2051
  displayName: string | undefined;
2037
2052
  /**
2038
2053
  * <p>The description of the budget.</p>
2054
+ * <important>
2055
+ * <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>
2056
+ * </important>
2039
2057
  * @public
2040
2058
  */
2041
2059
  description?: string;
@@ -2143,11 +2161,19 @@ export interface BudgetSummary {
2143
2161
  status: BudgetStatus | undefined;
2144
2162
  /**
2145
2163
  * <p>The display name of the budget summary to update.</p>
2164
+ * <important>
2165
+ * <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>
2166
+ * </important>
2146
2167
  * @public
2147
2168
  */
2148
2169
  displayName: string | undefined;
2149
2170
  /**
2171
+ * @deprecated
2172
+ *
2150
2173
  * <p>The description of the budget summary.</p>
2174
+ * <important>
2175
+ * <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>
2176
+ * </important>
2151
2177
  * @public
2152
2178
  */
2153
2179
  description?: string;
@@ -2218,11 +2244,17 @@ export interface UpdateBudgetRequest {
2218
2244
  budgetId: string | undefined;
2219
2245
  /**
2220
2246
  * <p>The display name of the budget to update.</p>
2247
+ * <important>
2248
+ * <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>
2249
+ * </important>
2221
2250
  * @public
2222
2251
  */
2223
2252
  displayName?: string;
2224
2253
  /**
2225
2254
  * <p>The description of the budget to update.</p>
2255
+ * <important>
2256
+ * <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>
2257
+ * </important>
2226
2258
  * @public
2227
2259
  */
2228
2260
  description?: string;
@@ -2387,11 +2419,17 @@ export interface CreateFarmRequest {
2387
2419
  clientToken?: string;
2388
2420
  /**
2389
2421
  * <p>The display name of the farm.</p>
2422
+ * <important>
2423
+ * <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>
2424
+ * </important>
2390
2425
  * @public
2391
2426
  */
2392
2427
  displayName: string | undefined;
2393
2428
  /**
2394
2429
  * <p>The description of the farm.</p>
2430
+ * <important>
2431
+ * <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>
2432
+ * </important>
2395
2433
  * @public
2396
2434
  */
2397
2435
  description?: string;
@@ -2751,11 +2789,17 @@ export interface CreateFleetRequest {
2751
2789
  farmId: string | undefined;
2752
2790
  /**
2753
2791
  * <p>The display name of the fleet.</p>
2792
+ * <important>
2793
+ * <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>
2794
+ * </important>
2754
2795
  * @public
2755
2796
  */
2756
2797
  displayName: string | undefined;
2757
2798
  /**
2758
2799
  * <p>The description of the fleet.</p>
2800
+ * <important>
2801
+ * <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>
2802
+ * </important>
2759
2803
  * @public
2760
2804
  */
2761
2805
  description?: string;
@@ -2838,7 +2882,8 @@ export interface CreateJobRequest {
2838
2882
  */
2839
2883
  templateType: JobTemplateType | undefined;
2840
2884
  /**
2841
- * <p>The priority of the job on a scale of 1 to 100. The highest priority is 1.</p>
2885
+ * <p>The priority of the job on a scale of 0 to 100. The highest priority (first scheduled)
2886
+ * is 100. When two jobs have the same priority, the oldest job is scheduled first.</p>
2842
2887
  * @public
2843
2888
  */
2844
2889
  priority: number | undefined;
@@ -2859,8 +2904,8 @@ export interface CreateJobRequest {
2859
2904
  */
2860
2905
  storageProfileId?: string;
2861
2906
  /**
2862
- * <p>The initial status of the job's tasks when they are created. Tasks that are created with
2863
- * a <code>SUSPENDED</code> status will not run until you update their status.</p>
2907
+ * <p>The initial job status when it is created. Jobs that are created with a
2908
+ * <code>SUSPENDED</code> status will not run until manually requeued.</p>
2864
2909
  * @public
2865
2910
  */
2866
2911
  targetTaskRunStatus?: CreateJobTargetTaskRunStatus;
@@ -2870,7 +2915,7 @@ export interface CreateJobRequest {
2870
2915
  */
2871
2916
  maxFailedTasksCount?: number;
2872
2917
  /**
2873
- * <p>The maximum number of retries for a job.</p>
2918
+ * <p>The maximum number of retries for each task.</p>
2874
2919
  * @public
2875
2920
  */
2876
2921
  maxRetriesPerTask?: number;
@@ -2936,6 +2981,9 @@ export interface CreateMonitorRequest {
2936
2981
  clientToken?: string;
2937
2982
  /**
2938
2983
  * <p>The name that you give the monitor that is displayed in the Deadline Cloud console.</p>
2984
+ * <important>
2985
+ * <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>
2986
+ * </important>
2939
2987
  * @public
2940
2988
  */
2941
2989
  displayName: string | undefined;
@@ -3002,11 +3050,17 @@ export interface CreateQueueRequest {
3002
3050
  farmId: string | undefined;
3003
3051
  /**
3004
3052
  * <p>The display name of the queue.</p>
3053
+ * <important>
3054
+ * <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>
3055
+ * </important>
3005
3056
  * @public
3006
3057
  */
3007
3058
  displayName: string | undefined;
3008
3059
  /**
3009
3060
  * <p>The description of the queue.</p>
3061
+ * <important>
3062
+ * <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>
3063
+ * </important>
3010
3064
  * @public
3011
3065
  */
3012
3066
  description?: string;
@@ -3203,6 +3257,9 @@ export interface CreateStorageProfileRequest {
3203
3257
  farmId: string | undefined;
3204
3258
  /**
3205
3259
  * <p>The display name of the storage profile.</p>
3260
+ * <important>
3261
+ * <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>
3262
+ * </important>
3206
3263
  * @public
3207
3264
  */
3208
3265
  displayName: string | undefined;
@@ -3507,11 +3564,17 @@ export interface GetFleetResponse {
3507
3564
  farmId: string | undefined;
3508
3565
  /**
3509
3566
  * <p>The display name of the fleet.</p>
3567
+ * <important>
3568
+ * <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>
3569
+ * </important>
3510
3570
  * @public
3511
3571
  */
3512
3572
  displayName: string | undefined;
3513
3573
  /**
3514
3574
  * <p>The description of the fleet.</p>
3575
+ * <important>
3576
+ * <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>
3577
+ * </important>
3515
3578
  * @public
3516
3579
  */
3517
3580
  description?: string;
@@ -3675,6 +3738,9 @@ export interface ListFleetsRequest {
3675
3738
  principalId?: string;
3676
3739
  /**
3677
3740
  * <p>The display names of a list of fleets.</p>
3741
+ * <important>
3742
+ * <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>
3743
+ * </important>
3678
3744
  * @public
3679
3745
  */
3680
3746
  displayName?: string;
@@ -3711,6 +3777,9 @@ export interface FleetSummary {
3711
3777
  farmId: string | undefined;
3712
3778
  /**
3713
3779
  * <p>The display name of the fleet summary to update.</p>
3780
+ * <important>
3781
+ * <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>
3782
+ * </important>
3714
3783
  * @public
3715
3784
  */
3716
3785
  displayName: string | undefined;
@@ -3806,11 +3875,17 @@ export interface UpdateFleetRequest {
3806
3875
  fleetId: string | undefined;
3807
3876
  /**
3808
3877
  * <p>The display name of the fleet to update.</p>
3878
+ * <important>
3879
+ * <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>
3880
+ * </important>
3809
3881
  * @public
3810
3882
  */
3811
3883
  displayName?: string;
3812
3884
  /**
3813
3885
  * <p>The description of the fleet to update.</p>
3886
+ * <important>
3887
+ * <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>
3888
+ * </important>
3814
3889
  * @public
3815
3890
  */
3816
3891
  description?: string;
@@ -4422,11 +4497,17 @@ export interface GetFarmResponse {
4422
4497
  farmId: string | undefined;
4423
4498
  /**
4424
4499
  * <p>The display name of the farm.</p>
4500
+ * <important>
4501
+ * <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>
4502
+ * </important>
4425
4503
  * @public
4426
4504
  */
4427
4505
  displayName: string | undefined;
4428
4506
  /**
4429
4507
  * <p>The description of the farm.</p>
4508
+ * <important>
4509
+ * <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>
4510
+ * </important>
4430
4511
  * @public
4431
4512
  */
4432
4513
  description?: string;
@@ -4482,6 +4563,9 @@ export interface GetStorageProfileResponse {
4482
4563
  storageProfileId: string | undefined;
4483
4564
  /**
4484
4565
  * <p>The display name of the storage profile.</p>
4566
+ * <important>
4567
+ * <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>
4568
+ * </important>
4485
4569
  * @public
4486
4570
  */
4487
4571
  displayName: string | undefined;
@@ -4614,6 +4698,9 @@ export interface FarmSummary {
4614
4698
  farmId: string | undefined;
4615
4699
  /**
4616
4700
  * <p>The display name of the farm.</p>
4701
+ * <important>
4702
+ * <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>
4703
+ * </important>
4617
4704
  * @public
4618
4705
  */
4619
4706
  displayName: string | undefined;
@@ -4690,6 +4777,9 @@ export interface StorageProfileSummary {
4690
4777
  storageProfileId: string | undefined;
4691
4778
  /**
4692
4779
  * <p>The display name of the storage profile summary to update.</p>
4780
+ * <important>
4781
+ * <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>
4782
+ * </important>
4693
4783
  * @public
4694
4784
  */
4695
4785
  displayName: string | undefined;
@@ -4835,11 +4925,17 @@ export interface GetQueueResponse {
4835
4925
  queueId: string | undefined;
4836
4926
  /**
4837
4927
  * <p>The display name of the queue.</p>
4928
+ * <important>
4929
+ * <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>
4930
+ * </important>
4838
4931
  * @public
4839
4932
  */
4840
4933
  displayName: string | undefined;
4841
4934
  /**
4842
4935
  * <p>The description of the queue.</p>
4936
+ * <important>
4937
+ * <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>
4938
+ * </important>
4843
4939
  * @public
4844
4940
  */
4845
4941
  description?: string;
@@ -5025,6 +5121,9 @@ export interface GetStorageProfileForQueueResponse {
5025
5121
  storageProfileId: string | undefined;
5026
5122
  /**
5027
5123
  * <p>The display name of the storage profile connected to a queue.</p>
5124
+ * <important>
5125
+ * <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>
5126
+ * </important>
5028
5127
  * @public
5029
5128
  */
5030
5129
  displayName: string | undefined;
@@ -5161,7 +5260,7 @@ export interface GetJobResponse {
5161
5260
  */
5162
5261
  name: string | undefined;
5163
5262
  /**
5164
- * <p>The life cycle status for the job.</p>
5263
+ * <p>The life cycle status for the job. </p>
5165
5264
  * @public
5166
5265
  */
5167
5266
  lifecycleStatus: JobLifecycleStatus | undefined;
@@ -5247,6 +5346,9 @@ export interface GetJobResponse {
5247
5346
  attachments?: Attachments;
5248
5347
  /**
5249
5348
  * <p>The description of the job.</p>
5349
+ * <important>
5350
+ * <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>
5351
+ * </important>
5250
5352
  * @public
5251
5353
  */
5252
5354
  description?: string;
@@ -5844,6 +5946,9 @@ export interface GetStepResponse {
5844
5946
  parameterSpace?: ParameterSpace;
5845
5947
  /**
5846
5948
  * <p>The description of the step.</p>
5949
+ * <important>
5950
+ * <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>
5951
+ * </important>
5847
5952
  * @public
5848
5953
  */
5849
5954
  description?: string;
@@ -7011,7 +7116,12 @@ export interface UpdateJobRequest {
7011
7116
  */
7012
7117
  maxRetriesPerTask?: number;
7013
7118
  /**
7014
- * <p>The status of a job in its lifecycle.</p>
7119
+ * <p>The status of a job in its lifecycle. When you change the status of the job to
7120
+ * <code>ARCHIVED</code>, the job can't be scheduled or archived.</p>
7121
+ * <important>
7122
+ * <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be
7123
+ * recovered.</p>
7124
+ * </important>
7015
7125
  * @public
7016
7126
  */
7017
7127
  lifecycleStatus?: UpdateJobLifecycleStatus;
@@ -7293,8 +7403,7 @@ export interface ListQueuesRequest {
7293
7403
  */
7294
7404
  farmId: string | undefined;
7295
7405
  /**
7296
- * <p>The principal ID. This filter is only valid when using Nimble Studio credentials and
7297
- * should match the user ID in the credentials of the caller.</p>
7406
+ * <p>The principal IDs to include in the list of queues.</p>
7298
7407
  * @public
7299
7408
  */
7300
7409
  principalId?: string;
@@ -7346,6 +7455,9 @@ export interface QueueSummary {
7346
7455
  queueId: string | undefined;
7347
7456
  /**
7348
7457
  * <p>The display name of the queue summary to update.</p>
7458
+ * <important>
7459
+ * <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>
7460
+ * </important>
7349
7461
  * @public
7350
7462
  */
7351
7463
  displayName: string | undefined;
@@ -35,11 +35,17 @@ export interface UpdateQueueRequest {
35
35
  queueId: string | undefined;
36
36
  /**
37
37
  * <p>The display name of the queue to update.</p>
38
+ * <important>
39
+ * <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>
40
+ * </important>
38
41
  * @public
39
42
  */
40
43
  displayName?: string;
41
44
  /**
42
45
  * <p>The description of the queue to update.</p>
46
+ * <important>
47
+ * <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>
48
+ * </important>
43
49
  * @public
44
50
  */
45
51
  description?: string;
@@ -146,11 +152,17 @@ export interface UpdateFarmRequest {
146
152
  farmId: string | undefined;
147
153
  /**
148
154
  * <p>The display name of the farm to update.</p>
155
+ * <important>
156
+ * <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>
157
+ * </important>
149
158
  * @public
150
159
  */
151
160
  displayName?: string;
152
161
  /**
153
162
  * <p>The description of the farm to update.</p>
163
+ * <important>
164
+ * <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>
165
+ * </important>
154
166
  * @public
155
167
  */
156
168
  description?: string;
@@ -181,6 +193,9 @@ export interface UpdateStorageProfileRequest {
181
193
  storageProfileId: string | undefined;
182
194
  /**
183
195
  * <p>The display name of the storage profile to update.</p>
196
+ * <important>
197
+ * <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>
198
+ * </important>
184
199
  * @public
185
200
  */
186
201
  displayName?: string;
@@ -446,7 +461,14 @@ export interface GetSessionsStatisticsAggregationResponse {
446
461
  */
447
462
  nextToken?: string;
448
463
  /**
449
- * <p>The status of the aggregated results.</p>
464
+ * <p>The status of the aggregated results. An aggregation may fail or time out if the results
465
+ * are too large. If this happens, you can call the
466
+ * <code>StartSessionsStatisticsAggregation</code> operation after you reduce the
467
+ * aggregation time frame, reduce the number of queues or fleets in the aggregation, or
468
+ * increase the period length.</p>
469
+ * <p>If you call the <code>StartSessionsStatisticsAggregation </code> operation when the
470
+ * status is <code>IN_PROGRESS</code>, you will receive a
471
+ * <code>ThrottlingException</code>.</p>
450
472
  * @public
451
473
  */
452
474
  status: SessionsStatisticsAggregationStatus | undefined;
@@ -887,6 +909,9 @@ export interface GetMonitorResponse {
887
909
  monitorId: string | undefined;
888
910
  /**
889
911
  * <p>The name used to identify the monitor on the Deadline Cloud console.</p>
912
+ * <important>
913
+ * <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>
914
+ * </important>
890
915
  * @public
891
916
  */
892
917
  displayName: string | undefined;
@@ -966,6 +991,9 @@ export interface MonitorSummary {
966
991
  monitorId: string | undefined;
967
992
  /**
968
993
  * <p>The name of the monitor that displays on the Deadline Cloud console.</p>
994
+ * <important>
995
+ * <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>
996
+ * </important>
969
997
  * @public
970
998
  */
971
999
  displayName: string | undefined;
@@ -1050,6 +1078,9 @@ export interface UpdateMonitorRequest {
1050
1078
  subdomain?: string;
1051
1079
  /**
1052
1080
  * <p>The new value to use for the monitor's display name.</p>
1081
+ * <important>
1082
+ * <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>
1083
+ * </important>
1053
1084
  * @public
1054
1085
  */
1055
1086
  displayName?: string;
@@ -1271,7 +1302,7 @@ export interface JobSearchSummary {
1271
1302
  */
1272
1303
  lifecycleStatusMessage?: string;
1273
1304
  /**
1274
- * <p>task run status for the job.</p>
1305
+ * <p>The task run status for the job.</p>
1275
1306
  * <ul>
1276
1307
  * <li>
1277
1308
  * <p>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-deadline",
3
3
  "description": "AWS SDK for JavaScript Deadline Client for Node.js, Browser and React Native",
4
- "version": "3.631.0",
4
+ "version": "3.634.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,17 +20,17 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.631.0",
24
- "@aws-sdk/client-sts": "3.631.0",
23
+ "@aws-sdk/client-sso-oidc": "3.632.0",
24
+ "@aws-sdk/client-sts": "3.632.0",
25
25
  "@aws-sdk/core": "3.629.0",
26
- "@aws-sdk/credential-provider-node": "3.631.0",
26
+ "@aws-sdk/credential-provider-node": "3.632.0",
27
27
  "@aws-sdk/middleware-host-header": "3.620.0",
28
28
  "@aws-sdk/middleware-logger": "3.609.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.620.0",
30
- "@aws-sdk/middleware-user-agent": "3.631.0",
30
+ "@aws-sdk/middleware-user-agent": "3.632.0",
31
31
  "@aws-sdk/region-config-resolver": "3.614.0",
32
32
  "@aws-sdk/types": "3.609.0",
33
- "@aws-sdk/util-endpoints": "3.631.0",
33
+ "@aws-sdk/util-endpoints": "3.632.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.609.0",
35
35
  "@aws-sdk/util-user-agent-node": "3.614.0",
36
36
  "@smithy/config-resolver": "^3.0.5",