@aws-sdk/client-mediaconvert 3.533.0 → 3.536.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 (63) hide show
  1. package/dist-types/MediaConvert.d.ts +8 -1
  2. package/dist-types/MediaConvertClient.d.ts +1 -1
  3. package/dist-types/commands/AssociateCertificateCommand.d.ts +2 -1
  4. package/dist-types/commands/CancelJobCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateJobCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateJobTemplateCommand.d.ts +2 -1
  7. package/dist-types/commands/CreatePresetCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateQueueCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteJobTemplateCommand.d.ts +2 -1
  10. package/dist-types/commands/DeletePolicyCommand.d.ts +2 -1
  11. package/dist-types/commands/DeletePresetCommand.d.ts +2 -1
  12. package/dist-types/commands/DeleteQueueCommand.d.ts +2 -1
  13. package/dist-types/commands/DescribeEndpointsCommand.d.ts +4 -3
  14. package/dist-types/commands/DisassociateCertificateCommand.d.ts +2 -1
  15. package/dist-types/commands/GetJobCommand.d.ts +2 -1
  16. package/dist-types/commands/GetJobTemplateCommand.d.ts +2 -1
  17. package/dist-types/commands/GetPolicyCommand.d.ts +2 -1
  18. package/dist-types/commands/GetPresetCommand.d.ts +2 -1
  19. package/dist-types/commands/GetQueueCommand.d.ts +2 -1
  20. package/dist-types/commands/ListJobTemplatesCommand.d.ts +2 -1
  21. package/dist-types/commands/ListJobsCommand.d.ts +2 -1
  22. package/dist-types/commands/ListPresetsCommand.d.ts +2 -1
  23. package/dist-types/commands/ListQueuesCommand.d.ts +2 -1
  24. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  25. package/dist-types/commands/PutPolicyCommand.d.ts +2 -1
  26. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  27. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  28. package/dist-types/commands/UpdateJobTemplateCommand.d.ts +2 -1
  29. package/dist-types/commands/UpdatePresetCommand.d.ts +2 -1
  30. package/dist-types/commands/UpdateQueueCommand.d.ts +2 -1
  31. package/dist-types/models/models_0.d.ts +709 -709
  32. package/dist-types/models/models_1.d.ts +659 -659
  33. package/dist-types/models/models_2.d.ts +126 -126
  34. package/dist-types/ts3.4/MediaConvert.d.ts +7 -0
  35. package/dist-types/ts3.4/commands/AssociateCertificateCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/CancelJobCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/CreateJobCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/CreateJobTemplateCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/CreatePresetCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/CreateQueueCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/DeleteJobTemplateCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/DeletePolicyCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/DeletePresetCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/DeleteQueueCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/DescribeEndpointsCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/DisassociateCertificateCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/GetJobCommand.d.ts +7 -0
  48. package/dist-types/ts3.4/commands/GetJobTemplateCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/GetPresetCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/GetQueueCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/ListJobTemplatesCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/ListPresetsCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/PutPolicyCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/UpdateJobTemplateCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/UpdatePresetCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/UpdateQueueCommand.d.ts +9 -0
  63. package/package.json +40 -40
