openapi: 3.0.0
info:
version: 2012-09-25
x-release: v4
title: Amazon Elastic Transcoder Jobs Pipelines API
description: <fullname>AWS Elastic Transcoder Service</fullname> <p>The AWS Elastic Transcoder Service.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
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: elastictranscoder
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/elastictranscoder-2012-09-25.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
servers:
- url: http://elastictranscoder.{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 Amazon Elastic Transcoder multi-region endpoint
- url: https://elastictranscoder.{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 Amazon Elastic Transcoder multi-region endpoint
- url: http://elastictranscoder.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Elastic Transcoder endpoint for China (Beijing) and China (Ningxia)
- url: https://elastictranscoder.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Elastic Transcoder endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Pipelines
paths:
/2012-09-25/pipelines:
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'
post:
operationId: CreatePipeline
description: The CreatePipeline operation creates a pipeline with settings that you specify.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePipelineResponse'
examples:
CreatePipeline201Example:
summary: Default CreatePipeline 201 response
x-microcks-default: true
value:
Pipeline: example
Warnings: arn:aws:service:us-east-1:123456789012:resource/example
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
CreatePipeline480Example:
summary: Default CreatePipeline 480 response
x-microcks-default: true
value: {}
'481':
description: IncompatibleVersionException
content:
application/json:
schema:
$ref: '#/components/schemas/IncompatibleVersionException'
examples:
CreatePipeline481Example:
summary: Default CreatePipeline 481 response
x-microcks-default: true
value: {}
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
CreatePipeline482Example:
summary: Default CreatePipeline 482 response
x-microcks-default: true
value: {}
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
CreatePipeline483Example:
summary: Default CreatePipeline 483 response
x-microcks-default: true
value: {}
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
examples:
CreatePipeline484Example:
summary: Default CreatePipeline 484 response
x-microcks-default: true
value: {}
'485':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
CreatePipeline485Example:
summary: Default CreatePipeline 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Name
- InputBucket
- Role
properties:
Name:
description: '<p>The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.</p> <p>Constraints: Maximum 40 characters.</p>'
type: string
minLength: 1
maxLength: 40
InputBucket:
description: The Amazon S3 bucket in which you saved the media files that you want to transcode.
type: string
pattern: ^(\w|\.|-){1,255}$
OutputBucket:
description: <p>The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)</p> <p>Specify this value when all of the following are true:</p> <ul> <li> <p>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</p> </li> <li> <p>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</p> </li> <li> <p>You do not want to specify the permissions that Elastic Transcoder grants to the files. </p> <important> <p>When Elastic Transcoder saves files in <code>OutputBucket</code>, it grants full control over the files only to the AWS account that owns the role that is specified by <code>Role</code>.</p> </important> </li> <li> <p>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</p> </li> </ul> <p>If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit <code>OutputBucket</code> and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead.</p>
type: string
pattern: ^(\w|\.|-){1,255}$
Role:
description: The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
type: string
pattern: ^arn:aws:iam::\w{12}:role/.+$
AwsKmsKeyArn:
description: <p>The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.</p> <p>If you use either <code>s3</code> or <code>s3-aws-kms</code> as your <code>Encryption:Mode</code>, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an <code>Encryption:Mode</code> of <code>aes-cbc-pkcs7</code>, <code>aes-ctr</code>, or <code>aes-gcm</code>.</p>
type: string
minLength: 0
maxLength: 255
Notifications:
description: <p>The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.</p> <important> <p>To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.</p> </important>
type: object
properties:
Progressing:
allOf:
- $ref: '#/components/schemas/SnsTopic'
- description: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
Completed:
allOf:
- $ref: '#/components/schemas/SnsTopic'
- description: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
Warning:
allOf:
- $ref: '#/components/schemas/SnsTopic'
- description: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
Error:
allOf:
- $ref: '#/components/schemas/SnsTopic'
- description: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
ContentConfig:
description: The <code>PipelineOutputConfig</code> structure.
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: <p> The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:</p> <ul> <li> <p>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</p> </li> <li> <p>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</p> </li> <li> <p>You do not want to specify the permissions that Elastic Transcoder grants to the files.</p> </li> <li> <p>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</p> </li> </ul> <p>If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>
StorageClass:
allOf:
- $ref: '#/components/schemas/StorageClass'
- description: ' The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. '
Permissions:
allOf:
- $ref: '#/components/schemas/Permissions'
- description: <p>Optional. The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</p> <p>If you include <code>Permissions</code>, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by <code>Role</code>. If you want that user to have full control, you must explicitly grant full control to the user.</p> <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by <code>Role</code>, and grants no other permissions to any other user or group.</p>
ThumbnailConfig:
description: The <code>PipelineOutputConfig</code> structure.
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: <p> The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:</p> <ul> <li> <p>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</p> </li> <li> <p>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</p> </li> <li> <p>You do not want to specify the permissions that Elastic Transcoder grants to the files.</p> </li> <li> <p>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</p> </li> </ul> <p>If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>
StorageClass:
allOf:
- $ref: '#/components/schemas/StorageClass'
- description: ' The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. '
Permissions:
allOf:
- $ref: '#/components/schemas/Permissions'
- description: <p>Optional. The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</p> <p>If you include <code>Permissions</code>, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by <code>Role</code>. If you want that user to have full control, you must explicitly grant full control to the user.</p> <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by <code>Role</code>, and grants no other permissions to any other user or group.</p>
examples:
CreatePipelineRequestExample:
summary: Default CreatePipeline request
x-microcks-default: true
value:
Name: example-name
InputBucket: example
OutputBucket: example
Role: example
AwsKmsKeyArn: arn:aws:service:us-east-1:123456789012:resource/example
summary: Amazon Elastic Transcoder CreatePipeline
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Pipelines
get:
operationId: ListPipelines
description: The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListPipelinesResponse'
examples:
ListPipelines200Example:
summary: Default ListPipelines 200 response
x-microcks-default: true
value:
Pipelines: example
NextPageToken: example
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListPipelines480Example:
summary: Default ListPipelines 480 response
x-microcks-default: true
value: {}
'481':
description: IncompatibleVersionException
content:
application/json:
schema:
$ref: '#/components/schemas/IncompatibleVersionException'
examples:
ListPipelines481Example:
summary: Default ListPipelines 481 response
x-microcks-default: true
value: {}
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ListPipelines482Example:
summary: Default ListPipelines 482 response
x-microcks-default: true
value: {}
'483':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
ListPipelines483Example:
summary: Default ListPipelines 483 response
x-microcks-default: true
value: {}
parameters:
- name: Ascending
in: query
required: false
description: To list pipelines in chronological order by the date and time that they were created, enter <code>true</code>. To list pipelines in reverse chronological order, enter <code>false</code>.
schema:
type: string
pattern: (^true$)|(^false$)
- name: PageToken
in: query
required: false
description: 'When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. '
schema:
type: string
pattern: ^\d{13}-\w{6}$
summary: Amazon Elastic Transcoder ListPipelines
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Pipelines
/2012-09-25/pipelines/{Id}:
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'
delete:
operationId: DeletePipeline
description: <p>The DeletePipeline operation removes a pipeline.</p> <p> You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, <code>DeletePipeline</code> returns an error. </p>
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePipelineResponse'
examples:
DeletePipeline202Example:
summary: Default DeletePipeline 202 response
x-microcks-default: true
value: {}
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DeletePipeline480Example:
summary: Default DeletePipeline 480 response
x-microcks-default: true
value: {}
'481':
description: IncompatibleVersionException
content:
application/json:
schema:
$ref: '#/components/schemas/IncompatibleVersionException'
examples:
DeletePipeline481Example:
summary: Default DeletePipeline 481 response
x-microcks-default: true
value: {}
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DeletePipeline482Example:
summary: Default DeletePipeline 482 response
x-microcks-default: true
value: {}
'483':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
examples:
DeletePipeline483Example:
summary: Default DeletePipeline 483 response
x-microcks-default: true
value: {}
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DeletePipeline484Example:
summary: Default DeletePipeline 484 response
x-microcks-default: true
value: {}
'485':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
DeletePipeline485Example:
summary: Default DeletePipeline 485 response
x-microcks-default: true
value: {}
parameters:
- name: Id
in: path
required: true
description: The identifier of the pipeline that you want to delete.
schema:
type: string
pattern: ^\d{13}-\w{6}$
summary: Amazon Elastic Transcoder DeletePipeline
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Pipelines
get:
operationId: ReadPipeline
description: The ReadPipeline operation gets detailed information about a pipeline.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ReadPipelineResponse'
examples:
ReadPipeline200Example:
summary: Default ReadPipeline 200 response
x-microcks-default: true
value:
Pipeline: example
Warnings: arn:aws:service:us-east-1:123456789012:resource/example
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ReadPipeline480Example:
summary: Default ReadPipeline 480 response
x-microcks-default: true
value: {}
'481':
description: IncompatibleVersionException
content:
application/json:
schema:
$ref: '#/components/schemas/IncompatibleVersionException'
examples:
ReadPipeline481Example:
summary: Default ReadPipeline 481 response
x-microcks-default: true
value: {}
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ReadPipeline482Example:
summary: Default ReadPipeline 482 response
x-microcks-default: true
value: {}
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
ReadPipeline483Example:
summary: Default ReadPipeline 483 response
x-microcks-default: true
value: {}
'484':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
ReadPipeline484Example:
summary: Default ReadPipeline 484 response
x-microcks-default: true
value: {}
parameters:
- name: Id
in: path
required: true
description: The identifier of the pipeline to read.
schema:
type: string
pattern: ^\d{13}-\w{6}$
summary: Amazon Elastic Transcoder ReadPipeline
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Pipelines
put:
operationId: UpdatePipeline
description: <p> Use the <code>UpdatePipeline</code> operation to update settings for a pipeline.</p> <important> <p>When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings. </p> </important>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePipelineResponse'
examples:
UpdatePipeline200Example:
summary: Default UpdatePipeline 200 response
x-microcks-default: true
value:
Pipeline: example
Warnings: arn:aws:service:us-east-1:123456789012:resource/example
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdatePipeline480Example:
summary: Default UpdatePipeline 480 response
x-microcks-default: true
value: {}
'481':
description: IncompatibleVersionException
content:
application/json:
schema:
$ref: '#/components/schemas/IncompatibleVersionException'
examples:
UpdatePipeline481Example:
summary: Default UpdatePipeline 481 response
x-microcks-default: true
value: {}
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
UpdatePipeline482Example:
summary: Default UpdatePipeline 482 response
x-microcks-default: true
value: {}
'483':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
examples:
UpdatePipeline483Example:
summary: Default UpdatePipeline 483 response
x-microcks-default: true
value: {}
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
UpdatePipeline484Example:
summary: Default UpdatePipeline 484 response
x-microcks-default: true
value: {}
'485':
description: InternalServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceException'
examples:
UpdatePipeline485Example:
summary: Default UpdatePipeline 485 response
x-microcks-default: true
value: {}
parameters:
- name: Id
in: path
required: true
description: The ID of the pipeline that you want to update.
schema:
type: string
pattern: ^\d{13}-\w{6}$
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Name:
description: '<p>The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.</p> <p>Constraints: Maximum 40 characters</p>'
type: string
minLength: 1
maxLength: 40
InputBucket:
description: The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.
type: string
pattern: ^(\w|\.|-){1,255}$
Role:
description: The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.
type: string
pattern: ^arn:aws:iam::\w{12}:role/.+$
AwsKmsKeyArn:
description: <p>The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.</p> <p>If you use either <code>s3</code> or <code>s3-aws-kms</code> as your <code>Encryption:Mode</code>, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an <code>Encryption:Mode</code> of <code>aes-cbc-pkcs7</code>, <code>aes-ctr</code>, or <code>aes-gcm</code>.</p>
type: string
minLength: 0
maxLength: 255
Notifications:
description: <p>The Amazon Simple Notification Service (Amazon SNS) topic or topic
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-elastic-transcoder/refs/heads/main/openapi/amazon-elastic-transcoder-pipelines-api-openapi.yml