The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::ElasticTranscoder - Perl Interface to AWS Amazon Elastic Transcoder

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ElasticTranscoder');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Elastic Transcoder Service

The AWS Elastic Transcoder Service.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elastictranscoder-2012-09-25

METHODS

CancelJob

Id => Str

Each argument is described in detail in: Paws::ElasticTranscoder::CancelJob

Returns: a Paws::ElasticTranscoder::CancelJobResponse instance

The CancelJob operation cancels an unfinished job.

You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

CreateJob

PipelineId => Str
[Input => Paws::ElasticTranscoder::JobInput]
[Inputs => ArrayRef[Paws::ElasticTranscoder::JobInput]]
[Output => Paws::ElasticTranscoder::CreateJobOutput]
[OutputKeyPrefix => Str]
[Outputs => ArrayRef[Paws::ElasticTranscoder::CreateJobOutput]]
[Playlists => ArrayRef[Paws::ElasticTranscoder::CreateJobPlaylist]]
[UserMetadata => Paws::ElasticTranscoder::UserMetadata]

Each argument is described in detail in: Paws::ElasticTranscoder::CreateJob

Returns: a Paws::ElasticTranscoder::CreateJobResponse instance

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

CreatePipeline

InputBucket => Str
Name => Str
Role => Str
[AwsKmsKeyArn => Str]
[ContentConfig => Paws::ElasticTranscoder::PipelineOutputConfig]
[Notifications => Paws::ElasticTranscoder::Notifications]
[OutputBucket => Str]
[ThumbnailConfig => Paws::ElasticTranscoder::PipelineOutputConfig]

Each argument is described in detail in: Paws::ElasticTranscoder::CreatePipeline

Returns: a Paws::ElasticTranscoder::CreatePipelineResponse instance

The CreatePipeline operation creates a pipeline with settings that you specify.

CreatePreset

Container => Str
Name => Str
[Audio => Paws::ElasticTranscoder::AudioParameters]
[Description => Str]
[Thumbnails => Paws::ElasticTranscoder::Thumbnails]
[Video => Paws::ElasticTranscoder::VideoParameters]

Each argument is described in detail in: Paws::ElasticTranscoder::CreatePreset

Returns: a Paws::ElasticTranscoder::CreatePresetResponse instance

The CreatePreset operation creates a preset with settings that you specify.

Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

DeletePipeline

Id => Str

Each argument is described in detail in: Paws::ElasticTranscoder::DeletePipeline

Returns: a Paws::ElasticTranscoder::DeletePipelineResponse instance

The DeletePipeline operation removes a pipeline.

You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error.

DeletePreset

Id => Str

Each argument is described in detail in: Paws::ElasticTranscoder::DeletePreset

Returns: a Paws::ElasticTranscoder::DeletePresetResponse instance

The DeletePreset operation removes a preset that you've added in an AWS region.

You can't delete the default presets that are included with Elastic Transcoder.

ListJobsByPipeline

PipelineId => Str
[Ascending => Str]
[PageToken => Str]

Each argument is described in detail in: Paws::ElasticTranscoder::ListJobsByPipeline

Returns: a Paws::ElasticTranscoder::ListJobsByPipelineResponse instance

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.

ListJobsByStatus

Status => Str
[Ascending => Str]
[PageToken => Str]

Each argument is described in detail in: Paws::ElasticTranscoder::ListJobsByStatus

Returns: a Paws::ElasticTranscoder::ListJobsByStatusResponse instance

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

ListPipelines

[Ascending => Str]
[PageToken => Str]

Each argument is described in detail in: Paws::ElasticTranscoder::ListPipelines

Returns: a Paws::ElasticTranscoder::ListPipelinesResponse instance

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

ListPresets

[Ascending => Str]
[PageToken => Str]

Each argument is described in detail in: Paws::ElasticTranscoder::ListPresets

Returns: a Paws::ElasticTranscoder::ListPresetsResponse instance

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.

ReadJob

Id => Str

Each argument is described in detail in: Paws::ElasticTranscoder::ReadJob

Returns: a Paws::ElasticTranscoder::ReadJobResponse instance

The ReadJob operation returns detailed information about a job.

ReadPipeline

Id => Str

Each argument is described in detail in: Paws::ElasticTranscoder::ReadPipeline

Returns: a Paws::ElasticTranscoder::ReadPipelineResponse instance

The ReadPipeline operation gets detailed information about a pipeline.

ReadPreset

Id => Str

Each argument is described in detail in: Paws::ElasticTranscoder::ReadPreset

Returns: a Paws::ElasticTranscoder::ReadPresetResponse instance

The ReadPreset operation gets detailed information about a preset.

TestRole

InputBucket => Str
OutputBucket => Str
Role => Str
Topics => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ElasticTranscoder::TestRole

Returns: a Paws::ElasticTranscoder::TestRoleResponse instance

The TestRole operation tests the IAM role used to create the pipeline.

The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.

UpdatePipeline

Id => Str
[AwsKmsKeyArn => Str]
[ContentConfig => Paws::ElasticTranscoder::PipelineOutputConfig]
[InputBucket => Str]
[Name => Str]
[Notifications => Paws::ElasticTranscoder::Notifications]
[Role => Str]
[ThumbnailConfig => Paws::ElasticTranscoder::PipelineOutputConfig]

Each argument is described in detail in: Paws::ElasticTranscoder::UpdatePipeline

Returns: a Paws::ElasticTranscoder::UpdatePipelineResponse instance

Use the UpdatePipeline operation to update settings for a pipeline.

When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

UpdatePipelineNotifications

Id => Str
Notifications => Paws::ElasticTranscoder::Notifications

Each argument is described in detail in: Paws::ElasticTranscoder::UpdatePipelineNotifications

Returns: a Paws::ElasticTranscoder::UpdatePipelineNotificationsResponse instance

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

UpdatePipelineStatus

Id => Str
Status => Str

Each argument is described in detail in: Paws::ElasticTranscoder::UpdatePipelineStatus

Returns: a Paws::ElasticTranscoder::UpdatePipelineStatusResponse instance

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllJobsByPipeline(sub { },PipelineId => Str, [Ascending => Str, PageToken => Str])

ListAllJobsByPipeline(PipelineId => Str, [Ascending => Str, PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Jobs, passing the object as the first parameter, and the string 'Jobs' as the second parameter 

If not, it will return a a Paws::ElasticTranscoder::ListJobsByPipelineResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllJobsByStatus(sub { },Status => Str, [Ascending => Str, PageToken => Str])

ListAllJobsByStatus(Status => Str, [Ascending => Str, PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Jobs, passing the object as the first parameter, and the string 'Jobs' as the second parameter 

If not, it will return a a Paws::ElasticTranscoder::ListJobsByStatusResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllPipelines(sub { },[Ascending => Str, PageToken => Str])

ListAllPipelines([Ascending => Str, PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Pipelines, passing the object as the first parameter, and the string 'Pipelines' as the second parameter 

If not, it will return a a Paws::ElasticTranscoder::ListPipelinesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllPresets(sub { },[Ascending => Str, PageToken => Str])

ListAllPresets([Ascending => Str, PageToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Presets, passing the object as the first parameter, and the string 'Presets' as the second parameter 

If not, it will return a a Paws::ElasticTranscoder::ListPresetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues