@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonElasticTranscoder extends Object implements AmazonElasticTranscoder
AmazonElasticTranscoder
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CancelJobResult |
cancelJob(CancelJobRequest request)
The CancelJob operation cancels an unfinished job.
|
CreateJobResult |
createJob(CreateJobRequest request)
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.
|
CreatePipelineResult |
createPipeline(CreatePipelineRequest request)
The CreatePipeline operation creates a pipeline with settings that you specify.
|
CreatePresetResult |
createPreset(CreatePresetRequest request)
The CreatePreset operation creates a preset with settings that you specify.
|
DeletePipelineResult |
deletePipeline(DeletePipelineRequest request)
The DeletePipeline operation removes a pipeline.
|
DeletePresetResult |
deletePreset(DeletePresetRequest request)
The DeletePreset operation removes a preset that you've added in an AWS region.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListJobsByPipelineResult |
listJobsByPipeline(ListJobsByPipelineRequest request)
The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
|
ListJobsByStatusResult |
listJobsByStatus(ListJobsByStatusRequest request)
The ListJobsByStatus operation gets a list of jobs that have a specified status.
|
ListPipelinesResult |
listPipelines()
Simplified method form for invoking the ListPipelines operation.
|
ListPipelinesResult |
listPipelines(ListPipelinesRequest request)
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
|
ListPresetsResult |
listPresets()
Simplified method form for invoking the ListPresets operation.
|
ListPresetsResult |
listPresets(ListPresetsRequest request)
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.
|
ReadJobResult |
readJob(ReadJobRequest request)
The ReadJob operation returns detailed information about a job.
|
ReadPipelineResult |
readPipeline(ReadPipelineRequest request)
The ReadPipeline operation gets detailed information about a pipeline.
|
ReadPresetResult |
readPreset(ReadPresetRequest request)
The ReadPreset operation gets detailed information about a preset.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("elastictranscoder.us-east-1.amazonaws.com/").
|
void |
setRegion(Region region)
An alternative to
AmazonElasticTranscoder.setEndpoint(String) , sets the regional endpoint for this
client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TestRoleResult |
testRole(TestRoleRequest request)
Deprecated.
|
UpdatePipelineResult |
updatePipeline(UpdatePipelineRequest request)
Use the
UpdatePipeline operation to update settings for a pipeline. |
UpdatePipelineNotificationsResult |
updatePipelineNotifications(UpdatePipelineNotificationsRequest request)
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS)
notifications for a pipeline.
|
UpdatePipelineStatusResult |
updatePipelineStatus(UpdatePipelineStatusRequest request)
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the
processing of jobs.
|
AmazonElasticTranscoderWaiters |
waiters() |
public void setEndpoint(String endpoint)
AmazonElasticTranscoder
Callers can pass in just the endpoint (ex: "elastictranscoder.us-east-1.amazonaws.com/") or a full URL, including
the protocol (ex: "elastictranscoder.us-east-1.amazonaws.com/"). If the protocol is not specified here, the
default protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonElasticTranscoder
endpoint
- The endpoint (ex: "elastictranscoder.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex:
"elastictranscoder.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will
communicate with.public void setRegion(Region region)
AmazonElasticTranscoder
AmazonElasticTranscoder.setEndpoint(String)
, sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonElasticTranscoder
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public CancelJobResult cancelJob(CancelJobRequest request)
AmazonElasticTranscoder
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.
cancelJob
in interface AmazonElasticTranscoder
request
- The CancelJobRequest
structure.public CreateJobResult createJob(CreateJobRequest request)
AmazonElasticTranscoder
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).
createJob
in interface AmazonElasticTranscoder
request
- The CreateJobRequest
structure.public CreatePipelineResult createPipeline(CreatePipelineRequest request)
AmazonElasticTranscoder
The CreatePipeline operation creates a pipeline with settings that you specify.
createPipeline
in interface AmazonElasticTranscoder
request
- The CreatePipelineRequest
structure.public CreatePresetResult createPreset(CreatePresetRequest request)
AmazonElasticTranscoder
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.
createPreset
in interface AmazonElasticTranscoder
request
- The CreatePresetRequest
structure.public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
AmazonElasticTranscoder
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.
deletePipeline
in interface AmazonElasticTranscoder
request
- The DeletePipelineRequest
structure.public DeletePresetResult deletePreset(DeletePresetRequest request)
AmazonElasticTranscoder
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.
deletePreset
in interface AmazonElasticTranscoder
request
- The DeletePresetRequest
structure.public ListJobsByPipelineResult listJobsByPipeline(ListJobsByPipelineRequest request)
AmazonElasticTranscoder
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.
listJobsByPipeline
in interface AmazonElasticTranscoder
request
- The ListJobsByPipelineRequest
structure.public ListJobsByStatusResult listJobsByStatus(ListJobsByStatusRequest request)
AmazonElasticTranscoder
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.
listJobsByStatus
in interface AmazonElasticTranscoder
request
- The ListJobsByStatusRequest
structure.public ListPipelinesResult listPipelines(ListPipelinesRequest request)
AmazonElasticTranscoder
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
listPipelines
in interface AmazonElasticTranscoder
request
- The ListPipelineRequest
structure.public ListPipelinesResult listPipelines()
AmazonElasticTranscoder
listPipelines
in interface AmazonElasticTranscoder
AmazonElasticTranscoder.listPipelines(ListPipelinesRequest)
public ListPresetsResult listPresets(ListPresetsRequest request)
AmazonElasticTranscoder
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.
listPresets
in interface AmazonElasticTranscoder
request
- The ListPresetsRequest
structure.public ListPresetsResult listPresets()
AmazonElasticTranscoder
listPresets
in interface AmazonElasticTranscoder
AmazonElasticTranscoder.listPresets(ListPresetsRequest)
public ReadJobResult readJob(ReadJobRequest request)
AmazonElasticTranscoder
The ReadJob operation returns detailed information about a job.
readJob
in interface AmazonElasticTranscoder
request
- The ReadJobRequest
structure.public ReadPipelineResult readPipeline(ReadPipelineRequest request)
AmazonElasticTranscoder
The ReadPipeline operation gets detailed information about a pipeline.
readPipeline
in interface AmazonElasticTranscoder
request
- The ReadPipelineRequest
structure.public ReadPresetResult readPreset(ReadPresetRequest request)
AmazonElasticTranscoder
The ReadPreset operation gets detailed information about a preset.
readPreset
in interface AmazonElasticTranscoder
request
- The ReadPresetRequest
structure.@Deprecated public TestRoleResult testRole(TestRoleRequest request)
AmazonElasticTranscoder
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.
testRole
in interface AmazonElasticTranscoder
request
- The TestRoleRequest
structure.public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)
AmazonElasticTranscoder
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.
updatePipeline
in interface AmazonElasticTranscoder
request
- The UpdatePipelineRequest
structure.public UpdatePipelineNotificationsResult updatePipelineNotifications(UpdatePipelineNotificationsRequest request)
AmazonElasticTranscoder
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.
updatePipelineNotifications
in interface AmazonElasticTranscoder
request
- The UpdatePipelineNotificationsRequest
structure.public UpdatePipelineStatusResult updatePipelineStatus(UpdatePipelineStatusRequest request)
AmazonElasticTranscoder
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.
updatePipelineStatus
in interface AmazonElasticTranscoder
request
- The UpdatePipelineStatusRequest
structure.public void shutdown()
AmazonElasticTranscoder
shutdown
in interface AmazonElasticTranscoder
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonElasticTranscoder
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonElasticTranscoder
request
- The originally executed request.public AmazonElasticTranscoderWaiters waiters()
waiters
in interface AmazonElasticTranscoder