Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

deletePlaybackRestrictionPolicy

inline suspend fun IvsClient.deletePlaybackRestrictionPolicy(crossinline block: DeletePlaybackRestrictionPolicyRequest.Builder.() -> Unit): DeletePlaybackRestrictionPolicyResponse

Deletes the specified playback restriction policy.

deleteRecordingConfiguration

inline suspend fun IvsClient.deleteRecordingConfiguration(crossinline block: DeleteRecordingConfigurationRequest.Builder.() -> Unit): DeleteRecordingConfigurationResponse

Deletes the recording configuration for the specified ARN.

deleteStreamKey

inline suspend fun IvsClient.deleteStreamKey(crossinline block: DeleteStreamKeyRequest.Builder.() -> Unit): DeleteStreamKeyResponse

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

getChannel

inline suspend fun IvsClient.getChannel(crossinline block: GetChannelRequest.Builder.() -> Unit): GetChannelResponse

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

getPlaybackKeyPair

inline suspend fun IvsClient.getPlaybackKeyPair(crossinline block: GetPlaybackKeyPairRequest.Builder.() -> Unit): GetPlaybackKeyPairResponse

Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

getPlaybackRestrictionPolicy

inline suspend fun IvsClient.getPlaybackRestrictionPolicy(crossinline block: GetPlaybackRestrictionPolicyRequest.Builder.() -> Unit): GetPlaybackRestrictionPolicyResponse

Gets the specified playback restriction policy.

getRecordingConfiguration

inline suspend fun IvsClient.getRecordingConfiguration(crossinline block: GetRecordingConfigurationRequest.Builder.() -> Unit): GetRecordingConfigurationResponse

Gets the recording configuration for the specified ARN.

getStream

inline suspend fun IvsClient.getStream(crossinline block: GetStreamRequest.Builder.() -> Unit): GetStreamResponse

Gets information about the active (live) stream on a specified channel.

getStreamKey

inline suspend fun IvsClient.getStreamKey(crossinline block: GetStreamKeyRequest.Builder.() -> Unit): GetStreamKeyResponse

Gets stream-key information for a specified ARN.

getStreamSession

inline suspend fun IvsClient.getStreamSession(crossinline block: GetStreamSessionRequest.Builder.() -> Unit): GetStreamSessionResponse

Gets metadata on a specified stream.

importPlaybackKeyPair

inline suspend fun IvsClient.importPlaybackKeyPair(crossinline block: ImportPlaybackKeyPairRequest.Builder.() -> Unit): ImportPlaybackKeyPairResponse

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

listChannels

inline suspend fun IvsClient.listChannels(crossinline block: ListChannelsRequest.Builder.() -> Unit): ListChannelsResponse

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

listPlaybackKeyPairs

inline suspend fun IvsClient.listPlaybackKeyPairs(crossinline block: ListPlaybackKeyPairsRequest.Builder.() -> Unit): ListPlaybackKeyPairsResponse

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

listPlaybackRestrictionPolicies

inline suspend fun IvsClient.listPlaybackRestrictionPolicies(crossinline block: ListPlaybackRestrictionPoliciesRequest.Builder.() -> Unit): ListPlaybackRestrictionPoliciesResponse

Gets summary information about playback restriction policies.

listRecordingConfigurations

inline suspend fun IvsClient.listRecordingConfigurations(crossinline block: ListRecordingConfigurationsRequest.Builder.() -> Unit): ListRecordingConfigurationsResponse

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

listStreamKeys

inline suspend fun IvsClient.listStreamKeys(crossinline block: ListStreamKeysRequest.Builder.() -> Unit): ListStreamKeysResponse

Gets summary information about stream keys for the specified channel.

listStreams

inline suspend fun IvsClient.listStreams(crossinline block: ListStreamsRequest.Builder.() -> Unit): ListStreamsResponse

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

listStreamSessions

inline suspend fun IvsClient.listStreamSessions(crossinline block: ListStreamSessionsRequest.Builder.() -> Unit): ListStreamSessionsResponse

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

listTagsForResource

inline suspend fun IvsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Gets information about Amazon Web Services tags for the specified ARN.

putMetadata

inline suspend fun IvsClient.putMetadata(crossinline block: PutMetadataRequest.Builder.() -> Unit): PutMetadataResponse

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

startViewerSessionRevocation

inline suspend fun IvsClient.startViewerSessionRevocation(crossinline block: StartViewerSessionRevocationRequest.Builder.() -> Unit): StartViewerSessionRevocationResponse

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.

stopStream

inline suspend fun IvsClient.stopStream(crossinline block: StopStreamRequest.Builder.() -> Unit): StopStreamResponse

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

tagResource

inline suspend fun IvsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

untagResource

inline suspend fun IvsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from the resource with the specified ARN.

updateChannel

inline suspend fun IvsClient.updateChannel(crossinline block: UpdateChannelRequest.Builder.() -> Unit): UpdateChannelResponse

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

updatePlaybackRestrictionPolicy

inline suspend fun IvsClient.updatePlaybackRestrictionPolicy(crossinline block: UpdatePlaybackRestrictionPolicyRequest.Builder.() -> Unit): UpdatePlaybackRestrictionPolicyResponse

Updates a specified playback restriction policy.

withConfig

fun IvsClient.withConfig(block: IvsClient.Config.Builder.() -> Unit): IvsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.