ivs/aws.sdk.kotlin.services.ivs.model

Package-level declarations

Types

AccessDeniedException

class AccessDeniedException : IvsException

User does not have sufficient access to perform this action.

AdConfiguration

class AdConfiguration

Object specifying a configuration for a server-side advertising insertion (which can be triggered with the operation).

AdConfigurationSummary

class AdConfigurationSummary

Summary information about an ad configuration.

AudioConfiguration

class AudioConfiguration

Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfigurations object and the deprecated IngestConfiguration object. It is used for monitoring stream health.

BatchError

class BatchError

Error related to a specific channel, specified by its ARN.

BatchGetChannelRequest

class BatchGetChannelRequest

BatchGetChannelResponse

class BatchGetChannelResponse

BatchGetStreamKeyRequest

class BatchGetStreamKeyRequest

BatchGetStreamKeyResponse

class BatchGetStreamKeyResponse

BatchStartViewerSessionRevocationError

class BatchStartViewerSessionRevocationError

Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.

BatchStartViewerSessionRevocationRequest

class BatchStartViewerSessionRevocationRequest

BatchStartViewerSessionRevocationResponse

class BatchStartViewerSessionRevocationResponse

BatchStartViewerSessionRevocationViewerSession

class BatchStartViewerSessionRevocationViewerSession

A viewer session to revoke in the call to BatchStartViewerSessionRevocation.

Channel

class Channel

Object specifying a channel.

ChannelLatencyMode

sealed class ChannelLatencyMode

ChannelNotBroadcasting

class ChannelNotBroadcasting : IvsException

The stream is offline for the given channel ARN.

ChannelSummary

class ChannelSummary

Summary information about a channel.

ChannelType

sealed class ChannelType

ConflictException

class ConflictException : IvsException

Updating or deleting a resource can cause an inconsistent state.

ContainerFormat

sealed class ContainerFormat

CreateAdConfigurationRequest

class CreateAdConfigurationRequest

CreateAdConfigurationResponse

class CreateAdConfigurationResponse

CreateChannelRequest

class CreateChannelRequest

CreateChannelResponse

class CreateChannelResponse

CreatePlaybackRestrictionPolicyRequest

class CreatePlaybackRestrictionPolicyRequest

CreatePlaybackRestrictionPolicyResponse

class CreatePlaybackRestrictionPolicyResponse

CreateRecordingConfigurationRequest

class CreateRecordingConfigurationRequest

CreateRecordingConfigurationResponse

class CreateRecordingConfigurationResponse

CreateStreamKeyRequest

class CreateStreamKeyRequest

CreateStreamKeyResponse

class CreateStreamKeyResponse

DeleteAdConfigurationRequest

class DeleteAdConfigurationRequest

DeleteAdConfigurationResponse

class DeleteAdConfigurationResponse

DeleteChannelRequest

class DeleteChannelRequest

DeleteChannelResponse

class DeleteChannelResponse

DeletePlaybackKeyPairRequest

class DeletePlaybackKeyPairRequest

DeletePlaybackKeyPairResponse

class DeletePlaybackKeyPairResponse

DeletePlaybackRestrictionPolicyRequest

class DeletePlaybackRestrictionPolicyRequest

DeletePlaybackRestrictionPolicyResponse

class DeletePlaybackRestrictionPolicyResponse

DeleteRecordingConfigurationRequest

class DeleteRecordingConfigurationRequest

DeleteRecordingConfigurationResponse

class DeleteRecordingConfigurationResponse

DeleteStreamKeyRequest

class DeleteStreamKeyRequest

DeleteStreamKeyResponse

class DeleteStreamKeyResponse

DestinationConfiguration

class DestinationConfiguration

A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.

GetAdConfigurationRequest

class GetAdConfigurationRequest

GetAdConfigurationResponse

class GetAdConfigurationResponse

GetChannelRequest

class GetChannelRequest

GetChannelResponse

class GetChannelResponse

GetPlaybackKeyPairRequest

class GetPlaybackKeyPairRequest

GetPlaybackKeyPairResponse

class GetPlaybackKeyPairResponse

GetPlaybackRestrictionPolicyRequest

class GetPlaybackRestrictionPolicyRequest

GetPlaybackRestrictionPolicyResponse

class GetPlaybackRestrictionPolicyResponse

GetRecordingConfigurationRequest

class GetRecordingConfigurationRequest

GetRecordingConfigurationResponse

class GetRecordingConfigurationResponse

GetStreamKeyRequest

class GetStreamKeyRequest

GetStreamKeyResponse

class GetStreamKeyResponse

GetStreamRequest

class GetStreamRequest

GetStreamResponse

class GetStreamResponse

GetStreamSessionRequest

class GetStreamSessionRequest

GetStreamSessionResponse

class GetStreamSessionResponse

ImportPlaybackKeyPairRequest

class ImportPlaybackKeyPairRequest

ImportPlaybackKeyPairResponse

class ImportPlaybackKeyPairResponse

IngestConfiguration

class IngestConfiguration

Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.

IngestConfigurations

class IngestConfigurations

Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.

InsertAdBreakRequest

class InsertAdBreakRequest

InsertAdBreakResponse

class InsertAdBreakResponse

InternalServerException

class InternalServerException : IvsException

Unexpected error during processing of request.

IvsException

open class IvsException : AwsServiceException

Base class for all service related exceptions thrown by the Ivs client

ListAdConfigurationsRequest

class ListAdConfigurationsRequest

ListAdConfigurationsResponse

class ListAdConfigurationsResponse

ListChannelsRequest

