MediaConnect

public struct MediaConnect

Client object for interacting with AWS MediaConnect service.

API for AWS Elemental MediaConnect

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


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

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

addFlowOutputs(_:)
Adds outputs to an existing flow. You can create up to 50 outputs per flow.
Declaration
Swift

public func addFlowOutputs(_ input: AddFlowOutputsRequest) -> EventLoopFuture<AddFlowOutputsResponse>


                    
                    
                    addFlowSources(_:)

Adds Sources to flow

Declaration

Swift

public func addFlowSources(_ input: AddFlowSourcesRequest) -> EventLoopFuture<AddFlowSourcesResponse>


                    
                    
                    addFlowVpcInterfaces(_:)

Adds VPC interfaces to flow

Declaration

Swift

public func addFlowVpcInterfaces(_ input: AddFlowVpcInterfacesRequest) -> EventLoopFuture<AddFlowVpcInterfacesResponse>

createFlow(_:)
Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
Declaration
Swift

public func createFlow(_ input: CreateFlowRequest) -> EventLoopFuture<CreateFlowResponse>
deleteFlow(_:)
Deletes a flow. Before you can delete a flow, you must stop the flow.
Declaration
Swift

public func deleteFlow(_ input: DeleteFlowRequest) -> EventLoopFuture<DeleteFlowResponse>
describeFlow(_:)
Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.
Declaration
Swift

public func describeFlow(_ input: DescribeFlowRequest) -> EventLoopFuture<DescribeFlowResponse>


                    
                    
                    grantFlowEntitlements(_:)

Grants entitlements to an existing flow.

Declaration

Swift

public func grantFlowEntitlements(_ input: GrantFlowEntitlementsRequest) -> EventLoopFuture<GrantFlowEntitlementsResponse>

listEntitlements(_:)
Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
Declaration
Swift

public func listEntitlements(_ input: ListEntitlementsRequest) -> EventLoopFuture<ListEntitlementsResponse>
listFlows(_:)
Displays a list of flows that are associated with this account. This request returns a paginated result.
Declaration
Swift

public func listFlows(_ input: ListFlowsRequest) -> EventLoopFuture<ListFlowsResponse>


                    
                    
                    listTagsForResource(_:)

List all tags on an AWS Elemental MediaConnect resource

Declaration

Swift

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

removeFlowOutput(_:)
Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.
Declaration
Swift

public func removeFlowOutput(_ input: RemoveFlowOutputRequest) -> EventLoopFuture<RemoveFlowOutputResponse>
removeFlowSource(_:)
Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.
Declaration
Swift

public func removeFlowSource(_ input: RemoveFlowSourceRequest) -> EventLoopFuture<RemoveFlowSourceResponse>
removeFlowVpcInterface(_:)
Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.
Declaration
Swift

public func removeFlowVpcInterface(_ input: RemoveFlowVpcInterfaceRequest) -> EventLoopFuture<RemoveFlowVpcInterfaceResponse>
revokeFlowEntitlement(_:)
Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
Declaration
Swift

public func revokeFlowEntitlement(_ input: RevokeFlowEntitlementRequest) -> EventLoopFuture<RevokeFlowEntitlementResponse>


                    
                    
                    startFlow(_:)

Starts a flow.

Declaration

Swift

public func startFlow(_ input: StartFlowRequest) -> EventLoopFuture<StartFlowResponse>


                    
                    
                    stopFlow(_:)

Stops a flow.

Declaration

Swift

public func stopFlow(_ input: StopFlowRequest) -> EventLoopFuture<StopFlowResponse>

tagResource(_:)
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
Declaration
Swift

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


                    
                    
                    untagResource(_:)

Deletes specified tags from a resource.

Declaration

Swift

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


                    
                    
                    updateFlow(_:)

Updates flow

Declaration

Swift

public func updateFlow(_ input: UpdateFlowRequest) -> EventLoopFuture<UpdateFlowResponse>

updateFlowEntitlement(_:)
You can change an entitlement’s description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.
Declaration
Swift

public func updateFlowEntitlement(_ input: UpdateFlowEntitlementRequest) -> EventLoopFuture<UpdateFlowEntitlementResponse>


                    
                    
                    updateFlowOutput(_:)

Updates an existing flow output.

Declaration

Swift

public func updateFlowOutput(_ input: UpdateFlowOutputRequest) -> EventLoopFuture<UpdateFlowOutputResponse>


                    
                    
                    updateFlowSource(_:)

