Module Awso_ivs_realtime_syncSource

include module type of struct include Awso_ivs_realtime.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 CompositionRecordingTargetSegmentDurationSeconds = Awso_ivs_realtime.Values.CompositionRecordingTargetSegmentDurationSeconds
Sourcemodule CompositionThumbnailConfiguration = Awso_ivs_realtime.Values.CompositionThumbnailConfiguration

An object representing a configuration of thumbnails for recorded video for a Composition.

Sourcemodule CompositionRecordingHlsConfiguration = Awso_ivs_realtime.Values.CompositionRecordingHlsConfiguration

An object representing a configuration of HLS recordings for server-side composition.

Sourcemodule CompositionThumbnailConfigurationList = Awso_ivs_realtime.Values.CompositionThumbnailConfigurationList

An object representing a configuration to record a stage stream.

Object specifying a channel as a destination.

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

Complex data type that defines S3Detail objects.

Sourcemodule ParticipantRecordingTargetSegmentDurationSeconds = Awso_ivs_realtime.Values.ParticipantRecordingTargetSegmentDurationSeconds

Complex data type that defines destination-configuration objects.

Complex data type that defines destination-detail objects.

Summary information about a Destination.

Sourcemodule AutoParticipantRecordingStorageConfigurationArn = Awso_ivs_realtime.Values.AutoParticipantRecordingStorageConfigurationArn
Sourcemodule ParticipantRecordingHlsConfiguration = Awso_ivs_realtime.Values.ParticipantRecordingHlsConfiguration

An object representing a configuration of participant HLS recordings for individual participant recording.

Sourcemodule ParticipantRecordingMediaTypeList = Awso_ivs_realtime.Values.ParticipantRecordingMediaTypeList
Sourcemodule ParticipantRecordingReconnectWindowSeconds = Awso_ivs_realtime.Values.ParticipantRecordingReconnectWindowSeconds
Sourcemodule ParticipantThumbnailConfiguration = Awso_ivs_realtime.Values.ParticipantThumbnailConfiguration

An object representing a configuration of thumbnails for recorded video from an individual participant.

An object representing a redundant ingest credential.

Object specifying the status of a Destination.

Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition.

Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.

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

Object specifying an exchanged participant token in a stage, created when an original participant token is updated. Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.

Sourcemodule AutoParticipantRecordingConfiguration = Awso_ivs_realtime.Values.AutoParticipantRecordingConfiguration

Object specifying a configuration for individual participant recording.

Summary information about various endpoints for a stage. We recommend that you cache these values at stage creation; the values can be cached for up to 14 days.

Configuration information of supported layouts for server-side composition.

Summary information about a storage configuration.

Summary information about a stage.

Summary information about a stage session.

Summary information about a public key.

Summary object describing a participant that has joined a stage.

Information about the replicated destination stage for a participant.

An occurrence during a stage session.

Summary information about an IngestConfiguration.

Summary information about an EncoderConfiguration.

Summary information about a Composition.

Sourcemodule ParticipantRecordingS3BucketName = Awso_ivs_realtime.Values.ParticipantRecordingS3BucketName

Settings for video.

Object specifying a participant token in a stage. Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.

Object specifying a participant token configuration in a stage.

Object specifying a stage.

Object specifying an ingest configuration.

Object specifying a Composition resource.

Sourcemodule ParticipantRecordingFilterByRecordingState = Awso_ivs_realtime.Values.ParticipantRecordingFilterByRecordingState

Object specifying a public key used to sign stage participant tokens.

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

A stage session begins when the first participant joins a stage and ends after the last participant leaves the stage. A stage session helps with debugging stages by grouping events and participants into shorter periods of time (i.e., a session), which is helpful when stages are used over long periods of time.

Object describing a participant that has joined a stage.

Settings for transcoding.

Updates a stage’s configuration.

Updates a stage’s configuration.

Sourcemodule UpdateIngestConfigurationResponse = Awso_ivs_realtime.Values.UpdateIngestConfigurationResponse

Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

Sourcemodule UpdateIngestConfigurationRequest = Awso_ivs_realtime.Values.UpdateIngestConfigurationRequest

Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

Removes tags from the resource with the specified ARN.

Removes tags from the resource with the specified ARN.

Adds or updates tags for the AWS resource with the specified ARN.

Adds or updates tags for the AWS resource with the specified ARN.

Sourcemodule StopParticipantReplicationResponse = Awso_ivs_realtime.Values.StopParticipantReplicationResponse

Stops a replicated participant session.

Sourcemodule StopParticipantReplicationRequest = Awso_ivs_realtime.Values.StopParticipantReplicationRequest

Stops a replicated participant session.

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

Sourcemodule StartParticipantReplicationResponse = Awso_ivs_realtime.Values.StartParticipantReplicationResponse

Starts replicating a publishing participant from a source stage to a destination stage.

Sourcemodule StartParticipantReplicationRequest = Awso_ivs_realtime.Values.StartParticipantReplicationRequest

Starts replicating a publishing participant from a source stage to a destination stage.

Starts a Composition from a stage based on the configuration provided in the request. A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted: When StopComposition is called. After a 1-minute timeout, when all participants are disconnected from the stage. After a 1-minute timeout, if there are no participants in the stage when StartComposition is called. When broadcasting to the IVS channel fails and all retries are exhausted. When broadcasting is disconnected and all attempts to reconnect are exhausted.

Starts a Composition from a stage based on the configuration provided in the request. A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted: When StopComposition is called. After a 1-minute timeout, when all participants are disconnected from the stage. After a 1-minute timeout, if there are no participants in the stage when StartComposition is called. When broadcasting to the IVS channel fails and all retries are exhausted. When broadcasting is disconnected and all attempts to reconnect are exhausted.

Gets information about AWS tags for the specified ARN.

Gets information about AWS tags for the specified ARN.

Sourcemodule ListStorageConfigurationsResponse = Awso_ivs_realtime.Values.ListStorageConfigurationsResponse

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

Sourcemodule ListStorageConfigurationsRequest = Awso_ivs_realtime.Values.ListStorageConfigurationsRequest

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

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

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

Gets all sessions for a specified stage.

Gets all sessions for a specified stage.

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

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

Lists all participants in a specified stage session.

Lists all participants in a specified stage session.

Lists all the replicas for a participant from a source stage.

Lists all the replicas for a participant from a source stage.

Lists events for a specified participant that occurred during a specified stage session.

Lists events for a specified participant that occurred during a specified stage session.

Sourcemodule ListIngestConfigurationsResponse = Awso_ivs_realtime.Values.ListIngestConfigurationsResponse

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

Sourcemodule ListEncoderConfigurationsResponse = Awso_ivs_realtime.Values.ListEncoderConfigurationsResponse

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

Sourcemodule ListEncoderConfigurationsRequest = Awso_ivs_realtime.Values.ListEncoderConfigurationsRequest

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

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

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

Import a public key to be used for signing stage participant tokens.

Import a public key to be used for signing stage participant tokens.

Gets the storage configuration for the specified ARN.

Gets the storage configuration for the specified ARN.

Gets information for the specified stage session.

Gets information for the specified stage session.

Gets information for the specified stage.

Gets information for the specified stage.

Gets information for the specified public key.

Gets information for the specified public key.

Gets information about the specified participant token.

Gets information about the specified participant token.

Gets information about the specified IngestConfiguration.

Gets information about the specified IngestConfiguration.

Gets information about the specified EncoderConfiguration resource.

Gets information about the specified EncoderConfiguration resource.

Get information about the specified Composition resource.

Get information about the specified Composition resource.

Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

Sourcemodule DeleteStorageConfigurationResponse = Awso_ivs_realtime.Values.DeleteStorageConfigurationResponse

Deletes the storage configuration for the specified ARN. If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.

Sourcemodule DeleteStorageConfigurationRequest = Awso_ivs_realtime.Values.DeleteStorageConfigurationRequest

Deletes the storage configuration for the specified ARN. If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.

Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

Sourcemodule DeleteIngestConfigurationResponse = Awso_ivs_realtime.Values.DeleteIngestConfigurationResponse

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.

Sourcemodule DeleteIngestConfigurationRequest = Awso_ivs_realtime.Values.DeleteIngestConfigurationRequest

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.

Sourcemodule DeleteEncoderConfigurationResponse = Awso_ivs_realtime.Values.DeleteEncoderConfigurationResponse

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

Sourcemodule DeleteEncoderConfigurationRequest = Awso_ivs_realtime.Values.DeleteEncoderConfigurationRequest

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

Sourcemodule CreateStorageConfigurationResponse = Awso_ivs_realtime.Values.CreateStorageConfigurationResponse

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

Sourcemodule CreateStorageConfigurationRequest = Awso_ivs_realtime.Values.CreateStorageConfigurationRequest

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

Creates a new stage (and optionally participant tokens).

Creates a new stage (and optionally participant tokens).

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created. Encryption keys are owned by Amazon IVS and never used directly by your application.

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created. Encryption keys are owned by Amazon IVS and never used directly by your application.

Sourcemodule CreateIngestConfigurationResponse = Awso_ivs_realtime.Values.CreateIngestConfigurationResponse

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

Sourcemodule CreateIngestConfigurationRequest = Awso_ivs_realtime.Values.CreateIngestConfigurationRequest

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

Sourcemodule CreateEncoderConfigurationResponse = Awso_ivs_realtime.Values.CreateEncoderConfigurationResponse

Creates an EncoderConfiguration object.

Sourcemodule CreateEncoderConfigurationRequest = Awso_ivs_realtime.Values.CreateEncoderConfigurationRequest

Creates an EncoderConfiguration object.