class ListChannelsRequest

ListChannelsResponse

class ListChannelsResponse

ListPlaybackKeyPairsRequest

class ListPlaybackKeyPairsRequest

ListPlaybackKeyPairsResponse

class ListPlaybackKeyPairsResponse

ListPlaybackRestrictionPoliciesRequest

class ListPlaybackRestrictionPoliciesRequest

ListPlaybackRestrictionPoliciesResponse

class ListPlaybackRestrictionPoliciesResponse

ListRecordingConfigurationsRequest

class ListRecordingConfigurationsRequest

ListRecordingConfigurationsResponse

class ListRecordingConfigurationsResponse

ListStreamKeysRequest

class ListStreamKeysRequest

ListStreamKeysResponse

class ListStreamKeysResponse

ListStreamSessionsRequest

class ListStreamSessionsRequest

ListStreamSessionsResponse

class ListStreamSessionsResponse

ListStreamsRequest

class ListStreamsRequest

ListStreamsResponse

class ListStreamsResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

MediaTailorPlaybackConfiguration

class MediaTailorPlaybackConfiguration

Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).

MultitrackInputConfiguration

class MultitrackInputConfiguration

A complex type that specifies multitrack input configuration.

MultitrackMaximumResolution

sealed class MultitrackMaximumResolution

MultitrackPolicy

sealed class MultitrackPolicy

PendingVerification

class PendingVerification : IvsException

Your account is pending verification.

PlaybackKeyPair

class PlaybackKeyPair

A key pair used to sign and validate a playback authorization token.

PlaybackKeyPairSummary

class PlaybackKeyPairSummary

Summary information about a playback key pair.

PlaybackRestrictionPolicy

class PlaybackRestrictionPolicy

An object representing a policy to constrain playback by country and/or origin sites.

PlaybackRestrictionPolicySummary

class PlaybackRestrictionPolicySummary

Summary information about a PlaybackRestrictionPolicy.

PostRollConfiguration

class PostRollConfiguration

Configuration for the post-roll ad break to use for this ad configuration.

PutMetadataRequest

class PutMetadataRequest

PutMetadataResponse

class PutMetadataResponse

RecordingConfiguration

class RecordingConfiguration

An object representing a configuration to record a channel stream.

RecordingConfigurationState

sealed class RecordingConfigurationState

RecordingConfigurationSummary

class RecordingConfigurationSummary

Summary information about a RecordingConfiguration.

RecordingMode

sealed class RecordingMode

RenditionConfiguration

class RenditionConfiguration

Object that describes which renditions should be recorded for a stream.

RenditionConfigurationRendition

sealed class RenditionConfigurationRendition

RenditionConfigurationRenditionSelection

sealed class RenditionConfigurationRenditionSelection

ResourceNotFoundException

class ResourceNotFoundException : IvsException

Request references a resource which does not exist.

S3DestinationConfiguration

class S3DestinationConfiguration

A complex type that describes an S3 location where recorded videos will be stored.

ServiceQuotaExceededException

class ServiceQuotaExceededException : IvsException

Request would cause a service quota to be exceeded.

ServiceUnavailable

class ServiceUnavailable : IvsException

The service is temporarily unavailable.

Srt

class Srt

Specifies information needed to stream using the SRT protocol.

StartViewerSessionRevocationRequest

class StartViewerSessionRevocationRequest

StartViewerSessionRevocationResponse

class StartViewerSessionRevocationResponse

StopStreamRequest

class StopStreamRequest

StopStreamResponse

class StopStreamResponse

Stream

class Stream

Specifies a live video stream that has been ingested and distributed.

StreamEvent

class StreamEvent

Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.

StreamFilters

class StreamFilters

Object specifying the stream attribute on which to filter.

StreamHealth

sealed class StreamHealth

StreamKey

class StreamKey

Object specifying a stream key.

StreamKeySummary

class StreamKeySummary

Summary information about a stream key.

StreamSession

class StreamSession

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

StreamSessionSummary

class StreamSessionSummary

Summary information about a stream session.

StreamState

sealed class StreamState

StreamSummary

class StreamSummary

Summary information about a stream.

StreamUnavailable

class StreamUnavailable : IvsException

The stream is temporarily unavailable.

TagResourceRequest

class TagResourceRequest

TagResourceResponse

class TagResourceResponse

ThrottlingException

class ThrottlingException : IvsException

Request was denied due to request throttling.

ThumbnailConfiguration

class ThumbnailConfiguration

An object representing a configuration of thumbnails for recorded video.

ThumbnailConfigurationResolution

sealed class ThumbnailConfigurationResolution

ThumbnailConfigurationStorage

sealed class ThumbnailConfigurationStorage

TranscodePreset

sealed class TranscodePreset

UntagResourceRequest

class UntagResourceRequest

UntagResourceResponse

class UntagResourceResponse

UpdateAdConfigurationRequest

class UpdateAdConfigurationRequest

UpdateAdConfigurationResponse

class UpdateAdConfigurationResponse

UpdateChannelRequest

class UpdateChannelRequest

UpdateChannelResponse

class UpdateChannelResponse

UpdatePlaybackRestrictionPolicyRequest

class UpdatePlaybackRestrictionPolicyRequest

UpdatePlaybackRestrictionPolicyResponse

class UpdatePlaybackRestrictionPolicyResponse

ValidationException

class ValidationException : IvsException

The input fails to satisfy the constraints specified by an Amazon Web Services service.

VideoConfiguration

class VideoConfiguration

Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfigurations object and the deprecated IngestConfiguration object. It is used for monitoring stream health.