| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ElasticTranscoder
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- Artwork
- AudioCodecOptions
- AudioParameters
- CaptionFormat
- CaptionSource
- Captions
- Clip
- CreateJobOutput
- CreateJobPlaylist
- DetectedProperties
- Encryption
- HlsContentProtection
- InputCaptions
- Job
- JobAlbumArt
- JobInput
- JobOutput
- JobWatermark
- Notifications
- Permission
- Pipeline
- PipelineOutputConfig
- PlayReadyDrm
- Playlist
- Preset
- PresetWatermark
- Thumbnails
- TimeSpan
- Timing
- VideoParameters
- Warning
Description
Derived from API version 2012-09-25 of the AWS service descriptions, licensed under Apache 2.0.
AWS Elastic Transcoder Service
The AWS Elastic Transcoder Service.
Synopsis
- defaultService :: Service
- _IncompatibleVersionException :: AsError a => Getting (First ServiceError) a ServiceError
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- newJobComplete :: Wait ReadJob
- data DeletePreset = DeletePreset' Text
- newDeletePreset :: Text -> DeletePreset
- data DeletePresetResponse = DeletePresetResponse' Int
- newDeletePresetResponse :: Int -> DeletePresetResponse
- data UpdatePipelineStatus = UpdatePipelineStatus' Text Text
- newUpdatePipelineStatus :: Text -> Text -> UpdatePipelineStatus
- data UpdatePipelineStatusResponse = UpdatePipelineStatusResponse' (Maybe Pipeline) Int
- newUpdatePipelineStatusResponse :: Int -> UpdatePipelineStatusResponse
- data ListJobsByPipeline = ListJobsByPipeline' (Maybe Text) (Maybe Text) Text
- newListJobsByPipeline :: Text -> ListJobsByPipeline
- data ListJobsByPipelineResponse = ListJobsByPipelineResponse' (Maybe Text) (Maybe [Job]) Int
- newListJobsByPipelineResponse :: Int -> ListJobsByPipelineResponse
- data UpdatePipeline = UpdatePipeline' (Maybe Text) (Maybe PipelineOutputConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notifications) (Maybe PipelineOutputConfig) Text
- newUpdatePipeline :: Text -> UpdatePipeline
- data UpdatePipelineResponse = UpdatePipelineResponse' (Maybe [Warning]) (Maybe Pipeline) Int
- newUpdatePipelineResponse :: Int -> UpdatePipelineResponse
- data DeletePipeline = DeletePipeline' Text
- newDeletePipeline :: Text -> DeletePipeline
- data DeletePipelineResponse = DeletePipelineResponse' Int
- newDeletePipelineResponse :: Int -> DeletePipelineResponse
- data CreateJob = CreateJob' (Maybe [JobInput]) (Maybe JobInput) (Maybe (HashMap Text Text)) (Maybe [CreateJobOutput]) (Maybe CreateJobOutput) (Maybe [CreateJobPlaylist]) (Maybe Text) Text
- newCreateJob :: Text -> CreateJob
- data CreateJobResponse = CreateJobResponse' (Maybe Job) Int
- newCreateJobResponse :: Int -> CreateJobResponse
- data ListPipelines = ListPipelines' (Maybe Text) (Maybe Text)
- newListPipelines :: ListPipelines
- data ListPipelinesResponse = ListPipelinesResponse' (Maybe Text) (Maybe [Pipeline]) Int
- newListPipelinesResponse :: Int -> ListPipelinesResponse
- data CreatePreset = CreatePreset' (Maybe VideoParameters) (Maybe Thumbnails) (Maybe Text) (Maybe AudioParameters) Text Text
- newCreatePreset :: Text -> Text -> CreatePreset
- data CreatePresetResponse = CreatePresetResponse' (Maybe Text) (Maybe Preset) Int
- newCreatePresetResponse :: Int -> CreatePresetResponse
- data ListPresets = ListPresets' (Maybe Text) (Maybe Text)
- newListPresets :: ListPresets
- data ListPresetsResponse = ListPresetsResponse' (Maybe Text) (Maybe [Preset]) Int
- newListPresetsResponse :: Int -> ListPresetsResponse
- data ReadPreset = ReadPreset' Text
- newReadPreset :: Text -> ReadPreset
- data ReadPresetResponse = ReadPresetResponse' (Maybe Preset) Int
- newReadPresetResponse :: Int -> ReadPresetResponse
- data ReadJob = ReadJob' Text
- newReadJob :: Text -> ReadJob
- data ReadJobResponse = ReadJobResponse' Int Job
- newReadJobResponse :: Int -> Job -> ReadJobResponse
- data UpdatePipelineNotifications = UpdatePipelineNotifications' Text Notifications
- newUpdatePipelineNotifications :: Text -> Notifications -> UpdatePipelineNotifications
- data UpdatePipelineNotificationsResponse = UpdatePipelineNotificationsResponse' (Maybe Pipeline) Int
- newUpdatePipelineNotificationsResponse :: Int -> UpdatePipelineNotificationsResponse
- data ReadPipeline = ReadPipeline' Text
- newReadPipeline :: Text -> ReadPipeline
- data ReadPipelineResponse = ReadPipelineResponse' (Maybe [Warning]) (Maybe Pipeline) Int
- newReadPipelineResponse :: Int -> ReadPipelineResponse
- data CreatePipeline = CreatePipeline' (Maybe PipelineOutputConfig) (Maybe Text) (Maybe Text) (Maybe Notifications) (Maybe PipelineOutputConfig) Text Text Text
- newCreatePipeline :: Text -> Text -> Text -> CreatePipeline
- data CreatePipelineResponse = CreatePipelineResponse' (Maybe [Warning]) (Maybe Pipeline) Int
- newCreatePipelineResponse :: Int -> CreatePipelineResponse
- data ListJobsByStatus = ListJobsByStatus' (Maybe Text) (Maybe Text) Text
- newListJobsByStatus :: Text -> ListJobsByStatus
- data ListJobsByStatusResponse = ListJobsByStatusResponse' (Maybe Text) (Maybe [Job]) Int
- newListJobsByStatusResponse :: Int -> ListJobsByStatusResponse
- data CancelJob = CancelJob' Text
- newCancelJob :: Text -> CancelJob
- data CancelJobResponse = CancelJobResponse' Int
- newCancelJobResponse :: Int -> CancelJobResponse
- data Artwork = Artwork' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Encryption) (Maybe Text)
- newArtwork :: Artwork
- data AudioCodecOptions = AudioCodecOptions' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newAudioCodecOptions :: AudioCodecOptions
- data AudioParameters = AudioParameters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AudioCodecOptions)
- newAudioParameters :: AudioParameters
- data CaptionFormat = CaptionFormat' (Maybe Text) (Maybe Text) (Maybe Encryption)
- newCaptionFormat :: CaptionFormat
- data CaptionSource = CaptionSource' (Maybe Text) (Maybe Encryption) (Maybe Text) (Maybe Text) (Maybe Text)
- newCaptionSource :: CaptionSource
- data Captions = Captions' (Maybe Text) (Maybe [CaptionSource]) (Maybe [CaptionFormat])
- newCaptions :: Captions
- data Clip = Clip' (Maybe TimeSpan)
- newClip :: Clip
- data CreateJobOutput = CreateJobOutput' (Maybe Text) (Maybe Captions) (Maybe Text) (Maybe [Clip]) (Maybe JobAlbumArt) (Maybe [JobWatermark]) (Maybe Encryption) (Maybe Text) (Maybe Text) (Maybe Encryption) (Maybe Text)
- newCreateJobOutput :: CreateJobOutput
- data CreateJobPlaylist = CreateJobPlaylist' (Maybe PlayReadyDrm) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe HlsContentProtection)
- newCreateJobPlaylist :: CreateJobPlaylist
- data DetectedProperties = DetectedProperties' (Maybe Int) (Maybe Text) (Maybe Integer) (Maybe Int) (Maybe Integer)
- newDetectedProperties :: DetectedProperties
- data Encryption = Encryption' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEncryption :: Encryption
- data HlsContentProtection = HlsContentProtection' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newHlsContentProtection :: HlsContentProtection
- data InputCaptions = InputCaptions' (Maybe Text) (Maybe [CaptionSource])
- newInputCaptions :: InputCaptions
- data Job = Job' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [JobInput]) (Maybe JobInput) (Maybe (HashMap Text Text)) (Maybe [JobOutput]) (Maybe JobOutput) (Maybe Text) (Maybe [Playlist]) (Maybe Text) (Maybe Timing)
- newJob :: Job
- data JobAlbumArt = JobAlbumArt' (Maybe Text) (Maybe [Artwork])
- newJobAlbumArt :: JobAlbumArt
- data JobInput = JobInput' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TimeSpan) (Maybe Encryption) (Maybe Text) (Maybe DetectedProperties) (Maybe Text) (Maybe Text) (Maybe InputCaptions)
- newJobInput :: JobInput
- data JobOutput = JobOutput' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Captions) (Maybe Text) (Maybe [Clip]) (Maybe JobAlbumArt) (Maybe Integer) (Maybe [JobWatermark]) (Maybe Int) (Maybe Encryption) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Encryption) (Maybe Integer) (Maybe Text)
- newJobOutput :: JobOutput
- data JobWatermark = JobWatermark' (Maybe Text) (Maybe Text) (Maybe Encryption)
- newJobWatermark :: JobWatermark
- data Notifications = Notifications' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newNotifications :: Notifications
- data Permission = Permission' (Maybe [Text]) (Maybe Text) (Maybe Text)
- newPermission :: Permission
- data Pipeline = Pipeline' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PipelineOutputConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notifications) (Maybe PipelineOutputConfig)
- newPipeline :: Pipeline
- data PipelineOutputConfig = PipelineOutputConfig' (Maybe Text) (Maybe Text) (Maybe [Permission])
- newPipelineOutputConfig :: PipelineOutputConfig
- data PlayReadyDrm = PlayReadyDrm' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPlayReadyDrm :: PlayReadyDrm
- data Playlist = Playlist' (Maybe Text) (Maybe PlayReadyDrm) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe HlsContentProtection)
- newPlaylist :: Playlist
- data Preset = Preset' (Maybe Text) (Maybe VideoParameters) (Maybe Thumbnails) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AudioParameters)
- newPreset :: Preset
- data PresetWatermark = PresetWatermark' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPresetWatermark :: PresetWatermark
- data Thumbnails = Thumbnails' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newThumbnails :: Thumbnails
- data TimeSpan = TimeSpan' (Maybe Text) (Maybe Text)
- newTimeSpan :: TimeSpan
- data Timing = Timing' (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newTiming :: Timing
- data VideoParameters = VideoParameters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [PresetWatermark]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text))
- newVideoParameters :: VideoParameters
- data Warning = Warning' (Maybe Text) (Maybe Text)
- newWarning :: Warning
Service Configuration
defaultService :: Service Source #
API version 2012-09-25 of the Amazon Elastic Transcoder SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ElasticTranscoder.
IncompatibleVersionException
_IncompatibleVersionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for IncompatibleVersionException' errors.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more required parameter values were not provided in the request.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
General authentication failure. The request was not signed correctly.
InternalServiceException
_InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
JobComplete
newJobComplete :: Wait ReadJob Source #
Polls ReadJob every 30 seconds until a successful state is reached. An error is returned after 120 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeletePreset
data DeletePreset Source #
The DeletePresetRequest structure.
See: newDeletePreset smart constructor.
Constructors
| DeletePreset' Text |
Instances
Arguments
| :: Text | |
| -> DeletePreset |
Create a value of DeletePreset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:DeletePreset', deletePreset_id - The identifier of the preset for which you want to get detailed
information.
data DeletePresetResponse Source #
The DeletePresetResponse structure.
See: newDeletePresetResponse smart constructor.
Constructors
| DeletePresetResponse' Int |
Instances
newDeletePresetResponse Source #
Arguments
| :: Int | |
| -> DeletePresetResponse |
Create a value of DeletePresetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeletePresetResponse', deletePresetResponse_httpStatus - The response's http status code.
UpdatePipelineStatus
data UpdatePipelineStatus Source #
The UpdatePipelineStatusRequest structure.
See: newUpdatePipelineStatus smart constructor.
Constructors
| UpdatePipelineStatus' Text Text |
Instances
newUpdatePipelineStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdatePipelineStatus |
Create a value of UpdatePipelineStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:UpdatePipelineStatus', updatePipelineStatus_id - The identifier of the pipeline to update.
$sel:status:UpdatePipelineStatus', updatePipelineStatus_status - The desired status of the pipeline:
Active: The pipeline is processing jobs.Paused: The pipeline is not currently processing jobs.
data UpdatePipelineStatusResponse Source #
When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.
See: newUpdatePipelineStatusResponse smart constructor.
Constructors
| UpdatePipelineStatusResponse' (Maybe Pipeline) Int |
Instances
newUpdatePipelineStatusResponse Source #
Create a value of UpdatePipelineStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipeline:UpdatePipelineStatusResponse', updatePipelineStatusResponse_pipeline - A section of the response body that provides information about the
pipeline.
$sel:httpStatus:UpdatePipelineStatusResponse', updatePipelineStatusResponse_httpStatus - The response's http status code.
ListJobsByPipeline (Paginated)
data ListJobsByPipeline Source #
The ListJobsByPipelineRequest structure.
See: newListJobsByPipeline smart constructor.
Instances
newListJobsByPipeline Source #
Arguments
| :: Text | |
| -> ListJobsByPipeline |
Create a value of ListJobsByPipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ascending:ListJobsByPipeline', listJobsByPipeline_ascending - To list jobs in chronological order by the date and time that they were
submitted, enter true. To list jobs in reverse chronological order,
enter false.
$sel:pageToken:ListJobsByPipeline', listJobsByPipeline_pageToken - When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of
results.
$sel:pipelineId:ListJobsByPipeline', listJobsByPipeline_pipelineId - The ID of the pipeline for which you want to get job information.
data ListJobsByPipelineResponse Source #
The ListJobsByPipelineResponse structure.
See: newListJobsByPipelineResponse smart constructor.
Instances
newListJobsByPipelineResponse Source #
Create a value of ListJobsByPipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextPageToken:ListJobsByPipelineResponse', listJobsByPipelineResponse_nextPageToken - A value that you use to access the second and subsequent pages of
results, if any. When the jobs in the specified pipeline fit on one page
or when you've reached the last page of results, the value of
NextPageToken is null.
$sel:jobs:ListJobsByPipelineResponse', listJobsByPipelineResponse_jobs - An array of Job objects that are in the specified pipeline.
$sel:httpStatus:ListJobsByPipelineResponse', listJobsByPipelineResponse_httpStatus - The response's http status code.
UpdatePipeline
data UpdatePipeline Source #
The UpdatePipelineRequest structure.
See: newUpdatePipeline smart constructor.
Constructors
| UpdatePipeline' (Maybe Text) (Maybe PipelineOutputConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notifications) (Maybe PipelineOutputConfig) Text |
Instances
Arguments
| :: Text | |
| -> UpdatePipeline |
Create a value of UpdatePipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputBucket:UpdatePipeline', updatePipeline_inputBucket - 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.
$sel:contentConfig:UpdatePipeline', updatePipeline_contentConfig - The optional ContentConfig object specifies information about the
Amazon S3 bucket in which you want Elastic Transcoder to save transcoded
files and playlists: which bucket to use, which users you want to have
access to the files, the type of access you want users to have, and the
storage class that you want to assign to the files.
If you specify values for ContentConfig, you must also specify values
for ThumbnailConfig.
If you specify values for ContentConfig and ThumbnailConfig, omit
the OutputBucket object.
- Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
- Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files 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.
Grantee Type: Specify the type of value that appears in the
Granteeobject:Canonical: The value in the
Granteeobject is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.A canonical user ID is not the same as an AWS account number.
- Email: The value in the
Granteeobject is the registered email address of an AWS account. - Group: The value in the
Granteeobject is one of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
- Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
Access: The permission that you want to give to the AWS user that you specified in
Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. 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 hasREAD,READ_ACP, andWRITE_ACPpermissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
- StorageClass: The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
$sel:role':UpdatePipeline', updatePipeline_role - The IAM Amazon Resource Name (ARN) for the role that you want Elastic
Transcoder to use to transcode jobs for this pipeline.
$sel:name:UpdatePipeline', updatePipeline_name - 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
$sel:awsKmsKeyArn:UpdatePipeline', updatePipeline_awsKmsKeyArn - 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.
$sel:notifications:UpdatePipeline', updatePipeline_notifications - The topic ARN for 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: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
- Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
- Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
- Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.
$sel:thumbnailConfig:UpdatePipeline', updatePipeline_thumbnailConfig - The ThumbnailConfig object specifies several values, including the
Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail
files, which users you want to have access to the files, the type of
access you want users to have, and the storage class that you want to
assign to the files.
If you specify values for ContentConfig, you must also specify values
for ThumbnailConfig even if you don't want to create thumbnails.
If you specify values for ContentConfig and ThumbnailConfig, omit
the OutputBucket object.
- Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
- Permissions (Optional): The
Permissionsobject specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, 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. GranteeType: Specify the type of value that appears in the Grantee object:
Canonical: The value in the
Granteeobject is 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 value in the
Granteeobject is the registered email address of an AWS account. - Group: The value in the
Granteeobject is one of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
- Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
Access: The permission that you want to give to the AWS user that you specified in
Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:READ: The grantee can read the thumbnails and metadata for objects 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 hasREAD,READ_ACP, andWRITE_ACPpermissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
- StorageClass: The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
$sel:id:UpdatePipeline', updatePipeline_id - The ID of the pipeline that you want to update.
data UpdatePipelineResponse Source #
When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.
See: newUpdatePipelineResponse smart constructor.
Instances
newUpdatePipelineResponse Source #
Create a value of UpdatePipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:warnings:UpdatePipelineResponse', updatePipelineResponse_warnings - 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.
$sel:pipeline:UpdatePipelineResponse', updatePipelineResponse_pipeline - The pipeline updated by this UpdatePipelineResponse call.
$sel:httpStatus:UpdatePipelineResponse', updatePipelineResponse_httpStatus - The response's http status code.
DeletePipeline
data DeletePipeline Source #
The DeletePipelineRequest structure.
See: newDeletePipeline smart constructor.
Constructors
| DeletePipeline' Text |
Instances
Arguments
| :: Text | |
| -> DeletePipeline |
Create a value of DeletePipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:DeletePipeline', deletePipeline_id - The identifier of the pipeline that you want to delete.
data DeletePipelineResponse Source #
The DeletePipelineResponse structure.
See: newDeletePipelineResponse smart constructor.
Constructors
| DeletePipelineResponse' Int |
Instances
newDeletePipelineResponse Source #
Create a value of DeletePipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeletePipelineResponse', deletePipelineResponse_httpStatus - The response's http status code.
CreateJob
The CreateJobRequest structure.
See: newCreateJob smart constructor.
Constructors
| CreateJob' (Maybe [JobInput]) (Maybe JobInput) (Maybe (HashMap Text Text)) (Maybe [CreateJobOutput]) (Maybe CreateJobOutput) (Maybe [CreateJobPlaylist]) (Maybe Text) Text |
Instances
Create a value of CreateJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputs:CreateJob', createJob_inputs - A section of the request body that provides information about the files
that are being transcoded.
$sel:input:CreateJob', createJob_input - A section of the request body that provides information about the file
that is being transcoded.
$sel:userMetadata:CreateJob', createJob_userMetadata - User-defined metadata that you want to associate with an Elastic
Transcoder job. You specify metadata in key/value pairs, and you can
add up to 10 key/value pairs per job. Elastic Transcoder does not
guarantee that key/value pairs are returned in the same order in
which you specify them.
$sel:outputs:CreateJob', createJob_outputs - A section of the request body that provides information about the
transcoded (target) files. We recommend that you use the Outputs
syntax instead of the Output syntax.
$sel:output:CreateJob', createJob_output - A section of the request body that provides information about the
transcoded (target) file. We strongly recommend that you use the
Outputs syntax instead of the Output syntax.
$sel:playlists:CreateJob', createJob_playlists - If you specify a preset in PresetId for which the value of Container
is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information
about the master playlists that you want Elastic Transcoder to create.
The maximum number of master playlists in a job is 30.
$sel:outputKeyPrefix:CreateJob', createJob_outputKeyPrefix - The value, if any, that you want Elastic Transcoder to prepend to the
names of all files that this job creates, including output files,
thumbnails, and playlists.
$sel:pipelineId:CreateJob', createJob_pipelineId - The Id of the pipeline that you want Elastic Transcoder to use for
transcoding. The pipeline determines several settings, including the
Amazon S3 bucket from which Elastic Transcoder gets the files to
transcode and the bucket into which Elastic Transcoder puts the
transcoded files.
data CreateJobResponse Source #
The CreateJobResponse structure.
See: newCreateJobResponse smart constructor.
Constructors
| CreateJobResponse' (Maybe Job) Int |
Instances
Arguments
| :: Int | |
| -> CreateJobResponse |
Create a value of CreateJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:job:CreateJobResponse', createJobResponse_job - A section of the response body that provides information about the job
that is created.
$sel:httpStatus:CreateJobResponse', createJobResponse_httpStatus - The response's http status code.
ListPipelines (Paginated)
data ListPipelines Source #
The ListPipelineRequest structure.
See: newListPipelines smart constructor.
Constructors
| ListPipelines' (Maybe Text) (Maybe Text) |
Instances
newListPipelines :: ListPipelines Source #
Create a value of ListPipelines with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ascending:ListPipelines', listPipelines_ascending - To list pipelines in chronological order by the date and time that they
were created, enter true. To list pipelines in reverse chronological
order, enter false.
$sel:pageToken:ListPipelines', listPipelines_pageToken - When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of
results.
data ListPipelinesResponse Source #
A list of the pipelines associated with the current AWS account.
See: newListPipelinesResponse smart constructor.
Instances
newListPipelinesResponse Source #
Create a value of ListPipelinesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextPageToken:ListPipelinesResponse', listPipelinesResponse_nextPageToken - 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.
$sel:pipelines:ListPipelinesResponse', listPipelinesResponse_pipelines - An array of Pipeline objects.
$sel:httpStatus:ListPipelinesResponse', listPipelinesResponse_httpStatus - The response's http status code.
CreatePreset
data CreatePreset Source #
The CreatePresetRequest structure.
See: newCreatePreset smart constructor.
Constructors
| CreatePreset' (Maybe VideoParameters) (Maybe Thumbnails) (Maybe Text) (Maybe AudioParameters) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreatePreset |
Create a value of CreatePreset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:video:CreatePreset', createPreset_video - A section of the request body that specifies the video parameters.
$sel:thumbnails:CreatePreset', createPreset_thumbnails - A section of the request body that specifies the thumbnail parameters,
if any.
$sel:description:CreatePreset', createPreset_description - A description of the preset.
$sel:audio:CreatePreset', createPreset_audio - A section of the request body that specifies the audio parameters.
$sel:name:CreatePreset', createPreset_name - The name of the preset. We recommend that the name be unique within the
AWS account, but uniqueness is not enforced.
$sel:container:CreatePreset', createPreset_container - The container type for the output file. Valid values include flac,
flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts,
and webm.
data CreatePresetResponse Source #
The CreatePresetResponse structure.
See: newCreatePresetResponse smart constructor.
Instances
newCreatePresetResponse Source #
Arguments
| :: Int | |
| -> CreatePresetResponse |
Create a value of CreatePresetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:warning:CreatePresetResponse', createPresetResponse_warning - If the preset settings don't comply with the standards for the video
codec but Elastic Transcoder created the preset, this message explains
the reason the preset settings don't meet the standard. Elastic
Transcoder created the preset because the settings might produce
acceptable output.
$sel:preset:CreatePresetResponse', createPresetResponse_preset - A section of the response body that provides information about the
preset that is created.
$sel:httpStatus:CreatePresetResponse', createPresetResponse_httpStatus - The response's http status code.
ListPresets (Paginated)
data ListPresets Source #
The ListPresetsRequest structure.
See: newListPresets smart constructor.
Constructors
| ListPresets' (Maybe Text) (Maybe Text) |
Instances
newListPresets :: ListPresets Source #
Create a value of ListPresets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ascending:ListPresets', listPresets_ascending - To list presets in chronological order by the date and time that they
were created, enter true. To list presets in reverse chronological
order, enter false.
$sel:pageToken:ListPresets', listPresets_pageToken - When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of
results.
data ListPresetsResponse Source #
The ListPresetsResponse structure.
See: newListPresetsResponse smart constructor.
Instances
newListPresetsResponse Source #
Arguments
| :: Int | |
| -> ListPresetsResponse |
Create a value of ListPresetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextPageToken:ListPresetsResponse', listPresetsResponse_nextPageToken - A value that you use to access the second and subsequent pages of
results, if any. When the presets fit on one page or when you've
reached the last page of results, the value of NextPageToken is
null.
$sel:presets:ListPresetsResponse', listPresetsResponse_presets - An array of Preset objects.
$sel:httpStatus:ListPresetsResponse', listPresetsResponse_httpStatus - The response's http status code.
ReadPreset
data ReadPreset Source #
The ReadPresetRequest structure.
See: newReadPreset smart constructor.
Constructors
| ReadPreset' Text |
Instances
Arguments
| :: Text | |
| -> ReadPreset |
Create a value of ReadPreset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:ReadPreset', readPreset_id - The identifier of the preset for which you want to get detailed
information.
data ReadPresetResponse Source #
The ReadPresetResponse structure.
See: newReadPresetResponse smart constructor.
Constructors
| ReadPresetResponse' (Maybe Preset) Int |
Instances
newReadPresetResponse Source #
Arguments
| :: Int | |
| -> ReadPresetResponse |
Create a value of ReadPresetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:preset:ReadPresetResponse', readPresetResponse_preset - A section of the response body that provides information about the
preset.
$sel:httpStatus:ReadPresetResponse', readPresetResponse_httpStatus - The response's http status code.
ReadJob
The ReadJobRequest structure.
See: newReadJob smart constructor.
Instances
Create a value of ReadJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:ReadJob', readJob_id - The identifier of the job for which you want to get detailed
information.
data ReadJobResponse Source #
The ReadJobResponse structure.
See: newReadJobResponse smart constructor.
Constructors
| ReadJobResponse' Int Job |
Instances
Create a value of ReadJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ReadJobResponse', readJobResponse_httpStatus - The response's http status code.
$sel:job:ReadJobResponse', readJobResponse_job - A section of the response body that provides information about the job.
UpdatePipelineNotifications
data UpdatePipelineNotifications Source #
The UpdatePipelineNotificationsRequest structure.
See: newUpdatePipelineNotifications smart constructor.
Constructors
| UpdatePipelineNotifications' Text Notifications |
Instances
newUpdatePipelineNotifications Source #
Arguments
| :: Text | |
| -> Notifications | |
| -> UpdatePipelineNotifications |
Create a value of UpdatePipelineNotifications with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:UpdatePipelineNotifications', updatePipelineNotifications_id - The identifier of the pipeline for which you want to change notification
settings.
$sel:notifications:UpdatePipelineNotifications', updatePipelineNotifications_notifications - The topic ARN for 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: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
- Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
- Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
- Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.
data UpdatePipelineNotificationsResponse Source #
The UpdatePipelineNotificationsResponse structure.
See: newUpdatePipelineNotificationsResponse smart constructor.
Constructors
| UpdatePipelineNotificationsResponse' (Maybe Pipeline) Int |
Instances
newUpdatePipelineNotificationsResponse Source #
Arguments
| :: Int | |
| -> UpdatePipelineNotificationsResponse |
Create a value of UpdatePipelineNotificationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipeline:UpdatePipelineNotificationsResponse', updatePipelineNotificationsResponse_pipeline - A section of the response body that provides information about the
pipeline associated with this notification.
$sel:httpStatus:UpdatePipelineNotificationsResponse', updatePipelineNotificationsResponse_httpStatus - The response's http status code.
ReadPipeline
data ReadPipeline Source #
The ReadPipelineRequest structure.
See: newReadPipeline smart constructor.
Constructors
| ReadPipeline' Text |
Instances
Arguments
| :: Text | |
| -> ReadPipeline |
Create a value of ReadPipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:ReadPipeline', readPipeline_id - The identifier of the pipeline to read.
data ReadPipelineResponse Source #
The ReadPipelineResponse structure.
See: newReadPipelineResponse smart constructor.
Instances
newReadPipelineResponse Source #
Arguments
| :: Int | |
| -> ReadPipelineResponse |
Create a value of ReadPipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:warnings:ReadPipelineResponse', readPipelineResponse_warnings - 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.
$sel:pipeline:ReadPipelineResponse', readPipelineResponse_pipeline - A section of the response body that provides information about the
pipeline.
$sel:httpStatus:ReadPipelineResponse', readPipelineResponse_httpStatus - The response's http status code.
CreatePipeline
data CreatePipeline Source #
The CreatePipelineRequest structure.
See: newCreatePipeline smart constructor.
Constructors
| CreatePipeline' (Maybe PipelineOutputConfig) (Maybe Text) (Maybe Text) (Maybe Notifications) (Maybe PipelineOutputConfig) Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreatePipeline |
Create a value of CreatePipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentConfig:CreatePipeline', createPipeline_contentConfig - The optional ContentConfig object specifies information about the
Amazon S3 bucket in which you want Elastic Transcoder to save transcoded
files and playlists: which bucket to use, which users you want to have
access to the files, the type of access you want users to have, and the
storage class that you want to assign to the files.
If you specify values for ContentConfig, you must also specify values
for ThumbnailConfig.
If you specify values for ContentConfig and ThumbnailConfig, omit
the OutputBucket object.
- Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
- Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files 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.
Grantee Type: Specify the type of value that appears in the
Granteeobject:Canonical: The value in the
Granteeobject is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.A canonical user ID is not the same as an AWS account number.
- Email: The value in the
Granteeobject is the registered email address of an AWS account. - Group: The value in the
Granteeobject is one of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
- Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
Access: The permission that you want to give to the AWS user that you specified in
Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. 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 hasREAD,READ_ACP, andWRITE_ACPpermissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
- StorageClass: The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
$sel:outputBucket:CreatePipeline', createPipeline_outputBucket - 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 byRole.- 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.
$sel:awsKmsKeyArn:CreatePipeline', createPipeline_awsKmsKeyArn - 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.
$sel:notifications:CreatePipeline', createPipeline_notifications - 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: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
- Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
- Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
- Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
$sel:thumbnailConfig:CreatePipeline', createPipeline_thumbnailConfig - The ThumbnailConfig object specifies several values, including the
Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail
files, which users you want to have access to the files, the type of
access you want users to have, and the storage class that you want to
assign to the files.
If you specify values for ContentConfig, you must also specify values
for ThumbnailConfig even if you don't want to create thumbnails.
If you specify values for ContentConfig and ThumbnailConfig, omit
the OutputBucket object.
- Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
- Permissions (Optional): The
Permissionsobject specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, 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. GranteeType: Specify the type of value that appears in the Grantee object:
Canonical: The value in the
Granteeobject is 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 value in the
Granteeobject is the registered email address of an AWS account. - Group: The value in the
Granteeobject is one of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
- Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
Access: The permission that you want to give to the AWS user that you specified in
Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:READ: The grantee can read the thumbnails and metadata for objects 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 hasREAD,READ_ACP, andWRITE_ACPpermissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
- StorageClass: The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
$sel:name:CreatePipeline', createPipeline_name - 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.
$sel:inputBucket:CreatePipeline', createPipeline_inputBucket - The Amazon S3 bucket in which you saved the media files that you want to
transcode.
$sel:role':CreatePipeline', createPipeline_role - The IAM Amazon Resource Name (ARN) for the role that you want Elastic
Transcoder to use to create the pipeline.
data CreatePipelineResponse Source #
When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.
See: newCreatePipelineResponse smart constructor.
Instances
newCreatePipelineResponse Source #
Create a value of CreatePipelineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:warnings:CreatePipelineResponse', createPipelineResponse_warnings - 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.
$sel:pipeline:CreatePipelineResponse', createPipelineResponse_pipeline - A section of the response body that provides information about the
pipeline that is created.
$sel:httpStatus:CreatePipelineResponse', createPipelineResponse_httpStatus - The response's http status code.
ListJobsByStatus (Paginated)
data ListJobsByStatus Source #
The ListJobsByStatusRequest structure.
See: newListJobsByStatus smart constructor.
Instances
Arguments
| :: Text | |
| -> ListJobsByStatus |
Create a value of ListJobsByStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ascending:ListJobsByStatus', listJobsByStatus_ascending - To list jobs in chronological order by the date and time that they were
submitted, enter true. To list jobs in reverse chronological order,
enter false.
$sel:pageToken:ListJobsByStatus', listJobsByStatus_pageToken - When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of
results.
$sel:status:ListJobsByStatus', listJobsByStatus_status - To get information about all of the jobs associated with the current AWS
account that have a given status, specify the following status:
Submitted, Progressing, Complete, Canceled, or Error.
data ListJobsByStatusResponse Source #
The ListJobsByStatusResponse structure.
See: newListJobsByStatusResponse smart constructor.
Instances
newListJobsByStatusResponse Source #
Create a value of ListJobsByStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextPageToken:ListJobsByStatusResponse', listJobsByStatusResponse_nextPageToken - A value that you use to access the second and subsequent pages of
results, if any. When the jobs in the specified pipeline fit on one page
or when you've reached the last page of results, the value of
NextPageToken is null.
$sel:jobs:ListJobsByStatusResponse', listJobsByStatusResponse_jobs - An array of Job objects that have the specified status.
$sel:httpStatus:ListJobsByStatusResponse', listJobsByStatusResponse_httpStatus - The response's http status code.
CancelJob
The CancelJobRequest structure.
See: newCancelJob smart constructor.
Constructors
| CancelJob' Text |
Instances
Create a value of CancelJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:CancelJob', cancelJob_id - The identifier of the job that you want to cancel.
To get a list of the jobs (including their jobId) that have a status
of Submitted, use the ListJobsByStatus API action.
data CancelJobResponse Source #
The response body contains a JSON object. If the job is successfully
canceled, the value of Success is true.
See: newCancelJobResponse smart constructor.
Constructors
| CancelJobResponse' Int |
Instances
Arguments
| :: Int | |
| -> CancelJobResponse |
Create a value of CancelJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelJobResponse', cancelJobResponse_httpStatus - The response's http status code.
Types
Artwork
The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.
To remove artwork or leave the artwork empty, you can either set
Artwork to null, or set the Merge Policy to "Replace" and use an
empty Artwork array.
To pass through existing artwork unchanged, set the Merge Policy to
"Prepend", "Append", or "Fallback", and use an empty Artwork
array.
See: newArtwork smart constructor.
Constructors
| Artwork' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Encryption) (Maybe Text) |
Instances
newArtwork :: Artwork Source #
Create a value of Artwork with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sizingPolicy:Artwork', artwork_sizingPolicy - Specify one of the following values to control scaling of the output
album art:
Fit:Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidthorMaxHeightwithout exceeding the other value.Fill:Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidthorMaxHeightand matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value.Stretch:Elastic Transcoder stretches the output art to match the values that you specified forMaxWidthandMaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted.Keep:Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified forMaxWidthandMaxHeight, Elastic Transcoder crops the output art.ShrinkToFit:Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.ShrinkToFillElastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.
$sel:albumArtFormat:Artwork', artwork_albumArtFormat - The format of album art, if any. Valid formats are .jpg and .png.
$sel:maxHeight:Artwork', artwork_maxHeight - The maximum height of the output album art in pixels. If you specify
auto, Elastic Transcoder uses 600 as the default value. If you specify
a numeric value, enter an even integer between 32 and 3072, inclusive.
$sel:inputKey:Artwork', artwork_inputKey - The name of the file to be used as album art. To determine which Amazon
S3 bucket contains the specified file, Elastic Transcoder checks the
pipeline specified by PipelineId; the InputBucket object in that
pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg,
include the prefix in the key. If the file isn't in the specified
bucket, Elastic Transcoder returns an error.
$sel:paddingPolicy:Artwork', artwork_paddingPolicy - When you set PaddingPolicy to Pad, Elastic Transcoder may add white
bars to the top and bottom and/or left and right sides of the output
album art to make the total size of the output art match the values that
you specified for MaxWidth and MaxHeight.
$sel:encryption:Artwork', artwork_encryption - The encryption settings, if any, that you want Elastic Transcoder to
apply to your artwork.
$sel:maxWidth:Artwork', artwork_maxWidth - The maximum width of the output album art in pixels. If you specify
auto, Elastic Transcoder uses 600 as the default value. If you specify
a numeric value, enter an even integer between 32 and 4096, inclusive.
AudioCodecOptions
data AudioCodecOptions Source #
Options associated with your audio codec.
See: newAudioCodecOptions smart constructor.
Instances
newAudioCodecOptions :: AudioCodecOptions Source #
Create a value of AudioCodecOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:signed:AudioCodecOptions', audioCodecOptions_signed - You can only choose whether an audio sample is signed when you specify
pcm for the value of Audio:Codec.
Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned).
The supported value is Signed.
$sel:bitDepth:AudioCodecOptions', audioCodecOptions_bitDepth - You can only choose an audio bit depth when you specify flac or pcm
for the value of Audio:Codec.
The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file.
Valid values are 16 and 24.
The most common bit depth is 24.
$sel:profile:AudioCodecOptions', audioCodecOptions_profile - You can only choose an audio profile when you specify AAC for the value
of Audio:Codec.
Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
auto: If you specifyauto, Elastic Transcoder selects the profile based on the bit rate selected for the output file.AAC-LC: The most common AAC profile. Use for bit rates larger than 64 kbps.HE-AAC: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps.HE-AACv2: Not supported on some players and devices. Use for bit rates less than 48 kbps.
All outputs in a Smooth playlist must have the same value for
Profile.
If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.
$sel:bitOrder:AudioCodecOptions', audioCodecOptions_bitOrder - You can only choose an audio bit order when you specify pcm for the
value of Audio:Codec.
The order the bits of a PCM sample are stored in.
The supported value is LittleEndian.
AudioParameters
data AudioParameters Source #
Parameters required for transcoding audio.
See: newAudioParameters smart constructor.
Constructors
| AudioParameters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AudioCodecOptions) |
Instances
newAudioParameters :: AudioParameters Source #
Create a value of AudioParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:AudioParameters', audioParameters_channels - The number of audio channels in the output file. The following values
are valid:
auto, 0, 1, 2
One channel carries the information played by a single speaker. For
example, a stereo track with two channels sends one channel to the left
speaker, and the other channel to the right speaker. The output channels
are organized into tracks. If you want Elastic Transcoder to
automatically detect the number of audio channels in the input file and
use that value for the output file, select auto.
The output of a specific channel value and inputs are as follows:
autochannel specified, with any input: Pass through up to eight input channels.0channels specified, with any input: Audio omitted from the output.1channel specified, with at least one input channel: Mono sound.2channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, seeAudio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels and
tracks, see Audio:AudioPackingMode.
$sel:codec:AudioParameters', audioParameters_codec - The audio codec for the output file. Valid values include aac, flac,
mp2, mp3, pcm, and vorbis.
$sel:audioPackingMode:AudioParameters', audioParameters_audioPackingMode - The method of organizing audio channels and tracks. Use Audio:Channels
to specify the number of channels in your output, and
Audio:AudioPackingMode to specify the number of tracks and their
relation to the channels. If you do not specify an
Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.
The following values are valid:
SingleTrack, OneChannelPerTrack, and
OneChannelPerTrackWithMosTo8Tracks
When you specify SingleTrack, Elastic Transcoder creates a single
track for your output. The track can have up to eight channels. Use
SingleTrack for all non-mxf containers.
The outputs of SingleTrack for a specific channel value and inputs are
as follows:
0channels with any input: Audio omitted from the output1, 2, or autochannels with no audio input: Audio omitted from the output1channel with any input with audio: One track with one channel, downmixed if necessary2channels with one track with one channel: One track with two identical channels2 or autochannels with two tracks with one channel each: One track with two channels2 or autochannels with one track with two channels: One track with two channels2channels with one track with multiple channels: One track with two channelsautochannels with one track with one channel: One track with one channelautochannels with one track with multiple channels: One track with multiple channels
When you specify OneChannelPerTrack, Elastic Transcoder creates a new
track for every channel in your output. Your output can have up to eight
single-channel tracks.
The outputs of OneChannelPerTrack for a specific channel value and
inputs are as follows:
0channels with any input: Audio omitted from the output1, 2, or autochannels with no audio input: Audio omitted from the output1channel with any input with audio: One track with one channel, downmixed if necessary2channels with one track with one channel: Two tracks with one identical channel each2 or autochannels with two tracks with one channel each: Two tracks with one channel each2 or autochannels with one track with two channels: Two tracks with one channel each2channels with one track with multiple channels: Two tracks with one channel eachautochannels with one track with one channel: One track with one channelautochannels with one track with multiple channels: Up to eight tracks with one channel each
When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic
Transcoder creates eight single-channel tracks for your output. All
tracks that do not contain audio data from an input channel are MOS, or
Mit Out Sound, tracks.
The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific
channel value and inputs are as follows:
0channels with any input: Audio omitted from the output1, 2, or autochannels with no audio input: Audio omitted from the output1channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks2channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks2 or autochannels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks2 or autochannels with one track with two channels: Two tracks with one channel each, plus six MOS tracks2channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracksautochannels with one track with one channel: One track with one channel, plus seven MOS tracksautochannels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all
$sel:sampleRate:AudioParameters', audioParameters_sampleRate - The sample rate of the audio stream in the output file, in Hertz. Valid
values include:
auto, 22050, 32000, 44100, 48000, 96000
If you specify auto, Elastic Transcoder automatically detects the
sample rate.
$sel:bitRate:AudioParameters', audioParameters_bitRate - The bit rate of the audio stream in the output file, in
kilobits/second. Enter an integer between 64 and 320, inclusive.
$sel:codecOptions:AudioParameters', audioParameters_codecOptions - If you specified AAC for Audio:Codec, this is the AAC compression
profile to use. Valid values include:
auto, AAC-LC, HE-AAC, HE-AACv2
If you specify auto, Elastic Transcoder chooses a profile based on the
bit rate of the output file.
CaptionFormat
data CaptionFormat Source #
The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.
See: newCaptionFormat smart constructor.
Constructors
| CaptionFormat' (Maybe Text) (Maybe Text) (Maybe Encryption) |
Instances
newCaptionFormat :: CaptionFormat Source #
Create a value of CaptionFormat with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pattern':CaptionFormat', captionFormat_pattern - The prefix for caption filenames, in the form
description-{language}, where:
- description is a description of the video.
{language}is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.
If you don't include {language} in the file name pattern, Elastic
Transcoder automatically appends "{language}" to the value that you
specify for the description. In addition, Elastic Transcoder
automatically appends the count to the end of the segment files.
For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.
$sel:format:CaptionFormat', captionFormat_format - The format you specify determines whether Elastic Transcoder generates
an embedded or sidecar caption for this output.
Valid Embedded Caption Formats:
- for FLAC: None
- For MP3: None
- For MP4: mov-text
- For MPEG-TS: None
- For ogg: None
- For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
- For FMP4: dfxp
- Non-FMP4 outputs: All sidecar types
fmp4captions have an extension of.ismt
$sel:encryption:CaptionFormat', captionFormat_encryption - The encryption settings, if any, that you want Elastic Transcoder to
apply to your caption formats.
CaptionSource
data CaptionSource Source #
A source file for the input sidecar captions used during the transcoding process.
See: newCaptionSource smart constructor.
Instances
newCaptionSource :: CaptionSource Source #
Create a value of CaptionSource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeOffset:CaptionSource', captionSource_timeOffset - For clip generation or captions that do not start at the same time as
the associated video file, the TimeOffset tells Elastic Transcoder how
much of the video to encode before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
$sel:encryption:CaptionSource', captionSource_encryption - The encryption settings, if any, that Elastic Transcoder needs to
decyrpt your caption sources, or that you want Elastic Transcoder to
apply to your caption sources.
$sel:key:CaptionSource', captionSource_key - The name of the sidecar caption file that you want Elastic Transcoder to
include in the output file.
$sel:language:CaptionSource', captionSource_language - A string that specifies the language of the caption. If you specified
multiple inputs with captions, the caption language must match in order
to be included in the output. Specify this as one of:
- 2-character ISO 639-1 code
- 3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
$sel:label:CaptionSource', captionSource_label - The label of the caption shown in the player when choosing a language.
We recommend that you put the caption language name here, in the
language of the captions.
Captions
The captions to be created, if any.
See: newCaptions smart constructor.
Constructors
| Captions' (Maybe Text) (Maybe [CaptionSource]) (Maybe [CaptionFormat]) |
Instances
newCaptions :: Captions Source #
Create a value of Captions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mergePolicy:Captions', captions_mergePolicy - A policy that determines how Elastic Transcoder handles the existence of
multiple captions.
- MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
- MergeRetain: Elastic Transcoder transcodes both embedded and
sidecar captions into outputs. If captions for a language are
embedded in the input file and also appear in a sidecar file,
Elastic Transcoder uses the embedded captions and ignores the
sidecar captions for that language. If
CaptionSourcesis empty, Elastic Transcoder omits all sidecar captions from the output files. - Override: Elastic Transcoder transcodes only the sidecar
captions that you specify in
CaptionSources.
MergePolicy cannot be null.
$sel:captionSources:Captions', captions_captionSources - Source files for the input sidecar captions used during the transcoding
process. To omit all sidecar captions, leave CaptionSources blank.
$sel:captionFormats:Captions', captions_captionFormats - The array of file formats for the output captions. If you leave this
value blank, Elastic Transcoder returns an error.
Clip
Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.
See: newClip smart constructor.
Instances
| Eq Clip Source # | |
| Read Clip Source # | |
| Show Clip Source # | |
| Generic Clip Source # | |
| NFData Clip Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Clip | |
| Hashable Clip Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Clip | |
| ToJSON Clip Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Clip | |
| FromJSON Clip Source # | |
| type Rep Clip Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Clip type Rep Clip = D1 ('MetaData "Clip" "Amazonka.ElasticTranscoder.Types.Clip" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "Clip'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timeSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeSpan)))) | |
Create a value of Clip with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeSpan:Clip', clip_timeSpan - Settings that determine when a clip begins and how long it lasts.
CreateJobOutput
data CreateJobOutput Source #
The CreateJobOutput structure.
See: newCreateJobOutput smart constructor.
Constructors
| CreateJobOutput' (Maybe Text) (Maybe Captions) (Maybe Text) (Maybe [Clip]) (Maybe JobAlbumArt) (Maybe [JobWatermark]) (Maybe Encryption) (Maybe Text) (Maybe Text) (Maybe Encryption) (Maybe Text) |
Instances
newCreateJobOutput :: CreateJobOutput Source #
Create a value of CreateJobOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:thumbnailPattern:CreateJobOutput', createJobOutput_thumbnailPattern - Whether you want Elastic Transcoder to create thumbnails for your videos
and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count}(Required): If you want to create thumbnails, you must include{count}in theThumbnailPatternobject. Wherever you specify{count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.If you specify a literal value and/or
{resolution}but you omit{count}, Elastic Transcoder returns a validation error and does not create the job.- Literal values (Optional): You can specify literal values
anywhere in the
ThumbnailPatternobject. For example, you can include them as a file name prefix or as a delimiter between{resolution}and{count}. {resolution}(Optional): If you want Elastic Transcoder to include the resolution in the file name, include{resolution}in theThumbnailPatternobject.
When creating thumbnails, Elastic Transcoder automatically saves the
files in the format (.jpg or .png) that appears in the preset that you
specified in the PresetID value of CreateJobOutput. Elastic
Transcoder also appends the applicable file name extension.
$sel:captions:CreateJobOutput', createJobOutput_captions - You can configure Elastic Transcoder to transcode captions, or
subtitles, from one format to another. All captions must be in UTF-8.
Elastic Transcoder supports two types of captions:
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include:
CEA-608 (EIA-608, first non-empty channel only),CEA-708 (EIA-708, first non-empty channel only), andmov-textValid outputs include:
mov-textElastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp(first div element only),ebu-tt,scc,smpt,srt,ttml(first div element only), andwebvttValid outputs include:
dfxp(first div element only),scc,srt, andwebvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or leave the captions empty, set Captions to null.
To pass through existing captions unchanged, set the MergePolicy to
MergeRetain, and pass in a null CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
$sel:presetId:CreateJobOutput', createJobOutput_presetId - The Id of the preset to use for this job. The preset determines the
audio, video, and thumbnail settings that Elastic Transcoder uses for
transcoding.
$sel:composition:CreateJobOutput', createJobOutput_composition - You can create an output file that contains an excerpt from the input
file. This excerpt, called a clip, can come from the beginning, middle,
or end of the file. The Composition object contains settings for the
clips that make up an output file. For the current release, you can only
specify settings for a single clip per output file. The Composition
object cannot be null.
$sel:albumArt:CreateJobOutput', createJobOutput_albumArt - Information about the album art that you want Elastic Transcoder to add
to the file during transcoding. You can specify up to twenty album
artworks for each output. Settings for each artwork must be defined in
the job for the current output.
$sel:watermarks:CreateJobOutput', createJobOutput_watermarks - Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding. You can specify up to four watermarks
for each output. Settings for each watermark must be defined in the
preset for the current output.
$sel:encryption:CreateJobOutput', createJobOutput_encryption - You can specify encryption settings for any output files that you want
to use for a transcoding job. This includes the output file and any
watermarks, thumbnails, album art, or captions that you want to use. You
must specify encryption settings for each file individually.
$sel:key:CreateJobOutput', createJobOutput_key - The name to assign to the transcoded file. Elastic Transcoder saves the
file in the Amazon S3 bucket specified by the OutputBucket object in
the pipeline that is specified by the pipeline ID. If a file with the
specified name already exists in the output bucket, the job fails.
$sel:segmentDuration:CreateJobOutput', createJobOutput_segmentDuration - (Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in PresetId for which the value of Container
is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the
target maximum duration of each segment in seconds. For HLSv3 format
playlists, each media segment is stored in a separate .ts file. For
HLSv4 and Smooth playlists, all media segments for an output are
stored in a single file. Each segment is approximately the length of the
SegmentDuration, though individual segments might be shorter or
longer.
The range of valid values is 1 to 60 seconds. If the duration of the
video is not evenly divisible by SegmentDuration, the duration of the
last segment is the remainder of total length/SegmentDuration.
Elastic Transcoder creates an output-specific playlist for each output
HLS output that you specify in OutputKeys. To add an output to the
master playlist for this job, include it in the OutputKeys of the
associated playlist.
$sel:thumbnailEncryption:CreateJobOutput', createJobOutput_thumbnailEncryption - The encryption settings, if any, that you want Elastic Transcoder to
apply to your thumbnail.
$sel:rotate:CreateJobOutput', createJobOutput_rotate - The number of degrees clockwise by which you want Elastic Transcoder to
rotate the output relative to the input. Enter one of the following
values: auto, 0, 90, 180, 270. The value auto generally
works only if the file that you're transcoding contains rotation
metadata.
CreateJobPlaylist
data CreateJobPlaylist Source #
Information about the master playlist.
See: newCreateJobPlaylist smart constructor.
Constructors
| CreateJobPlaylist' (Maybe PlayReadyDrm) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe HlsContentProtection) |
Instances
newCreateJobPlaylist :: CreateJobPlaylist Source #
Create a value of CreateJobPlaylist with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:playReadyDrm:CreateJobPlaylist', createJobPlaylist_playReadyDrm - The DRM settings, if any, that you want Elastic Transcoder to apply to
the output files associated with this playlist.
$sel:format:CreateJobPlaylist', createJobPlaylist_format - The format of the output playlist. Valid formats include HLSv3,
HLSv4, and Smooth.
$sel:outputKeys:CreateJobPlaylist', createJobPlaylist_outputKeys - For each output in this job that you want to include in a master
playlist, the value of the Outputs:Key object.
If your output is not
HLSor does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefixandOutputs:Key:OutputKeyPrefix
Outputs:KeyIf your output is
HLSv3and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8, and a series of.tsfiles that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key.m3u8OutputKeyPrefix
Outputs:Key00000.tsIf your output is
HLSv4, has a segment duration set, and is included in anHLSv4playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8:OutputKeyPrefix
Outputs:Key_v4.m3u8OutputKeyPrefix
Outputs:Key_iframe.m3u8OutputKeyPrefix
Outputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration
settings, clip settings, or caption settings must be the same for all
outputs in the playlist. For Smooth playlists, the Audio:Profile,
Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio
must be the same for all outputs.
$sel:name:CreateJobPlaylist', createJobPlaylist_name - The name that you want Elastic Transcoder to assign to the master
playlist, for example, nyc-vacation.m3u8. If the name includes a /
character, the section of the name before the last / must be
identical for all Name objects. If you create more than one master
playlist, the values of all Name objects must be unique.
Elastic Transcoder automatically appends the relevant file extension to
the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and
.ismc for Smooth playlists). If you include a file extension in
Name, the file name will have two extensions.
$sel:hlsContentProtection:CreateJobPlaylist', createJobPlaylist_hlsContentProtection - The HLS content protection settings, if any, that you want Elastic
Transcoder to apply to the output files associated with this playlist.
DetectedProperties
data DetectedProperties Source #
The detected properties of the input file. Elastic Transcoder identifies these values from the input file.
See: newDetectedProperties smart constructor.
Constructors
| DetectedProperties' (Maybe Int) (Maybe Text) (Maybe Integer) (Maybe Int) (Maybe Integer) |
Instances
newDetectedProperties :: DetectedProperties Source #
Create a value of DetectedProperties with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:height:DetectedProperties', detectedProperties_height - The detected height of the input file, in pixels.
$sel:frameRate:DetectedProperties', detectedProperties_frameRate - The detected frame rate of the input file, in frames per second.
$sel:fileSize:DetectedProperties', detectedProperties_fileSize - The detected file size of the input file, in bytes.
$sel:width:DetectedProperties', detectedProperties_width - The detected width of the input file, in pixels.
$sel:durationMillis:DetectedProperties', detectedProperties_durationMillis - The detected duration of the input file, in milliseconds.
Encryption
data Encryption Source #
The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.
See: newEncryption smart constructor.
Instances
newEncryption :: Encryption Source #
Create a value of Encryption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mode:Encryption', encryption_mode - The specific server-side encryption mode that you want Elastic
Transcoder to use when decrypting your input files or encrypting your
output files. Elastic Transcoder supports the following options:
- s3: Amazon S3 creates and manages the keys used for encrypting your files.
- s3-aws-kms: Amazon S3 calls the Amazon Key Management Service,
which creates and manages the keys that are used for encrypting your
files. If you specify
s3-aws-kmsand you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline. - aes-cbc-pkcs7: A padded cipher-block mode of operation originally used for HLS files.
- aes-ctr: AES Counter Mode.
- aes-gcm: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
- Key
- Key MD5
- Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
$sel:keyMd5:Encryption', encryption_keyMd5 - The MD5 digest of the key that you used to encrypt your input file, or
that you want Elastic Transcoder to use to encrypt your output file.
Elastic Transcoder uses the key digest as a checksum to make sure your
key was not corrupted in transit. The key MD5 must be base64-encoded,
and it must be exactly 16 bytes long before being base64-encoded.
$sel:key:Encryption', encryption_key - The data encryption key that you want Elastic Transcoder to use to
encrypt your output file, or that was used to encrypt your input file.
The key must be base64-encoded and it must be one of the following bit
lengths before being base64-encoded:
128, 192, or 256.
The key must also be encrypted by using the Amazon Key Management Service.
$sel:initializationVector:Encryption', encryption_initializationVector - The series of random bits created by a random bit generator, unique for
every encryption operation, that you used to encrypt your input files or
that you want Elastic Transcoder to use to encrypt your output files.
The initialization vector must be base64-encoded, and it must be exactly
16 bytes long before being base64-encoded.
HlsContentProtection
data HlsContentProtection Source #
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.
See: newHlsContentProtection smart constructor.
Constructors
| HlsContentProtection' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newHlsContentProtection :: HlsContentProtection Source #
Create a value of HlsContentProtection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyMd5:HlsContentProtection', hlsContentProtection_keyMd5 - If Elastic Transcoder is generating your key for you, you must leave
this field blank.
The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
$sel:keyStoragePolicy:HlsContentProtection', hlsContentProtection_keyStoragePolicy - Specify whether you want Elastic Transcoder to write your HLS license
key to an Amazon S3 bucket. If you choose WithVariantPlaylists,
LicenseAcquisitionUrl must be left blank and Elastic Transcoder writes
your data key into the same bucket as the associated playlist.
$sel:key:HlsContentProtection', hlsContentProtection_key - If you want Elastic Transcoder to generate a key for you, leave this
field blank.
If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
128, 192, or 256.
$sel:method:HlsContentProtection', hlsContentProtection_method - The content protection method for your output. The only valid value is:
aes-128.
This value is written into the method attribute of the EXT-X-KEY
metadata tag in the output playlist.
$sel:initializationVector:HlsContentProtection', hlsContentProtection_initializationVector - If Elastic Transcoder is generating your key for you, you must leave
this field blank.
The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
$sel:licenseAcquisitionUrl:HlsContentProtection', hlsContentProtection_licenseAcquisitionUrl - The location of the license key required to decrypt your HLS playlist.
The URL must be an absolute path, and is referenced in the URI attribute
of the EXT-X-KEY metadata tag in the playlist file.
InputCaptions
data InputCaptions Source #
The captions to be created, if any.
See: newInputCaptions smart constructor.
Constructors
| InputCaptions' (Maybe Text) (Maybe [CaptionSource]) |
Instances
newInputCaptions :: InputCaptions Source #
Create a value of InputCaptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mergePolicy:InputCaptions', inputCaptions_mergePolicy - A policy that determines how Elastic Transcoder handles the existence of
multiple captions.
- MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
- MergeRetain: Elastic Transcoder transcodes both embedded and
sidecar captions into outputs. If captions for a language are
embedded in the input file and also appear in a sidecar file,
Elastic Transcoder uses the embedded captions and ignores the
sidecar captions for that language. If
CaptionSourcesis empty, Elastic Transcoder omits all sidecar captions from the output files. - Override: Elastic Transcoder transcodes only the sidecar
captions that you specify in
CaptionSources.
MergePolicy cannot be null.
$sel:captionSources:InputCaptions', inputCaptions_captionSources - Source files for the input sidecar captions used during the transcoding
process. To omit all sidecar captions, leave CaptionSources blank.
Job
A section of the response body that provides information about the job that is created.
See: newJob smart constructor.
Constructors
| Job' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [JobInput]) (Maybe JobInput) (Maybe (HashMap Text Text)) (Maybe [JobOutput]) (Maybe JobOutput) (Maybe Text) (Maybe [Playlist]) (Maybe Text) (Maybe Timing) |
Instances
Create a value of Job with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:Job', job_status - The status of the job: Submitted, Progressing, Complete,
Canceled, or Error.
$sel:pipelineId:Job', job_pipelineId - The Id of the pipeline that you want Elastic Transcoder to use for
transcoding. The pipeline determines several settings, including the
Amazon S3 bucket from which Elastic Transcoder gets the files to
transcode and the bucket into which Elastic Transcoder puts the
transcoded files.
$sel:arn:Job', job_arn - The Amazon Resource Name (ARN) for the job.
$sel:inputs:Job', job_inputs - Information about the files that you're transcoding. If you specified
multiple files for this job, Elastic Transcoder stitches the files
together to make one output.
$sel:input:Job', job_input - A section of the request or response body that provides information
about the file that is being transcoded.
$sel:userMetadata:Job', job_userMetadata - User-defined metadata that you want to associate with an Elastic
Transcoder job. You specify metadata in key/value pairs, and you can
add up to 10 key/value pairs per job. Elastic Transcoder does not
guarantee that key/value pairs are returned in the same order in
which you specify them.
Metadata keys and values must use characters from the following
list:
0-9
A-Zanda-zSpace
- The following symbols:
_.:/=+-%@
$sel:outputs:Job', job_outputs - Information about the output files. We recommend that you use the
Outputs syntax for all jobs, even when you want Elastic Transcoder to
transcode a file into only one format. Do not use both the Outputs and
Output syntaxes in the same request. You can create a maximum of 30
outputs per job.
If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
$sel:output:Job', job_output - If you specified one output for a job, information about that output. If
you specified multiple outputs for a job, the Output object lists
information about the first output. This duplicates the information that
is listed for the first output in the Outputs object.
Outputs recommended instead.
A section of the request or response body that provides information about the transcoded (target) file.
$sel:id:Job', job_id - The identifier that Elastic Transcoder assigned to the job. You use this
value to get settings for the job or to delete the job.
$sel:playlists:Job', job_playlists - Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in PresetId for which the value of Container
is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains
information about the master playlists that you want Elastic Transcoder
to create.
The maximum number of master playlists in a job is 30.
$sel:outputKeyPrefix:Job', job_outputKeyPrefix - The value, if any, that you want Elastic Transcoder to prepend to the
names of all files that this job creates, including output files,
thumbnails, and playlists. We recommend that you add a / or some other
delimiter to the end of the OutputKeyPrefix.
$sel:timing:Job', job_timing - Details about the timing of a job.
JobAlbumArt
data JobAlbumArt Source #
The .jpg or .png file associated with an audio file.
See: newJobAlbumArt smart constructor.
Constructors
| JobAlbumArt' (Maybe Text) (Maybe [Artwork]) |
Instances
newJobAlbumArt :: JobAlbumArt Source #
Create a value of JobAlbumArt with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:mergePolicy:JobAlbumArt', jobAlbumArt_mergePolicy - A policy that determines how Elastic Transcoder handles the existence of
multiple album artwork files.
Replace:The specified album art replaces any existing album art.Prepend:The specified album art is placed in front of any existing album art.Append:The specified album art is placed after any existing album art.Fallback:If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file.
$sel:artwork:JobAlbumArt', jobAlbumArt_artwork - The file to be used as album art. There can be multiple artworks
associated with an audio file, to a maximum of 20. Valid formats are
.jpg and .png
JobInput
Information about the file that you're transcoding.
See: newJobInput smart constructor.
Constructors
| JobInput' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TimeSpan) (Maybe Encryption) (Maybe Text) (Maybe DetectedProperties) (Maybe Text) (Maybe Text) (Maybe InputCaptions) |
Instances
newJobInput :: JobInput Source #
Create a value of JobInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:frameRate:JobInput', jobInput_frameRate - The frame rate of the input file. If you want Elastic Transcoder to
automatically detect the frame rate of the input file, specify auto.
If you want to specify the frame rate for the input file, enter one of
the following values:
10, 15, 23.97, 24, 25, 29.97, 30, 60
If you specify a value other than auto, Elastic Transcoder disables
automatic detection of the frame rate.
$sel:resolution:JobInput', jobInput_resolution - This value must be auto, which causes Elastic Transcoder to
automatically detect the resolution of the input file.
$sel:aspectRatio:JobInput', jobInput_aspectRatio - The aspect ratio of the input file. If you want Elastic Transcoder to
automatically detect the aspect ratio of the input file, specify auto.
If you want to specify the aspect ratio for the output file, enter one
of the following values:
1:1, 4:3, 3:2, 16:9
If you specify a value other than auto, Elastic Transcoder disables
automatic detection of the aspect ratio.
$sel:timeSpan:JobInput', jobInput_timeSpan - Settings for clipping an input. Each input can have different clip
settings.
$sel:encryption:JobInput', jobInput_encryption - The encryption settings, if any, that are used for decrypting your input
files. If your input file is encrypted, you must specify the mode that
Elastic Transcoder uses to decrypt your file.
$sel:key:JobInput', jobInput_key - The name of the file to transcode. Elsewhere in the body of the JSON
block is the the ID of the pipeline to use for processing the job. The
InputBucket object in that pipeline tells Elastic Transcoder which
Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as cooking/lasagna.mpg,
include the prefix in the key. If the file isn't in the specified
bucket, Elastic Transcoder returns an error.
$sel:detectedProperties:JobInput', jobInput_detectedProperties - The detected properties of the input file.
$sel:container:JobInput', jobInput_container - The container type for the input file. If you want Elastic Transcoder to
automatically detect the container type of the input file, specify
auto. If you want to specify the container type for the input file,
enter one of the following values:
3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3,
mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm
$sel:interlaced:JobInput', jobInput_interlaced - Whether the input file is interlaced. If you want Elastic Transcoder to
automatically detect whether the input file is interlaced, specify
auto. If you want to specify whether the input file is interlaced,
enter one of the following values:
true, false
If you specify a value other than auto, Elastic Transcoder disables
automatic detection of interlacing.
$sel:inputCaptions:JobInput', jobInput_inputCaptions - You can configure Elastic Transcoder to transcode captions, or
subtitles, from one format to another. All captions must be in UTF-8.
Elastic Transcoder supports two types of captions:
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include:
CEA-608 (EIA-608, first non-empty channel only),CEA-708 (EIA-708, first non-empty channel only), andmov-textValid outputs include:
mov-textElastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp(first div element only),ebu-tt,scc,smpt,srt,ttml(first div element only), andwebvttValid outputs include:
dfxp(first div element only),scc,srt, andwebvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or leave the captions empty, set Captions to null.
To pass through existing captions unchanged, set the MergePolicy to
MergeRetain, and pass in a null CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
JobOutput
Outputs recommended instead.
If you specified one output for a job, information about that output. If
you specified multiple outputs for a job, the Output object lists
information about the first output. This duplicates the information that
is listed for the first output in the Outputs object.
See: newJobOutput smart constructor.
Constructors
| JobOutput' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Captions) (Maybe Text) (Maybe [Clip]) (Maybe JobAlbumArt) (Maybe Integer) (Maybe [JobWatermark]) (Maybe Int) (Maybe Encryption) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Encryption) (Maybe Integer) (Maybe Text) |
Instances
newJobOutput :: JobOutput Source #
Create a value of JobOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appliedColorSpaceConversion:JobOutput', jobOutput_appliedColorSpaceConversion - If Elastic Transcoder used a preset with a ColorSpaceConversionMode to
transcode the output file, the AppliedColorSpaceConversion parameter
shows the conversion used. If no ColorSpaceConversionMode was defined
in the preset, this parameter is not be included in the job response.
$sel:thumbnailPattern:JobOutput', jobOutput_thumbnailPattern - Whether you want Elastic Transcoder to create thumbnails for your videos
and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count}(Required): If you want to create thumbnails, you must include{count}in theThumbnailPatternobject. Wherever you specify{count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.If you specify a literal value and/or
{resolution}but you omit{count}, Elastic Transcoder returns a validation error and does not create the job.- Literal values (Optional): You can specify literal values
anywhere in the
ThumbnailPatternobject. For example, you can include them as a file name prefix or as a delimiter between{resolution}and{count}. {resolution}(Optional): If you want Elastic Transcoder to include the resolution in the file name, include{resolution}in theThumbnailPatternobject.
When creating thumbnails, Elastic Transcoder automatically saves the
files in the format (.jpg or .png) that appears in the preset that you
specified in the PresetID value of CreateJobOutput. Elastic
Transcoder also appends the applicable file name extension.
$sel:status:JobOutput', jobOutput_status - The status of one output in a job. If you specified only one output for
the job, Outputs:Status is always the same as Job:Status. If you
specified more than one output:
Job:StatusandOutputs:Statusfor all of the outputs is Submitted until Elastic Transcoder starts to process the first output.- When Elastic Transcoder starts to process the first output,
Outputs:Statusfor that output andJob:Statusboth change to Progressing. For each output, the value ofOutputs:Statusremains Submitted until Elastic Transcoder starts to process the output. - Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
- When all of the outputs reach a terminal status,
Job:Statuschanges to Complete only ifOutputs:Statusfor all of the outputs isComplete. IfOutputs:Statusfor one or more outputs isError, the terminal status forJob:Statusis alsoError.
The value of Status is one of the following: Submitted,
Progressing, Complete, Canceled, or Error.
$sel:height:JobOutput', jobOutput_height - Height of the output file, in pixels.
$sel:frameRate:JobOutput', jobOutput_frameRate - Frame rate of the output file, in frames per second.
$sel:captions:JobOutput', jobOutput_captions - You can configure Elastic Transcoder to transcode captions, or
subtitles, from one format to another. All captions must be in UTF-8.
Elastic Transcoder supports two types of captions:
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include:
CEA-608 (EIA-608, first non-empty channel only),CEA-708 (EIA-708, first non-empty channel only), andmov-textValid outputs include:
mov-textElastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp(first div element only),ebu-tt,scc,smpt,srt,ttml(first div element only), andwebvttValid outputs include:
dfxp(first div element only),scc,srt, andwebvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or leave the captions empty, set Captions to null.
To pass through existing captions unchanged, set the MergePolicy to
MergeRetain, and pass in a null CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
$sel:presetId:JobOutput', jobOutput_presetId - The value of the Id object for the preset that you want to use for
this job. The preset determines the audio, video, and thumbnail settings
that Elastic Transcoder uses for transcoding. To use a preset that you
created, specify the preset ID that Elastic Transcoder returned in the
response when you created the preset. You can also use the Elastic
Transcoder system presets, which you can get with ListPresets.
$sel:composition:JobOutput', jobOutput_composition - You can create an output file that contains an excerpt from the input
file. This excerpt, called a clip, can come from the beginning, middle,
or end of the file. The Composition object contains settings for the
clips that make up an output file. For the current release, you can only
specify settings for a single clip per output file. The Composition
object cannot be null.
$sel:albumArt:JobOutput', jobOutput_albumArt - The album art to be associated with the output file, if any.
$sel:fileSize:JobOutput', jobOutput_fileSize - File size of the output file, in bytes.
$sel:watermarks:JobOutput', jobOutput_watermarks - Information about the watermarks that you want Elastic Transcoder to add
to the video during transcoding. You can specify up to four watermarks
for each output. Settings for each watermark must be defined in the
preset that you specify in Preset for the current output.
Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add covers the first one, the third one covers the second, and the fourth one covers the third.
$sel:width:JobOutput', jobOutput_width - Specifies the width of the output file in pixels.
$sel:encryption:JobOutput', jobOutput_encryption - The encryption settings, if any, that you want Elastic Transcoder to
apply to your output files. If you choose to use encryption, you must
specify a mode to use. If you choose not to use encryption, Elastic
Transcoder writes an unencrypted file to your Amazon S3 bucket.
$sel:key:JobOutput', jobOutput_key - The name to assign to the transcoded file. Elastic Transcoder saves the
file in the Amazon S3 bucket specified by the OutputBucket object in
the pipeline that is specified by the pipeline ID.
$sel:statusDetail:JobOutput', jobOutput_statusDetail - Information that further explains Status.
$sel:id:JobOutput', jobOutput_id - A sequential counter, starting with 1, that identifies an output among
the outputs from the current job. In the Output syntax, this value is
always 1.
$sel:segmentDuration:JobOutput', jobOutput_segmentDuration - (Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in PresetId for which the value of Container
is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the
target maximum duration of each segment in seconds. For HLSv3 format
playlists, each media segment is stored in a separate .ts file. For
HLSv4, MPEG-DASH, and Smooth playlists, all media segments for an
output are stored in a single file. Each segment is approximately the
length of the SegmentDuration, though individual segments might be
shorter or longer.
The range of valid values is 1 to 60 seconds. If the duration of the
video is not evenly divisible by SegmentDuration, the duration of the
last segment is the remainder of total length/SegmentDuration.
Elastic Transcoder creates an output-specific playlist for each output
HLS output that you specify in OutputKeys. To add an output to the
master playlist for this job, include it in the OutputKeys of the
associated playlist.
$sel:durationMillis:JobOutput', jobOutput_durationMillis - Duration of the output file, in milliseconds.
$sel:thumbnailEncryption:JobOutput', jobOutput_thumbnailEncryption - The encryption settings, if any, that you want Elastic Transcoder to
apply to your thumbnail.
$sel:duration:JobOutput', jobOutput_duration - Duration of the output file, in seconds.
$sel:rotate:JobOutput', jobOutput_rotate - The number of degrees clockwise by which you want Elastic Transcoder to
rotate the output relative to the input. Enter one of the following
values:
auto, 0, 90, 180, 270
The value auto generally works only if the file that you're
transcoding contains rotation metadata.
JobWatermark
data JobWatermark Source #
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
See: newJobWatermark smart constructor.
Constructors
| JobWatermark' (Maybe Text) (Maybe Text) (Maybe Encryption) |
Instances
newJobWatermark :: JobWatermark Source #
Create a value of JobWatermark with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:presetWatermarkId:JobWatermark', jobWatermark_presetWatermarkId - The ID of the watermark settings that Elastic Transcoder uses to add
watermarks to the video during transcoding. The settings are in the
preset specified by Preset for the current output. In that preset, the
value of Watermarks Id tells Elastic Transcoder which settings to use.
$sel:inputKey:JobWatermark', jobWatermark_inputKey - The name of the .png or .jpg file that you want to use for the
watermark. To determine which Amazon S3 bucket contains the specified
file, Elastic Transcoder checks the pipeline specified by Pipeline;
the Input Bucket object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
$sel:encryption:JobWatermark', jobWatermark_encryption - The encryption settings, if any, that you want Elastic Transcoder to
apply to your watermarks.
Notifications
data Notifications Source #
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.
See: newNotifications smart constructor.
Instances
newNotifications :: Notifications Source #
Create a value of Notifications with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:Notifications', notifications_error - The Amazon SNS topic that you want to notify when Elastic Transcoder
encounters an error condition.
$sel:warning:Notifications', notifications_warning - The Amazon SNS topic that you want to notify when Elastic Transcoder
encounters a warning condition.
$sel:progressing:Notifications', notifications_progressing - The Amazon Simple Notification Service (Amazon SNS) topic that you want
to notify when Elastic Transcoder has started to process the job.
$sel:completed:Notifications', notifications_completed - The Amazon SNS topic that you want to notify when Elastic Transcoder has
finished processing the job.
Permission
data Permission Source #
The Permission structure.
See: newPermission smart constructor.
Instances
newPermission :: Permission Source #
Create a value of Permission with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:access:Permission', permission_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.
$sel:granteeType:Permission', permission_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, orLogDelivery.
$sel:grantee:Permission', permission_grantee - The AWS user or group that you want to have access to transcoded files
and playlists. To identify the user or group, you can specify the
canonical user ID for an AWS account, an origin access identity for a
CloudFront distribution, the registered email address of an AWS account,
or a predefined Amazon S3 group.
Pipeline
The pipeline (queue) that is used to manage jobs.
See: newPipeline smart constructor.
Constructors
| Pipeline' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PipelineOutputConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notifications) (Maybe PipelineOutputConfig) |
Instances
newPipeline :: Pipeline Source #
Create a value of Pipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:Pipeline', pipeline_status - The current status of the pipeline:
Active: The pipeline is processing jobs.Paused: The pipeline is not currently processing jobs.
$sel:arn:Pipeline', pipeline_arn - The Amazon Resource Name (ARN) for the pipeline.
$sel:inputBucket:Pipeline', pipeline_inputBucket - The Amazon S3 bucket from which Elastic Transcoder gets media files for
transcoding and the graphics files, if any, that you want to use for
watermarks.
$sel:contentConfig:Pipeline', pipeline_contentConfig - 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
Granteeobject: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, orLogDelivery.
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 inGrantee. 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 hasREAD,READ_ACP, andWRITE_ACPpermissions 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.
$sel:outputBucket:Pipeline', pipeline_outputBucket - The Amazon S3 bucket in which you want Elastic Transcoder to save
transcoded files, thumbnails, and playlists. Either you specify this
value, or you specify both ContentConfig and ThumbnailConfig.
$sel:role':Pipeline', pipeline_role - The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder
uses to transcode jobs for this pipeline.
$sel:name:Pipeline', pipeline_name - 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
$sel:awsKmsKeyArn:Pipeline', pipeline_awsKmsKeyArn - 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.
$sel:id:Pipeline', pipeline_id - 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.
$sel:notifications:Pipeline', pipeline_notifications - 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.
$sel:thumbnailConfig:Pipeline', pipeline_thumbnailConfig - 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, orLogDelivery.
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,StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
PipelineOutputConfig
data PipelineOutputConfig Source #
The PipelineOutputConfig structure.
See: newPipelineOutputConfig smart constructor.
Constructors
| PipelineOutputConfig' (Maybe Text) (Maybe Text) (Maybe [Permission]) |
Instances
newPipelineOutputConfig :: PipelineOutputConfig Source #
Create a value of PipelineOutputConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:PipelineOutputConfig', pipelineOutputConfig_bucket - 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.
$sel:storageClass:PipelineOutputConfig', pipelineOutputConfig_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.
$sel:permissions:PipelineOutputConfig', pipelineOutputConfig_permissions - 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.
PlayReadyDrm
data PlayReadyDrm Source #
The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
PlayReady DRM encrypts your media files using aes-ctr encryption.
If you use DRM for an HLSv3 playlist, your outputs must have a master
playlist.
See: newPlayReadyDrm smart constructor.
Constructors
| PlayReadyDrm' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newPlayReadyDrm :: PlayReadyDrm Source #
Create a value of PlayReadyDrm with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:PlayReadyDrm', playReadyDrm_keyId - The ID for your DRM key, so that your DRM license provider knows which
key to provide.
The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider.
$sel:format:PlayReadyDrm', playReadyDrm_format - The type of DRM, if any, that you want Elastic Transcoder to apply to
the output files associated with this playlist.
$sel:keyMd5:PlayReadyDrm', playReadyDrm_keyMd5 - The MD5 digest of the key used for DRM on your file, and that you want
Elastic Transcoder to use as a checksum to make sure your key was not
corrupted in transit. The key MD5 must be base64-encoded, and it must be
exactly 16 bytes before being base64-encoded.
$sel:key:PlayReadyDrm', playReadyDrm_key - The DRM key for your file, provided by your DRM license provider. The
key must be base64-encoded, and it must be one of the following bit
lengths before being base64-encoded:
128, 192, or 256.
The key must also be encrypted by using AWS KMS.
$sel:initializationVector:PlayReadyDrm', playReadyDrm_initializationVector - The series of random bits created by a random bit generator, unique for
every encryption operation, that you want Elastic Transcoder to use to
encrypt your files. The initialization vector must be base64-encoded,
and it must be exactly 8 bytes long before being base64-encoded. If no
initialization vector is provided, Elastic Transcoder generates one for
you.
$sel:licenseAcquisitionUrl:PlayReadyDrm', playReadyDrm_licenseAcquisitionUrl - The location of the license key required to play DRM content. The URL
must be an absolute path, and is referenced by the PlayReady header. The
PlayReady header is referenced in the protection header of the client
manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and
EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example URL
looks like this: https://www.example.com/exampleKey/
Playlist
Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset
for which the value of Container is fmp4 (Fragmented MP4) or ts
(MPEG-TS), Playlists contains information about the master playlists
that you want Elastic Transcoder to create. We recommend that you create
only one master playlist per output format. The maximum number of master
playlists in a job is 30.
See: newPlaylist smart constructor.
Constructors
| Playlist' (Maybe Text) (Maybe PlayReadyDrm) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe HlsContentProtection) |
Instances
newPlaylist :: Playlist Source #
Create a value of Playlist with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:Playlist', playlist_status - The status of the job with which the playlist is associated.
$sel:playReadyDrm:Playlist', playlist_playReadyDrm - The DRM settings, if any, that you want Elastic Transcoder to apply to
the output files associated with this playlist.
$sel:format:Playlist', playlist_format - The format of the output playlist. Valid formats include HLSv3,
HLSv4, and Smooth.
$sel:outputKeys:Playlist', playlist_outputKeys - For each output in this job that you want to include in a master
playlist, the value of the Outputs:Key object.
If your output is not
HLSor does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefixandOutputs:Key:OutputKeyPrefix
Outputs:KeyIf your output is
HLSv3and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8, and a series of.tsfiles that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key.m3u8OutputKeyPrefix
Outputs:Key00000.tsIf your output is
HLSv4, has a segment duration set, and is included in anHLSv4playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8:OutputKeyPrefix
Outputs:Key_v4.m3u8OutputKeyPrefix
Outputs:Key_iframe.m3u8OutputKeyPrefix
Outputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration
settings, clip settings, or caption settings must be the same for all
outputs in the playlist. For Smooth playlists, the Audio:Profile,
Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio
must be the same for all outputs.
$sel:name:Playlist', playlist_name - The name that you want Elastic Transcoder to assign to the master
playlist, for example, nyc-vacation.m3u8. If the name includes a /
character, the section of the name before the last / must be
identical for all Name objects. If you create more than one master
playlist, the values of all Name objects must be unique.
Elastic Transcoder automatically appends the relevant file extension to
the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and
.ismc for Smooth playlists). If you include a file extension in
Name, the file name will have two extensions.
$sel:statusDetail:Playlist', playlist_statusDetail - Information that further explains the status.
$sel:hlsContentProtection:Playlist', playlist_hlsContentProtection - The HLS content protection settings, if any, that you want Elastic
Transcoder to apply to the output files associated with this playlist.
Preset
Presets are templates that contain most of the settings for transcoding media files from one format to another. Elastic Transcoder includes some default presets for common formats, for example, several iPod and iPhone versions. You can also create your own presets for formats that aren't included among the default presets. You specify which preset you want to use when you create a job.
See: newPreset smart constructor.
Constructors
| Preset' (Maybe Text) (Maybe VideoParameters) (Maybe Thumbnails) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AudioParameters) |
Instances
Create a value of Preset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Preset', preset_arn - The Amazon Resource Name (ARN) for the preset.
$sel:video:Preset', preset_video - A section of the response body that provides information about the video
preset values.
$sel:thumbnails:Preset', preset_thumbnails - A section of the response body that provides information about the
thumbnail preset values, if any.
$sel:name:Preset', preset_name - The name of the preset.
$sel:container:Preset', preset_container - The container type for the output file. Valid values include flac,
flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts,
and webm.
$sel:id:Preset', preset_id - Identifier for the new preset. You use this value to get settings for
the preset or to delete it.
$sel:type':Preset', preset_type - Whether the preset is a default preset provided by Elastic Transcoder
(System) or a preset that you have defined (Custom).
$sel:description:Preset', preset_description - A description of the preset.
$sel:audio:Preset', preset_audio - A section of the response body that provides information about the audio
preset values.
PresetWatermark
data PresetWatermark Source #
Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
See: newPresetWatermark smart constructor.
Constructors
| PresetWatermark' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newPresetWatermark :: PresetWatermark Source #
Create a value of PresetWatermark with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:verticalAlign:PresetWatermark', presetWatermark_verticalAlign - The vertical position of the watermark unless you specify a non-zero
value for VerticalOffset:
- Top: The top edge of the watermark is aligned with the top border of the video.
- Bottom: The bottom edge of the watermark is aligned with the bottom border of the video.
- Center: The watermark is centered between the top and bottom borders.
$sel:sizingPolicy:PresetWatermark', presetWatermark_sizingPolicy - A value that controls scaling of the watermark:
- Fit: Elastic Transcoder scales the watermark so it matches the
value that you specified in either
MaxWidthorMaxHeightwithout exceeding the other value. - Stretch: Elastic Transcoder stretches the watermark to match the
values that you specified for
MaxWidthandMaxHeight. If the relative proportions of the watermark and the values ofMaxWidthandMaxHeightare different, the watermark will be distorted. - ShrinkToFit: Elastic Transcoder scales the watermark down so
that its dimensions match the values that you specified for at least
one of
MaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up.
$sel:horizontalOffset:PresetWatermark', presetWatermark_horizontalOffset - The amount by which you want the horizontal position of the watermark to
be offset from the position specified by HorizontalAlign:
- number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth.
- integer percentage (%): The range of valid values is 0 to 100.
For example, if you specify Left for HorizontalAlign and 5px for
HorizontalOffset, the left side of the watermark appears 5 pixels from
the left border of the output video.
HorizontalOffset is only valid when the value of HorizontalAlign is
Left or Right. If you specify an offset that causes the watermark to
extend beyond the left or right border and Elastic Transcoder has not
added black bars, the watermark is cropped. If Elastic Transcoder has
added black bars, the watermark extends into the black bars. If the
watermark extends beyond the black bars, it is cropped.
Use the value of Target to specify whether you want to include the
black bars that are added by Elastic Transcoder, if any, in the offset
calculation.
$sel:maxHeight:PresetWatermark', presetWatermark_maxHeight - The maximum height of the watermark in one of the following formats:
- number of pixels (px): The minimum value is 16 pixels, and the
maximum value is the value of
MaxHeight. - integer percentage (%): The range of valid values is 0 to 100. Use
the value of
Targetto specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.
If you specify the value in pixels, it must be less than or equal to the
value of MaxHeight.
$sel:opacity:PresetWatermark', presetWatermark_opacity - A percentage that indicates how much you want a watermark to obscure the
video in the location where it appears. Valid values are 0 (the
watermark is invisible) to 100 (the watermark completely obscures the
video in the specified location). The datatype of Opacity is float.
Elastic Transcoder supports transparent .png graphics. If you use a
transparent .png, the transparent portion of the video appears as if you
had specified a value of 0 for Opacity. The .jpg file format doesn't
support transparency.
$sel:verticalOffset:PresetWatermark', presetWatermark_verticalOffset - VerticalOffset
The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:
- number of pixels (px): The minimum value is 0 pixels, and the
maximum value is the value of
MaxHeight. - integer percentage (%): The range of valid values is 0 to 100.
For example, if you specify Top for VerticalAlign and 5px for
VerticalOffset, the top of the watermark appears 5 pixels from the top
border of the output video.
VerticalOffset is only valid when the value of VerticalAlign is Top or
Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.
Use the value of Target to specify whether you want Elastic Transcoder
to include the black bars that are added by Elastic Transcoder, if any,
in the offset calculation.
$sel:maxWidth:PresetWatermark', presetWatermark_maxWidth - The maximum width of the watermark in one of the following formats:
- number of pixels (px): The minimum value is 16 pixels, and the
maximum value is the value of
MaxWidth. integer percentage (%): The range of valid values is 0 to 100. Use the value of
Targetto specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.If you specify the value in pixels, it must be less than or equal to the value of
MaxWidth.
$sel:id:PresetWatermark', presetWatermark_id - A unique identifier for the settings for one watermark. The value of
Id can be up to 40 characters long.
$sel:horizontalAlign:PresetWatermark', presetWatermark_horizontalAlign - The horizontal position of the watermark unless you specify a non-zero
value for HorizontalOffset:
- Left: The left edge of the watermark is aligned with the left border of the video.
- Right: The right edge of the watermark is aligned with the right border of the video.
- Center: The watermark is centered between the left and right borders.
$sel:target:PresetWatermark', presetWatermark_target - A value that determines how Elastic Transcoder interprets values that
you specified for HorizontalOffset, VerticalOffset, MaxWidth, and
MaxHeight:
- Content:
HorizontalOffsetandVerticalOffsetvalues are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition,MaxWidthandMaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. - Frame:
HorizontalOffsetandVerticalOffsetvalues are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. In addition,MaxWidthandMaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.
Thumbnails
data Thumbnails Source #
Thumbnails for videos.
See: newThumbnails smart constructor.
Constructors
| Thumbnails' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newThumbnails :: Thumbnails Source #
Create a value of Thumbnails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sizingPolicy:Thumbnails', thumbnails_sizingPolicy - Specify one of the following values to control scaling of thumbnails:
Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value.Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnailMaxWidthorMaxHeightsettings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnailMaxWidthandMaxHeightsettings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnailMaxWidthandMaxHeightsettings, Elastic Transcoder crops the thumbnails.ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnailMaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
$sel:format:Thumbnails', thumbnails_format - The format of thumbnails, if any. Valid values are jpg and png.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
$sel:maxHeight:Thumbnails', thumbnails_maxHeight - The maximum height of thumbnails in pixels. If you specify auto, Elastic
Transcoder uses 1080 (Full HD) as the default value. If you specify a
numeric value, enter an even integer between 32 and 3072.
$sel:resolution:Thumbnails', thumbnails_resolution - To better control resolution and aspect ratio of thumbnails, we
recommend that you use the values MaxWidth, MaxHeight,
SizingPolicy, and PaddingPolicy instead of Resolution and
AspectRatio. The two groups of settings are mutually exclusive. Do not
use them together.
The width and height of thumbnail files in pixels. Specify a value in
the format width x height where both values are even integers.
The values cannot exceed the width and height that you specified in the
Video:Resolution object.
$sel:aspectRatio:Thumbnails', thumbnails_aspectRatio - To better control resolution and aspect ratio of thumbnails, we
recommend that you use the values MaxWidth, MaxHeight,
SizingPolicy, and PaddingPolicy instead of Resolution and
AspectRatio. The two groups of settings are mutually exclusive. Do not
use them together.
The aspect ratio of thumbnails. Valid values include:
auto, 1:1, 4:3, 3:2, 16:9
If you specify auto, Elastic Transcoder tries to preserve the aspect
ratio of the video in the output file.
$sel:paddingPolicy:Thumbnails', thumbnails_paddingPolicy - When you set PaddingPolicy to Pad, Elastic Transcoder may add black
bars to the top and bottom and/or left and right sides of thumbnails to
make the total size of the thumbnails match the values that you
specified for thumbnail MaxWidth and MaxHeight settings.
$sel:interval:Thumbnails', thumbnails_interval - The approximate number of seconds between thumbnails. Specify an integer
value.
$sel:maxWidth:Thumbnails', thumbnails_maxWidth - The maximum width of thumbnails in pixels. If you specify auto, Elastic
Transcoder uses 1920 (Full HD) as the default value. If you specify a
numeric value, enter an even integer between 32 and 4096.
TimeSpan
Settings that determine when a clip begins and how long it lasts.
See: newTimeSpan smart constructor.
Instances
| Eq TimeSpan Source # | |
| Read TimeSpan Source # | |
| Show TimeSpan Source # | |
| Generic TimeSpan Source # | |
| NFData TimeSpan Source # | |
Defined in Amazonka.ElasticTranscoder.Types.TimeSpan | |
| Hashable TimeSpan Source # | |
Defined in Amazonka.ElasticTranscoder.Types.TimeSpan | |
| ToJSON TimeSpan Source # | |
Defined in Amazonka.ElasticTranscoder.Types.TimeSpan | |
| FromJSON TimeSpan Source # | |
| type Rep TimeSpan Source # | |
Defined in Amazonka.ElasticTranscoder.Types.TimeSpan type Rep TimeSpan = D1 ('MetaData "TimeSpan" "Amazonka.ElasticTranscoder.Types.TimeSpan" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "TimeSpan'" 'PrefixI 'True) (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newTimeSpan :: TimeSpan Source #
Create a value of TimeSpan with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:TimeSpan', timeSpan_startTime - The place in the input file where you want a clip to start. The format
can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is
thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you
don't specify a value, Elastic Transcoder starts at the beginning of
the input file.
$sel:duration:TimeSpan', timeSpan_duration - The duration of the clip. The format can be either HH:mm:ss.SSS (maximum
value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS
(maximum value: 86399.999). If you don't specify a value, Elastic
Transcoder creates an output file from StartTime to the end of the file.
If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.
Timing
Details about the timing of a job.
See: newTiming smart constructor.
Instances
| Eq Timing Source # | |
| Read Timing Source # | |
| Show Timing Source # | |
| Generic Timing Source # | |
| NFData Timing Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Timing | |
| Hashable Timing Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Timing | |
| FromJSON Timing Source # | |
| type Rep Timing Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Timing type Rep Timing = D1 ('MetaData "Timing" "Amazonka.ElasticTranscoder.Types.Timing" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "Timing'" 'PrefixI 'True) (S1 ('MetaSel ('Just "submitTimeMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "finishTimeMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "startTimeMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) | |
Create a value of Timing with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeMillis:Timing', timing_submitTimeMillis - The time the job was submitted to Elastic Transcoder, in epoch
milliseconds.
$sel:finishTimeMillis:Timing', timing_finishTimeMillis - The time the job finished transcoding, in epoch milliseconds.
$sel:startTimeMillis:Timing', timing_startTimeMillis - The time the job began transcoding, in epoch milliseconds.
VideoParameters
data VideoParameters Source #
The VideoParameters structure.
See: newVideoParameters smart constructor.
Constructors
| VideoParameters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [PresetWatermark]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) |
Instances
newVideoParameters :: VideoParameters Source #
Create a value of VideoParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyframesMaxDist:VideoParameters', videoParameters_keyframesMaxDist - Applicable only when the value of Video:Codec is one of H.264,
MPEG2, or VP8.
The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.
For Smooth outputs, the FrameRate must have a constant ratio to the
KeyframesMaxDist. This allows Smooth playlists to switch between
different quality levels while the file is being played.
For example, an input file can have a FrameRate of 30 with a
KeyframesMaxDist of 90. The output file then needs to have a ratio of
1:3. Valid outputs would have FrameRate of 30, 25, and 10, and
KeyframesMaxDist of 90, 75, and 30, respectively.
Alternately, this can be achieved by setting FrameRate to auto and
having the same values for MaxFrameRate and KeyframesMaxDist.
$sel:frameRate:VideoParameters', videoParameters_frameRate - The frames per second for the video stream in the output file. Valid
values include:
auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60
If you specify auto, Elastic Transcoder uses the detected frame rate
of the input source. If you specify a frame rate, we recommend that you
perform the following calculation:
Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)
where:
- width in pixels and height in pixels represent the Resolution of the output video.
- maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
- 1 - 380160
- 1b - 380160
- 1.1 - 76800
- 1.2 - 1536000
- 1.3 - 3041280
- 2 - 3041280
- 2.1 - 5068800
- 2.2 - 5184000
- 3 - 10368000
- 3.1 - 27648000
- 3.2 - 55296000
- 4 - 62914560
- 4.1 - 62914560
$sel:sizingPolicy:VideoParameters', videoParameters_sizingPolicy - Specify one of the following values to control scaling of the output
video:
Fit: Elastic Transcoder scales the output video so it matches the value that you specified in eitherMaxWidthorMaxHeightwithout exceeding the other value.Fill: Elastic Transcoder scales the output video so it matches the value that you specified in eitherMaxWidthorMaxHeightand matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value.Stretch: Elastic Transcoder stretches the output video to match the values that you specified forMaxWidthandMaxHeight. If the relative proportions of the input video and the output video are different, the output video will be distorted.Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified forMaxWidthandMaxHeight, Elastic Transcoder crops the output video.ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up.ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.
$sel:maxFrameRate:VideoParameters', videoParameters_maxFrameRate - If you specify auto for FrameRate, Elastic Transcoder uses the frame
rate of the input video for the frame rate of the output video. Specify
the maximum frame rate that you want Elastic Transcoder to use when the
frame rate of the input video is greater than the desired maximum frame
rate of the output video. Valid values include: 10, 15, 23.97,
24, 25, 29.97, 30, 60.
$sel:maxHeight:VideoParameters', videoParameters_maxHeight - The maximum height of the output video in pixels. If you specify auto,
Elastic Transcoder uses 1080 (Full HD) as the default value. If you
specify a numeric value, enter an even integer between 96 and 3072.
$sel:watermarks:VideoParameters', videoParameters_watermarks - Settings for the size, location, and opacity of graphics that you want
Elastic Transcoder to overlay over videos that are transcoded using this
preset. You can specify settings for up to four watermarks. Watermarks
appear in the specified size and location, and with the specified
opacity for the duration of the transcoded video.
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
$sel:displayAspectRatio:VideoParameters', videoParameters_displayAspectRatio - The value that Elastic Transcoder adds to the metadata in the output
file.
$sel:resolution:VideoParameters', videoParameters_resolution - To better control resolution and aspect ratio of output videos, we
recommend that you use the values MaxWidth, MaxHeight,
SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of
Resolution and AspectRatio. The two groups of settings are mutually
exclusive. Do not use them together.
The width and height of the video in the output file, in pixels. Valid
values are auto and width x height:
auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules.width x height: The width and height of the output video in pixels.
Note the following about specifying the width and height:
- The width must be an even integer between 128 and 4096, inclusive.
- The height must be an even integer between 96 and 3072, inclusive.
- If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.
- If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.
We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value):
- 1 - 25344
- 1b - 25344
- 1.1 - 101376
- 1.2 - 101376
- 1.3 - 101376
- 2 - 101376
- 2.1 - 202752
- 2.2 - 404720
- 3 - 404720
- 3.1 - 921600
- 3.2 - 1310720
- 4 - 2097152
- 4.1 - 2097152
$sel:codec:VideoParameters', videoParameters_codec - The video codec for the output file. Valid values include gif,
H.264, mpeg2, vp8, and vp9. You can only specify vp8 and vp9
when the container type is webm, gif when the container type is
gif, and mpeg2 when the container type is mpg.
$sel:aspectRatio:VideoParameters', videoParameters_aspectRatio - To better control resolution and aspect ratio of output videos, we
recommend that you use the values MaxWidth, MaxHeight,
SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of
Resolution and AspectRatio. The two groups of settings are mutually
exclusive. Do not use them together.
The display aspect ratio of the video in the output file. Valid values include:
auto, 1:1, 4:3, 3:2, 16:9
If you specify auto, Elastic Transcoder tries to preserve the aspect
ratio of the input file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.
$sel:paddingPolicy:VideoParameters', videoParameters_paddingPolicy - When you set PaddingPolicy to Pad, Elastic Transcoder may add black
bars to the top and bottom and/or left and right sides of the output
video to make the total size of the output video match the values that
you specified for MaxWidth and MaxHeight.
$sel:maxWidth:VideoParameters', videoParameters_maxWidth - The maximum width of the output video in pixels. If you specify auto,
Elastic Transcoder uses 1920 (Full HD) as the default value. If you
specify a numeric value, enter an even integer between 128 and 4096.
$sel:bitRate:VideoParameters', videoParameters_bitRate - The bit rate of the video stream in the output file, in
kilobits/second. Valid values depend on the values of Level and
Profile. If you specify auto, Elastic Transcoder uses the detected
bit rate of the input source. If you specify a value other than auto,
we recommend that you specify a value less than or equal to the maximum
H.264-compliant value listed for your level and profile:
/Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)/
- 1 - 64 : 80
- 1b - 128 : 160
- 1.1 - 192 : 240
- 1.2 - 384 : 480
- 1.3 - 768 : 960
- 2 - 2000 : 2500
- 3 - 10000 : 12500
- 3.1 - 14000 : 17500
- 3.2 - 20000 : 25000
- 4 - 20000 : 25000
- 4.1 - 50000 : 62500
$sel:fixedGOP:VideoParameters', videoParameters_fixedGOP - Applicable only when the value of Video:Codec is one of H.264,
MPEG2, or VP8.
Whether to use a fixed value for FixedGOP. Valid values are true and
false:
true: Elastic Transcoder uses the value ofKeyframesMaxDistfor the distance between key frames (the number of frames in a group of pictures, or GOP).false: The distance between key frames can vary.
FixedGOP must be set to true for fmp4 containers.
$sel:codecOptions:VideoParameters', videoParameters_codecOptions - Profile (H.264/VP8/VP9 Only)
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
baseline: The profile most commonly used for videoconferencing and for mobile applications.main: The profile used for standard-definition digital TV broadcasts.high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.
Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2,
4, 4.1
MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)
where Width in pixels and Height in pixels represent either MaxWidth
and MaxHeight, or Resolution. /Maximum decoded picture buffer in
macroblocks/ depends on the value of the Level object. See the list
below. (A macroblock is a block of pixels measuring 16x16.)
- 1 - 396
- 1b - 396
- 1.1 - 900
- 1.2 - 2376
- 1.3 - 2376
- 2 - 2376
- 2.1 - 4752
- 2.2 - 8100
- 3 - 8100
- 3.1 - 18000
- 3.2 - 20480
- 4 - 32768
- 4.1 - 32768
MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)
The maximum number of bits per second in a video buffer; the size of the
buffer is specified by BufferSize. Specify a value between 16 and
62,500. You can reduce the bandwidth required to stream a video by
reducing the maximum bit rate, but this also reduces the quality of the
video.
BufferSize (Optional, H.264/MPEG2/VP8/VP9 only)
The maximum number of bits in any x seconds of the output video. This
window is commonly 10 seconds, the standard segment duration when
you're using FMP4 or MPEG-TS for the container type of the output
video. Specify an integer greater than 0. If you specify MaxBitRate
and omit BufferSize, Elastic Transcoder sets BufferSize to 10 times
the value of MaxBitRate.
InterlacedMode (Optional, H.264/MPEG2 Only)
The interlace mode for the output video.
Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.
Valid values include Progressive (no interlacing, top to bottom),
TopFirst (top field first), BottomFirst (bottom field first), and
Auto.
If InterlaceMode is not specified, Elastic Transcoder uses
Progressive for the output. If Auto is specified, Elastic Transcoder
interlaces the output.
ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)
The color space conversion Elastic Transcoder applies to the output
video. Color spaces are the algorithms used by the computer to store
information about how to render color. Bt.601 is the standard for
standard definition video, while Bt.709 is the standard for high
definition video.
Valid values include None, Bt709toBt601, Bt601toBt709, and Auto.
If you chose Auto for ColorSpaceConversionMode and your output is
interlaced, your frame rate is one of 23.97, 24, 25, 29.97,
50, or 60, your SegmentDuration is null, and you are using one of
the resolution changes from the list below, Elastic Transcoder applies
the following color space conversions:
- Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies
Bt601ToBt709 - Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies
Bt601ToBt709 - HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies
Bt709ToBt601 - HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies
Bt709ToBt601
Elastic Transcoder may change the behavior of the
ColorspaceConversionMode Auto mode in the future. All outputs in a
playlist must use the same ColorSpaceConversionMode.
If you do not specify a ColorSpaceConversionMode, Elastic Transcoder
does not change the color space of a file. If you are unsure what
ColorSpaceConversionMode was applied to your output file, you can
check the AppliedColorSpaceConversion parameter included in your job
response. If your job does not have an AppliedColorSpaceConversion in
its response, no ColorSpaceConversionMode was applied.
ChromaSubsampling
The sampling pattern for the chroma (color) channels of the output
video. Valid values include yuv420p and yuv422p.
yuv420p samples the chroma information of every other horizontal and
every other vertical line, yuv422p samples the color information of
every horizontal line and every other vertical line.
LoopCount (Gif Only)
The number of times you want the output gif to loop. Valid values
include Infinite and integers between 0 and 100, inclusive.
Warning
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.
See: newWarning smart constructor.
Instances
| Eq Warning Source # | |
| Read Warning Source # | |
| Show Warning Source # | |
| Generic Warning Source # | |
| NFData Warning Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Warning | |
| Hashable Warning Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Warning | |
| FromJSON Warning Source # | |
| type Rep Warning Source # | |
Defined in Amazonka.ElasticTranscoder.Types.Warning type Rep Warning = D1 ('MetaData "Warning" "Amazonka.ElasticTranscoder.Types.Warning" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "Warning'" 'PrefixI 'True) (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newWarning :: Warning Source #
Create a value of Warning with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:Warning', warning_code - The code of the cross-regional warning.
$sel:message:Warning', warning_message - 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.