Module Awso_ivs_lwtSource

Sourceval delete_ad_configuration : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_ivs.Values.DeleteAdConfigurationRequest.t -> (unit, unit) Result.t Lwt.t
Sourceval delete_channel : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_ivs.Values.DeleteChannelRequest.t -> (unit, unit) Result.t Lwt.t
Sourceval delete_playback_restriction_policy : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_ivs.Values.DeletePlaybackRestrictionPolicyRequest.t -> (unit, unit) Result.t Lwt.t
Sourceval delete_recording_configuration : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_ivs.Values.DeleteRecordingConfigurationRequest.t -> (unit, unit) Result.t Lwt.t
Sourceval delete_stream_key : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_ivs.Values.DeleteStreamKeyRequest.t -> (unit, unit) Result.t Lwt.t
Sourceval put_metadata : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_ivs.Values.PutMetadataRequest.t -> (unit, unit) Result.t Lwt.t
include module type of struct include Awso_ivs.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule S3DestinationBucketName = Awso_ivs.Values.S3DestinationBucketName
Sourcemodule MediaTailorPlaybackConfigurationArn = Awso_ivs.Values.MediaTailorPlaybackConfigurationArn
Sourcemodule RenditionConfigurationRendition = Awso_ivs.Values.RenditionConfigurationRendition
Sourcemodule ThumbnailConfigurationStorage = Awso_ivs.Values.ThumbnailConfigurationStorage
Sourcemodule S3DestinationConfiguration = Awso_ivs.Values.S3DestinationConfiguration

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

Sourcemodule PlaybackRestrictionPolicyAllowedCountry = Awso_ivs.Values.PlaybackRestrictionPolicyAllowedCountry
Sourcemodule PlaybackRestrictionPolicyAllowedOrigin = Awso_ivs.Values.PlaybackRestrictionPolicyAllowedOrigin
Sourcemodule MediaTailorPlaybackConfiguration = Awso_ivs.Values.MediaTailorPlaybackConfiguration

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

Sourcemodule IsMultitrackInputEnabled = Awso_ivs.Values.IsMultitrackInputEnabled
Sourcemodule MultitrackMaximumResolution = Awso_ivs.Values.MultitrackMaximumResolution
Sourcemodule MultitrackPolicy = Awso_ivs.Values.MultitrackPolicy
Sourcemodule AudioConfiguration = Awso_ivs.Values.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.

Sourcemodule VideoConfiguration = Awso_ivs.Values.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.

Sourcemodule RenditionConfigurationRenditionList = Awso_ivs.Values.RenditionConfigurationRenditionList
Sourcemodule RenditionConfigurationRenditionSelection = Awso_ivs.Values.RenditionConfigurationRenditionSelection
Sourcemodule TargetIntervalSeconds = Awso_ivs.Values.TargetIntervalSeconds
Sourcemodule ThumbnailConfigurationResolution = Awso_ivs.Values.ThumbnailConfigurationResolution
Sourcemodule ThumbnailConfigurationStorageList = Awso_ivs.Values.ThumbnailConfigurationStorageList
Sourcemodule StreamStartTime = Awso_ivs.Values.StreamStartTime
Sourcemodule StreamViewerCount = Awso_ivs.Values.StreamViewerCount
Sourcemodule DestinationConfiguration = Awso_ivs.Values.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.

