MediaPackage

public struct MediaPackage

Client object for interacting with AWS MediaPackage service.

AWS Elemental MediaPackage

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the MediaPackage 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


                    
                    
                    createChannel(_:)

Creates a new Channel.

Declaration

Swift

public func createChannel(_ input: CreateChannelRequest) -> EventLoopFuture<CreateChannelResponse>


                    
                    
                    createHarvestJob(_:)

Creates a new HarvestJob record.

Declaration

Swift

public func createHarvestJob(_ input: CreateHarvestJobRequest) -> EventLoopFuture<CreateHarvestJobResponse>


                    
                    
                    createOriginEndpoint(_:)

Creates a new OriginEndpoint record.

Declaration

Swift

public func createOriginEndpoint(_ input: CreateOriginEndpointRequest) -> EventLoopFuture<CreateOriginEndpointResponse>


                    
                    
                    deleteChannel(_:)

Deletes an existing Channel.

Declaration

Swift

public func deleteChannel(_ input: DeleteChannelRequest) -> EventLoopFuture<DeleteChannelResponse>


                    
                    
                    deleteOriginEndpoint(_:)

Deletes an existing OriginEndpoint.

Declaration

Swift

public func deleteOriginEndpoint(_ input: DeleteOriginEndpointRequest) -> EventLoopFuture<DeleteOriginEndpointResponse>


                    
                    
                    describeChannel(_:)

Gets details about a Channel.

Declaration

Swift

public func describeChannel(_ input: DescribeChannelRequest) -> EventLoopFuture<DescribeChannelResponse>


                    
                    
                    describeHarvestJob(_:)

Gets details about an existing HarvestJob.

Declaration

Swift

public func describeHarvestJob(_ input: DescribeHarvestJobRequest) -> EventLoopFuture<DescribeHarvestJobResponse>


                    
                    
                    describeOriginEndpoint(_:)

Gets details about an existing OriginEndpoint.

Declaration

Swift

public func describeOriginEndpoint(_ input: DescribeOriginEndpointRequest) -> EventLoopFuture<DescribeOriginEndpointResponse>


                    
                    
                    listChannels(_:)

Returns a collection of Channels.

Declaration

Swift

public func listChannels(_ input: ListChannelsRequest) -> EventLoopFuture<ListChannelsResponse>


                    
                    
                    listHarvestJobs(_:)

Returns a collection of HarvestJob records.

Declaration

Swift

public func listHarvestJobs(_ input: ListHarvestJobsRequest) -> EventLoopFuture<ListHarvestJobsResponse>


                    
                    
                    listOriginEndpoints(_:)

Returns a collection of OriginEndpoint records.

Declaration

Swift

public func listOriginEndpoints(_ input: ListOriginEndpointsRequest) -> EventLoopFuture<ListOriginEndpointsResponse>


                    
                    
                    listTagsForResource(_:)

Undocumented

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>


                    
                    
                    rotateChannelCredentials(_:)

Changes the Channel’s first IngestEndpoint’s username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated. Please use RotateIngestEndpointCredentials instead")
public func rotateChannelCredentials(_ input: RotateChannelCredentialsRequest) -> EventLoopFuture<RotateChannelCredentialsResponse>


                    
                    
                    rotateIngestEndpointCredentials(_:)

Rotate the IngestEndpoint’s username and password, as specified by the IngestEndpoint’s id.

Declaration

Swift

public func rotateIngestEndpointCredentials(_ input: RotateIngestEndpointCredentialsRequest) -> EventLoopFuture<RotateIngestEndpointCredentialsResponse>


                    
                    
                    tagResource(_:)

Undocumented

Declaration

Swift

@discardableResult
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void>


                    
                    
                    untagResource(_:)

Undocumented

Declaration

Swift

@discardableResult
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>


                    
                    
                    updateChannel(_:)

Updates an existing Channel.

Declaration

Swift

public func updateChannel(_ input: UpdateChannelRequest) -> EventLoopFuture<UpdateChannelResponse>


                    
                    
                    updateOriginEndpoint(_:)

Updates an existing OriginEndpoint.

Declaration

Swift

public func updateOriginEndpoint(_ input: UpdateOriginEndpointRequest) -> EventLoopFuture<UpdateOriginEndpointResponse>

Paginators


                    
                    
                    listChannelsPaginator(_:onPage:)

Returns a collection of Channels.

Declaration

Swift

