@aws-sdk/client-mediaconvert 3.379.1 → 3.382.0

package/dist-types/models/models_2.d.ts

@@ -23,14 +23,17 @@ export type DescribeEndpointsMode = (typeof DescribeEndpointsMode)[keyof typeof
  */
 export interface DescribeEndpointsRequest {
     /**
+     * @public
      * Optional. Max number of endpoints, up to twenty, that will be returned at one time.
      */
     MaxResults?: number;
     /**
+     * @public
      * 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.
      */
     Mode?: DescribeEndpointsMode | string;
     /**
+     * @public
      * Use this string, provided with the response to a previous request, to request the next batch of endpoints.
      */
     NextToken?: string;
@@ -40,10 +43,12 @@ export interface DescribeEndpointsRequest {
  */
 export interface DescribeEndpointsResponse {
     /**
+     * @public
      * List of endpoints
      */
     Endpoints?: Endpoint[];
     /**
+     * @public
      * Use this string to request the next batch of endpoints.
      */
     NextToken?: string;
@@ -53,6 +58,7 @@ export interface DescribeEndpointsResponse {
  */
 export interface DisassociateCertificateRequest {
     /**
+     * @public
      * The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource.
      */
     Arn: string | undefined;
@@ -67,6 +73,7 @@ export interface DisassociateCertificateResponse {
  */
 export interface GetJobRequest {
     /**
+     * @public
      * the job ID of the job.
      */
     Id: string | undefined;
@@ -76,6 +83,7 @@ export interface GetJobRequest {
  */
 export interface GetJobResponse {
     /**
+     * @public
      * 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
      */
     Job?: Job;
@@ -85,6 +93,7 @@ export interface GetJobResponse {
  */
 export interface GetJobTemplateRequest {
     /**
+     * @public
      * The name of the job template.
      */
     Name: string | undefined;
@@ -94,6 +103,7 @@ export interface GetJobTemplateRequest {
  */
 export interface GetJobTemplateResponse {
     /**
+     * @public
      * A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
      */
     JobTemplate?: JobTemplate;
@@ -121,14 +131,17 @@ export type InputPolicy = (typeof InputPolicy)[keyof typeof InputPolicy];
  */
 export interface Policy {
     /**
+     * @public
      * Allow or disallow jobs that specify HTTP inputs.
      */
     HttpInputs?: InputPolicy | string;
     /**
+     * @public
      * Allow or disallow jobs that specify HTTPS inputs.
      */
     HttpsInputs?: InputPolicy | string;
     /**
+     * @public
      * Allow or disallow jobs that specify Amazon S3 inputs.
      */
     S3Inputs?: InputPolicy | string;
@@ -138,6 +151,7 @@ export interface Policy {
  */
 export interface GetPolicyResponse {
     /**
+     * @public
      * 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
      */
     Policy?: Policy;
@@ -147,6 +161,7 @@ export interface GetPolicyResponse {
  */
 export interface GetPresetRequest {
     /**
+     * @public
      * The name of the preset.
      */
     Name: string | undefined;
@@ -156,6 +171,7 @@ export interface GetPresetRequest {
  */
 export interface GetPresetResponse {
     /**
+     * @public
      * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
      */
     Preset?: Preset;
@@ -165,6 +181,7 @@ export interface GetPresetResponse {
  */
 export interface GetQueueRequest {
     /**
+     * @public
      * The name of the queue that you want information about.
      */
     Name: string | undefined;
@@ -174,6 +191,7 @@ export interface GetQueueRequest {
  */
 export interface GetQueueResponse {
     /**
+     * @public
      * 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.
      */
     Queue?: Queue;
@@ -208,22 +226,27 @@ export type Order = (typeof Order)[keyof typeof Order];
  */
 export interface ListJobsRequest {
     /**
+     * @public
      * Optional. Number of jobs, up to twenty, that will be returned at one time.
      */
     MaxResults?: number;
     /**
+     * @public
      * Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
      */
     NextToken?: string;
     /**
+     * @public
      * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
      */
     Order?: Order | string;
     /**
+     * @public
      * Optional. Provide a queue name to get back only jobs from that queue.
      */
     Queue?: string;
     /**
+     * @public
      * Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
      */
     Status?: JobStatus | string;
@@ -233,10 +256,12 @@ export interface ListJobsRequest {
  */
 export interface ListJobsResponse {
     /**
+     * @public
      * List of jobs
      */
     Jobs?: Job[];
     /**
+     * @public
      * Use this string to request the next batch of jobs.
      */
     NextToken?: string;
@@ -246,22 +271,27 @@ export interface ListJobsResponse {
  */
 export interface ListJobTemplatesRequest {
     /**
+     * @public
      * Optionally, specify a job template category to limit responses to only job templates from that category.
      */
     Category?: string;
     /**
+     * @public
      * 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.
      */
     ListBy?: JobTemplateListBy | string;
     /**
+     * @public
      * Optional. Number of job templates, up to twenty, that will be returned at one time.
      */
     MaxResults?: number;
     /**
+     * @public
      * Use this string, provided with the response to a previous request, to request the next batch of job templates.
      */
     NextToken?: string;
     /**
+     * @public
      * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
      */
     Order?: Order | string;
@@ -271,10 +301,12 @@ export interface ListJobTemplatesRequest {
  */
 export interface ListJobTemplatesResponse {
     /**
+     * @public
      * List of Job templates.
      */
     JobTemplates?: JobTemplate[];
     /**
+     * @public
      * Use this string to request the next batch of job templates.
      */
     NextToken?: string;
@@ -297,22 +329,27 @@ export type PresetListBy = (typeof PresetListBy)[keyof typeof PresetListBy];
  */
 export interface ListPresetsRequest {
     /**
+     * @public
      * Optionally, specify a preset category to limit responses to only presets from that category.
      */
     Category?: string;
     /**
+     * @public
      * 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.
      */
     ListBy?: PresetListBy | string;
     /**
+     * @public
      * Optional. Number of presets, up to twenty, that will be returned at one time
      */
     MaxResults?: number;
     /**
+     * @public
      * Use this string, provided with the response to a previous request, to request the next batch of presets.
      */
     NextToken?: string;
     /**
+     * @public
      * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
      */
     Order?: Order | string;
@@ -322,10 +359,12 @@ export interface ListPresetsRequest {
  */
 export interface ListPresetsResponse {
     /**
+     * @public
      * Use this string to request the next batch of presets.
      */
     NextToken?: string;
     /**
+     * @public
      * List of presets
      */
     Presets?: Preset[];
@@ -347,18 +386,22 @@ export type QueueListBy = (typeof QueueListBy)[keyof typeof QueueListBy];
  */
 export interface ListQueuesRequest {
     /**
+     * @public
      * 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.
      */
     ListBy?: QueueListBy | string;
     /**
+     * @public
      * Optional. Number of queues, up to twenty, that will be returned at one time.
      */
     MaxResults?: number;
     /**
+     * @public
      * Use this string, provided with the response to a previous request, to request the next batch of queues.
      */
     NextToken?: string;
     /**
+     * @public
      * Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
      */
     Order?: Order | string;
@@ -368,10 +411,12 @@ export interface ListQueuesRequest {
  */
 export interface ListQueuesResponse {
     /**
+     * @public
      * Use this string to request the next batch of queues.
      */
     NextToken?: string;
     /**
+     * @public
      * List of queues.
      */
     Queues?: Queue[];
@@ -381,6 +426,7 @@ export interface ListQueuesResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * 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.
      */
     Arn: string | undefined;
@@ -391,10 +437,12 @@ export interface ListTagsForResourceRequest {
  */
 export interface ResourceTags {
     /**
+     * @public
      * The Amazon Resource Name (ARN) of the resource.
      */
     Arn?: string;
     /**
+     * @public
      * The tags for the resource.
      */
     Tags?: Record<string, string>;
@@ -404,6 +452,7 @@ export interface ResourceTags {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.
      */
     ResourceTags?: ResourceTags;
@@ -413,6 +462,7 @@ export interface ListTagsForResourceResponse {
  */
 export interface PutPolicyRequest {
     /**
+     * @public
      * 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
      */
     Policy: Policy | undefined;
@@ -422,6 +472,7 @@ export interface PutPolicyRequest {
  */
 export interface PutPolicyResponse {
     /**
+     * @public
      * 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
      */
     Policy?: Policy;
@@ -431,10 +482,12 @@ export interface PutPolicyResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * 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.
      */
     Arn: string | undefined;
     /**
+     * @public
      * The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
      */
     Tags: Record<string, string> | undefined;
@@ -449,10 +502,12 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * 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.
      */
     Arn: string | undefined;
     /**
+     * @public
      * The keys of the tags that you want to remove from the resource.
      */
     TagKeys?: string[];
@@ -467,38 +522,47 @@ export interface UntagResourceResponse {
  */
 export interface UpdateJobTemplateRequest {
     /**
+     * @public
      * 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.
      */
     AccelerationSettings?: AccelerationSettings;
     /**
+     * @public
      * The new category for the job template, if you are changing it.
      */
     Category?: string;
     /**
+     * @public
      * The new description for the job template, if you are changing it.
      */
     Description?: string;
     /**
+     * @public
      * Optional list of hop destinations.
      */
     HopDestinations?: HopDestination[];
     /**
+     * @public
      * The name of the job template you are modifying
      */
     Name: string | undefined;
     /**
+     * @public
      * 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.
      */
     Priority?: number;
     /**
+     * @public
      * The new queue for the job template, if you are changing it.
      */
     Queue?: string;
     /**
+     * @public
      * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
      */
     Settings?: JobTemplateSettings;
     /**
+     * @public
      * 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.
      */
     StatusUpdateInterval?: StatusUpdateInterval | string;
@@ -508,6 +572,7 @@ export interface UpdateJobTemplateRequest {
  */
 export interface UpdateJobTemplateResponse {
     /**
+     * @public
      * A job template is a pre-made set of encoding instructions that you can use to quickly create a job.
      */
     JobTemplate?: JobTemplate;
@@ -517,18 +582,22 @@ export interface UpdateJobTemplateResponse {
  */
 export interface UpdatePresetRequest {
     /**
+     * @public
      * The new category for the preset, if you are changing it.
      */
     Category?: string;
     /**
+     * @public
      * The new description for the preset, if you are changing it.
      */
     Description?: string;
     /**
+     * @public
      * The name of the preset you are modifying.
      */
     Name: string | undefined;
     /**
+     * @public
      * Settings for preset
      */
     Settings?: PresetSettings;
@@ -538,6 +607,7 @@ export interface UpdatePresetRequest {
  */
 export interface UpdatePresetResponse {
     /**
+     * @public
      * A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.
      */
     Preset?: Preset;
@@ -547,18 +617,22 @@ export interface UpdatePresetResponse {
  */
 export interface UpdateQueueRequest {
     /**
+     * @public
      * The new description for the queue, if you are changing it.
      */
     Description?: string;
     /**
+     * @public
      * The name of the queue that you are modifying.
      */
     Name: string | undefined;
     /**
+     * @public
      * 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.
      */
     ReservationPlanSettings?: ReservationPlanSettings;
     /**
+     * @public
      * 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.
      */
     Status?: QueueStatus | string;
@@ -568,6 +642,7 @@ export interface UpdateQueueRequest {
  */
 export interface UpdateQueueResponse {
     /**
+     * @public
      * 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.
      */
     Queue?: Queue;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-mediaconvert",
   "description": "AWS SDK for JavaScript Mediaconvert Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",