Updates the source of a flow.

Declaration

Swift

public func updateFlowSource(_ input: UpdateFlowSourceRequest) -> EventLoopFuture<UpdateFlowSourceResponse>

Paginators


                    
                    
                    listEntitlementsPaginator(_:onPage:)

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

Declaration

Swift

public func listEntitlementsPaginator(_ input: ListEntitlementsRequest, onPage: @escaping (ListEntitlementsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listFlowsPaginator(_:onPage:)

Displays a list of flows that are associated with this account. This request returns a paginated result.

Declaration

Swift

public func listFlowsPaginator(_ input: ListFlowsRequest, onPage: @escaping (ListFlowsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListEntitlementsRequest

Undocumented

Declaration

Swift

public struct ListEntitlementsRequest : AWSShape

extension MediaConnect.ListEntitlementsRequest: AWSPaginateStringToken


                    
                    
                    ListFlowsRequest

Undocumented

Declaration

Swift

public struct ListFlowsRequest : AWSShape

extension MediaConnect.ListFlowsRequest: AWSPaginateStringToken

AddFlowOutputsRequest
Undocumented
See more
Declaration
Swift

public struct AddFlowOutputsRequest : AWSShape
AddFlowOutputsResponse
Undocumented
See more
Declaration
Swift

public struct AddFlowOutputsResponse : AWSShape
AddFlowSourcesRequest
Undocumented
See more
Declaration
Swift

public struct AddFlowSourcesRequest : AWSShape
AddFlowSourcesResponse
Undocumented
See more
Declaration
Swift

public struct AddFlowSourcesResponse : AWSShape
AddFlowVpcInterfacesRequest
Undocumented
See more
Declaration
Swift

public struct AddFlowVpcInterfacesRequest : AWSShape
AddFlowVpcInterfacesResponse
Undocumented
See more
Declaration
Swift

public struct AddFlowVpcInterfacesResponse : AWSShape
AddOutputRequest
Undocumented
See more
Declaration
Swift

public struct AddOutputRequest : AWSShape
CreateFlowRequest
Undocumented
See more
Declaration
Swift

public struct CreateFlowRequest : AWSShape
CreateFlowResponse
Undocumented
See more
Declaration
Swift

public struct CreateFlowResponse : AWSShape
DeleteFlowRequest
Undocumented
See more
Declaration
Swift

public struct DeleteFlowRequest : AWSShape
DeleteFlowResponse
Undocumented
See more
Declaration
Swift

public struct DeleteFlowResponse : AWSShape
DescribeFlowRequest
Undocumented
See more
Declaration
Swift

public struct DescribeFlowRequest : AWSShape
DescribeFlowResponse
Undocumented
See more
Declaration
Swift

public struct DescribeFlowResponse : AWSShape
Encryption
Undocumented
See more
Declaration
Swift

public struct Encryption : AWSShape
Entitlement
Undocumented
See more
Declaration
Swift

public struct Entitlement : AWSShape
FailoverConfig
Undocumented
See more
Declaration
Swift

public struct FailoverConfig : AWSShape
Flow
Undocumented
See more
Declaration
Swift

public struct Flow : AWSShape
GrantEntitlementRequest
Undocumented
See more
Declaration
Swift

public struct GrantEntitlementRequest : AWSShape
GrantFlowEntitlementsRequest
Undocumented
See more
Declaration
Swift

public struct GrantFlowEntitlementsRequest : AWSShape
GrantFlowEntitlementsResponse
Undocumented
See more
Declaration
Swift

public struct GrantFlowEntitlementsResponse : AWSShape
ListEntitlementsResponse
Undocumented
See more
Declaration
Swift

public struct ListEntitlementsResponse : AWSShape
ListFlowsResponse
Undocumented
See more
Declaration
Swift

public struct ListFlowsResponse : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
ListedEntitlement
Undocumented
See more
Declaration
Swift

public struct ListedEntitlement : AWSShape
ListedFlow
Undocumented
See more
Declaration
Swift

public struct ListedFlow : AWSShape
Messages
Undocumented
See more
Declaration
Swift

public struct Messages : AWSShape
Output
Undocumented
See more
Declaration
Swift

public struct Output : AWSShape
RemoveFlowOutputRequest
Undocumented
See more
Declaration
Swift

public struct RemoveFlowOutputRequest : AWSShape
RemoveFlowOutputResponse
Undocumented
See more
Declaration
Swift

public struct RemoveFlowOutputResponse : AWSShape
RemoveFlowSourceRequest
Undocumented
See more
Declaration
Swift

public struct RemoveFlowSourceRequest : AWSShape
RemoveFlowSourceResponse
Undocumented
See more
Declaration
Swift

public struct RemoveFlowSourceResponse : AWSShape
RemoveFlowVpcInterfaceRequest
Undocumented
See more
Declaration
Swift

public struct RemoveFlowVpcInterfaceRequest : AWSShape
RemoveFlowVpcInterfaceResponse
Undocumented
See more
Declaration
Swift

public struct RemoveFlowVpcInterfaceResponse : AWSShape
RevokeFlowEntitlementRequest
Undocumented
See more
Declaration
Swift

public struct RevokeFlowEntitlementRequest : AWSShape
RevokeFlowEntitlementResponse
Undocumented
See more
Declaration
Swift

public struct RevokeFlowEntitlementResponse : AWSShape
SetSourceRequest
Undocumented
See more
Declaration
Swift

public struct SetSourceRequest : AWSShape
Source
Undocumented
See more
Declaration
Swift

public struct Source : AWSShape
StartFlowRequest
Undocumented
See more
Declaration
Swift

public struct StartFlowRequest : AWSShape
StartFlowResponse
Undocumented
See more
Declaration
Swift

public struct StartFlowResponse : AWSShape
StopFlowRequest
Undocumented
See more
Declaration
Swift

public struct StopFlowRequest : AWSShape
StopFlowResponse
Undocumented
See more
Declaration
Swift

public struct StopFlowResponse : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
Transport
Undocumented
See more
Declaration
Swift

public struct Transport : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UpdateEncryption
Undocumented
See more
Declaration
Swift

public struct UpdateEncryption : AWSShape
UpdateFailoverConfig
Undocumented
See more
Declaration
Swift

public struct UpdateFailoverConfig : AWSShape
UpdateFlowEntitlementRequest
Undocumented
See more
Declaration
Swift

public struct UpdateFlowEntitlementRequest : AWSShape
UpdateFlowEntitlementResponse
Undocumented
See more
Declaration
Swift

public struct UpdateFlowEntitlementResponse : AWSShape
UpdateFlowOutputRequest
Undocumented
See more
Declaration
Swift

public struct UpdateFlowOutputRequest : AWSShape
UpdateFlowOutputResponse
Undocumented
See more
Declaration
Swift

public struct UpdateFlowOutputResponse : AWSShape
UpdateFlowRequest
Undocumented
See more
Declaration
Swift

public struct UpdateFlowRequest : AWSShape
UpdateFlowResponse
Undocumented
See more
Declaration
Swift

public struct UpdateFlowResponse : AWSShape
UpdateFlowSourceRequest
Undocumented
See more
Declaration
Swift

public struct UpdateFlowSourceRequest : AWSShape
UpdateFlowSourceResponse
Undocumented
See more
Declaration
Swift

public struct UpdateFlowSourceResponse : AWSShape
VpcInterface
Undocumented
See more
Declaration
Swift

public struct VpcInterface : AWSShape
VpcInterfaceAttachment
Undocumented
See more
Declaration
Swift

public struct VpcInterfaceAttachment : AWSShape
VpcInterfaceRequest
Undocumented
See more
Declaration
Swift

public struct VpcInterfaceRequest : AWSShape

Enums


                    
                    
                    Algorithm

Undocumented

Declaration

Swift

public enum Algorithm : String, CustomStringConvertible, Codable


                    
                    
                    EntitlementStatus

Undocumented

Declaration

Swift

public enum EntitlementStatus : String, CustomStringConvertible, Codable


                    
                    
                    KeyType

Undocumented

Declaration

Swift

public enum KeyType : String, CustomStringConvertible, Codable


                    
                    
                    Protocol

Undocumented

Declaration

Swift

public enum `Protocol` : String, CustomStringConvertible, Codable


                    
                    
                    SourceType

Undocumented

Declaration

Swift

public enum SourceType : String, CustomStringConvertible, Codable


                    
                    
                    State

Undocumented

Declaration

Swift

public enum State : String, CustomStringConvertible, Codable


                    
                    
                    Status

Undocumented

Declaration

Swift

public enum Status : String, CustomStringConvertible, Codable