
Elastic Transcoder
******************


boto.elastictranscoder
======================

boto.elastictranscoder.connect_to_region(region_name, **kw_params)

boto.elastictranscoder.regions()

   Get all available regions for the AWS Elastic Transcoder service.

   Return type:
      list

   Returns:
      A list of "boto.regioninfo.RegionInfo"


boto.elastictranscoder.layer1
=============================

class class boto.elastictranscoder.layer1.ElasticTranscoderConnection(**kwargs)

   AWS Elastic Transcoder Service The AWS Elastic Transcoder Service.

   APIVersion = '2012-09-25'

   DefaultRegionEndpoint = 'elastictranscoder.us-east-1.amazonaws.com'

   DefaultRegionName = 'us-east-1'

   ResponseError

      alias of "JSONResponseError"

   cancel_job(id)

      To delete a job, send a DELETE request to the *//jobs/ [jobId] `
      resource. 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.

      Parameters:
         **id** (*string*) -- The identifier of the job that you want
         to delete.

      To get a list of the jobs (including their *jobId*) that have
         a status of *Submitted*, use the ListJobsByStatus API action.

   create_job(pipeline_id, input_name, output)

      To create a job, send a POST request to the *//jobs* resource.

      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.

      Parameters:
         * **pipeline_id** (*string*) -- 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.

         * **input_name** (*structure*) -- A section of the request
           body that provides information about the file that is being
           transcoded.

         * **output** (*structure*) -- A section of the request body
           that provides information about the transcoded (target)
           file.

   create_pipeline(name, input_bucket, output_bucket, role, notifications)

      To create a pipeline, send a POST request to the */pipelines*
      resource.

      Parameters:
         **name** (*string*) -- 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.

      Parameters:
         * **input_bucket** (*string*) -- The bucket in which you
           saved the media files that you want to transcode.

         * **output_bucket** (*string*) -- The bucket in which you
           want to save the transcoded files.

         * **role** (*string*) -- The IAM Amazon Resource Name (ARN)
           for the role that you want to use to create the pipeline.

         * **notifications** (*structure*) -- The () topic that you
           want to notify to report job status.

      To receive notifications, you must also subscribe
         to the new topic in the console.

      * **Progressing**: The () topic that you want to
           notify when has started to process the job.

      * **Completed**: The topic that you want to notify
           when has finished processing the job.

      * **Warning**: The topic that you want to notify
           when encounters a warning condition.

      * **Error**: The topic that you want to notify
           when encounters an error condition.

   create_preset(name, container, video, audio, thumbnails, description=None)

      To create a preset, send a POST request to the *//presets*
      resource. checks the settings that you specify to ensure that
      they meet requirements and to determine whether they comply with
      H.264 standards. If your settings are not valid for , returns an
      HTTP 400 response ( *ValidationException*) and does not create
      the preset. If the settings are valid for but aren't strictly
      compliant with the H.264 standard, 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 produces. 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 .

      Parameters:
         * **name** (*string*) -- The name of the preset. We recommend
           that the name be unique within the AWS account, but
           uniqueness is not enforced.

         * **description** (*string*) -- A description of the preset.

         * **container** (*string*) -- The container type for the
           output file. This value must be *mp4*.

         * **video** (*structure*) -- A section of the request body
           that specifies the video parameters.

         * **audio** (*structure*) -- A section of the request body
           that specifies the audio parameters

         * **thumbnails** (*structure*) -- A section of the request
           body that specifies the thumbnail parameters, if any.

   delete_pipeline(id)

      To delete a pipeline, send a DELETE request to the
      >>`<<//pipelines/ [pipelineId] ` resource.

      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.

      Parameters:
         **id** (*string*) -- The identifier of the pipeline that you
         want to delete.

   delete_preset(id)

      To delete a preset, send a DELETE request to the >>`<<//presets/
      [presetId] ` resource.

      If the preset has been used, you cannot delete it.

      Parameters:
         **id** (*string*) -- The identifier of the preset for which
         you want to get detailed information.

   list_jobs_by_pipeline(pipeline_id, ascending=None, page_token=None)

      To get a list of the jobs currently in a pipeline, send a GET
      request to the >>`<<//jobsByPipeline/ [pipelineId] ` resource.

      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.

      Parameters:
         * **pipeline_id** (*string*) -- The ID of the pipeline for
           which you want to get job information.

         * **ascending** (*string*) -- 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*.

         * **page_token** (*string*) -- When returns more than one
           page of results, use *pageToken* in subsequent *GET*
           requests to get each successive page of results.

   list_jobs_by_status(status, ascending=None, page_token=None)

      To get a list of the jobs that have a specified status, send a
      GET request to the >>`<<//jobsByStatus/ [status] ` resource.

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

      Parameters:
         * **status** (*string*) -- 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*, *Completed*, *Canceled*, or *Error*.

         * **ascending** (*string*) -- 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*.

         * **page_token** (*string*) -- When returns more than one
           page of results, use *pageToken* in subsequent *GET*
           requests to get each successive page of results.

   list_pipelines()

      To get a list of the pipelines associated with the current AWS
      account, send a GET request to the *//pipelines* resource.

   list_presets()

      To get a list of all presets associated with the current AWS
      account, send a GET request to the *//presets* resource.

   make_request(verb, resource, headers=None, data='', expected_status=None, params=None)

   read_job(id)

      To get detailed information about a job, send a GET request to
      the >>`<<//jobs/ [jobId] ` resource.

      Parameters:
         **id** (*string*) -- The identifier of the job for which you
         want to get detailed information.

   read_pipeline(id)

      To get detailed information about a pipeline, send a GET request
      to the >>`<<//pipelines/ [pipelineId] ` resource.

      Parameters:
         **id** (*string*) -- The identifier of the pipeline to read.

   read_preset(id)

      To get detailed information about a preset, send a GET request
      to the >>`<<//presets/ [presetId] ` resource.

      Parameters:
         **id** (*string*) -- The identifier of the preset for which
         you want to get detailed information.

   test_role(role, input_bucket, output_bucket, topics)

      To test the IAM role that's used by Elastic Transcoder to create
      the pipeline, send a POST request to the *//roleTests* resource.

      The *TestRole* action lets you determine whether the IAM role
      you are using has sufficient permissions to let 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.

      Parameters:
         * **role** (*string*) -- The IAM Amazon Resource Name (ARN)
           for the role that you want Elastic Transcoder to test.

         * **input_bucket** (*string*) -- The bucket that contains
           media files to be transcoded. The action attempts to read
           from this bucket.

         * **output_bucket** (*string*) -- The bucket that will write
           transcoded media files to. The action attempts to read from
           this bucket.

         * **topics** (*list*) -- The ARNs of one or more () topics
           that you want the action to send a test notification to.

   update_pipeline_notifications(id, notifications)

      To update () notifications for a pipeline, send a POST request
      to the *//pipelines/ [pipelineId] /notifications* resource.

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

      Parameters:
         * **id** (*string*) -- The identifier of the pipeline for
           which you want to change notification settings.

         * **notifications** (*structure*) -- The () topic that you
           want to notify to report job status.

      To receive notifications, you must also subscribe
         to the new topic in the console.

      * **Progressing**: The () topic that you want to
           notify when has started to process the job.

      * **Completed**: The topic that you want to notify
           when has finished processing the job.

      * **Warning**: The topic that you want to notify
           when encounters a warning condition.

      * **Error**: The topic that you want to notify
           when encounters an error condition.

   update_pipeline_status(id, status)

      To pause or reactivate a pipeline, so the pipeline stops or
      restarts processing jobs, update the status for the pipeline.
      Send a POST request to the *//pipelines/ [pipelineId] /status*
      resource.

      Changing the pipeline status is useful if you want to cancel one
      or more jobs. You can't cancel jobs after 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.

      Parameters:
         * **id** (*string*) -- The identifier of the pipeline to
           update.

         * **status** (*string*) -- The new status of the pipeline:

      * *active*: Enable the pipeline, so it starts processing
           jobs.

      * *paused*: Disable the pipeline, so it stops processing
           jobs.


boto.elastictranscoder.exceptions
=================================

exception exception boto.elastictranscoder.exceptions.AccessDeniedException(status, reason, body=None, *args)

exception exception boto.elastictranscoder.exceptions.InternalServiceException(status, reason, body=None, *args)

exception exception boto.elastictranscoder.exceptions.LimitExceededException(status, reason, body=None, *args)

exception exception boto.elastictranscoder.exceptions.ResourceInUseException(status, reason, body=None, *args)

exception exception boto.elastictranscoder.exceptions.ResourceNotFoundException(status, reason, body=None, *args)

exception exception boto.elastictranscoder.exceptions.ValidationException(status, reason, body=None, *args)
