MediaLive
Service object for interacting with AWS MediaLive service.
public struct MediaLive: AWSService
API for AWS Elemental MediaLive
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the MediaLive 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: MediaLive, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
acceptInputDeviceTransfer(_:logger:on:)
Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account.
public func acceptInputDeviceTransfer(_ input: AcceptInputDeviceTransferRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AcceptInputDeviceTransferResponse>
batchDelete(_:logger:on:)
Starts delete of resources.
public func batchDelete(_ input: BatchDeleteRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<BatchDeleteResponse>
batchStart(_:logger:on:)
Starts existing resources
public func batchStart(_ input: BatchStartRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<BatchStartResponse>
batchStop(_:logger:on:)
Stops running resources
public func batchStop(_ input: BatchStopRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<BatchStopResponse>
batchUpdateSchedule(_:logger:on:)
Update a channel schedule
public func batchUpdateSchedule(_ input: BatchUpdateScheduleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<BatchUpdateScheduleResponse>
cancelInputDeviceTransfer(_:logger:on:)
Cancel an input device transfer that you have requested.
public func cancelInputDeviceTransfer(_ input: CancelInputDeviceTransferRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CancelInputDeviceTransferResponse>
claimDevice(_:logger:on:)
Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor. After the request succeeds, you will own the device.
public func claimDevice(_ input: ClaimDeviceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ClaimDeviceResponse>
createChannel(_:logger:on:)
Creates a new channel
public func createChannel(_ input: CreateChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateChannelResponse>
createInput(_:logger:on:)
Create an input
public func createInput(_ input: CreateInputRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateInputResponse>
createInputSecurityGroup(_:logger:on:)
Creates a Input Security Group
public func createInputSecurityGroup(_ input: CreateInputSecurityGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateInputSecurityGroupResponse>
createMultiplex(_:logger:on:)
Create a new multiplex.
public func createMultiplex(_ input: CreateMultiplexRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateMultiplexResponse>
createMultiplexProgram(_:logger:on:)
Create a new program in the multiplex.
public func createMultiplexProgram(_ input: CreateMultiplexProgramRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateMultiplexProgramResponse>
createPartnerInput(_:logger:on:)
Create a partner input
public func createPartnerInput(_ input: CreatePartnerInputRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreatePartnerInputResponse>
createTags(_:logger:on:)
Create tags for a resource
@discardableResult public func createTags(_ input: CreateTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
deleteChannel(_:logger:on:)
Starts deletion of channel. The associated outputs are also deleted.
public func deleteChannel(_ input: DeleteChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteChannelResponse>
deleteInput(_:logger:on:)
Deletes the input end point
public func deleteInput(_ input: DeleteInputRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteInputResponse>
deleteInputSecurityGroup(_:logger:on:)
Deletes an Input Security Group
public func deleteInputSecurityGroup(_ input: DeleteInputSecurityGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteInputSecurityGroupResponse>
deleteMultiplex(_:logger:on:)
Delete a multiplex. The multiplex must be idle.
public func deleteMultiplex(_ input: DeleteMultiplexRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteMultiplexResponse>
deleteMultiplexProgram(_:logger:on:)
Delete a program from a multiplex.
public func deleteMultiplexProgram(_ input: DeleteMultiplexProgramRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteMultiplexProgramResponse>
deleteReservation(_:logger:on:)
Delete an expired reservation.
public func deleteReservation(_ input: DeleteReservationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteReservationResponse>
deleteSchedule(_:logger:on:)
Delete all schedule actions on a channel.
public func deleteSchedule(_ input: DeleteScheduleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteScheduleResponse>
deleteTags(_:logger:on:)
Removes tags for a resource
@discardableResult public func deleteTags(_ input: DeleteTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
describeChannel(_:logger:on:)
Gets details about a channel
public func describeChannel(_ input: DescribeChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeChannelResponse>
describeInput(_:logger:on:)
Produces details about an input
public func describeInput(_ input: DescribeInputRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeInputResponse>
describeInputDevice(_:logger:on:)
Gets the details for the input device
public func describeInputDevice(_ input: DescribeInputDeviceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeInputDeviceResponse>
describeInputDeviceThumbnail(_:logger:on:)
Get the latest thumbnail data for the input device.
public func describeInputDeviceThumbnail(_ input: DescribeInputDeviceThumbnailRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeInputDeviceThumbnailResponse>
describeInputSecurityGroup(_:logger:on:)
Produces a summary of an Input Security Group
public func describeInputSecurityGroup(_ input: DescribeInputSecurityGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeInputSecurityGroupResponse>
describeMultiplex(_:logger:on:)
Gets details about a multiplex.
public func describeMultiplex(_ input: DescribeMultiplexRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeMultiplexResponse>
describeMultiplexProgram(_:logger:on:)
Get the details for a program in a multiplex.
public func describeMultiplexProgram(_ input: DescribeMultiplexProgramRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeMultiplexProgramResponse>
describeOffering(_:logger:on:)
Get details for an offering.
public func describeOffering(_ input: DescribeOfferingRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeOfferingResponse>
describeReservation(_:logger:on:)
Get details for a reservation.
public func describeReservation(_ input: DescribeReservationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeReservationResponse>
describeSchedule(_:logger:on:)
Get a channel schedule
public func describeSchedule(_ input: DescribeScheduleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeScheduleResponse>
listChannels(_:logger:on:)
Produces list of channels that have been created
public func listChannels(_ input: ListChannelsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListChannelsResponse>
listInputDeviceTransfers(_:logger:on:)
List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.
public func listInputDeviceTransfers(_ input: ListInputDeviceTransfersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListInputDeviceTransfersResponse>
listInputDevices(_:logger:on:)
List input devices
public func listInputDevices(_ input: ListInputDevicesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListInputDevicesResponse>
listInputSecurityGroups(_:logger:on:)
Produces a list of Input Security Groups for an account
public func listInputSecurityGroups(_ input: ListInputSecurityGroupsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListInputSecurityGroupsResponse>
listInputs(_:logger:on:)
Produces list of inputs that have been created
public func listInputs(_ input: ListInputsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListInputsResponse>
listMultiplexPrograms(_:logger:on:)
List the programs that currently exist for a specific multiplex.
public func listMultiplexPrograms(_ input: ListMultiplexProgramsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListMultiplexProgramsResponse>
listMultiplexes(_:logger:on:)
Retrieve a list of the existing multiplexes.
public func listMultiplexes(_ input: ListMultiplexesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListMultiplexesResponse>
listOfferings(_:logger:on:)
List offerings available for purchase.
public func listOfferings(_ input: ListOfferingsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListOfferingsResponse>
listReservations(_:logger:on:)
List purchased reservations.
public func listReservations(_ input: ListReservationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListReservationsResponse>
listTagsForResource(_:logger:on:)
Produces list of tags that have been created for a resource
public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>
purchaseOffering(_:logger:on:)
Purchase an offering and create a reservation.
public func purchaseOffering(_ input: PurchaseOfferingRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PurchaseOfferingResponse>
rejectInputDeviceTransfer(_:logger:on:)
Reject the transfer of the specified input device to your AWS account.
public func rejectInputDeviceTransfer(_ input: RejectInputDeviceTransferRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RejectInputDeviceTransferResponse>
startChannel(_:logger:on:)
Starts an existing channel
public func startChannel(_ input: StartChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartChannelResponse>
startMultiplex(_:logger:on:)
Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.
public func startMultiplex(_ input: StartMultiplexRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartMultiplexResponse>
stopChannel(_:logger:on:)
Stops a running channel
public func stopChannel(_ input: StopChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StopChannelResponse>
stopMultiplex(_:logger:on:)
Stops a running multiplex. If the multiplex isn't running, this action has no effect.
public func stopMultiplex(_ input: StopMultiplexRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StopMultiplexResponse>
transferInputDevice(_:logger:on:)
Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.
public func transferInputDevice(_ input: TransferInputDeviceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TransferInputDeviceResponse>
updateChannel(_:logger:on:)
Updates a channel.
public func updateChannel(_ input: UpdateChannelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateChannelResponse>
updateChannelClass(_:logger:on:)
Changes the class of the channel.
public func updateChannelClass(_ input: UpdateChannelClassRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateChannelClassResponse>
updateInput(_:logger:on:)
Updates an input.
public func updateInput(_ input: UpdateInputRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateInputResponse>
updateInputDevice(_:logger:on:)
Updates the parameters for the input device.
public func updateInputDevice(_ input: UpdateInputDeviceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateInputDeviceResponse>
updateInputSecurityGroup(_:logger:on:)
Update an Input Security Group's Whilelists.
public func updateInputSecurityGroup(_ input: UpdateInputSecurityGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateInputSecurityGroupResponse>
updateMultiplex(_:logger:on:)
Updates a multiplex.
public func updateMultiplex(_ input: UpdateMultiplexRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateMultiplexResponse>
updateMultiplexProgram(_:logger:on:)
Update a program in a multiplex.
public func updateMultiplexProgram(_ input: UpdateMultiplexProgramRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateMultiplexProgramResponse>
updateReservation(_:logger:on:)
Update reservation.
public func updateReservation(_ input: UpdateReservationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateReservationResponse>
describeInputDeviceThumbnailStreaming(_:logger:on:_:)
Get the latest thumbnail data for the input device.
public func describeInputDeviceThumbnailStreaming(_ input: DescribeInputDeviceThumbnailRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil, _ stream: @escaping (ByteBuffer, EventLoop)->EventLoopFuture<Void>) -> EventLoopFuture<DescribeInputDeviceThumbnailResponse>
describeSchedulePaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Get a channel schedule
Return PaginatorSequence for operation.
public func describeSchedulePaginator( _ input: DescribeScheduleRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<DescribeScheduleRequest, DescribeScheduleResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listChannelsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Produces list of channels that have been created
Return PaginatorSequence for operation.
public func listChannelsPaginator( _ input: ListChannelsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListChannelsRequest, ListChannelsResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listInputDeviceTransfersPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.
Return PaginatorSequence for operation.
public func listInputDeviceTransfersPaginator( _ input: ListInputDeviceTransfersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListInputDeviceTransfersRequest, ListInputDeviceTransfersResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listInputDevicesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
List input devices
Return PaginatorSequence for operation.
public func listInputDevicesPaginator( _ input: ListInputDevicesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListInputDevicesRequest, ListInputDevicesResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listInputSecurityGroupsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Produces a list of Input Security Groups for an account
Return PaginatorSequence for operation.
public func listInputSecurityGroupsPaginator( _ input: ListInputSecurityGroupsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListInputSecurityGroupsRequest, ListInputSecurityGroupsResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listInputsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Produces list of inputs that have been created
Return PaginatorSequence for operation.
public func listInputsPaginator( _ input: ListInputsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListInputsRequest, ListInputsResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listMultiplexProgramsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
List the programs that currently exist for a specific multiplex.
Return PaginatorSequence for operation.
public func listMultiplexProgramsPaginator( _ input: ListMultiplexProgramsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListMultiplexProgramsRequest, ListMultiplexProgramsResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listMultiplexesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
Retrieve a list of the existing multiplexes.
Return PaginatorSequence for operation.
public func listMultiplexesPaginator( _ input: ListMultiplexesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListMultiplexesRequest, ListMultiplexesResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listOfferingsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
List offerings available for purchase.
Return PaginatorSequence for operation.
public func listOfferingsPaginator( _ input: ListOfferingsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListOfferingsRequest, ListOfferingsResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listReservationsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
-
List purchased reservations.
Return PaginatorSequence for operation.
public func listReservationsPaginator( _ input: ListReservationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListReservationsRequest, ListReservationsResponse>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
describeSchedulePaginator(_:_:logger:on:onPage:)
Get a channel schedule
public func describeSchedulePaginator<Result>(
_ input: DescribeScheduleRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, DescribeScheduleResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
describeSchedulePaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func describeSchedulePaginator(
_ input: DescribeScheduleRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (DescribeScheduleResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listChannelsPaginator(_:_:logger:on:onPage:)
Produces list of channels that have been created
public func listChannelsPaginator<Result>(
_ input: ListChannelsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListChannelsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listChannelsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listChannelsPaginator(
_ input: ListChannelsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListChannelsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listInputDeviceTransfersPaginator(_:_:logger:on:onPage:)
List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.
public func listInputDeviceTransfersPaginator<Result>(
_ input: ListInputDeviceTransfersRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListInputDeviceTransfersResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listInputDeviceTransfersPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listInputDeviceTransfersPaginator(
_ input: ListInputDeviceTransfersRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListInputDeviceTransfersResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listInputDevicesPaginator(_:_:logger:on:onPage:)
List input devices
public func listInputDevicesPaginator<Result>(
_ input: ListInputDevicesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListInputDevicesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listInputDevicesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listInputDevicesPaginator(
_ input: ListInputDevicesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListInputDevicesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listInputSecurityGroupsPaginator(_:_:logger:on:onPage:)
Produces a list of Input Security Groups for an account
public func listInputSecurityGroupsPaginator<Result>(
_ input: ListInputSecurityGroupsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListInputSecurityGroupsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listInputSecurityGroupsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listInputSecurityGroupsPaginator(
_ input: ListInputSecurityGroupsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListInputSecurityGroupsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listInputsPaginator(_:_:logger:on:onPage:)
Produces list of inputs that have been created
public func listInputsPaginator<Result>(
_ input: ListInputsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListInputsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listInputsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listInputsPaginator(
_ input: ListInputsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListInputsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listMultiplexProgramsPaginator(_:_:logger:on:onPage:)
List the programs that currently exist for a specific multiplex.
public func listMultiplexProgramsPaginator<Result>(
_ input: ListMultiplexProgramsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListMultiplexProgramsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listMultiplexProgramsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listMultiplexProgramsPaginator(
_ input: ListMultiplexProgramsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListMultiplexProgramsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listMultiplexesPaginator(_:_:logger:on:onPage:)
Retrieve a list of the existing multiplexes.
public func listMultiplexesPaginator<Result>(
_ input: ListMultiplexesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListMultiplexesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listMultiplexesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listMultiplexesPaginator(
_ input: ListMultiplexesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListMultiplexesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listOfferingsPaginator(_:_:logger:on:onPage:)
List offerings available for purchase.
public func listOfferingsPaginator<Result>(
_ input: ListOfferingsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListOfferingsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listOfferingsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listOfferingsPaginator(
_ input: ListOfferingsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListOfferingsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listReservationsPaginator(_:_:logger:on:onPage:)
List purchased reservations.
public func listReservationsPaginator<Result>(
_ input: ListReservationsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListReservationsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listReservationsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listReservationsPaginator(
_ input: ListReservationsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListReservationsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
waitUntilChannelCreated(_:maxWaitTime:logger:on:)
Wait until a channel has been created
public func waitUntilChannelCreated(
_ input: DescribeChannelRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilChannelDeleted(_:maxWaitTime:logger:on:)
Wait until a channel has been deleted
public func waitUntilChannelDeleted(
_ input: DescribeChannelRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilChannelRunning(_:maxWaitTime:logger:on:)
Wait until a channel is running
public func waitUntilChannelRunning(
_ input: DescribeChannelRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilChannelStopped(_:maxWaitTime:logger:on:)
Wait until a channel has is stopped
public func waitUntilChannelStopped(
_ input: DescribeChannelRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilInputAttached(_:maxWaitTime:logger:on:)
Wait until an input has been attached
public func waitUntilInputAttached(
_ input: DescribeInputRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilInputDeleted(_:maxWaitTime:logger:on:)
Wait until an input has been deleted
public func waitUntilInputDeleted(
_ input: DescribeInputRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilInputDetached(_:maxWaitTime:logger:on:)
Wait until an input has been detached
public func waitUntilInputDetached(
_ input: DescribeInputRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilMultiplexCreated(_:maxWaitTime:logger:on:)
Wait until a multiplex has been created
public func waitUntilMultiplexCreated(
_ input: DescribeMultiplexRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilMultiplexDeleted(_:maxWaitTime:logger:on:)
Wait until a multiplex has been deleted
public func waitUntilMultiplexDeleted(
_ input: DescribeMultiplexRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilMultiplexRunning(_:maxWaitTime:logger:on:)
Wait until a multiplex is running
public func waitUntilMultiplexRunning(
_ input: DescribeMultiplexRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilMultiplexStopped(_:maxWaitTime:logger:on:)
Wait until a multiplex has is stopped
public func waitUntilMultiplexStopped(
_ input: DescribeMultiplexRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>