Sourcemodule RecordingConfigurationArn = Awso_ivs.Values.RecordingConfigurationArn
Sourcemodule RecordingConfigurationName = Awso_ivs.Values.RecordingConfigurationName
Sourcemodule RecordingConfigurationState = Awso_ivs.Values.RecordingConfigurationState
Sourcemodule PlaybackRestrictionPolicyAllowedCountryList = Awso_ivs.Values.PlaybackRestrictionPolicyAllowedCountryList
Sourcemodule PlaybackRestrictionPolicyAllowedOriginList = Awso_ivs.Values.PlaybackRestrictionPolicyAllowedOriginList
Sourcemodule PlaybackRestrictionPolicyArn = Awso_ivs.Values.PlaybackRestrictionPolicyArn
Sourcemodule PlaybackRestrictionPolicyEnableStrictOriginEnforcement = Awso_ivs.Values.PlaybackRestrictionPolicyEnableStrictOriginEnforcement
Sourcemodule PlaybackRestrictionPolicyName = Awso_ivs.Values.PlaybackRestrictionPolicyName
Sourcemodule PlaybackKeyPairArn = Awso_ivs.Values.PlaybackKeyPairArn
Sourcemodule PlaybackKeyPairName = Awso_ivs.Values.PlaybackKeyPairName
Sourcemodule ChannelAdConfigurationArn = Awso_ivs.Values.ChannelAdConfigurationArn
Sourcemodule ChannelLatencyMode = Awso_ivs.Values.ChannelLatencyMode
Sourcemodule ChannelPlaybackRestrictionPolicyArn = Awso_ivs.Values.ChannelPlaybackRestrictionPolicyArn
Sourcemodule ChannelRecordingConfigurationArn = Awso_ivs.Values.ChannelRecordingConfigurationArn
Sourcemodule InsecureIngest = Awso_ivs.Values.InsecureIngest
Sourcemodule TranscodePreset = Awso_ivs.Values.TranscodePreset
Sourcemodule AdConfigurationArn = Awso_ivs.Values.AdConfigurationArn
Sourcemodule AdConfigurationName = Awso_ivs.Values.AdConfigurationName
Sourcemodule MediaTailorPlaybackConfigurationsList = Awso_ivs.Values.MediaTailorPlaybackConfigurationsList
Sourcemodule ContainerFormat = Awso_ivs.Values.ContainerFormat
Sourcemodule IngestEndpoint = Awso_ivs.Values.IngestEndpoint
Sourcemodule MultitrackInputConfiguration = Awso_ivs.Values.MultitrackInputConfiguration

A complex type that specifies multitrack input configuration.

Specifies information needed to stream using the SRT protocol.

Sourcemodule AudioConfigurationList = Awso_ivs.Values.AudioConfigurationList
Sourcemodule VideoConfigurationList = Awso_ivs.Values.VideoConfigurationList
Sourcemodule RecordingReconnectWindowSeconds = Awso_ivs.Values.RecordingReconnectWindowSeconds
Sourcemodule RenditionConfiguration = Awso_ivs.Values.RenditionConfiguration

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

Sourcemodule ThumbnailConfiguration = Awso_ivs.Values.ThumbnailConfiguration

An object representing a configuration of thumbnails for recorded video.

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

Sourcemodule ViewerSessionVersion = Awso_ivs.Values.ViewerSessionVersion
Sourcemodule StreamKeyValue = Awso_ivs.Values.StreamKeyValue

Summary information about a stream.

Sourcemodule StreamSessionSummary = Awso_ivs.Values.StreamSessionSummary

Summary information about a stream session.

Sourcemodule StreamKeySummary = Awso_ivs.Values.StreamKeySummary

Summary information about a stream key.

Sourcemodule RecordingConfigurationSummary = Awso_ivs.Values.RecordingConfigurationSummary

Summary information about a RecordingConfiguration.

Sourcemodule PlaybackRestrictionPolicySummary = Awso_ivs.Values.PlaybackRestrictionPolicySummary

Summary information about a PlaybackRestrictionPolicy.

Sourcemodule PlaybackKeyPairSummary = Awso_ivs.Values.PlaybackKeyPairSummary

Summary information about a playback key pair.

Sourcemodule ChannelSummary = Awso_ivs.Values.ChannelSummary

Summary information about a channel.

Sourcemodule AdConfigurationSummary = Awso_ivs.Values.AdConfigurationSummary

Summary information about an ad configuration.

Sourcemodule PlaybackKeyPairFingerprint = Awso_ivs.Values.PlaybackKeyPairFingerprint

Object specifying a channel.

