openapi: 3.0.0
info:
version: 2012-09-25
x-release: v4
title: Amazon Elastic Transcoder Jobs Pipelines API
description:
The AWS Elastic Transcoder Service.
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: 'The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters.
' 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:The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
Specify this value when all of the following are true:
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
You do not want to specify the permissions that Elastic Transcoder grants to the files.
When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role.
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
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 ContentConfig and ThumbnailConfig instead.
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either s3 or s3-aws-kms as your Encryption:Mode, 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 Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
PipelineOutputConfig structure.
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: 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:
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
You do not want to specify the permissions that Elastic Transcoder grants to the files.
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
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 ContentConfig and ThumbnailConfig instead.
Standard or ReducedRedundancy, 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: Optional. The Permissions 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.
If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.
If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.
PipelineOutputConfig structure.
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: 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:
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
You do not want to specify the permissions that Elastic Transcoder grants to the files.
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
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 ContentConfig and ThumbnailConfig instead.
Standard or ReducedRedundancy, 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: Optional. The Permissions 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.
If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.
If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.
true. To list pipelines in reverse chronological order, enter false.
schema:
type: string
pattern: (^true$)|(^false$)
- name: PageToken
in: query
required: false
description: 'When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET 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: The DeletePipeline operation removes a pipeline.
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, DeletePipeline returns an error.
Use the UpdatePipeline operation to update settings for a pipeline.
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.
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters
' 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:The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either s3 or s3-aws-kms as your Encryption:Mode, 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 Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
PipelineOutputConfig structure.
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: 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:
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
You do not want to specify the permissions that Elastic Transcoder grants to the files.
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
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 ContentConfig and ThumbnailConfig instead.
Standard or ReducedRedundancy, 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: Optional. The Permissions 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.
If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.
If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.
PipelineOutputConfig structure.
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: 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:
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
You do not want to specify the permissions that Elastic Transcoder grants to the files.
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
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 ContentConfig and ThumbnailConfig instead.
Standard or ReducedRedundancy, 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: Optional. The Permissions 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.
If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.
If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.
When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineNotificationsResponse' examples: UpdatePipelineNotifications200Example: summary: Default UpdatePipelineNotifications 200 response x-microcks-default: true value: Pipeline: example '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdatePipelineNotifications480Example: summary: Default UpdatePipelineNotifications 480 response x-microcks-default: true value: {} '481': description: IncompatibleVersionException content: application/json: schema: $ref: '#/components/schemas/IncompatibleVersionException' examples: UpdatePipelineNotifications481Example: summary: Default UpdatePipelineNotifications 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdatePipelineNotifications482Example: summary: Default UpdatePipelineNotifications 482 response x-microcks-default: true value: {} '483': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: UpdatePipelineNotifications483Example: summary: Default UpdatePipelineNotifications 483 response x-microcks-default: true value: {} '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdatePipelineNotifications484Example: summary: Default UpdatePipelineNotifications 484 response x-microcks-default: true value: {} '485': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdatePipelineNotifications485Example: summary: Default UpdatePipelineNotifications 485 response x-microcks-default: true value: {} parameters: - name: Id in: path required: true description: The identifier of the pipeline for which you want to change notification settings. schema: type: string pattern: ^\d{13}-\w{6}$ requestBody: required: true content: application/json: schema: type: object required: - Notifications properties: Notifications: description:The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.
Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineStatusResponse' examples: UpdatePipelineStatus200Example: summary: Default UpdatePipelineStatus 200 response x-microcks-default: true value: Pipeline: example '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdatePipelineStatus480Example: summary: Default UpdatePipelineStatus 480 response x-microcks-default: true value: {} '481': description: IncompatibleVersionException content: application/json: schema: $ref: '#/components/schemas/IncompatibleVersionException' examples: UpdatePipelineStatus481Example: summary: Default UpdatePipelineStatus 481 response x-microcks-default: true value: {} '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdatePipelineStatus482Example: summary: Default UpdatePipelineStatus 482 response x-microcks-default: true value: {} '483': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: UpdatePipelineStatus483Example: summary: Default UpdatePipelineStatus 483 response x-microcks-default: true value: {} '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdatePipelineStatus484Example: summary: Default UpdatePipelineStatus 484 response x-microcks-default: true value: {} '485': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: UpdatePipelineStatus485Example: summary: Default UpdatePipelineStatus 485 response x-microcks-default: true value: {} parameters: - name: Id in: path required: true description: The identifier of the pipeline to update. schema: type: string pattern: ^\d{13}-\w{6}$ requestBody: required: true content: application/json: schema: type: object required: - Status properties: Status: description: 'The desired status of the pipeline:
Active: The pipeline is processing jobs.
Paused: The pipeline is not currently processing jobs.
The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
description: TheReadPipelineResponse structure.
InternalServiceException: {}
ResourceNotFoundException: {}
ValidationException: {}
Name:
type: string
minLength: 1
maxLength: 40
Pipelines:
type: array
items:
$ref: '#/components/schemas/Pipeline'
IncompatibleVersionException: {}
Grantee:
type: string
minLength: 1
maxLength: 255
UpdatePipelineResponse:
type: object
properties:
Pipeline:
allOf:
- $ref: '#/components/schemas/Pipeline'
- description: The pipeline updated by this UpdatePipelineResponse call.
Warnings:
allOf:
- $ref: '#/components/schemas/Warnings'
- description: Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
description: When you update a pipeline, Elastic Transcoder returns the values that you specified in the request. UpdatePipelineNotificationsResponse: type: object properties: Pipeline: allOf: - $ref: '#/components/schemas/Pipeline' - description: A section of the response body that provides information about the pipeline associated with this notification. description: TheUpdatePipelineNotificationsResponse structure.
DeletePipelineResponse:
type: object
properties: {}
description: The DeletePipelineResponse structure.
Permission:
type: object
properties:
GranteeType:
allOf:
- $ref: '#/components/schemas/GranteeType'
- description: 'The type of value that appears in the Grantee object:
Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.
A canonical user ID is not the same as an AWS account number.
Email: The registered email address of an AWS account.
Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
Permission structure.
AccessControls:
type: array
items:
$ref: '#/components/schemas/AccessControl'
maxItems: 30
String:
type: string
StorageClass:
type: string
pattern: (^ReducedRedundancy$)|(^Standard$)
Role:
type: string
pattern: ^arn:aws:iam::\w{12}:role/.+$
Warnings:
type: array
items:
$ref: '#/components/schemas/Warning'
PipelineOutputConfig:
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/BucketName'
- description: 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:
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
You do not want to specify the permissions that Elastic Transcoder grants to the files.
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
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 ContentConfig and ThumbnailConfig instead.
Standard or ReducedRedundancy, 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: Optional. The Permissions 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.
If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.
If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.
PipelineOutputConfig structure.
PipelineStatus:
type: string
pattern: (^Active$)|(^Paused$)
UpdatePipelineStatusResponse:
type: object
properties:
Pipeline:
allOf:
- $ref: '#/components/schemas/Pipeline'
- description: A section of the response body that provides information about the pipeline.
description: When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.
KeyArn:
type: string
minLength: 0
maxLength: 255
LimitExceededException: {}
ResourceInUseException: {}
Permissions:
type: array
items:
$ref: '#/components/schemas/Permission'
maxItems: 30
GranteeType:
type: string
pattern: (^Canonical$)|(^Email$)|(^Group$)
Id:
type: string
pattern: ^\d{13}-\w{6}$
ListPipelinesResponse:
type: object
properties:
Pipelines:
allOf:
- $ref: '#/components/schemas/Pipelines'
- description: An array of Pipeline objects.
NextPageToken:
allOf:
- $ref: '#/components/schemas/Id'
- description: A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of NextPageToken is null.
description: A list of the pipelines associated with the current AWS account.
CreatePipelineResponse:
type: object
properties:
Pipeline:
allOf:
- $ref: '#/components/schemas/Pipeline'
- description: A section of the response body that provides information about the pipeline that is created.
Warnings:
allOf:
- $ref: '#/components/schemas/Warnings'
- description: Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
description: When you create a pipeline, Elastic Transcoder returns the values that you specified in the request. AccessDeniedException: {} Warning: type: object properties: Code: allOf: - $ref: '#/components/schemas/String' - description: The code of the cross-regional warning. Message: allOf: - $ref: '#/components/schemas/String' - description:The message explaining what resources are in a different region from the pipeline.
AWS KMS keys must be in the same region as the pipeline.
Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.
Pipeline: type: object properties: Id: allOf: - $ref: '#/components/schemas/Id' - description: The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset. Arn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) for the pipeline. Name: allOf: - $ref: '#/components/schemas/Name' - description: 'The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters
' Status: allOf: - $ref: '#/components/schemas/PipelineStatus' - description: 'The current status of the pipeline:
Active: The pipeline is processing jobs.
Paused: The pipeline is not currently processing jobs.
ContentConfig and ThumbnailConfig.
Role:
allOf:
- $ref: '#/components/schemas/Role'
- description: The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.
AwsKmsKeyArn:
allOf:
- $ref: '#/components/schemas/KeyArn'
- description: The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either s3 or s3-aws-kms as your Encryption:Mode, 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 Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.
GranteeType: The type of value that appears in the Grantee object:
Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.
Email: The registered email address of an AWS account.
Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
Grantee: The AWS user or group that you want to have access to transcoded files and playlists.
Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.
READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.
WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.
GranteeType: The type of value that appears in the Grantee object:
Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.
A canonical user ID is not the same as an AWS account number.
Email: The registered email address of an AWS account.
Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
Grantee: The AWS user or group that you want to have access to thumbnail files.
Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.