Awso_ivs.ValuesSourceval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]A complex type that describes an S3 location where recorded videos will be stored.
Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
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.
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.
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.
A complex type that specifies multitrack input configuration.
Object that describes which renditions should be recorded for a stream.
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.
Summary information about a stream.
Summary information about a stream session.
Summary information about a stream key.
Summary information about a RecordingConfiguration.
Summary information about a PlaybackRestrictionPolicy.
Summary information about a playback key pair.
Summary information about a channel.
Summary information about an ad configuration.
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.
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.
An object representing a configuration to record a channel stream.
Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.
A viewer session to revoke in the call to BatchStartViewerSessionRevocation.
Error related to a specific channel, specified by its ARN.
An object representing a policy to constrain playback by country and/or origin sites.
Object specifying the stream attribute on which to filter.
A key pair used to sign and validate a playback authorization token.
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.
Object specifying a configuration for a server-side advertising insertion (which can be triggered with the operation).
Updates a specified playback restriction policy.
Updates a specified playback restriction policy.
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.
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.
Removes tags from the resource with the specified ARN.
Removes tags from the resource with the specified ARN.
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
Adds or updates tags for the Amazon Web Services resource with the specified ARN.
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.
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.
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.
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.
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.
Gets information about Amazon Web Services tags for the specified ARN.
Gets information about Amazon Web Services tags for the specified ARN.
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
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.
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.
Gets summary information about stream keys for the specified channel.
Gets summary information about stream keys for the specified channel.
Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
Gets summary information about playback restriction policies.
Gets summary information about playback restriction policies.
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
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).
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).
Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.
Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.
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.
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.
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.
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.
Gets metadata on a specified stream.
Gets metadata on a specified stream.
Gets information about the active (live) stream on a specified channel.
Gets information about the active (live) stream on a specified channel.
Gets stream-key information for a specified ARN.
Gets stream-key information for a specified ARN.
Gets the recording configuration for the specified ARN.
Gets the recording configuration for the specified ARN.
Gets the specified playback restriction policy.
Gets the specified playback restriction policy.
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.
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.
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
Gets the ad configuration represented by the specified ARN.
Gets the ad configuration represented by the specified ARN.
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
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.
Deletes the specified playback restriction policy.
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.
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.
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.)
Deletes the specified ad configuration.
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.
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.
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.
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.
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
Creates a new playback restriction policy, for constraining playback by countries and/or origins.
Creates a new channel and an associated stream key to start streaming.
Creates a new channel and an associated stream key to start streaming.
Creates a new ad configuration to be used for server-side ad insertion.
Creates a new ad configuration to be used for server-side ad insertion.
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
Performs GetStreamKey on multiple ARNs simultaneously.
Performs GetStreamKey on multiple ARNs simultaneously.
Performs GetChannel on multiple ARNs simultaneously.
Performs GetChannel on multiple ARNs simultaneously.