Sourcemodule IngestConfiguration = Awso_ivs.Values.IngestConfiguration

Object specifying the ingest configuration set up by the broadcaster, usually in an encoder. Note: IngestConfiguration is deprecated in favor of IngestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, IngestConfiguration and IngestConfigurations contain the same data, namely information about Track0 (the sole track). If multitrack is enabled, IngestConfiguration contains data for only the first track (Track0) and IngestConfigurations contains data for all tracks.

Sourcemodule IngestConfigurations = Awso_ivs.Values.IngestConfigurations

Object specifying the ingest configuration set up by the broadcaster, usually in an encoder. Note: Use IngestConfigurations instead of IngestConfiguration (which is deprecated). If multitrack is not enabled, IngestConfiguration and IngestConfigurations contain the same data, namely information about Track0 (the sole track). If multitrack is enabled, IngestConfiguration contains data for only the first track (Track0) and IngestConfigurations contains data for all tracks.

Sourcemodule RecordingConfiguration = Awso_ivs.Values.RecordingConfiguration

An object representing a configuration to record a channel stream.

Sourcemodule BatchStartViewerSessionRevocationError = Awso_ivs.Values.BatchStartViewerSessionRevocationError

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

Sourcemodule BatchStartViewerSessionRevocationViewerSession = Awso_ivs.Values.BatchStartViewerSessionRevocationViewerSession

A viewer session to revoke in the call to BatchStartViewerSessionRevocation.

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

Object specifying a stream key.

Sourcemodule AccessDeniedException = Awso_ivs.Values.AccessDeniedException
Sourcemodule ConflictException = Awso_ivs.Values.ConflictException
Sourcemodule PendingVerification = Awso_ivs.Values.PendingVerification
Sourcemodule PlaybackRestrictionPolicy = Awso_ivs.Values.PlaybackRestrictionPolicy

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

Sourcemodule ResourceNotFoundException = Awso_ivs.Values.ResourceNotFoundException
Sourcemodule ValidationException = Awso_ivs.Values.ValidationException
Sourcemodule InternalServerException = Awso_ivs.Values.InternalServerException
Sourcemodule ChannelNotBroadcasting = Awso_ivs.Values.ChannelNotBroadcasting
Sourcemodule StreamUnavailable = Awso_ivs.Values.StreamUnavailable
Sourcemodule ThrottlingException = Awso_ivs.Values.ThrottlingException
Sourcemodule StreamMetadata = Awso_ivs.Values.StreamMetadata
Sourcemodule PaginationToken = Awso_ivs.Values.PaginationToken
Sourcemodule MaxStreamResults = Awso_ivs.Values.MaxStreamResults

Object specifying the stream attribute on which to filter.

Sourcemodule StreamSessionList = Awso_ivs.Values.StreamSessionList
Sourcemodule MaxStreamKeyResults = Awso_ivs.Values.MaxStreamKeyResults
Sourcemodule RecordingConfigurationList = Awso_ivs.Values.RecordingConfigurationList
Sourcemodule MaxRecordingConfigurationResults = Awso_ivs.Values.MaxRecordingConfigurationResults
Sourcemodule PlaybackRestrictionPolicyList = Awso_ivs.Values.PlaybackRestrictionPolicyList
Sourcemodule MaxPlaybackRestrictionPolicyResults = Awso_ivs.Values.MaxPlaybackRestrictionPolicyResults
Sourcemodule PlaybackKeyPairList = Awso_ivs.Values.PlaybackKeyPairList
Sourcemodule MaxPlaybackKeyPairResults = Awso_ivs.Values.MaxPlaybackKeyPairResults
Sourcemodule MaxChannelResults = Awso_ivs.Values.MaxChannelResults
Sourcemodule AdConfigurationList = Awso_ivs.Values.AdConfigurationList
Sourcemodule MaxAdConfigurationResults = Awso_ivs.Values.MaxAdConfigurationResults
Sourcemodule AdDurationSeconds = Awso_ivs.Values.AdDurationSeconds
Sourcemodule PlaybackKeyPair = Awso_ivs.Values.PlaybackKeyPair

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

