ElasticTranscoder

public struct ElasticTranscoder

Client object for interacting with AWS ElasticTranscoder service.

AWS Elastic Transcoder Service The AWS Elastic Transcoder Service.

Member variables

Initialization

  • Initialize the ElasticTranscoder client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • 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.

    Declaration

    Swift

    public func cancelJob(_ input: CancelJobRequest) -> EventLoopFuture<CancelJobResponse>

  • 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).

    Declaration

    Swift

    public func createJob(_ input: CreateJobRequest) -> EventLoopFuture<CreateJobResponse>

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

    Declaration

    Swift

    public func createPipeline(_ input: CreatePipelineRequest) -> EventLoopFuture<CreatePipelineResponse>

  • 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.

    Declaration

    Swift

    public func createPreset(_ input: CreatePresetRequest) -> EventLoopFuture<CreatePresetResponse>

  • 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.

    Declaration

    Swift

    public func deletePipeline(_ input: DeletePipelineRequest) -> EventLoopFuture<DeletePipelineResponse>

  • 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.

    Declaration

    Swift

    public func deletePreset(_ input: DeletePresetRequest) -> EventLoopFuture<DeletePresetResponse>

  • 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.

    Declaration

    Swift

    public func listJobsByPipeline(_ input: ListJobsByPipelineRequest) -> EventLoopFuture<ListJobsByPipelineResponse>

  • 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.

    Declaration

    Swift

    public func listJobsByStatus(_ input: ListJobsByStatusRequest) -> EventLoopFuture<ListJobsByStatusResponse>

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

    Declaration

    Swift

    public func listPipelines(_ input: ListPipelinesRequest) -> EventLoopFuture<ListPipelinesResponse>

  • 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.

    Declaration

    Swift

    public func listPresets(_ input: ListPresetsRequest) -> EventLoopFuture<ListPresetsResponse>

  • The ReadJob operation returns detailed information about a job.

    Declaration

    Swift

    public func readJob(_ input: ReadJobRequest) -> EventLoopFuture<ReadJobResponse>

  • The ReadPipeline operation gets detailed information about a pipeline.

    Declaration

    Swift

    public func readPipeline(_ input: ReadPipelineRequest) -> EventLoopFuture<ReadPipelineResponse>

  • The ReadPreset operation gets detailed information about a preset.

    Declaration

    Swift

    public func readPreset(_ input: ReadPresetRequest) -> EventLoopFuture<ReadPresetResponse>

  • 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.

    Declaration

    Swift

    @available(*, deprecated, message: "TestRole is deprecated.")
public func testRole(_ input: TestRoleRequest) -> EventLoopFuture<TestRoleResponse>

  • 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.

    Declaration

    Swift

    public func updatePipeline(_ input: UpdatePipelineRequest) -> EventLoopFuture<UpdatePipelineResponse>

  • 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.

    Declaration

    Swift

    public func updatePipelineNotifications(_ input: UpdatePipelineNotificationsRequest) -> EventLoopFuture<UpdatePipelineNotificationsResponse>

  • 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.

    Declaration

    Swift

    public func updatePipelineStatus(_ input: UpdatePipelineStatusRequest) -> EventLoopFuture<UpdatePipelineStatusResponse>

Paginators

  • 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.

    Declaration

    Swift

    public func listJobsByPipelinePaginator(_ input: ListJobsByPipelineRequest, onPage: @escaping (ListJobsByPipelineResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func listJobsByStatusPaginator(_ input: ListJobsByStatusRequest, onPage: @escaping (ListJobsByStatusResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listPipelinesPaginator(_ input: ListPipelinesRequest, onPage: @escaping (ListPipelinesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func listPresetsPaginator(_ input: ListPresetsRequest, onPage: @escaping (ListPresetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes