AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface ElasticTranscoderAsyncClient extends AutoCloseable
builder()
method.
The AWS Elastic Transcoder Service.
Modifier and Type | Method | Description |
---|---|---|
static ElasticTranscoderAsyncClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ElasticTranscoderAsyncClient . |
default CompletableFuture<CancelJobResponse> |
cancelJob(CancelJobRequest cancelJobRequest) |
The CancelJob operation cancels an unfinished job.
|
static ElasticTranscoderAsyncClient |
create() |
Create a
ElasticTranscoderAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateJobResponse> |
createJob(CreateJobRequest createJobRequest) |
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.
|
default CompletableFuture<CreatePipelineResponse> |
createPipeline(CreatePipelineRequest createPipelineRequest) |
The CreatePipeline operation creates a pipeline with settings that you specify.
|
default CompletableFuture<CreatePresetResponse> |
createPreset(CreatePresetRequest createPresetRequest) |
The CreatePreset operation creates a preset with settings that you specify.
|
default CompletableFuture<DeletePipelineResponse> |
deletePipeline(DeletePipelineRequest deletePipelineRequest) |
The DeletePipeline operation removes a pipeline.
|
default CompletableFuture<DeletePresetResponse> |
deletePreset(DeletePresetRequest deletePresetRequest) |
The DeletePreset operation removes a preset that you've added in an AWS region.
|
default CompletableFuture<ListJobsByPipelineResponse> |
listJobsByPipeline(ListJobsByPipelineRequest listJobsByPipelineRequest) |
The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
|
default CompletableFuture<ListJobsByStatusResponse> |
listJobsByStatus(ListJobsByStatusRequest listJobsByStatusRequest) |
The ListJobsByStatus operation gets a list of jobs that have a specified status.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines(ListPipelinesRequest listPipelinesRequest) |
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
|
default CompletableFuture<ListPresetsResponse> |
listPresets(ListPresetsRequest listPresetsRequest) |
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.
|
default CompletableFuture<ReadJobResponse> |
readJob(ReadJobRequest readJobRequest) |
The ReadJob operation returns detailed information about a job.
|
default CompletableFuture<ReadPipelineResponse> |
readPipeline(ReadPipelineRequest readPipelineRequest) |
The ReadPipeline operation gets detailed information about a pipeline.
|
default CompletableFuture<ReadPresetResponse> |
readPreset(ReadPresetRequest readPresetRequest) |
The ReadPreset operation gets detailed information about a preset.
|
default CompletableFuture<TestRoleResponse> |
testRole(TestRoleRequest testRoleRequest) |
The TestRole operation tests the IAM role used to create the pipeline.
|
default CompletableFuture<UpdatePipelineResponse> |
updatePipeline(UpdatePipelineRequest updatePipelineRequest) |
Use the
UpdatePipeline operation to update settings for a pipeline. |
default CompletableFuture<UpdatePipelineNotificationsResponse> |
updatePipelineNotifications(UpdatePipelineNotificationsRequest updatePipelineNotificationsRequest) |
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS)
notifications for a pipeline.
|
default CompletableFuture<UpdatePipelineStatusResponse> |
updatePipelineStatus(UpdatePipelineStatusRequest updatePipelineStatusRequest) |
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the
processing of jobs.
|
close
static ElasticTranscoderAsyncClient create()
ElasticTranscoderAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ElasticTranscoderAsyncClientBuilder builder()
ElasticTranscoderAsyncClient
.default CompletableFuture<CancelJobResponse> cancelJob(CancelJobRequest cancelJobRequest)
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.
cancelJobRequest
- The CancelJobRequest
structure.default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)
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).
createJobRequest
- The CreateJobRequest
structure.default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest)
The CreatePipeline operation creates a pipeline with settings that you specify.
createPipelineRequest
- The CreatePipelineRequest
structure.default CompletableFuture<CreatePresetResponse> createPreset(CreatePresetRequest createPresetRequest)
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.
createPresetRequest
- The CreatePresetRequest
structure.default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest)
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.
deletePipelineRequest
- The DeletePipelineRequest
structure.default CompletableFuture<DeletePresetResponse> deletePreset(DeletePresetRequest deletePresetRequest)
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.
deletePresetRequest
- The DeletePresetRequest
structure.default CompletableFuture<ListJobsByPipelineResponse> listJobsByPipeline(ListJobsByPipelineRequest listJobsByPipelineRequest)
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.
listJobsByPipelineRequest
- The ListJobsByPipelineRequest
structure.default CompletableFuture<ListJobsByStatusResponse> listJobsByStatus(ListJobsByStatusRequest listJobsByStatusRequest)
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.
listJobsByStatusRequest
- The ListJobsByStatusRequest
structure.default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest)
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
listPipelinesRequest
- The ListPipelineRequest
structure.default CompletableFuture<ListPresetsResponse> listPresets(ListPresetsRequest listPresetsRequest)
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.
listPresetsRequest
- The ListPresetsRequest
structure.default CompletableFuture<ReadJobResponse> readJob(ReadJobRequest readJobRequest)
The ReadJob operation returns detailed information about a job.
readJobRequest
- The ReadJobRequest
structure.default CompletableFuture<ReadPipelineResponse> readPipeline(ReadPipelineRequest readPipelineRequest)
The ReadPipeline operation gets detailed information about a pipeline.
readPipelineRequest
- The ReadPipelineRequest
structure.default CompletableFuture<ReadPresetResponse> readPreset(ReadPresetRequest readPresetRequest)
The ReadPreset operation gets detailed information about a preset.
readPresetRequest
- The ReadPresetRequest
structure.default CompletableFuture<TestRoleResponse> testRole(TestRoleRequest testRoleRequest)
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.
testRoleRequest
- The TestRoleRequest
structure.default CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest updatePipelineRequest)
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.
updatePipelineRequest
- The UpdatePipelineRequest
structure.default CompletableFuture<UpdatePipelineNotificationsResponse> updatePipelineNotifications(UpdatePipelineNotificationsRequest updatePipelineNotificationsRequest)
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.
updatePipelineNotificationsRequest
- The UpdatePipelineNotificationsRequest
structure.default CompletableFuture<UpdatePipelineStatusResponse> updatePipelineStatus(UpdatePipelineStatusRequest updatePipelineStatusRequest)
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.
updatePipelineStatusRequest
- The UpdatePipelineStatusRequest
structure.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.