Sourcemodule ServiceQuotaExceededException = Awso_ivs.Values.ServiceQuotaExceededException
Sourcemodule PlaybackPublicKeyMaterial = Awso_ivs.Values.PlaybackPublicKeyMaterial

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.

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

Sourcemodule AdConfiguration = Awso_ivs.Values.AdConfiguration

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

Sourcemodule BatchStartViewerSessionRevocationErrors = Awso_ivs.Values.BatchStartViewerSessionRevocationErrors
Sourcemodule BatchStartViewerSessionRevocationViewerSessionList = Awso_ivs.Values.BatchStartViewerSessionRevocationViewerSessionList
Sourcemodule ServiceUnavailable = Awso_ivs.Values.ServiceUnavailable
Sourcemodule StreamKeyArnList = Awso_ivs.Values.StreamKeyArnList
Sourcemodule ChannelArnList = Awso_ivs.Values.ChannelArnList
Sourcemodule UpdatePlaybackRestrictionPolicyResponse = Awso_ivs.Values.UpdatePlaybackRestrictionPolicyResponse

Updates a specified playback restriction policy.

Sourcemodule UpdatePlaybackRestrictionPolicyRequest = Awso_ivs.Values.UpdatePlaybackRestrictionPolicyRequest

Updates a specified playback restriction policy.

Sourcemodule UpdateChannelResponse = Awso_ivs.Values.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.

Sourcemodule UpdateChannelRequest = Awso_ivs.Values.UpdateChannelRequest

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.

Sourcemodule UntagResourceResponse = Awso_ivs.Values.UntagResourceResponse

Removes tags from the resource with the specified ARN.

Sourcemodule UntagResourceRequest = Awso_ivs.Values.UntagResourceRequest

Removes tags from the resource with the specified ARN.

Sourcemodule TagResourceResponse = Awso_ivs.Values.TagResourceResponse

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

Sourcemodule TagResourceRequest = Awso_ivs.Values.TagResourceRequest

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

Sourcemodule StopStreamResponse = Awso_ivs.Values.StopStreamResponse

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel. Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

Sourcemodule StopStreamRequest = Awso_ivs.Values.StopStreamRequest

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel. Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

Sourcemodule StartViewerSessionRevocationResponse = Awso_ivs.Values.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.

Sourcemodule StartViewerSessionRevocationRequest = Awso_ivs.Values.StartViewerSessionRevocationRequest

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.

Sourcemodule PutMetadataRequest = Awso_ivs.Values.PutMetadataRequest

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.

Sourcemodule ListTagsForResourceResponse = Awso_ivs.Values.ListTagsForResourceResponse

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

Sourcemodule ListTagsForResourceRequest = Awso_ivs.Values.ListTagsForResourceRequest

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

Sourcemodule ListStreamsResponse = Awso_ivs.Values.ListStreamsResponse

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

Sourcemodule ListStreamsRequest = Awso_ivs.Values.ListStreamsRequest

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

Sourcemodule ListStreamSessionsResponse = Awso_ivs.Values.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.

Sourcemodule ListStreamSessionsRequest = Awso_ivs.Values.ListStreamSessionsRequest

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.

Sourcemodule ListStreamKeysResponse = Awso_ivs.Values.ListStreamKeysResponse

Gets summary information about stream keys for the specified channel.

Sourcemodule ListStreamKeysRequest = Awso_ivs.Values.ListStreamKeysRequest

Gets summary information about stream keys for the specified channel.

Sourcemodule ListRecordingConfigurationsResponse = Awso_ivs.Values.ListRecordingConfigurationsResponse

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

Sourcemodule ListRecordingConfigurationsRequest = Awso_ivs.Values.ListRecordingConfigurationsRequest

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

Sourcemodule ListPlaybackRestrictionPoliciesResponse = Awso_ivs.Values.ListPlaybackRestrictionPoliciesResponse

