Soto icon

Soto

MediaTailor

Service object for interacting with AWS MediaTailor service.

public struct MediaTailor: AWSService

Use the AWS Elemental MediaTailor SDK to configure scalable ad insertion for your live and VOD content. With AWS Elemental MediaTailor, you can serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.

Through the SDK, you manage AWS Elemental MediaTailor configurations the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).

Inheritance

AWSService

Initializers

init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)

Initialize the MediaTailor client
public init(client: AWSClient, region: SotoCore.Region? = nil, partition: AWSPartition = .aws, endpoint: String? = nil, timeout: TimeAmount? = nil, byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(), options: AWSServiceConfig.Options = [])

Parameters

- client: AWSClient used to process requests - region: Region of server you want to communicate with. This will override the partition parameter. - partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov). - endpoint: Custom endpoint URL to use instead of standard AWS servers - timeout: Timeout value for HTTP requests

init(from:patch:)

Initializer required by `AWSService.with(middlewares:​timeout:​byteBufferAllocator:​options)`. You are not able to use this initializer directly as there are no public initializers for `AWSServiceConfig.Patch`. Please use `AWSService.with(middlewares:​timeout:​byteBufferAllocator:​options)` instead.
public init(from: MediaTailor, patch: AWSServiceConfig.Patch)

Properties

client

Client used for communication with AWS
let client: AWSClient

config

Service configuration
let config: AWSServiceConfig

Methods

deletePlaybackConfiguration(_:logger:on:)

public func deletePlaybackConfiguration(_ input: DeletePlaybackConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeletePlaybackConfigurationResponse>

Deletes the playback configuration for the specified name.

getPlaybackConfiguration(_:logger:on:)

public func getPlaybackConfiguration(_ input: GetPlaybackConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetPlaybackConfigurationResponse>

Returns the playback configuration for the specified name.

listPlaybackConfigurations(_:logger:on:)

public func listPlaybackConfigurations(_ input: ListPlaybackConfigurationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListPlaybackConfigurationsResponse>

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

listTagsForResource(_:logger:on:)

public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>

Returns a list of the tags assigned to the specified playback configuration resource.

putPlaybackConfiguration(_:logger:on:)

public func putPlaybackConfiguration(_ input: PutPlaybackConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutPlaybackConfigurationResponse>

Adds a new playback configuration to AWS Elemental MediaTailor.

tagResource(_:logger:on:)

@discardableResult public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

untagResource(_:logger:on:)

@discardableResult public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.