@aws-sdk/client-mediaconvert 3.378.0 → 3.382.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.
@@ -23,14 +23,17 @@ export type DescribeEndpointsMode = (typeof DescribeEndpointsMode)[keyof typeof
23
23
  */
24
24
  export interface DescribeEndpointsRequest {
25
25
  /**
26
+ * @public
26
27
  * Optional. Max number of endpoints, up to twenty, that will be returned at one time.
27
28
  */
28
29
  MaxResults?: number;
29
30
  /**
31
+ * @public
30
32
  * Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.
31
33
  */
32
34
  Mode?: DescribeEndpointsMode | string;
33
35
  /**
36
+ * @public
34
37
  * Use this string, provided with the response to a previous request, to request the next batch of endpoints.
35
38
  */
36
39
  NextToken?: string;
@@ -40,10 +43,12 @@ export interface DescribeEndpointsRequest {
40
43
  */
41
44
  export interface DescribeEndpointsResponse {
42
45
  /**
46
+ * @public
43
47
  * List of endpoints
44
48
  */
45
49
  Endpoints?: Endpoint[];
46
50
  /**
51
+ * @public
47
52
  * Use this string to request the next batch of endpoints.
48
53
  */
49
54
  NextToken?: string;
@@ -53,6 +58,7 @@ export interface DescribeEndpointsResponse {
53
58
  */
54
59
  export interface DisassociateCertificateRequest {
55
60
  /**
61
+ * @public
56
62
  * The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource.
57
63
  */
58
64
  Arn: string | undefined;
@@ -67,6 +73,7 @@ export interface DisassociateCertificateResponse {
67
73
  */
68
74
  export interface GetJobRequest {
69
75
  /**
76
+ * @public
70
77
  * the job ID of the job.
71
78
  */
72
79
  Id: string | undefined;
@@ -76,6 +83,7 @@ export interface GetJobRequest {
76
83
  */
77
84
  export interface GetJobResponse {
78
85
  /**
86
+ * @public
79
87
  * Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
80
88
  */
81
89
  Job?: Job;
@@ -85,6 +93,7 @@ export interface GetJobResponse {
85
93
  */
86
94
  export interface GetJobTemplateRequest {
87
95
  /**
96
+ * @public
88
97
  * The name of the job template.
89
98
  */
90
99
  Name: string | undefined;
@@ -94,6 +103,7 @@ export interface GetJobTemplateRequest {
94
103
  */
95
104
  export interface GetJobTemplateResponse {
96
105
  /**
106
+ * @public
97
107
  * A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
98
108
  */
99
109
  JobTemplate?: JobTemplate;
@@ -121,14 +131,17 @@ export type InputPolicy = (typeof InputPolicy)[keyof typeof InputPolicy];
121
131
  */
122
132
  export interface Policy {
123
133
  /**
134
+ * @public
124
135
  * Allow or disallow jobs that specify HTTP inputs.
125
136
  */
126
137
  HttpInputs?: InputPolicy | string;
127
138
  /**
139
+ * @public
128
140
  * Allow or disallow jobs that specify HTTPS inputs.
129
141
  */
130
142
  HttpsInputs?: InputPolicy | string;
131
143
  /**
144
+ * @public
132
145
  * Allow or disallow jobs that specify Amazon S3 inputs.
133
146
  */
134
147
  S3Inputs?: InputPolicy | string;
@@ -138,6 +151,7 @@ export interface Policy {
138
151
  */
139
152
  export interface GetPolicyResponse {
140
153
  /**
154
+ * @public
141
155
  * A policy configures behavior that you allow or disallow for your account. For information about MediaConvert policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
142
156
  */
143
157
  Policy?: Policy;
@@ -147,6 +161,7 @@ export interface GetPolicyResponse {
147
161
  */
148
162
  export interface GetPresetRequest {
149
163
  /**
164
+ * @public
150
165
  * The name of the preset.
151
166
  */
152
167
  Name: string | undefined;
@@ -156,6 +171,7 @@ export interface GetPresetRequest {
156
171
  */
157
172
  export interface GetPresetResponse {
158
173
  /**
174
+ * @public
159
175
  * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
160
176
  */
161
177
  Preset?: Preset;
@@ -165,6 +181,7 @@ export interface GetPresetResponse {
165
181
  */
166
182
  export interface GetQueueRequest {
167
183
  /**
184
+ * @public
168
185
  * The name of the queue that you want information about.
169
186
  */
170
187
  Name: string | undefined;
@@ -174,6 +191,7 @@ export interface GetQueueRequest {
174
191
  */
175
192
  export interface GetQueueResponse {
176
193
  /**
194
+ * @public
177
195
  * You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
178
196
  */
179
197
  Queue?: Queue;
@@ -208,22 +226,27 @@ export type Order = (typeof Order)[keyof typeof Order];
208
226
  */
209
227
  export interface ListJobsRequest {
210
228
  /**
229
+ * @public
211
230
  * Optional. Number of jobs, up to twenty, that will be returned at one time.
212
231
  */
213
232
  MaxResults?: number;
214
233
  /**
234
+ * @public
215
235
  * Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
216
236
  */
217
237
  NextToken?: string;
218
238
  /**
239
+ * @public
219
240
  * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
220
241
  */
221
242
  Order?: Order | string;
222
243
  /**
244
+ * @public
223
245
  * Optional. Provide a queue name to get back only jobs from that queue.
224
246
  */
225
247
  Queue?: string;
226
248
  /**
249
+ * @public
227
250
  * Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
228
251
  */
229
252
  Status?: JobStatus | string;
@@ -233,10 +256,12 @@ export interface ListJobsRequest {
233
256
  */
234
257
  export interface ListJobsResponse {
235
258
  /**
259
+ * @public
236
260
  * List of jobs
237
261
  */
238
262
  Jobs?: Job[];
239
263
  /**
264
+ * @public
240
265
  * Use this string to request the next batch of jobs.
241
266
  */
242
267
  NextToken?: string;
@@ -246,22 +271,27 @@ export interface ListJobsResponse {
246
271
  */
247
272
  export interface ListJobTemplatesRequest {
248
273
  /**
274
+ * @public
249
275
  * Optionally, specify a job template category to limit responses to only job templates from that category.
250
276
  */
251
277
  Category?: string;
252
278
  /**
279
+ * @public
253
280
  * Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
254
281
  */
255
282
  ListBy?: JobTemplateListBy | string;
256
283
  /**
284
+ * @public
257
285
  * Optional. Number of job templates, up to twenty, that will be returned at one time.
258
286
  */
259
287
  MaxResults?: number;
260
288
  /**
289
+ * @public
261
290
  * Use this string, provided with the response to a previous request, to request the next batch of job templates.
262
291
  */
263
292
  NextToken?: string;
264
293
  /**
294
+ * @public
265
295
  * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
266
296
  */
267
297
  Order?: Order | string;
@@ -271,10 +301,12 @@ export interface ListJobTemplatesRequest {
271
301
  */
272
302
  export interface ListJobTemplatesResponse {
273
303
  /**
304
+ * @public
274
305
  * List of Job templates.
275
306
  */
276
307
  JobTemplates?: JobTemplate[];
277
308
  /**
309
+ * @public
278
310
  * Use this string to request the next batch of job templates.
279
311
  */
280
312
  NextToken?: string;
@@ -297,22 +329,27 @@ export type PresetListBy = (typeof PresetListBy)[keyof typeof PresetListBy];
297
329
  */
298
330
  export interface ListPresetsRequest {
299
331
  /**
332
+ * @public
300
333
  * Optionally, specify a preset category to limit responses to only presets from that category.
301
334
  */
302
335
  Category?: string;
303
336
  /**
337
+ * @public
304
338
  * Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
305
339
  */
306
340
  ListBy?: PresetListBy | string;
307
341
  /**
342
+ * @public
308
343
  * Optional. Number of presets, up to twenty, that will be returned at one time
309
344
  */
310
345
  MaxResults?: number;
311
346
  /**
347
+ * @public
312
348
  * Use this string, provided with the response to a previous request, to request the next batch of presets.
313
349
  */
314
350
  NextToken?: string;
315
351
  /**
352
+ * @public
316
353
  * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
317
354
  */
318
355
  Order?: Order | string;
@@ -322,10 +359,12 @@ export interface ListPresetsRequest {
322
359
  */
323
360
  export interface ListPresetsResponse {
324
361
  /**
362
+ * @public
325
363
  * Use this string to request the next batch of presets.
326
364
  */
327
365
  NextToken?: string;
328
366
  /**
367
+ * @public
329
368
  * List of presets
330
369
  */
331
370
  Presets?: Preset[];
@@ -347,18 +386,22 @@ export type QueueListBy = (typeof QueueListBy)[keyof typeof QueueListBy];
347
386
  */
348
387
  export interface ListQueuesRequest {
349
388
  /**
389
+ * @public
350
390
  * Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.
351
391
  */
352
392
  ListBy?: QueueListBy | string;
353
393
  /**
394
+ * @public
354
395
  * Optional. Number of queues, up to twenty, that will be returned at one time.
355
396
  */
356
397
  MaxResults?: number;
357
398
  /**
399
+ * @public
358
400
  * Use this string, provided with the response to a previous request, to request the next batch of queues.
359
401
  */
360
402
  NextToken?: string;
361
403
  /**
404
+ * @public
362
405
  * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
363
406
  */
364
407
  Order?: Order | string;
@@ -368,10 +411,12 @@ export interface ListQueuesRequest {
368
411
  */
369
412
  export interface ListQueuesResponse {
370
413
  /**
414
+ * @public
371
415
  * Use this string to request the next batch of queues.
372
416
  */
373
417
  NextToken?: string;
374
418
  /**
419
+ * @public
375
420
  * List of queues.
376
421
  */
377
422
  Queues?: Queue[];
@@ -381,6 +426,7 @@ export interface ListQueuesResponse {
381
426
  */
382
427
  export interface ListTagsForResourceRequest {
383
428
  /**
429
+ * @public
384
430
  * The Amazon Resource Name (ARN) of the resource that you want to list tags for. To get the ARN, send a GET request with the resource name.
385
431
  */
386
432
  Arn: string | undefined;
@@ -391,10 +437,12 @@ export interface ListTagsForResourceRequest {
391
437
  */
392
438
  export interface ResourceTags {
393
439
  /**
440
+ * @public
394
441
  * The Amazon Resource Name (ARN) of the resource.
395
442
  */
396
443
  Arn?: string;
397
444
  /**
445
+ * @public
398
446
  * The tags for the resource.
399
447
  */
400
448
  Tags?: Record<string, string>;
@@ -404,6 +452,7 @@ export interface ResourceTags {
404
452
  */
405
453
  export interface ListTagsForResourceResponse {
406
454
  /**
455
+ * @public
407
456
  * The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.
408
457
  */
409
458
  ResourceTags?: ResourceTags;
@@ -413,6 +462,7 @@ export interface ListTagsForResourceResponse {
413
462
  */
414
463
  export interface PutPolicyRequest {
415
464
  /**
465
+ * @public
416
466
  * A policy configures behavior that you allow or disallow for your account. For information about MediaConvert policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
417
467
  */
418
468
  Policy: Policy | undefined;
@@ -422,6 +472,7 @@ export interface PutPolicyRequest {
422
472
  */
423
473
  export interface PutPolicyResponse {
424
474
  /**
475
+ * @public
425
476
  * A policy configures behavior that you allow or disallow for your account. For information about MediaConvert policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
426
477
  */
427
478
  Policy?: Policy;
@@ -431,10 +482,12 @@ export interface PutPolicyResponse {
431
482
  */
432
483
  export interface TagResourceRequest {
433
484
  /**
485
+ * @public
434
486
  * The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the resource name.
435
487
  */
436
488
  Arn: string | undefined;
437
489
  /**
490
+ * @public
438
491
  * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
439
492
  */
440
493
  Tags: Record<string, string> | undefined;
@@ -449,10 +502,12 @@ export interface TagResourceResponse {
449
502
  */
450
503
  export interface UntagResourceRequest {
451
504
  /**
505
+ * @public
452
506
  * The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name.
453
507
  */
454
508
  Arn: string | undefined;
455
509
  /**
510
+ * @public
456
511
  * The keys of the tags that you want to remove from the resource.
457
512
  */
458
513
  TagKeys?: string[];
@@ -467,38 +522,47 @@ export interface UntagResourceResponse {
467
522
  */
468
523
  export interface UpdateJobTemplateRequest {
469
524
  /**
525
+ * @public
470
526
  * Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.
471
527
  */
472
528
  AccelerationSettings?: AccelerationSettings;
473
529
  /**
530
+ * @public
474
531
  * The new category for the job template, if you are changing it.
475
532
  */
476
533
  Category?: string;
477
534
  /**
535
+ * @public
478
536
  * The new description for the job template, if you are changing it.
479
537
  */
480
538
  Description?: string;
481
539
  /**
540
+ * @public
482
541
  * Optional list of hop destinations.
483
542
  */
484
543
  HopDestinations?: HopDestination[];
485
544
  /**
545
+ * @public
486
546
  * The name of the job template you are modifying
487
547
  */
488
548
  Name: string | undefined;
489
549
  /**
550
+ * @public
490
551
  * Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.
491
552
  */
492
553
  Priority?: number;
493
554
  /**
555
+ * @public
494
556
  * The new queue for the job template, if you are changing it.
495
557
  */
496
558
  Queue?: string;
497
559
  /**
560
+ * @public
498
561
  * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
499
562
  */
500
563
  Settings?: JobTemplateSettings;
501
564
  /**
565
+ * @public
502
566
  * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.
503
567
  */
504
568
  StatusUpdateInterval?: StatusUpdateInterval | string;
@@ -508,6 +572,7 @@ export interface UpdateJobTemplateRequest {
508
572
  */
509
573
  export interface UpdateJobTemplateResponse {
510
574
  /**
575
+ * @public
511
576
  * A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
512
577
  */
513
578
  JobTemplate?: JobTemplate;
@@ -517,18 +582,22 @@ export interface UpdateJobTemplateResponse {
517
582
  */
518
583
  export interface UpdatePresetRequest {
519
584
  /**
585
+ * @public
520
586
  * The new category for the preset, if you are changing it.
521
587
  */
522
588
  Category?: string;
523
589
  /**
590
+ * @public
524
591
  * The new description for the preset, if you are changing it.
525
592
  */
526
593
  Description?: string;
527
594
  /**
595
+ * @public
528
596
  * The name of the preset you are modifying.
529
597
  */
530
598
  Name: string | undefined;
531
599
  /**
600
+ * @public
532
601
  * Settings for preset
533
602
  */
534
603
  Settings?: PresetSettings;
@@ -538,6 +607,7 @@ export interface UpdatePresetRequest {
538
607
  */
539
608
  export interface UpdatePresetResponse {
540
609
  /**
610
+ * @public
541
611
  * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
542
612
  */
543
613
  Preset?: Preset;
@@ -547,18 +617,22 @@ export interface UpdatePresetResponse {
547
617
  */
548
618
  export interface UpdateQueueRequest {
549
619
  /**
620
+ * @public
550
621
  * The new description for the queue, if you are changing it.
551
622
  */
552
623
  Description?: string;
553
624
  /**
625
+ * @public
554
626
  * The name of the queue that you are modifying.
555
627
  */
556
628
  Name: string | undefined;
557
629
  /**
630
+ * @public
558
631
  * The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.
559
632
  */
560
633
  ReservationPlanSettings?: ReservationPlanSettings;
561
634
  /**
635
+ * @public
562
636
  * Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
563
637
  */
564
638
  Status?: QueueStatus | string;
@@ -568,6 +642,7 @@ export interface UpdateQueueRequest {
568
642
  */
569
643
  export interface UpdateQueueResponse {
570
644
  /**
645
+ * @public
571
646
  * You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.
572
647
  */
573
648
  Queue?: Queue;
@@ -1,5 +1,6 @@
1
1
  export * from "./MediaConvertClient";
2
2
  export * from "./MediaConvert";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-mediaconvert",
3
3
  "description": "AWS SDK for JavaScript Mediaconvert Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
4
+ "version": "3.382.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",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
+ "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",