Gets summary information about playback restriction policies.

Sourcemodule ListPlaybackRestrictionPoliciesRequest = Awso_ivs.Values.ListPlaybackRestrictionPoliciesRequest

Gets summary information about playback restriction policies.

Sourcemodule ListPlaybackKeyPairsResponse = Awso_ivs.Values.ListPlaybackKeyPairsResponse

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

Sourcemodule ListPlaybackKeyPairsRequest = Awso_ivs.Values.ListPlaybackKeyPairsRequest

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

Sourcemodule ListChannelsResponse = Awso_ivs.Values.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).

Sourcemodule ListChannelsRequest = Awso_ivs.Values.ListChannelsRequest

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).

Sourcemodule ListAdConfigurationsResponse = Awso_ivs.Values.ListAdConfigurationsResponse

Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.

Sourcemodule ListAdConfigurationsRequest = Awso_ivs.Values.ListAdConfigurationsRequest

Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.

Sourcemodule InsertAdBreakResponse = Awso_ivs.Values.InsertAdBreakResponse

Inserts an ad marker in the playlist for the specified channel and duration using the ad configuration associated with the channel. Note: AWS Elemental MediaTailor (EMT), the service that handles ad requests, provides CloudWatch metrics to help you monitor the success or failure of each InsertAdBreak operation. See Monitoring AWS Elemental MediaTailor with Amazon CloudWatch metrics in the AWS Elemental MediaTailor User Guide for details on available metrics.

Sourcemodule InsertAdBreakRequest = Awso_ivs.Values.InsertAdBreakRequest

Inserts an ad marker in the playlist for the specified channel and duration using the ad configuration associated with the channel. Note: AWS Elemental MediaTailor (EMT), the service that handles ad requests, provides CloudWatch metrics to help you monitor the success or failure of each InsertAdBreak operation. See Monitoring AWS Elemental MediaTailor with Amazon CloudWatch metrics in the AWS Elemental MediaTailor User Guide for details on available metrics.

Sourcemodule ImportPlaybackKeyPairResponse = Awso_ivs.Values.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.

Sourcemodule ImportPlaybackKeyPairRequest = Awso_ivs.Values.ImportPlaybackKeyPairRequest

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.

Sourcemodule GetStreamSessionResponse = Awso_ivs.Values.GetStreamSessionResponse

Gets metadata on a specified stream.

Sourcemodule GetStreamSessionRequest = Awso_ivs.Values.GetStreamSessionRequest

Gets metadata on a specified stream.

Sourcemodule GetStreamResponse = Awso_ivs.Values.GetStreamResponse

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

Sourcemodule GetStreamRequest = Awso_ivs.Values.GetStreamRequest

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

Sourcemodule GetStreamKeyResponse = Awso_ivs.Values.GetStreamKeyResponse

Gets stream-key information for a specified ARN.

Sourcemodule GetStreamKeyRequest = Awso_ivs.Values.GetStreamKeyRequest

Gets stream-key information for a specified ARN.

Sourcemodule GetRecordingConfigurationResponse = Awso_ivs.Values.GetRecordingConfigurationResponse

Gets the recording configuration for the specified ARN.

Sourcemodule GetRecordingConfigurationRequest = Awso_ivs.Values.GetRecordingConfigurationRequest

Gets the recording configuration for the specified ARN.

Sourcemodule GetPlaybackRestrictionPolicyResponse = Awso_ivs.Values.GetPlaybackRestrictionPolicyResponse

Gets the specified playback restriction policy.

Sourcemodule GetPlaybackRestrictionPolicyRequest = Awso_ivs.Values.GetPlaybackRestrictionPolicyRequest

Gets the specified playback restriction policy.

Sourcemodule GetPlaybackKeyPairResponse = Awso_ivs.Values.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.

Sourcemodule GetPlaybackKeyPairRequest = Awso_ivs.Values.GetPlaybackKeyPairRequest

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.

Sourcemodule GetChannelResponse = Awso_ivs.Values.GetChannelResponse

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

Sourcemodule GetChannelRequest = Awso_ivs.Values.GetChannelRequest

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

Sourcemodule GetAdConfigurationResponse = Awso_ivs.Values.GetAdConfigurationResponse

Gets the ad configuration represented by the specified ARN.

Sourcemodule GetAdConfigurationRequest = Awso_ivs.Values.GetAdConfigurationRequest

Gets the ad configuration represented by the specified ARN.

Sourcemodule DeleteStreamKeyRequest = Awso_ivs.Values.DeleteStreamKeyRequest

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

Sourcemodule DeleteRecordingConfigurationRequest = Awso_ivs.Values.DeleteRecordingConfigurationRequest

Deletes the recording configuration for the specified ARN. If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

Sourcemodule DeletePlaybackRestrictionPolicyRequest = Awso_ivs.Values.DeletePlaybackRestrictionPolicyRequest

Deletes the specified playback restriction policy.

Sourcemodule DeletePlaybackKeyPairResponse = Awso_ivs.Values.DeletePlaybackKeyPairResponse

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.

Sourcemodule DeletePlaybackKeyPairRequest = Awso_ivs.Values.DeletePlaybackKeyPairRequest

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.

Sourcemodule DeleteChannelRequest = Awso_ivs.Values.DeleteChannelRequest

Deletes the specified channel and its associated stream keys. If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Sourcemodule DeleteAdConfigurationRequest = Awso_ivs.Values.DeleteAdConfigurationRequest

Deletes the specified ad configuration.

Sourcemodule CreateStreamKeyResponse = Awso_ivs.Values.CreateStreamKeyResponse

Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

Sourcemodule CreateStreamKeyRequest = Awso_ivs.Values.CreateStreamKeyRequest

Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

Sourcemodule CreateRecordingConfigurationResponse = Awso_ivs.Values.CreateRecordingConfigurationResponse

Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.) Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Sourcemodule CreateRecordingConfigurationRequest = Awso_ivs.Values.CreateRecordingConfigurationRequest

Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.) Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Sourcemodule CreatePlaybackRestrictionPolicyResponse = Awso_ivs.Values.CreatePlaybackRestrictionPolicyResponse

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

Sourcemodule CreatePlaybackRestrictionPolicyRequest = Awso_ivs.Values.CreatePlaybackRestrictionPolicyRequest

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

Sourcemodule CreateChannelResponse = Awso_ivs.Values.CreateChannelResponse

Creates a new channel and an associated stream key to start streaming.

Sourcemodule CreateChannelRequest = Awso_ivs.Values.CreateChannelRequest

Creates a new channel and an associated stream key to start streaming.

Sourcemodule CreateAdConfigurationResponse = Awso_ivs.Values.CreateAdConfigurationResponse

Creates a new ad configuration to be used for server-side ad insertion.

Sourcemodule CreateAdConfigurationRequest = Awso_ivs.Values.CreateAdConfigurationRequest

Creates a new ad configuration to be used for server-side ad insertion.

Sourcemodule BatchStartViewerSessionRevocationResponse = Awso_ivs.Values.BatchStartViewerSessionRevocationResponse

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

Sourcemodule BatchStartViewerSessionRevocationRequest = Awso_ivs.Values.BatchStartViewerSessionRevocationRequest

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

Sourcemodule BatchGetStreamKeyResponse = Awso_ivs.Values.BatchGetStreamKeyResponse

Performs GetStreamKey on multiple ARNs simultaneously.

Sourcemodule BatchGetStreamKeyRequest = Awso_ivs.Values.BatchGetStreamKeyRequest

Performs GetStreamKey on multiple ARNs simultaneously.

Sourcemodule BatchGetChannelResponse = Awso_ivs.Values.BatchGetChannelResponse

Performs GetChannel on multiple ARNs simultaneously.

Sourcemodule BatchGetChannelRequest = Awso_ivs.Values.BatchGetChannelRequest

Performs GetChannel on multiple ARNs simultaneously.