KinesisVideo

public struct KinesisVideo

Client object for interacting with AWS KinesisVideo service.

Member variables

Initialization

  • Initialize the KinesisVideo 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

  • Creates a signaling channel. CreateSignalingChannel is an asynchronous operation.

    Declaration

    Swift

    public func createSignalingChannel(_ input: CreateSignalingChannelInput) -> EventLoopFuture<CreateSignalingChannelOutput>

  • Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream’s metadata, Kinesis Video Streams updates the version. CreateStream is an asynchronous operation. For information about how the service works, see How it Works. You must have permissions for the KinesisVideo:CreateStream action.

    Declaration

    Swift

    public func createStream(_ input: CreateStreamInput) -> EventLoopFuture<CreateStreamOutput>

  • Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don’t specify the channel’s current version, the most recent version is deleted.

    Declaration

    Swift

    public func deleteSignalingChannel(_ input: DeleteSignalingChannelInput) -> EventLoopFuture<DeleteSignalingChannelOutput>

  • Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream for deletion, and makes the data in the stream inaccessible immediately. To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. This operation requires permission for the KinesisVideo:DeleteStream action.

    Declaration

    Swift

    public func deleteStream(_ input: DeleteStreamInput) -> EventLoopFuture<DeleteStreamOutput>

  • Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.

    Declaration

    Swift

    public func describeSignalingChannel(_ input: DescribeSignalingChannelInput) -> EventLoopFuture<DescribeSignalingChannelOutput>

  • Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

    Declaration

    Swift

    public func describeStream(_ input: DescribeStreamInput) -> EventLoopFuture<DescribeStreamOutput>

  • Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation). The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint. In the request, specify the stream either by StreamName or StreamARN.

    Declaration

    Swift

    public func getDataEndpoint(_ input: GetDataEndpointInput) -> EventLoopFuture<GetDataEndpointOutput>

  • Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties. Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint. Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

    Declaration

    Swift

    public func getSignalingChannelEndpoint(_ input: GetSignalingChannelEndpointInput) -> EventLoopFuture<GetSignalingChannelEndpointOutput>

  • Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

    Declaration

    Swift

    public func listSignalingChannels(_ input: ListSignalingChannelsInput) -> EventLoopFuture<ListSignalingChannelsOutput>

  • Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

    Declaration

    Swift

    public func listStreams(_ input: ListStreamsInput) -> EventLoopFuture<ListStreamsOutput>

  • Returns a list of tags associated with the specified signaling channel.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceInput) -> EventLoopFuture<ListTagsForResourceOutput>

  • Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN.

    Declaration

    Swift

    public func listTagsForStream(_ input: ListTagsForStreamInput) -> EventLoopFuture<ListTagsForStreamOutput>

  • Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceInput) -> EventLoopFuture<TagResourceOutput>

  • Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. You must provide either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:TagStream action. Kinesis video streams support up to 50 tags.

    Declaration

    Swift

    public func tagStream(_ input: TagStreamInput) -> EventLoopFuture<TagStreamOutput>

  • Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don’t specify the value. If you specify a tag key that does not exist, it’s ignored.

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceInput) -> EventLoopFuture<UntagResourceOutput>

  • Removes one or more tags from a stream. In the request, specify only a tag key or keys; don’t specify the value. If you specify a tag key that does not exist, it’s ignored. In the request, you must provide the StreamName or StreamARN.

    Declaration

    Swift

    public func untagStream(_ input: UntagStreamInput) -> EventLoopFuture<UntagStreamOutput>

  • Increases or decreases the stream’s data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN. The retention period that you specify replaces the current value. This operation requires permission for the KinesisVideo:UpdateDataRetention action. Changing the data retention period affects the data in the stream as follows: If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours. If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

    Declaration

    Swift

    public func updateDataRetention(_ input: UpdateDataRetentionInput) -> EventLoopFuture<UpdateDataRetentionOutput>

  • Updates the existing signaling channel. This is an asynchronous operation and takes time to complete. If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it’s been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.

    Declaration

    Swift

    public func updateSignalingChannel(_ input: UpdateSignalingChannelInput) -> EventLoopFuture<UpdateSignalingChannelOutput>

  • Updates stream metadata, such as the device name and media type. You must provide the stream name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. UpdateStream is an asynchronous operation, and takes time to complete.

    Declaration

    Swift

    public func updateStream(_ input: UpdateStreamInput) -> EventLoopFuture<UpdateStreamOutput>

Paginators

  • Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

    Declaration

    Swift

    public func listSignalingChannelsPaginator(_ input: ListSignalingChannelsInput, onPage: @escaping (ListSignalingChannelsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

    Declaration

    Swift

    public func listStreamsPaginator(_ input: ListStreamsInput, onPage: @escaping (ListStreamsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum APIName : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ChannelProtocol : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ChannelRole : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ChannelType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ComparisonOperator : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Status : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum UpdateDataRetentionOperation : String, CustomStringConvertible, Codable