public func listChannelsPaginator(_ input: ListChannelsRequest, onPage: @escaping (ListChannelsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listHarvestJobsPaginator(_:onPage:)

Returns a collection of HarvestJob records.

Declaration

Swift

public func listHarvestJobsPaginator(_ input: ListHarvestJobsRequest, onPage: @escaping (ListHarvestJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listOriginEndpointsPaginator(_:onPage:)

Returns a collection of OriginEndpoint records.

Declaration

Swift

public func listOriginEndpointsPaginator(_ input: ListOriginEndpointsRequest, onPage: @escaping (ListOriginEndpointsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListChannelsRequest

Undocumented

Declaration

Swift

public struct ListChannelsRequest : AWSShape

extension MediaPackage.ListChannelsRequest: AWSPaginateStringToken


                    
                    
                    ListHarvestJobsRequest

Undocumented

Declaration

Swift

public struct ListHarvestJobsRequest : AWSShape

extension MediaPackage.ListHarvestJobsRequest: AWSPaginateStringToken


                    
                    
                    ListOriginEndpointsRequest

Undocumented

Declaration

Swift

public struct ListOriginEndpointsRequest : AWSShape

extension MediaPackage.ListOriginEndpointsRequest: AWSPaginateStringToken

Authorization
Undocumented
See more
Declaration
Swift

public struct Authorization : AWSShape
Channel
Undocumented
See more
Declaration
Swift

public struct Channel : AWSShape
CmafEncryption
Undocumented
See more
Declaration
Swift

public struct CmafEncryption : AWSShape
CmafPackage
Undocumented
See more
Declaration
Swift

public struct CmafPackage : AWSShape
CmafPackageCreateOrUpdateParameters
Undocumented
See more
Declaration
Swift

public struct CmafPackageCreateOrUpdateParameters : AWSShape
CreateChannelRequest
Undocumented
See more
Declaration
Swift

public struct CreateChannelRequest : AWSShape
CreateChannelResponse
Undocumented
See more
Declaration
Swift

public struct CreateChannelResponse : AWSShape
CreateHarvestJobRequest
Undocumented
See more
Declaration
Swift

public struct CreateHarvestJobRequest : AWSShape
CreateHarvestJobResponse
Undocumented
See more
Declaration
Swift

public struct CreateHarvestJobResponse : AWSShape
CreateOriginEndpointRequest
Undocumented
See more
Declaration
Swift

public struct CreateOriginEndpointRequest : AWSShape
CreateOriginEndpointResponse
Undocumented
See more
Declaration
Swift

public struct CreateOriginEndpointResponse : AWSShape
DashEncryption
Undocumented
See more
Declaration
Swift

public struct DashEncryption : AWSShape
DashPackage
Undocumented
See more
Declaration
Swift

public struct DashPackage : AWSShape
DeleteChannelRequest
Undocumented
See more
Declaration
Swift

public struct DeleteChannelRequest : AWSShape
DeleteChannelResponse
Undocumented
See more
Declaration
Swift

public struct DeleteChannelResponse : AWSShape
DeleteOriginEndpointRequest
Undocumented
See more
Declaration
Swift

public struct DeleteOriginEndpointRequest : AWSShape
DeleteOriginEndpointResponse
Undocumented
See more
Declaration
Swift

public struct DeleteOriginEndpointResponse : AWSShape
DescribeChannelRequest
Undocumented
See more
Declaration
Swift

public struct DescribeChannelRequest : AWSShape
DescribeChannelResponse
Undocumented
See more
Declaration
Swift

public struct DescribeChannelResponse : AWSShape
DescribeHarvestJobRequest
Undocumented
See more
Declaration
Swift

public struct DescribeHarvestJobRequest : AWSShape
DescribeHarvestJobResponse
Undocumented
See more
Declaration
Swift

public struct DescribeHarvestJobResponse : AWSShape
DescribeOriginEndpointRequest
Undocumented
See more
Declaration
Swift

public struct DescribeOriginEndpointRequest : AWSShape
DescribeOriginEndpointResponse
Undocumented
See more
Declaration
Swift

public struct DescribeOriginEndpointResponse : AWSShape
HarvestJob
Undocumented
See more
Declaration
Swift

public struct HarvestJob : AWSShape
HlsEncryption
Undocumented
See more
Declaration
Swift

public struct HlsEncryption : AWSShape
HlsIngest
Undocumented
See more
Declaration
Swift

public struct HlsIngest : AWSShape
HlsManifest
Undocumented
See more
Declaration
Swift

public struct HlsManifest : AWSShape
HlsManifestCreateOrUpdateParameters
Undocumented
See more
Declaration
Swift

public struct HlsManifestCreateOrUpdateParameters : AWSShape
HlsPackage
Undocumented
See more
Declaration
Swift

public struct HlsPackage : AWSShape
IngestEndpoint
Undocumented
See more
Declaration
Swift

public struct IngestEndpoint : AWSShape
ListChannelsResponse
Undocumented
See more
Declaration
Swift

public struct ListChannelsResponse : AWSShape
ListHarvestJobsResponse
Undocumented
See more
Declaration
Swift

public struct ListHarvestJobsResponse : AWSShape
ListOriginEndpointsResponse
Undocumented
See more
Declaration
Swift

public struct ListOriginEndpointsResponse : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
MssEncryption
Undocumented
See more
Declaration
Swift

public struct MssEncryption : AWSShape
MssPackage
Undocumented
See more
Declaration
Swift

public struct MssPackage : AWSShape
OriginEndpoint
Undocumented
See more
Declaration
Swift

public struct OriginEndpoint : AWSShape
RotateChannelCredentialsRequest
Undocumented
See more
Declaration
Swift

public struct RotateChannelCredentialsRequest : AWSShape
RotateChannelCredentialsResponse
Undocumented
See more
Declaration
Swift

public struct RotateChannelCredentialsResponse : AWSShape
RotateIngestEndpointCredentialsRequest
Undocumented
See more
Declaration
Swift

public struct RotateIngestEndpointCredentialsRequest : AWSShape
RotateIngestEndpointCredentialsResponse
Undocumented
See more
Declaration
Swift

public struct RotateIngestEndpointCredentialsResponse : AWSShape
S3Destination
Undocumented
See more
Declaration
Swift

public struct S3Destination : AWSShape
SpekeKeyProvider
Undocumented
See more
Declaration
Swift

public struct SpekeKeyProvider : AWSShape
StreamSelection
Undocumented
See more
Declaration
Swift

public struct StreamSelection : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UpdateChannelRequest
Undocumented
See more
Declaration
Swift

public struct UpdateChannelRequest : AWSShape
UpdateChannelResponse
Undocumented
See more
Declaration
Swift

public struct UpdateChannelResponse : AWSShape
UpdateOriginEndpointRequest
Undocumented
See more
Declaration
Swift

public struct UpdateOriginEndpointRequest : AWSShape
UpdateOriginEndpointResponse
Undocumented
See more
Declaration
Swift

public struct UpdateOriginEndpointResponse : AWSShape

Enums


                    
                    
                    AdMarkers

Undocumented

Declaration

Swift

public enum AdMarkers : String, CustomStringConvertible, Codable


                    
                    
                    AdsOnDeliveryRestrictions

Undocumented

Declaration

Swift

public enum AdsOnDeliveryRestrictions : String, CustomStringConvertible, Codable


                    
                    
                    EncryptionMethod

Undocumented

Declaration

Swift

public enum EncryptionMethod : String, CustomStringConvertible, Codable


                    
                    
                    ManifestLayout

Undocumented

Declaration

Swift

public enum ManifestLayout : String, CustomStringConvertible, Codable


                    
                    
                    Origination

Undocumented

Declaration

Swift

public enum Origination : String, CustomStringConvertible, Codable


                    
                    
                    PlaylistType

Undocumented

Declaration

Swift

public enum PlaylistType : String, CustomStringConvertible, Codable


                    
                    
                    Profile

Undocumented

Declaration

Swift

public enum Profile : String, CustomStringConvertible, Codable


                    
                    
                    SegmentTemplateFormat

Undocumented

Declaration

Swift

public enum SegmentTemplateFormat : String, CustomStringConvertible, Codable


                    
                    
                    Status

Undocumented

Declaration

Swift

public enum Status : String, CustomStringConvertible, Codable


                    
                    
                    StreamOrder

Undocumented

Declaration

Swift

public enum StreamOrder : String, CustomStringConvertible, Codable


                    
                    
                    UtcTiming

Undocumented

Declaration

Swift

public enum UtcTiming : String, CustomStringConvertible, Codable


                    
                    
                    Adtriggerselement

Undocumented

Declaration

Swift

public enum Adtriggerselement : String, CustomStringConvertible, Codable


                    
                    
                    Periodtriggerselement

Undocumented

Declaration

Swift

public enum Periodtriggerselement : String, CustomStringConvertible, Codable