Values (p.awso.0.9.1.doc.awso.ivs-realtime.Awso_ivs

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

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule ThumbnailStorageType : sig ... end

Sourcemodule ThumbnailIntervalSeconds : sig ... end

Sourcemodule ThumbnailStorageTypeList : sig ... end

Sourcemodule CompositionRecordingTargetSegmentDurationSeconds : sig ... end

Sourcemodule CompositionThumbnailConfiguration : sig ... end

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

Sourcemodule EncoderConfigurationArn : sig ... end

Sourcemodule CompositionRecordingHlsConfiguration : sig ... end

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

Sourcemodule RecordingConfigurationFormat : sig ... end

Sourcemodule ChannelArn : sig ... end

Sourcemodule CompositionThumbnailConfigurationList : sig ... end

Sourcemodule EncoderConfigurationArnList : sig ... end

Sourcemodule RecordingConfiguration : sig ... end

An object representing a configuration to record a stage stream.

Sourcemodule StorageConfigurationArn : sig ... end

Sourcemodule String_ : sig ... end

Sourcemodule ChannelDestinationConfiguration : sig ... end

Object specifying a channel as a destination.

Sourcemodule DestinationConfigurationName : sig ... end

Sourcemodule S3DestinationConfiguration : sig ... end

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

Sourcemodule S3Detail : sig ... end

Complex data type that defines S3Detail objects.

Sourcemodule ParticipantTokenCapability : sig ... end

Sourcemodule DestinationState : sig ... end

Sourcemodule Time : sig ... end

Sourcemodule ParticipantRecordingTargetSegmentDurationSeconds : sig ... end

Sourcemodule ParticipantRecordingMediaType : sig ... end

Sourcemodule ThumbnailRecordingMode : sig ... end

Sourcemodule ParticipantId : sig ... end

Sourcemodule StreamKey : sig ... end

Sourcemodule DestinationConfiguration : sig ... end

Complex data type that defines destination-configuration objects.

Sourcemodule DestinationDetail : sig ... end

Complex data type that defines destination-detail objects.

Sourcemodule AttributeKey : sig ... end

Sourcemodule GridGap : sig ... end

Sourcemodule OmitStoppedVideo : sig ... end

Sourcemodule VideoAspectRatio : sig ... end

Sourcemodule VideoFillMode : sig ... end

Sourcemodule PipBehavior : sig ... end

Sourcemodule PipHeight : sig ... end

Sourcemodule PipOffset : sig ... end

Sourcemodule PipPosition : sig ... end

Sourcemodule PipWidth : sig ... end

Sourcemodule S3BucketName : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule ParticipantTokenAttributes : sig ... end

Sourcemodule ParticipantTokenCapabilities : sig ... end

Sourcemodule ParticipantTokenExpirationTime : sig ... end

Sourcemodule ParticipantTokenUserId : sig ... end

Sourcemodule DestinationSummary : sig ... end

Summary information about a Destination.

Sourcemodule AutoParticipantRecordingStorageConfigurationArn : sig ... end

Sourcemodule ParticipantRecordingHlsConfiguration : sig ... end

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

Sourcemodule ParticipantRecordingMediaTypeList : sig ... end

Sourcemodule ParticipantRecordingReconnectWindowSeconds : sig ... end

Sourcemodule ParticipantThumbnailConfiguration : sig ... end

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

Sourcemodule RecordParticipantReplicas : sig ... end

Sourcemodule StageEndpoint : sig ... end

Sourcemodule RedundantIngestCredential : sig ... end

An object representing a redundant ingest credential.

Sourcemodule Destination : sig ... end

Object specifying the status of a Destination.

Sourcemodule GridConfiguration : sig ... end

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

Sourcemodule PipConfiguration : sig ... end

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

Sourcemodule S3StorageConfiguration : sig ... end

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

Sourcemodule StorageConfigurationName : sig ... end

Sourcemodule Tags : sig ... end

Sourcemodule StageArn : sig ... end

Sourcemodule StageName : sig ... end

Sourcemodule StageSessionId : sig ... end

Sourcemodule PublicKeyArn : sig ... end

Sourcemodule PublicKeyName : sig ... end

Sourcemodule IngestConfigurationArn : sig ... end

Sourcemodule ParticipantRecordingState : sig ... end

Sourcemodule ParticipantState : sig ... end

Sourcemodule Published : sig ... end

Sourcemodule RedundantIngest : sig ... end

Sourcemodule ReplicationState : sig ... end

Sourcemodule ReplicationType : sig ... end

Sourcemodule UserId : sig ... end

Sourcemodule EventErrorCode : sig ... end

Sourcemodule EventName : sig ... end

Sourcemodule ExchangedParticipantToken : sig ... end

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 Replica : sig ... end

Sourcemodule IngestConfigurationName : sig ... end

Sourcemodule IngestConfigurationStageArn : sig ... end

Sourcemodule IngestConfigurationState : sig ... end

Sourcemodule IngestProtocol : sig ... end

Sourcemodule EncoderConfigurationName : sig ... end

Sourcemodule CompositionArn : sig ... end

Sourcemodule CompositionState : sig ... end

Sourcemodule DestinationSummaryList : sig ... end

Sourcemodule Bitrate : sig ... end

Sourcemodule Framerate : sig ... end

Sourcemodule Height : sig ... end

Sourcemodule Width : sig ... end

Sourcemodule ParticipantTokenDurationMinutes : sig ... end

Sourcemodule ParticipantTokenId : sig ... end

Sourcemodule ParticipantTokenString : sig ... end

Sourcemodule ErrorMessage : sig ... end

Sourcemodule AutoParticipantRecordingConfiguration : sig ... end

Object specifying a configuration for individual participant recording.

Sourcemodule StageEndpoints : sig ... end

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.

Sourcemodule ParticipantAttributes : sig ... end

Sourcemodule RedundantIngestCredentials : sig ... end

Sourcemodule DestinationList : sig ... end

Sourcemodule LayoutConfiguration : sig ... end

Configuration information of supported layouts for server-side composition.

Sourcemodule StorageConfigurationSummary : sig ... end

Summary information about a storage configuration.

Sourcemodule StageSummary : sig ... end

Summary information about a stage.

Sourcemodule StageSessionSummary : sig ... end

Summary information about a stage session.

Sourcemodule PublicKeySummary : sig ... end

Summary information about a public key.

Sourcemodule ParticipantSummary : sig ... end

Summary object describing a participant that has joined a stage.

Sourcemodule ParticipantReplica : sig ... end

Information about the replicated destination stage for a participant.

Sourcemodule Event : sig ... end

An occurrence during a stage session.

Sourcemodule IngestConfigurationSummary : sig ... end

Summary information about an IngestConfiguration.

Sourcemodule EncoderConfigurationSummary : sig ... end

Summary information about an EncoderConfiguration.

Sourcemodule CompositionSummary : sig ... end

Summary information about a Composition.

Sourcemodule PublicKeyFingerprint : sig ... end

Sourcemodule PublicKeyMaterial : sig ... end

Sourcemodule ParticipantClientAttribute : sig ... end

Sourcemodule ParticipantProtocol : sig ... end

Sourcemodule ParticipantRecordingS3BucketName : sig ... end

Sourcemodule ParticipantRecordingS3Prefix : sig ... end

Sourcemodule Video : sig ... end

Settings for video.

Sourcemodule ParticipantToken : sig ... end

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.

Sourcemodule ParticipantTokenConfiguration : sig ... end

Object specifying a participant token configuration in a stage.

Sourcemodule AccessDeniedException : sig ... end

Sourcemodule ConflictException : sig ... end

Sourcemodule PendingVerification : sig ... end

Sourcemodule ResourceNotFoundException : sig ... end

Sourcemodule ServiceQuotaExceededException : sig ... end

Sourcemodule Stage : sig ... end

Object specifying a stage.

Sourcemodule ValidationException : sig ... end

Sourcemodule IngestConfiguration : sig ... end

Object specifying an ingest configuration.

Sourcemodule InternalServerException : sig ... end

Sourcemodule ResourceArn : sig ... end

Sourcemodule TagKeyList : sig ... end

Sourcemodule ReconnectWindowSeconds : sig ... end

Sourcemodule Composition : sig ... end

Object specifying a Composition resource.

Sourcemodule CompositionClientToken : sig ... end

Sourcemodule DestinationConfigurationList : sig ... end

Sourcemodule PaginationToken : sig ... end

Sourcemodule StorageConfigurationSummaryList : sig ... end

Sourcemodule MaxStorageConfigurationResults : sig ... end

Sourcemodule StageSummaryList : sig ... end

Sourcemodule MaxStageResults : sig ... end

Sourcemodule StageSessionList : sig ... end

Sourcemodule MaxStageSessionResults : sig ... end

Sourcemodule PublicKeyList : sig ... end

Sourcemodule MaxPublicKeyResults : sig ... end

Sourcemodule ParticipantList : sig ... end

Sourcemodule MaxParticipantResults : sig ... end

Sourcemodule ParticipantRecordingFilterByRecordingState : sig ... end

Sourcemodule ParticipantReplicaList : sig ... end

Sourcemodule MaxParticipantReplicaResults : sig ... end

Sourcemodule EventList : sig ... end

Sourcemodule MaxParticipantEventResults : sig ... end

Sourcemodule IngestConfigurationList : sig ... end

Sourcemodule MaxIngestConfigurationResults : sig ... end

Sourcemodule EncoderConfigurationSummaryList : sig ... end

Sourcemodule MaxEncoderConfigurationResults : sig ... end

Sourcemodule CompositionSummaryList : sig ... end

Sourcemodule MaxCompositionResults : sig ... end

Sourcemodule PublicKey : sig ... end

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

Sourcemodule StorageConfiguration : sig ... end

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

Sourcemodule StageSession : sig ... end

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.

Sourcemodule Participant : sig ... end

Object describing a participant that has joined a stage.

Sourcemodule EncoderConfiguration : sig ... end

Settings for transcoding.

Sourcemodule DisconnectParticipantReason : sig ... end

Sourcemodule Boolean : sig ... end

Sourcemodule ParticipantTokenList : sig ... end

Sourcemodule ParticipantTokenConfigurations : sig ... end

Sourcemodule InsecureIngest : sig ... end

Sourcemodule UpdateStageResponse : sig ... end

Updates a stage’s configuration.

Sourcemodule UpdateStageRequest : sig ... end

Updates a stage’s configuration.

Sourcemodule UpdateIngestConfigurationResponse : sig ... end

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 : sig ... end

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

Sourcemodule UntagResourceResponse : sig ... end

Removes tags from the resource with the specified ARN.

Sourcemodule UntagResourceRequest : sig ... end

Removes tags from the resource with the specified ARN.

Sourcemodule TagResourceResponse : sig ... end

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

Sourcemodule TagResourceRequest : sig ... end

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

Sourcemodule StopParticipantReplicationResponse : sig ... end

Stops a replicated participant session.

Sourcemodule StopParticipantReplicationRequest : sig ... end

Stops a replicated participant session.

Sourcemodule StopCompositionResponse : sig ... end

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

Sourcemodule StopCompositionRequest : sig ... end

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

Sourcemodule StartParticipantReplicationResponse : sig ... end

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

Sourcemodule StartParticipantReplicationRequest : sig ... end

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

Sourcemodule StartCompositionResponse : sig ... end

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.

Sourcemodule StartCompositionRequest : sig ... end

Sourcemodule ListTagsForResourceResponse : sig ... end

Gets information about AWS tags for the specified ARN.

Sourcemodule ListTagsForResourceRequest : sig ... end

Gets information about AWS tags for the specified ARN.

Sourcemodule ListStorageConfigurationsResponse : sig ... end

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

Sourcemodule ListStorageConfigurationsRequest : sig ... end

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

Sourcemodule ListStagesResponse : sig ... end

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

Sourcemodule ListStagesRequest : sig ... end

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

Sourcemodule ListStageSessionsResponse : sig ... end

Gets all sessions for a specified stage.

Sourcemodule ListStageSessionsRequest : sig ... end

Gets all sessions for a specified stage.

Sourcemodule ListPublicKeysResponse : sig ... end

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

Sourcemodule ListPublicKeysRequest : sig ... end

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

Sourcemodule ListParticipantsResponse : sig ... end

Lists all participants in a specified stage session.

Sourcemodule ListParticipantsRequest : sig ... end

Lists all participants in a specified stage session.

Sourcemodule ListParticipantReplicasResponse : sig ... end

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

Sourcemodule ListParticipantReplicasRequest : sig ... end

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

Sourcemodule ListParticipantEventsResponse : sig ... end

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

Sourcemodule ListParticipantEventsRequest : sig ... end

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

Sourcemodule ListIngestConfigurationsResponse : sig ... end

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

Sourcemodule ListIngestConfigurationsRequest : sig ... end

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

Sourcemodule ListEncoderConfigurationsResponse : sig ... end

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

Sourcemodule ListEncoderConfigurationsRequest : sig ... end

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

Sourcemodule ListCompositionsResponse : sig ... end

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

Sourcemodule ListCompositionsRequest : sig ... end

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

Sourcemodule ImportPublicKeyResponse : sig ... end

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

Sourcemodule ImportPublicKeyRequest : sig ... end

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

Sourcemodule GetStorageConfigurationResponse : sig ... end

Gets the storage configuration for the specified ARN.

Sourcemodule GetStorageConfigurationRequest : sig ... end

Gets the storage configuration for the specified ARN.

Sourcemodule GetStageSessionResponse : sig ... end

Gets information for the specified stage session.

Sourcemodule GetStageSessionRequest : sig ... end

Gets information for the specified stage session.

Sourcemodule GetStageResponse : sig ... end

Gets information for the specified stage.

Sourcemodule GetStageRequest : sig ... end

Gets information for the specified stage.

Sourcemodule GetPublicKeyResponse : sig ... end

Gets information for the specified public key.

Sourcemodule GetPublicKeyRequest : sig ... end

Gets information for the specified public key.

Sourcemodule GetParticipantResponse : sig ... end

Gets information about the specified participant token.

Sourcemodule GetParticipantRequest : sig ... end

Gets information about the specified participant token.

Sourcemodule GetIngestConfigurationResponse : sig ... end

Gets information about the specified IngestConfiguration.

Sourcemodule GetIngestConfigurationRequest : sig ... end

Gets information about the specified IngestConfiguration.

Sourcemodule GetEncoderConfigurationResponse : sig ... end

Gets information about the specified EncoderConfiguration resource.

Sourcemodule GetEncoderConfigurationRequest : sig ... end

Gets information about the specified EncoderConfiguration resource.

Sourcemodule GetCompositionResponse : sig ... end

Get information about the specified Composition resource.

Sourcemodule GetCompositionRequest : sig ... end

Get information about the specified Composition resource.

Sourcemodule DisconnectParticipantResponse : sig ... end

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 DisconnectParticipantRequest : sig ... end

Sourcemodule DeleteStorageConfigurationResponse : sig ... end

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 : sig ... end

Sourcemodule DeleteStageResponse : sig ... end

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.

Sourcemodule DeleteStageRequest : sig ... end

Sourcemodule DeletePublicKeyResponse : sig ... end

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 DeletePublicKeyRequest : sig ... end

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 : sig ... end

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 : sig ... end

Sourcemodule DeleteEncoderConfigurationResponse : sig ... end

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

Sourcemodule DeleteEncoderConfigurationRequest : sig ... end

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

Sourcemodule CreateStorageConfigurationResponse : sig ... end

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 : sig ... end

Sourcemodule CreateStageResponse : sig ... end

Creates a new stage (and optionally participant tokens).

Sourcemodule CreateStageRequest : sig ... end

Creates a new stage (and optionally participant tokens).

Sourcemodule CreateParticipantTokenResponse : sig ... end

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 CreateParticipantTokenRequest : sig ... end

Sourcemodule CreateIngestConfigurationResponse : sig ... end

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

Sourcemodule CreateIngestConfigurationRequest : sig ... end

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

Sourcemodule CreateEncoderConfigurationResponse : sig ... end

Creates an EncoderConfiguration object.

Sourcemodule CreateEncoderConfigurationRequest : sig ... end

Creates an EncoderConfiguration object.