openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 852 kB
JSON
{"openapi":"3.0.0","info":{"version":"2017-08-29","x-release":"v4","title":"AWS Elemental MediaConvert","description":"AWS Elemental MediaConvert","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"mediaconvert","x-aws-signingName":"mediaconvert","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediaconvert-2017-08-29.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/mediaconvert/"},"servers":[{"url":"http://mediaconvert.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The MediaConvert multi-region endpoint"},{"url":"https://mediaconvert.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The MediaConvert multi-region endpoint"},{"url":"http://mediaconvert.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The MediaConvert endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://mediaconvert.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The MediaConvert endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/2017-08-29/certificates":{"post":{"operationId":"AssociateCertificate","description":"Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateCertificateResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["arn"],"properties":{"arn":{"description":"The ARN of the ACM certificate that you want to associate with your MediaConvert resource.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/2017-08-29/jobs/{id}":{"delete":{"operationId":"CancelJob","description":"Permanently cancel a job. Once you have canceled a job, you can't start it again.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelJobResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"id","in":"path","required":true,"description":"The Job ID of the job to be cancelled.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetJob","description":"Retrieve the JSON for a specific completed transcoding job.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetJobResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"id","in":"path","required":true,"description":"the job ID of the job.","schema":{"type":"string"}}]}},"/2017-08-29/jobs":{"post":{"operationId":"CreateJob","description":"Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateJobResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["role","settings"],"properties":{"accelerationSettings":{"description":"Accelerated transcoding can significantly speed up jobs with long, visually complex content.","type":"object","properties":{"Mode":{"allOf":[{"$ref":"#/components/schemas/AccelerationMode"},{"xml":{"name":"mode"},"description":"Specify the conditions when the service will run your job with accelerated transcoding."}]}}},"billingTagsSource":{"description":"The 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.","type":"string","enum":["QUEUE","PRESET","JOB_TEMPLATE","JOB"]},"clientRequestToken":{"description":"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.","type":"string"},"hopDestinations":{"description":"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.","type":"array","items":{"$ref":"#/components/schemas/HopDestination"}},"jobTemplate":{"description":"Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.","type":"string"},"priority":{"description":"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.","type":"integer","minimum":-50,"maximum":50},"queue":{"description":"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.","type":"string"},"role":{"description":"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.","type":"string"},"settings":{"description":"JobSettings contains all the transcode settings for a job.","type":"object","properties":{"AdAvailOffset":{"allOf":[{"$ref":"#/components/schemas/__integerMinNegative1000Max1000"},{"xml":{"name":"adAvailOffset"},"description":"When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time."}]},"AvailBlanking":{"allOf":[{"$ref":"#/components/schemas/AvailBlanking"},{"xml":{"name":"availBlanking"},"description":"Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails."}]},"Esam":{"allOf":[{"$ref":"#/components/schemas/EsamSettings"},{"xml":{"name":"esam"},"description":"Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings."}]},"ExtendedDataServices":{"allOf":[{"$ref":"#/components/schemas/ExtendedDataServices"},{"xml":{"name":"extendedDataServices"},"description":"If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory."}]},"Inputs":{"allOf":[{"$ref":"#/components/schemas/__listOfInput"},{"xml":{"name":"inputs"},"description":"Use Inputs to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output."}]},"KantarWatermark":{"allOf":[{"$ref":"#/components/schemas/KantarWatermarkSettings"},{"xml":{"name":"kantarWatermark"},"description":"Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html."}]},"MotionImageInserter":{"allOf":[{"$ref":"#/components/schemas/MotionImageInserter"},{"xml":{"name":"motionImageInserter"},"description":"Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html."}]},"NielsenConfiguration":{"allOf":[{"$ref":"#/components/schemas/NielsenConfiguration"},{"xml":{"name":"nielsenConfiguration"},"description":"Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs in the job."}]},"NielsenNonLinearWatermark":{"allOf":[{"$ref":"#/components/schemas/NielsenNonLinearWatermarkSettings"},{"xml":{"name":"nielsenNonLinearWatermark"},"description":"Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]"}]},"OutputGroups":{"allOf":[{"$ref":"#/components/schemas/__listOfOutputGroup"},{"xml":{"name":"outputGroups"},"description":"Contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in is a group of settings that apply to the whole group. This required object depends on the value you set for Type. Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings"}]},"TimecodeConfig":{"allOf":[{"$ref":"#/components/schemas/TimecodeConfig"},{"xml":{"name":"timecodeConfig"},"description":"These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping."}]},"TimedMetadataInsertion":{"allOf":[{"$ref":"#/components/schemas/TimedMetadataInsertion"},{"xml":{"name":"timedMetadataInsertion"},"description":"Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to include this metadata, you must set ID3 metadata to Passthrough."}]}}},"simulateReservedQueue":{"description":"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.","type":"string","enum":["DISABLED","ENABLED"]},"statusUpdateInterval":{"description":"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.","type":"string","enum":["SECONDS_10","SECONDS_12","SECONDS_15","SECONDS_20","SECONDS_30","SECONDS_60","SECONDS_120","SECONDS_180","SECONDS_240","SECONDS_300","SECONDS_360","SECONDS_420","SECONDS_480","SECONDS_540","SECONDS_600"]},"tags":{"description":"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.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}},"userMetadata":{"description":"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.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListJobs","description":"Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListJobsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"Optional. Number of jobs, up to twenty, that will be returned at one time.","schema":{"type":"integer","minimum":1,"maximum":20}},{"name":"nextToken","in":"query","required":false,"description":"Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.","schema":{"type":"string"}},{"name":"order","in":"query","required":false,"description":"Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.","schema":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource."}},{"name":"queue","in":"query","required":false,"description":"Optional. Provide a queue name to get back only jobs from that queue.","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.","schema":{"type":"string","enum":["SUBMITTED","PROGRESSING","COMPLETE","CANCELED","ERROR"],"description":"A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR."}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/2017-08-29/jobTemplates":{"post":{"operationId":"CreateJobTemplate","description":"Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateJobTemplateResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","settings"],"properties":{"accelerationSettings":{"description":"Accelerated transcoding can significantly speed up jobs with long, visually complex content.","type":"object","properties":{"Mode":{"allOf":[{"$ref":"#/components/schemas/AccelerationMode"},{"xml":{"name":"mode"},"description":"Specify the conditions when the service will run your job with accelerated transcoding."}]}}},"category":{"description":"Optional. A category for the job template you are creating","type":"string"},"description":{"description":"Optional. A description of the job template you are creating.","type":"string"},"hopDestinations":{"description":"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.","type":"array","items":{"$ref":"#/components/schemas/HopDestination"}},"name":{"description":"The name of the job template you are creating.","type":"string"},"priority":{"description":"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.","type":"integer","minimum":-50,"maximum":50},"queue":{"description":"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.","type":"string"},"settings":{"description":"JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.","type":"object","properties":{"AdAvailOffset":{"allOf":[{"$ref":"#/components/schemas/__integerMinNegative1000Max1000"},{"xml":{"name":"adAvailOffset"},"description":"When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time."}]},"AvailBlanking":{"allOf":[{"$ref":"#/components/schemas/AvailBlanking"},{"xml":{"name":"availBlanking"},"description":"Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails."}]},"Esam":{"allOf":[{"$ref":"#/components/schemas/EsamSettings"},{"xml":{"name":"esam"},"description":"Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings."}]},"ExtendedDataServices":{"allOf":[{"$ref":"#/components/schemas/ExtendedDataServices"},{"xml":{"name":"extendedDataServices"},"description":"If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory."}]},"Inputs":{"allOf":[{"$ref":"#/components/schemas/__listOfInputTemplate"},{"xml":{"name":"inputs"},"description":"Use Inputs to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template."}]},"KantarWatermark":{"allOf":[{"$ref":"#/components/schemas/KantarWatermarkSettings"},{"xml":{"name":"kantarWatermark"},"description":"Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html."}]},"MotionImageInserter":{"allOf":[{"$ref":"#/components/schemas/MotionImageInserter"},{"xml":{"name":"motionImageInserter"},"description":"Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html."}]},"NielsenConfiguration":{"allOf":[{"$ref":"#/components/schemas/NielsenConfiguration"},{"xml":{"name":"nielsenConfiguration"},"description":"Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs in the job."}]},"NielsenNonLinearWatermark":{"allOf":[{"$ref":"#/components/schemas/NielsenNonLinearWatermarkSettings"},{"xml":{"name":"nielsenNonLinearWatermark"},"description":"Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]"}]},"OutputGroups":{"allOf":[{"$ref":"#/components/schemas/__listOfOutputGroup"},{"xml":{"name":"outputGroups"},"description":"Contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in is a group of settings that apply to the whole group. This required object depends on the value you set for Type. Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings"}]},"TimecodeConfig":{"allOf":[{"$ref":"#/components/schemas/TimecodeConfig"},{"xml":{"name":"timecodeConfig"},"description":"These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping."}]},"TimedMetadataInsertion":{"allOf":[{"$ref":"#/components/schemas/TimedMetadataInsertion"},{"xml":{"name":"timedMetadataInsertion"},"description":"Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to include this metadata, you must set ID3 metadata to Passthrough."}]}}},"statusUpdateInterval":{"description":"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.","type":"string","enum":["SECONDS_10","SECONDS_12","SECONDS_15","SECONDS_20","SECONDS_30","SECONDS_60","SECONDS_120","SECONDS_180","SECONDS_240","SECONDS_300","SECONDS_360","SECONDS_420","SECONDS_480","SECONDS_540","SECONDS_600"]},"tags":{"description":"The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListJobTemplates","description":"Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListJobTemplatesResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"category","in":"query","required":false,"description":"Optionally, specify a job template category to limit responses to only job templates from that category.","schema":{"type":"string"}},{"name":"listBy","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["NAME","CREATION_DATE","SYSTEM"],"description":"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."}},{"name":"maxResults","in":"query","required":false,"description":"Optional. Number of job templates, up to twenty, that will be returned at one time.","schema":{"type":"integer","minimum":1,"maximum":20}},{"name":"nextToken","in":"query","required":false,"description":"Use this string, provided with the response to a previous request, to request the next batch of job templates.","schema":{"type":"string"}},{"name":"order","in":"query","required":false,"description":"Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.","schema":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource."}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/2017-08-29/presets":{"post":{"operationId":"CreatePreset","description":"Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePresetResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","settings"],"properties":{"category":{"description":"Optional. A category for the preset you are creating.","type":"string"},"description":{"description":"Optional. A description of the preset you are creating.","type":"string"},"name":{"description":"The name of the preset you are creating.","type":"string"},"settings":{"description":"Settings for preset","type":"object","properties":{"AudioDescriptions":{"allOf":[{"$ref":"#/components/schemas/__listOfAudioDescription"},{"xml":{"name":"audioDescriptions"},"description":"Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings."}]},"CaptionDescriptions":{"allOf":[{"$ref":"#/components/schemas/__listOfCaptionDescriptionPreset"},{"xml":{"name":"captionDescriptions"},"description":"This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions."}]},"ContainerSettings":{"allOf":[{"$ref":"#/components/schemas/ContainerSettings"},{"xml":{"name":"containerSettings"},"description":"Container specific settings."}]},"VideoDescription":{"allOf":[{"$ref":"#/components/schemas/VideoDescription"},{"xml":{"name":"videoDescription"},"description":"VideoDescription contains a group of video encoding settings. The specific video settings depend on the video codec that you choose for the property codec. Include one instance of VideoDescription per output."}]}}},"tags":{"description":"The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListPresets","description":"Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPresetsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"category","in":"query","required":false,"description":"Optionally, specify a preset category to limit responses to only presets from that category.","schema":{"type":"string"}},{"name":"listBy","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["NAME","CREATION_DATE","SYSTEM"],"description":"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."}},{"name":"maxResults","in":"query","required":false,"description":"Optional. Number of presets, up to twenty, that will be returned at one time","schema":{"type":"integer","minimum":1,"maximum":20}},{"name":"nextToken","in":"query","required":false,"description":"Use this string, provided with the response to a previous request, to request the next batch of presets.","schema":{"type":"string"}},{"name":"order","in":"query","required":false,"description":"Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.","schema":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource."}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/2017-08-29/queues":{"post":{"operationId":"CreateQueue","description":"Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQueueResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"description":{"description":"Optional. A description of the queue that you are creating.","type":"string"},"name":{"description":"The name of the queue that you are creating.","type":"string"},"pricingPlan":{"description":"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.","type":"string","enum":["ON_DEMAND","RESERVED"]},"reservationPlanSettings":{"description":"Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.","type":"object","properties":{"Commitment":{"allOf":[{"$ref":"#/components/schemas/Commitment"},{"xml":{"name":"commitment"},"description":"The length of the term of your reserved queue pricing plan commitment."}]},"RenewalType":{"allOf":[{"$ref":"#/components/schemas/RenewalType"},{"xml":{"name":"renewalType"},"description":"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."}]},"ReservedSlots":{"allOf":[{"$ref":"#/components/schemas/__integer"},{"xml":{"name":"reservedSlots"},"description":"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."}]}}},"status":{"description":"Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause a queue continue to run until they finish or result in an error.","type":"string","enum":["ACTIVE","PAUSED"]},"tags":{"description":"The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListQueues","description":"Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListQueuesResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"listBy","in":"query","required":false,"description":"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.","schema":{"type":"string","enum":["NAME","CREATION_DATE"],"description":"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."}},{"name":"maxResults","in":"query","required":false,"description":"Optional. Number of queues, up to twenty, that will be returned at one time.","schema":{"type":"integer","minimum":1,"maximum":20}},{"name":"nextToken","in":"query","required":false,"description":"Use this string, provided with the response to a previous request, to request the next batch of queues.","schema":{"type":"string"}},{"name":"order","in":"query","required":false,"description":"Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.","schema":{"type":"string","enum":["ASCENDING","DESCENDING"],"description":"Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource."}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/2017-08-29/jobTemplates/{name}":{"delete":{"operationId":"DeleteJobTemplate","description":"Permanently delete a job template you have created.","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteJobTemplateResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"name","in":"path","required":true,"description":"The name of the job template to be deleted.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetJobTemplate","description":"Retrieve the JSON for a specific job template.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetJobTemplateResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"482":{"description":"ForbiddenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"name","in":"path","required":true,"description":"The name of the job template.","schem