View on GitHub
MediaTailor Structure Reference
MediaTailor
public struct MediaTailorClient object for interacting with AWS MediaTailor service.
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).
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the MediaTailor 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
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Deletes the playback configuration for the specified name.
Declaration
Swift
public func deletePlaybackConfiguration(_ input: DeletePlaybackConfigurationRequest) -> EventLoopFuture<DeletePlaybackConfigurationResponse> -
Returns the playback configuration for the specified name.
Declaration
Swift
public func getPlaybackConfiguration(_ input: GetPlaybackConfigurationRequest) -> EventLoopFuture<GetPlaybackConfigurationResponse> -
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.
Declaration
Swift
public func listPlaybackConfigurations(_ input: ListPlaybackConfigurationsRequest) -> EventLoopFuture<ListPlaybackConfigurationsResponse> -
Returns a list of the tags assigned to the specified playback configuration resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Adds a new playback configuration to AWS Elemental MediaTailor.
Declaration
Swift
public func putPlaybackConfiguration(_ input: PutPlaybackConfigurationRequest) -> EventLoopFuture<PutPlaybackConfigurationResponse> -
Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
Declaration
Swift
@discardableResult public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void> -
Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
Declaration
Swift
@discardableResult public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>