@@ -5,8 +5,8 @@ import { Commitment, Job, JobSettings, JobStatus, JobTemplate, JobTemplateSettin
5
5
  */
6
6
  export interface CancelJobRequest {
7
7
  /**
8
- * @public
9
8
  * The Job ID of the job to be cancelled.
9
+ * @public
10
10
  */
11
11
  Id: string | undefined;
12
12
  }
@@ -20,68 +20,68 @@ export interface CancelJobResponse {
20
20
  */
21
21
  export interface CreateJobRequest {
22
22
  /**
23
- * @public
24
23
  * Optional. 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.
24
+ * @public
25
25
  */
26
26
  AccelerationSettings?: AccelerationSettings;
27
27
  /**
28
- * @public
29
28
  * Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.
29
+ * @public
30
30
  */
31
31
  BillingTagsSource?: BillingTagsSource;
32
32
  /**
33
- * @public
34
33
  * Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
34
+ * @public
35
35
  */
36
36
  ClientRequestToken?: string;
37
37
  /**
38
- * @public
39
38
  * Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
39
+ * @public
40
40
  */
41
41
  HopDestinations?: HopDestination[];
42
42
  /**
43
- * @public
44
43
  * Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.
44
+ * @public
45
45
  */
46
46
  JobTemplate?: string;
47
47
  /**
48
- * @public
49
48
  * Optional. 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.
49
+ * @public
50
50
  */
51
51
  Priority?: number;
52
52
  /**
53
- * @public
54
53
  * Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.
54
+ * @public
55
55
  */
56
56
  Queue?: string;
57
57
  /**
58
- * @public
59
58
  * Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
59
+ * @public
60
60
  */
61
61
  Role: string | undefined;
62
62
  /**
63
- * @public
64
63
  * JobSettings contains all the transcode settings for a job.
64
+ * @public
65
65
  */
66
66
  Settings: JobSettings | undefined;
67
67
  /**
68
- * @public
69
68
  * Optional. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
69
+ * @public
70
70
  */
71
71
  SimulateReservedQueue?: SimulateReservedQueue;
72
72
  /**
73
- * @public
74
73
  * Optional. 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.
74
+ * @public
75
75
  */
76
76
  StatusUpdateInterval?: StatusUpdateInterval;
77
77
  /**
78
- * @public
79
78
  * Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations and workflows.
79
+ * @public
80
80
  */
81
81
  Tags?: Record<string, string>;
82
82
  /**
83
- * @public
84
83
  * Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you use standard AWS tags.
84
+ * @public
85
85
  */
86
86
  UserMetadata?: Record<string, string>;
87
87
  }
@@ -90,8 +90,8 @@ export interface CreateJobRequest {
90
90
  */
91
91
  export interface CreateJobResponse {
92
92
  /**
93
- * @public
94
93
  * 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
94
+ * @public
95
95
  */
96
96
  Job?: Job;
97
97
  }
@@ -100,53 +100,53 @@ export interface CreateJobResponse {
100
100
  */
101
101
  export interface CreateJobTemplateRequest {
102
102
  /**
103
- * @public
104
103
  * 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.
104
+ * @public
105
105
  */
106
106
  AccelerationSettings?: AccelerationSettings;
107
107
  /**
108
- * @public
109
108
  * Optional. A category for the job template you are creating
109
+ * @public
110
110
  */
111
111
  Category?: string;
112
112
  /**
113
- * @public
114
113
  * Optional. A description of the job template you are creating.
114
+ * @public
115
115
  */
116
116
  Description?: string;
117
117
  /**
118
- * @public
119
118
  * Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.
119
+ * @public
120
120
  */
121
121
  HopDestinations?: HopDestination[];
122
122
  /**
123
- * @public
124
123
  * The name of the job template you are creating.
124
+ * @public
125
125
  */
126
126
  Name: string | undefined;
127
127
  /**
128
- * @public
129
128
  * 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.
129
+ * @public
130
130
  */
131
131
  Priority?: number;
132
132
  /**
133
- * @public
134
133
  * Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.
134
+ * @public
135
135
  */
136
136
  Queue?: string;
137
137
  /**
138
- * @public
139
138
  * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
139
+ * @public
140
140
  */
141
141
  Settings: JobTemplateSettings | undefined;
142
142
  /**
143
- * @public
144
143
  * 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.
144
+ * @public
145
145
  */
146
146
  StatusUpdateInterval?: StatusUpdateInterval;
147
147
  /**
148
- * @public
149
148
  * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
149
+ * @public
150
150
  */
151
151
  Tags?: Record<string, string>;
152
152
  }
@@ -155,8 +155,8 @@ export interface CreateJobTemplateRequest {
155
155
  */
156
156
  export interface CreateJobTemplateResponse {
157
157
  /**
158
- * @public
159
158
  * A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
159
+ * @public
160
160
  */
161
161
  JobTemplate?: JobTemplate;
162
162
  }
@@ -165,28 +165,28 @@ export interface CreateJobTemplateResponse {
165
165
  */
166
166
  export interface CreatePresetRequest {
167
167
  /**
168
- * @public
169
168
  * Optional. A category for the preset you are creating.
169
+ * @public
170
170
  */
171
171
  Category?: string;
172
172
  /**
173
- * @public
174
173
  * Optional. A description of the preset you are creating.
174
+ * @public
175
175
  */
176
176
  Description?: string;
177
177
  /**
178
- * @public
179
178
  * The name of the preset you are creating.
179
+ * @public
180
180
  */
181
181
  Name: string | undefined;
182
182
  /**
183
- * @public
184
183
  * Settings for preset
184
+ * @public
185
185
  */
186
186
  Settings: PresetSettings | undefined;
187
187
  /**
188
- * @public
189
188
  * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
189
+ * @public
190
190
  */
191
191
  Tags?: Record<string, string>;
192
192
  }
@@ -195,29 +195,29 @@ export interface CreatePresetRequest {
195
195
  */
196
196
  export interface CreatePresetResponse {
197
197
  /**
198
- * @public
199
198
  * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
199
+ * @public
200
200
  */
201
201
  Preset?: Preset;
202
202
  }
203
203
  /**
204
- * @public
205
204
  * Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
205
+ * @public
206
206
  */
207
207
  export interface ReservationPlanSettings {
208
208
  /**
209
- * @public
210
209
  * The length of the term of your reserved queue pricing plan commitment.
210
+ * @public
211
211
  */
212
212
  Commitment: Commitment | undefined;
213
213
  /**
214
- * @public
215
214
  * Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the auto renew date. You can cancel this commitment.
215
+ * @public
216
216
  */
217
217
  RenewalType: RenewalType | undefined;
218
218
  /**
219
- * @public
220
219
  * Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity.
220
+ * @public
221
221
  */
222
222
  ReservedSlots: number | undefined;
223
223
  }
@@ -226,33 +226,33 @@ export interface ReservationPlanSettings {
226
226
  */
227
227
  export interface CreateQueueRequest {
228
228
  /**
229
- * @public
230
229
  * Optional. A description of the queue that you are creating.
230
+ * @public
231
231
  */
232
232
  Description?: string;
233
233
  /**
234
- * @public
235
234
  * The name of the queue that you are creating.
235
+ * @public
236
236
  */
237
237
  Name: string | undefined;
238
238
  /**
239
- * @public
240
239
  * Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.
240
+ * @public
241
241
  */
242
242
  PricingPlan?: PricingPlan;
243
243
  /**
244
- * @public
245
244
  * Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
245
+ * @public
246
246
  */
247
247
  ReservationPlanSettings?: ReservationPlanSettings;
248
248
  /**
249
- * @public
250
249
  * Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.
250
+ * @public
251
251
  */
252
252
  Status?: QueueStatus;
253
253
  /**
254
- * @public
255
254
  * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
255
+ * @public
256
256
  */
257
257
  Tags?: Record<string, string>;
258
258
  }
@@ -261,8 +261,8 @@ export interface CreateQueueRequest {
261
261
  */
262
262
  export interface CreateQueueResponse {
263
263
  /**
264
- * @public
265
264
  * 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.
265
+ * @public
266
266
  */
267
267
  Queue?: Queue;
268
268
  }
@@ -271,8 +271,8 @@ export interface CreateQueueResponse {
271
271
  */
272
272
  export interface DeleteJobTemplateRequest {
273
273
  /**
274
- * @public
275
274
  * The name of the job template to be deleted.
275
+ * @public
276
276
  */
277
277
  Name: string | undefined;
278
278
  }
@@ -296,8 +296,8 @@ export interface DeletePolicyResponse {
296
296
  */
297
297
  export interface DeletePresetRequest {
298
298
  /**
299
- * @public
300
299
  * The name of the preset to be deleted.
300
+ * @public
301
301
  */
302
302
  Name: string | undefined;
303
303
  }
@@ -311,8 +311,8 @@ export interface DeletePresetResponse {
311
311
  */
312
312
  export interface DeleteQueueRequest {
313
313
  /**
314
- * @public
315
314
  * The name of the queue that you want to delete.
315
+ * @public
316
316
  */
317
317
  Name: string | undefined;
318
318
  }
@@ -334,27 +334,27 @@ export declare const DescribeEndpointsMode: {
334
334
  */
335
335
  export type DescribeEndpointsMode = (typeof DescribeEndpointsMode)[keyof typeof DescribeEndpointsMode];
336
336
  /**
337
- * @public
338
- * @deprecated
339
- *
340
337
  * DescribeEndpointsRequest
338
+ *
339
+ * @deprecated DescribeEndpoints and account specific endpoints are no longer required. We recommend that you send your requests directly to the regional endpoint instead.
340
+ * @public
341
341
  */
342
342
  export interface DescribeEndpointsRequest {
343
343
  /**
344
- * @public
345
344
  * Optional. Max number of endpoints, up to twenty, that will be returned at one time.
345
+ * @public
346
346
  */
347
347
  MaxResults?: number;
348
348
  /**
349
- * @public
350
349
  * @deprecated
351
350
  *
352
351
  * 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.
352
+ * @public
353
353
  */
354
354
  Mode?: DescribeEndpointsMode;
355
355
  /**
356
- * @public
357
356
  * Use this string, provided with the response to a previous request, to request the next batch of endpoints.
357
+ * @public
358
358
  */
359
359
  NextToken?: string;
360
360
  }
@@ -363,13 +363,13 @@ export interface DescribeEndpointsRequest {
363
363
  */
364
364
  export interface DescribeEndpointsResponse {
365
365
  /**
366
- * @public
367
366
  * List of endpoints
367
+ * @public
368
368
  */
369
369
  Endpoints?: Endpoint[];
370
370
  /**
371
- * @public
372
371
  * Use this string to request the next batch of endpoints.
372
+ * @public
373
373
  */
374
374
  NextToken?: string;
375
375
  }
@@ -378,8 +378,8 @@ export interface DescribeEndpointsResponse {
378
378
  */
379
379
  export interface DisassociateCertificateRequest {
380
380
  /**
381
- * @public
382
381
  * The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource.
382
+ * @public
383
383
  */
384
384
  Arn: string | undefined;
385
385
  }
@@ -393,8 +393,8 @@ export interface DisassociateCertificateResponse {
393
393
  */
394
394
  export interface GetJobRequest {
395
395
  /**
396
- * @public
397
396
  * the job ID of the job.
397
+ * @public
398
398
  */
399
399
  Id: string | undefined;
400
400
  }
@@ -403,8 +403,8 @@ export interface GetJobRequest {
403
403
  */
404
404
  export interface GetJobResponse {
405
405
  /**
406
- * @public
407
406
  * 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
407
+ * @public
408
408
  */
409
409
  Job?: Job;
410
410
  }
@@ -413,8 +413,8 @@ export interface GetJobResponse {
413
413
  */
414
414
  export interface GetJobTemplateRequest {
415
415
  /**
416
- * @public
417
416
  * The name of the job template.
417
+ * @public
418
418
  */
419
419
  Name: string | undefined;
420
420
  }
@@ -423,8 +423,8 @@ export interface GetJobTemplateRequest {
423
423
  */
424
424
  export interface GetJobTemplateResponse {
425
425
  /**
426
- * @public
427
426
  * A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
427
+ * @public
428
428
  */
429
429
  JobTemplate?: JobTemplate;
430
430
  }
@@ -446,23 +446,23 @@ export declare const InputPolicy: {
446
446
  */
447
447
  export type InputPolicy = (typeof InputPolicy)[keyof typeof InputPolicy];
448
448
  /**
449
- * @public
450
449
  * 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
450
+ * @public
451
451
  */
452
452
  export interface Policy {
453
453
  /**
454
- * @public
455
454
  * Allow or disallow jobs that specify HTTP inputs.
455
+ * @public
456
456
  */
457
457
  HttpInputs?: InputPolicy;
458
458
  /**
459
- * @public
460
459
  * Allow or disallow jobs that specify HTTPS inputs.
460
+ * @public
461
461
  */
462
462
  HttpsInputs?: InputPolicy;
463
463
  /**
464
- * @public
465
464
  * Allow or disallow jobs that specify Amazon S3 inputs.
465
+ * @public
466
466
  */
467
467
  S3Inputs?: InputPolicy;
468
468
  }
@@ -471,8 +471,8 @@ export interface Policy {
471
471
  */
472
472
  export interface GetPolicyResponse {
473
473
  /**
474
- * @public
475
474
  * 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
475
+ * @public
476
476
  */
477
477
  Policy?: Policy;
478
478
  }
@@ -481,8 +481,8 @@ export interface GetPolicyResponse {
481
481
  */
482
482
  export interface GetPresetRequest {
483
483
  /**
484
- * @public
485
484
  * The name of the preset.
485
+ * @public
486
486
  */
487
487
  Name: string | undefined;
488
488
  }
@@ -491,8 +491,8 @@ export interface GetPresetRequest {
491
491
  */
492
492
  export interface GetPresetResponse {
493
493
  /**
494
- * @public
495
494
  * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
495
+ * @public
496
496
  */
497
497
  Preset?: Preset;
498
498
  }
@@ -501,8 +501,8 @@ export interface GetPresetResponse {
501
501
  */
502
502
  export interface GetQueueRequest {
503
503
  /**
504
- * @public
505
504
  * The name of the queue that you want information about.
505
+ * @public
506
506
  */
507
507
  Name: string | undefined;
508
508
  }
@@ -511,8 +511,8 @@ export interface GetQueueRequest {
511
511
  */
512
512
  export interface GetQueueResponse {
513
513
  /**
514
- * @public
515
514
  * 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.
515
+ * @public
516
516
  */
517
517
  Queue?: Queue;
518
518
  }
@@ -546,28 +546,28 @@ export type Order = (typeof Order)[keyof typeof Order];
546
546
  */
547
547
  export interface ListJobsRequest {
548
548
  /**
549
- * @public
550
549
  * Optional. Number of jobs, up to twenty, that will be returned at one time.
550
+ * @public
551
551
  */
552
552
  MaxResults?: number;
553
553
  /**
554
- * @public
555
554
  * Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
555
+ * @public
556
556
  */
557
557
  NextToken?: string;
558
558
  /**
559
- * @public
560
559
  * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
560
+ * @public
561
561
  */
562
562
  Order?: Order;
563
563
  /**
564
- * @public
565
564
  * Optional. Provide a queue name to get back only jobs from that queue.
565
+ * @public
566
566
  */
567
567
  Queue?: string;
568
568
  /**
569
- * @public
570
569
  * Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
570
+ * @public
571
571
  */
572
572
  Status?: JobStatus;
573
573
  }
@@ -576,13 +576,13 @@ export interface ListJobsRequest {
576
576
  */
577
577
  export interface ListJobsResponse {
578
578
  /**
579
- * @public
580
579
  * List of jobs
580
+ * @public
581
581
  */
582
582
  Jobs?: Job[];
583
583
  /**
584
- * @public
585
584
  * Use this string to request the next batch of jobs.
585
+ * @public
586
586
  */
587
587
  NextToken?: string;
588
588
  }
@@ -591,28 +591,28 @@ export interface ListJobsResponse {
591
591
  */
592
592
  export interface ListJobTemplatesRequest {
593
593
  /**
594
- * @public
595
594
  * Optionally, specify a job template category to limit responses to only job templates from that category.
595
+ * @public
596
596
  */
597
597
  Category?: string;
598
598
  /**
599
- * @public
600
599
  * 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.
600
+ * @public
601
601
  */
602
602
  ListBy?: JobTemplateListBy;
603
603
  /**
604
- * @public
605
604
  * Optional. Number of job templates, up to twenty, that will be returned at one time.
605
+ * @public
606
606
  */
607
607
  MaxResults?: number;
608
608
  /**
609
- * @public
610
609
  * Use this string, provided with the response to a previous request, to request the next batch of job templates.
610
+ * @public
611
611
  */
612
612
  NextToken?: string;
613
613
  /**
614
- * @public
615
614
  * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
615
+ * @public
616
616
  */
617
617
  Order?: Order;
618
618
  }
@@ -621,13 +621,13 @@ export interface ListJobTemplatesRequest {
621
621
  */
622
622
  export interface ListJobTemplatesResponse {
623
623
  /**
624
- * @public
625
624
  * List of Job templates.
625
+ * @public
626
626
  */
627
627
  JobTemplates?: JobTemplate[];
628
628
  /**
629
- * @public
630
629
  * Use this string to request the next batch of job templates.
630
+ * @public
631
631
  */
632
632
  NextToken?: string;
633
633
  }
@@ -649,28 +649,28 @@ export type PresetListBy = (typeof PresetListBy)[keyof typeof PresetListBy];
649
649
  */
650
650
  export interface ListPresetsRequest {
651
651
  /**
652
- * @public
653
652
  * Optionally, specify a preset category to limit responses to only presets from that category.
653
+ * @public
654
654
  */
655
655
  Category?: string;
656
656
  /**
657
- * @public
658
657
  * 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.
658
+ * @public
659
659
  */
660
660
  ListBy?: PresetListBy;
661
661
  /**
662
- * @public
663
662
  * Optional. Number of presets, up to twenty, that will be returned at one time
663
+ * @public
664
664
  */
665
665
  MaxResults?: number;
666
666
  /**
667
- * @public
668
667
  * Use this string, provided with the response to a previous request, to request the next batch of presets.
668
+ * @public
669
669
  */
670
670
  NextToken?: string;
671
671
  /**
672
- * @public
673
672
  * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
673
+ * @public
674
674
  */
675
675
  Order?: Order;
676
676
  }
@@ -679,13 +679,13 @@ export interface ListPresetsRequest {
679
679
  */
680
680
  export interface ListPresetsResponse {
681
681
  /**
682
- * @public
683
682
  * Use this string to request the next batch of presets.
683
+ * @public
684
684
  */
685
685
  NextToken?: string;
686
686
  /**
687
- * @public
688
687
  * List of presets
688
+ * @public
689
689
  */
690
690
  Presets?: Preset[];
691
691
  }
@@ -706,23 +706,23 @@ export type QueueListBy = (typeof QueueListBy)[keyof typeof QueueListBy];
706
706
  */
707
707
  export interface ListQueuesRequest {
708
708
  /**
709
- * @public
710
709
  * 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.
710
+ * @public
711
711
  */
712
712
  ListBy?: QueueListBy;
713
713
  /**
714
- * @public
715
714
  * Optional. Number of queues, up to twenty, that will be returned at one time.
715
+ * @public
716
716
  */
717
717
  MaxResults?: number;
718
718
  /**
719
- * @public
720
719
  * Use this string, provided with the response to a previous request, to request the next batch of queues.
720
+ * @public
721
721
  */
722
722
  NextToken?: string;
723
723
  /**
724
- * @public
725
724
  * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
725
+ * @public
726
726
  */
727
727
  Order?: Order;
728
728
  }
@@ -731,13 +731,13 @@ export interface ListQueuesRequest {
731
731
  */
732
732
  export interface ListQueuesResponse {
733
733
  /**
734
- * @public
735
734
  * Use this string to request the next batch of queues.
735
+ * @public
736
736
  */
737
737
  NextToken?: string;
738
738
  /**
739
- * @public
740
739
  * List of queues.
740
+ * @public
741
741
  */
742
742
  Queues?: Queue[];
743
743
  }
@@ -746,24 +746,24 @@ export interface ListQueuesResponse {
746
746
  */
747
747
  export interface ListTagsForResourceRequest {
748
748
  /**
749
- * @public
750
749
  * 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.
750
+ * @public
751
751
  */
752
752
  Arn: string | undefined;
753
753
  }
754
754
  /**
755
- * @public
756
755
  * The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.
756
+ * @public
757
757
  */
758
758
  export interface ResourceTags {
759
759
  /**
760
- * @public
761
760
  * The Amazon Resource Name (ARN) of the resource.
761
+ * @public
762
762
  */
763
763
  Arn?: string;
764
764
  /**
765
- * @public
766
765
  * The tags for the resource.
766
+ * @public
767
767
  */
768
768
  Tags?: Record<string, string>;
769
769
  }
@@ -772,8 +772,8 @@ export interface ResourceTags {
772
772
  */
773
773
  export interface ListTagsForResourceResponse {
774
774
  /**
775
- * @public
776
775
  * The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.
776
+ * @public
777
777
  */
778
778
  ResourceTags?: ResourceTags;
779
779
  }
@@ -782,8 +782,8 @@ export interface ListTagsForResourceResponse {
782
782
  */
783
783
  export interface PutPolicyRequest {
784
784
  /**
785
- * @public
786
785
  * 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
786
+ * @public
787
787
  */
788
788
  Policy: Policy | undefined;
789
789
  }
@@ -792,8 +792,8 @@ export interface PutPolicyRequest {
792
792
  */
793
793
  export interface PutPolicyResponse {
794
794
  /**
795
- * @public
796
795
  * 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
796
+ * @public
797
797
  */
798
798
  Policy?: Policy;
799
799
  }
@@ -802,13 +802,13 @@ export interface PutPolicyResponse {
802
802
  */
803
803
  export interface TagResourceRequest {
804
804
  /**
805
- * @public
806
805
  * 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.
806
+ * @public
807
807
  */
808
808
  Arn: string | undefined;
809
809
  /**
810
- * @public
811
810
  * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
811
+ * @public
812
812
  */
813
813
  Tags: Record<string, string> | undefined;
814
814
  }
@@ -822,13 +822,13 @@ export interface TagResourceResponse {
822
822
  */
823
823
  export interface UntagResourceRequest {
824
824
  /**
825
- * @public
826
825
  * 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.
826
+ * @public
827
827
  */
828
828
  Arn: string | undefined;
829
829
  /**
830
- * @public
831
830
  * The keys of the tags that you want to remove from the resource.
831
+ * @public
832
832
  */
833
833
  TagKeys?: string[];
834
834
  }
@@ -842,48 +842,48 @@ export interface UntagResourceResponse {
842
842
  */
843
843
  export interface UpdateJobTemplateRequest {
844
844
  /**
845
- * @public
846
845
  * 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.
846
+ * @public
847
847
  */
848
848
  AccelerationSettings?: AccelerationSettings;
849
849
  /**
850
- * @public
851
850
  * The new category for the job template, if you are changing it.
851
+ * @public
852
852
  */
853
853
  Category?: string;
854
854
  /**
855
- * @public
856
855
  * The new description for the job template, if you are changing it.
856
+ * @public
857
857
  */
858
858
  Description?: string;
859
859
  /**
860
- * @public
861
860
  * Optional list of hop destinations.
861
+ * @public
862
862
  */
863
863
  HopDestinations?: HopDestination[];
864
864
  /**
865
- * @public
866
865
  * The name of the job template you are modifying
866
+ * @public
867
867
  */
868
868
  Name: string | undefined;
869
869
  /**
870
- * @public
871
870
  * 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.
871
+ * @public
872
872
  */
873
873
  Priority?: number;
874
874
  /**
875
- * @public
876
875
  * The new queue for the job template, if you are changing it.
876
+ * @public
877
877
  */
878
878
  Queue?: string;
879
879
  /**
880
- * @public
881
880
  * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
881
+ * @public
882
882
  */
883
883
  Settings?: JobTemplateSettings;
884
884
  /**
885
- * @public
886
885
  * 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.
886
+ * @public
887
887
  */
888
888
  StatusUpdateInterval?: StatusUpdateInterval;
889
889
  }
@@ -892,8 +892,8 @@ export interface UpdateJobTemplateRequest {
892
892
  */
893
893
  export interface UpdateJobTemplateResponse {
894
894
  /**
895
- * @public
896
895
  * A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
896
+ * @public
897
897
  */
898
898
  JobTemplate?: JobTemplate;
899
899
  }
@@ -902,23 +902,23 @@ export interface UpdateJobTemplateResponse {
902
902
  */
903
903
  export interface UpdatePresetRequest {
904
904
  /**
905
- * @public
906
905
  * The new category for the preset, if you are changing it.
906
+ * @public
907
907
  */
908
908
  Category?: string;
909
909
  /**
910
- * @public
911
910
  * The new description for the preset, if you are changing it.
911
+ * @public
912
912
  */
913
913
  Description?: string;
914
914
  /**
915
- * @public
916
915
  * The name of the preset you are modifying.
916
+ * @public
917
917
  */
918
918
  Name: string | undefined;
919
919
  /**
920
- * @public
921
920
  * Settings for preset
921
+ * @public
922
922
  */
923
923
  Settings?: PresetSettings;
924
924
  }
@@ -927,8 +927,8 @@ export interface UpdatePresetRequest {
927
927
  */
928
928
  export interface UpdatePresetResponse {
929
929
  /**
930
- * @public
931
930
  * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
931
+ * @public
932
932
  */
933
933
  Preset?: Preset;
934
934
  }
@@ -937,23 +937,23 @@ export interface UpdatePresetResponse {
937
937
  */
938
938
  export interface UpdateQueueRequest {
939
939
  /**
940
- * @public
941
940
  * The new description for the queue, if you are changing it.
941
+ * @public
942
942
  */
943
943
  Description?: string;
944
944
  /**
945
- * @public
946
945
  * The name of the queue that you are modifying.
946
+ * @public
947
947
  */
948
948
  Name: string | undefined;
949
949
  /**
950
- * @public
951
950
  * 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.
951
+ * @public
952
952
  */
953
953
  ReservationPlanSettings?: ReservationPlanSettings;
954
954
  /**
955
- * @public
956
955
  * 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.
956
+ * @public
957
957
  */
958
958
  Status?: QueueStatus;
959
959
  }
@@ -962,8 +962,8 @@ export interface UpdateQueueRequest {
962
962
  */
963
963
  export interface UpdateQueueResponse {
964
964
  /**
965
- * @public
966
965
  * 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.
966
+ * @public
967
967
  */
968
968
  Queue?: Queue;
969
969
  }