The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Key Concepts
Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
For server-side composition:
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For participant replication:
Source stage — The stage where the participant originally joined, which is used as the source for replication.
Destination stage — The stage to which the participant is replicated.
Replicated participant — A participant in a stage that is replicated to one or more destination stages.
Replica participant — A participant in a destination stage that is replicated from another stage (the source stage).
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
", "operations": { "CreateEncoderConfiguration": "Creates an EncoderConfiguration object.
", "CreateIngestConfiguration": "Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
", "CreateParticipantToken": "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.
", "CreateStage": "Creates a new stage (and optionally participant tokens).
", "CreateStorageConfiguration": "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.
", "DeleteEncoderConfiguration": "Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
", "DeleteIngestConfiguration": "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.
Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
", "DeleteStage": "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 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.
", "DisconnectParticipant": "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.
Get information about the specified Composition resource.
", "GetEncoderConfiguration": "Gets information about the specified EncoderConfiguration resource.
", "GetIngestConfiguration": "Gets information about the specified IngestConfiguration.
", "GetParticipant": "Gets information about the specified participant token.
", "GetPublicKey": "Gets information for the specified public key.
", "GetStage": "Gets information for the specified stage.
", "GetStageSession": "Gets information for the specified stage session.
", "GetStorageConfiguration": "Gets the storage configuration for the specified ARN.
", "ImportPublicKey": "Import a public key to be used for signing stage participant tokens.
", "ListCompositions": "Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
", "ListEncoderConfigurations": "Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
", "ListIngestConfigurations": "Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.
", "ListParticipantEvents": "Lists events for a specified participant that occurred during a specified stage session.
", "ListParticipantReplicas": "Lists all the replicas for a participant from a source stage.
", "ListParticipants": "Lists all participants in a specified stage session.
", "ListPublicKeys": "Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
", "ListStageSessions": "Gets all sessions for a specified stage.
", "ListStages": "Gets summary information about all stages in your account, in the AWS region where the API request is processed.
", "ListStorageConfigurations": "Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
", "ListTagsForResource": "Gets information about AWS tags for the specified ARN.
", "StartComposition": "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 replicating a publishing participant from a source stage to a destination stage.
", "StopComposition": "Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
", "StopParticipantReplication": "Stops a replicated participant session.
", "TagResource": "Adds or updates tags for the AWS resource with the specified ARN.
", "UntagResource": "Removes tags from the resource with the specified ARN.
", "UpdateIngestConfiguration": "Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.
", "UpdateStage": "Updates a stage’s configuration.
" }, "shapes": { "AccessDeniedException": { "base": "", "refs": { } }, "AttributeKey": { "base": null, "refs": { "GridConfiguration$featuredParticipantAttribute": "This attribute name identifies the featured slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: \"\" (no featured participant).
This attribute name identifies the featured slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: \"\" (no featured participant).
Specifies the participant for the PiP window. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: \"\" (no PiP participant).
Object specifying a configuration for individual participant recording.
", "refs": { "CreateStageRequest$autoParticipantRecordingConfiguration": "Configuration object for individual participant recording, to attach to the new stage.
", "Stage$autoParticipantRecordingConfiguration": "Configuration object for individual participant recording, attached to the stage.
", "UpdateStageRequest$autoParticipantRecordingConfiguration": "Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.
" } }, "AutoParticipantRecordingStorageConfigurationArn": { "base": null, "refs": { "AutoParticipantRecordingConfiguration$storageConfigurationArn": "ARN of the StorageConfiguration resource to use for individual participant recording. Default: \"\" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated. To disable individual participant recording, set this to \"\"; other fields in this object will get reset to their defaults when sending \"\".
Bitrate for generated output, in bps. Default: 2500000.
" } }, "Boolean": { "base": null, "refs": { "DeleteIngestConfigurationRequest$force": "Optional field to force deletion of the IngestConfiguration. If this is set to true when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: false.
ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).
" } }, "ChannelDestinationConfiguration": { "base": "Object specifying a channel as a destination.
", "refs": { "DestinationConfiguration$channel": "An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.
Object specifying a Composition resource.
", "refs": { "GetCompositionResponse$composition": "The Composition that was returned.
", "StartCompositionResponse$composition": "The Composition that was created.
" } }, "CompositionArn": { "base": null, "refs": { "Composition$arn": "ARN of the Composition resource.
", "CompositionSummary$arn": "ARN of the Composition resource.
", "GetCompositionRequest$arn": "ARN of the Composition resource.
", "StopCompositionRequest$arn": "ARN of the Composition.
" } }, "CompositionClientToken": { "base": null, "refs": { "StartCompositionRequest$idempotencyToken": "Idempotency token.
" } }, "CompositionRecordingHlsConfiguration": { "base": "An object representing a configuration of HLS recordings for server-side composition.
", "refs": { "RecordingConfiguration$hlsConfiguration": "An HLS configuration object to return information about how the recording will be configured.
" } }, "CompositionRecordingTargetSegmentDurationSeconds": { "base": null, "refs": { "CompositionRecordingHlsConfiguration$targetSegmentDurationSeconds": "Defines the target duration for recorded segments generated when using composite recording. Default: 2.
" } }, "CompositionState": { "base": null, "refs": { "Composition$state": "State of the Composition.
", "CompositionSummary$state": "State of the Composition resource.
" } }, "CompositionSummary": { "base": "Summary information about a Composition.
", "refs": { "CompositionSummaryList$member": null } }, "CompositionSummaryList": { "base": null, "refs": { "ListCompositionsResponse$compositions": "List of the matching Compositions (summary information only).
" } }, "CompositionThumbnailConfiguration": { "base": "An object representing a configuration of thumbnails for recorded video for a Composition.
", "refs": { "CompositionThumbnailConfigurationList$member": null } }, "CompositionThumbnailConfigurationList": { "base": null, "refs": { "S3DestinationConfiguration$thumbnailConfigurations": "A complex type that allows you to enable/disable the recording of thumbnails for a Composition and modify the interval at which thumbnails are generated for the live session.
" } }, "ConflictException": { "base": "", "refs": { } }, "CreateEncoderConfigurationRequest": { "base": null, "refs": { } }, "CreateEncoderConfigurationResponse": { "base": null, "refs": { } }, "CreateIngestConfigurationRequest": { "base": null, "refs": { } }, "CreateIngestConfigurationResponse": { "base": null, "refs": { } }, "CreateParticipantTokenRequest": { "base": null, "refs": { } }, "CreateParticipantTokenResponse": { "base": null, "refs": { } }, "CreateStageRequest": { "base": null, "refs": { } }, "CreateStageResponse": { "base": null, "refs": { } }, "CreateStorageConfigurationRequest": { "base": null, "refs": { } }, "CreateStorageConfigurationResponse": { "base": null, "refs": { } }, "DeleteEncoderConfigurationRequest": { "base": null, "refs": { } }, "DeleteEncoderConfigurationResponse": { "base": null, "refs": { } }, "DeleteIngestConfigurationRequest": { "base": null, "refs": { } }, "DeleteIngestConfigurationResponse": { "base": null, "refs": { } }, "DeletePublicKeyRequest": { "base": null, "refs": { } }, "DeletePublicKeyResponse": { "base": null, "refs": { } }, "DeleteStageRequest": { "base": null, "refs": { } }, "DeleteStageResponse": { "base": null, "refs": { } }, "DeleteStorageConfigurationRequest": { "base": null, "refs": { } }, "DeleteStorageConfigurationResponse": { "base": null, "refs": { } }, "Destination": { "base": "Object specifying the status of a Destination.
", "refs": { "DestinationList$member": null } }, "DestinationConfiguration": { "base": "Complex data type that defines destination-configuration objects.
", "refs": { "Destination$configuration": "Configuration used to create this destination.
", "DestinationConfigurationList$member": null } }, "DestinationConfigurationList": { "base": null, "refs": { "StartCompositionRequest$destinations": "Array of destination configuration.
" } }, "DestinationConfigurationName": { "base": null, "refs": { "DestinationConfiguration$name": "Name that can be specified to help identify the destination.
" } }, "DestinationDetail": { "base": "Complex data type that defines destination-detail objects.
", "refs": { "Destination$detail": "Optional details regarding the status of the destination.
" } }, "DestinationList": { "base": null, "refs": { "Composition$destinations": "Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).
State of the Composition Destination.
", "DestinationSummary$state": "State of the Composition Destination.
" } }, "DestinationSummary": { "base": "Summary information about a Destination.
", "refs": { "DestinationSummaryList$member": null } }, "DestinationSummaryList": { "base": null, "refs": { "CompositionSummary$destinations": "Array of Destination objects.
" } }, "DisconnectParticipantReason": { "base": null, "refs": { "DisconnectParticipantRequest$reason": "Description of why this participant is being disconnected.
" } }, "DisconnectParticipantRequest": { "base": null, "refs": { } }, "DisconnectParticipantResponse": { "base": null, "refs": { } }, "EncoderConfiguration": { "base": "Settings for transcoding.
", "refs": { "CreateEncoderConfigurationResponse$encoderConfiguration": "The EncoderConfiguration that was created.
", "GetEncoderConfigurationResponse$encoderConfiguration": "The EncoderConfiguration that was returned.
" } }, "EncoderConfigurationArn": { "base": null, "refs": { "ChannelDestinationConfiguration$encoderConfigurationArn": "ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
", "DeleteEncoderConfigurationRequest$arn": "ARN of the EncoderConfiguration.
", "EncoderConfiguration$arn": "ARN of the EncoderConfiguration resource.
", "EncoderConfigurationArnList$member": null, "EncoderConfigurationSummary$arn": "ARN of the EncoderConfiguration resource.
", "GetEncoderConfigurationRequest$arn": "ARN of the EncoderConfiguration resource.
", "ListCompositionsRequest$filterByEncoderConfigurationArn": "Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
" } }, "EncoderConfigurationArnList": { "base": null, "refs": { "S3DestinationConfiguration$encoderConfigurationArns": "ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
" } }, "EncoderConfigurationName": { "base": null, "refs": { "CreateEncoderConfigurationRequest$name": "Optional name to identify the resource.
", "EncoderConfiguration$name": "Optional name to identify the resource.
", "EncoderConfigurationSummary$name": "Optional name to identify the resource.
" } }, "EncoderConfigurationSummary": { "base": "Summary information about an EncoderConfiguration.
", "refs": { "EncoderConfigurationSummaryList$member": null } }, "EncoderConfigurationSummaryList": { "base": null, "refs": { "ListEncoderConfigurationsResponse$encoderConfigurations": "List of the matching EncoderConfigurations (summary information only).
" } }, "Event": { "base": "An occurrence during a stage session.
", "refs": { "EventList$member": null } }, "EventErrorCode": { "base": null, "refs": { "Event$errorCode": "If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.
B_FRAME_PRESENT — The participant's stream includes B-frames. For details, see IVS RTMP Publishing.
BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate. For details, see Service Quotas.
INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken.
INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage due to an internal server error.
INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For details, see Stream Ingest.
INVALID_INPUT — The participant is using an invalid input stream.
INVALID_PROTOCOL — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing.
INVALID_STREAM_KEY — The participant is using an invalid stream key. For details, see IVS RTMP Publishing.
INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For details, see Stream Ingest.
PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that doesn’t exist.
QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas.
RESOLUTION_EXCEEDED — The participant exceeded the maximum supported resolution. For details, see Service Quotas.
REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is associated with another active stage session.
STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.
List of the matching events.
" } }, "EventName": { "base": null, "refs": { "Event$name": "The name of the event.
" } }, "Framerate": { "base": null, "refs": { "Video$framerate": "Video frame rate, in fps. Default: 30.
" } }, "GetCompositionRequest": { "base": null, "refs": { } }, "GetCompositionResponse": { "base": null, "refs": { } }, "GetEncoderConfigurationRequest": { "base": null, "refs": { } }, "GetEncoderConfigurationResponse": { "base": null, "refs": { } }, "GetIngestConfigurationRequest": { "base": null, "refs": { } }, "GetIngestConfigurationResponse": { "base": null, "refs": { } }, "GetParticipantRequest": { "base": null, "refs": { } }, "GetParticipantResponse": { "base": null, "refs": { } }, "GetPublicKeyRequest": { "base": null, "refs": { } }, "GetPublicKeyResponse": { "base": null, "refs": { } }, "GetStageRequest": { "base": null, "refs": { } }, "GetStageResponse": { "base": null, "refs": { } }, "GetStageSessionRequest": { "base": null, "refs": { } }, "GetStageSessionResponse": { "base": null, "refs": { } }, "GetStorageConfigurationRequest": { "base": null, "refs": { } }, "GetStorageConfigurationResponse": { "base": null, "refs": { } }, "GridConfiguration": { "base": "Configuration information specific to Grid layout, for server-side composition. See \"Layouts\" in Server-Side Composition.
", "refs": { "LayoutConfiguration$grid": "Configuration related to grid layout. Default: Grid layout.
" } }, "GridGap": { "base": null, "refs": { "GridConfiguration$gridGap": "Specifies the spacing between participant tiles in pixels. Default: 2.
Specifies the spacing between participant tiles in pixels. Default: 0.
Video-resolution height. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
Object specifying an ingest configuration.
", "refs": { "CreateIngestConfigurationResponse$ingestConfiguration": "The IngestConfiguration that was created.
", "GetIngestConfigurationResponse$ingestConfiguration": "The IngestConfiguration that was returned.
", "UpdateIngestConfigurationResponse$ingestConfiguration": "The updated IngestConfiguration.
" } }, "IngestConfigurationArn": { "base": null, "refs": { "DeleteIngestConfigurationRequest$arn": "ARN of the IngestConfiguration.
", "GetIngestConfigurationRequest$arn": "ARN of the ingest for which the information is to be retrieved.
", "IngestConfiguration$arn": "Ingest configuration ARN.
", "IngestConfigurationSummary$arn": "Ingest configuration ARN.
", "UpdateIngestConfigurationRequest$arn": "ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.
" } }, "IngestConfigurationList": { "base": null, "refs": { "ListIngestConfigurationsResponse$ingestConfigurations": "List of the matching ingest configurations (summary information only).
" } }, "IngestConfigurationName": { "base": null, "refs": { "CreateIngestConfigurationRequest$name": "Optional name that can be specified for the IngestConfiguration being created.
", "IngestConfiguration$name": "Ingest name
", "IngestConfigurationSummary$name": "Ingest name.
" } }, "IngestConfigurationStageArn": { "base": null, "refs": { "CreateIngestConfigurationRequest$stageArn": "ARN of the stage with which the IngestConfiguration is associated.
", "IngestConfiguration$stageArn": "ARN of the stage with which the IngestConfiguration is associated.
", "IngestConfigurationSummary$stageArn": "ARN of the stage with which the IngestConfiguration is associated.
", "UpdateIngestConfigurationRequest$stageArn": "Stage ARN that needs to be updated.
" } }, "IngestConfigurationState": { "base": null, "refs": { "IngestConfiguration$state": "State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.
" } }, "IngestConfigurationSummary": { "base": "Summary information about an IngestConfiguration.
", "refs": { "IngestConfigurationList$member": null } }, "IngestProtocol": { "base": null, "refs": { "CreateIngestConfigurationRequest$ingestProtocol": "Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.
Type of ingest protocol that the user employs for broadcasting.
", "IngestConfigurationSummary$ingestProtocol": "Type of ingest protocol that the user employs for broadcasting.
" } }, "InsecureIngest": { "base": null, "refs": { "CreateIngestConfigurationRequest$insecureIngest": "Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.
Configuration information of supported layouts for server-side composition.
", "refs": { "Composition$layout": "Layout object to configure composition parameters.
", "StartCompositionRequest$layout": "Layout object to configure composition parameters.
" } }, "ListCompositionsRequest": { "base": null, "refs": { } }, "ListCompositionsResponse": { "base": null, "refs": { } }, "ListEncoderConfigurationsRequest": { "base": null, "refs": { } }, "ListEncoderConfigurationsResponse": { "base": null, "refs": { } }, "ListIngestConfigurationsRequest": { "base": null, "refs": { } }, "ListIngestConfigurationsResponse": { "base": null, "refs": { } }, "ListParticipantEventsRequest": { "base": null, "refs": { } }, "ListParticipantEventsResponse": { "base": null, "refs": { } }, "ListParticipantReplicasRequest": { "base": null, "refs": { } }, "ListParticipantReplicasResponse": { "base": null, "refs": { } }, "ListParticipantsRequest": { "base": null, "refs": { } }, "ListParticipantsResponse": { "base": null, "refs": { } }, "ListPublicKeysRequest": { "base": null, "refs": { } }, "ListPublicKeysResponse": { "base": null, "refs": { } }, "ListStageSessionsRequest": { "base": null, "refs": { } }, "ListStageSessionsResponse": { "base": null, "refs": { } }, "ListStagesRequest": { "base": null, "refs": { } }, "ListStagesResponse": { "base": null, "refs": { } }, "ListStorageConfigurationsRequest": { "base": null, "refs": { } }, "ListStorageConfigurationsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "MaxCompositionResults": { "base": null, "refs": { "ListCompositionsRequest$maxResults": "Maximum number of results to return. Default: 100.
" } }, "MaxEncoderConfigurationResults": { "base": null, "refs": { "ListEncoderConfigurationsRequest$maxResults": "Maximum number of results to return. Default: 100.
" } }, "MaxIngestConfigurationResults": { "base": null, "refs": { "ListIngestConfigurationsRequest$maxResults": "Maximum number of results to return. Default: 50.
" } }, "MaxParticipantEventResults": { "base": null, "refs": { "ListParticipantEventsRequest$maxResults": "Maximum number of results to return. Default: 50.
" } }, "MaxParticipantReplicaResults": { "base": null, "refs": { "ListParticipantReplicasRequest$maxResults": "Maximum number of results to return. Default: 50.
" } }, "MaxParticipantResults": { "base": null, "refs": { "ListParticipantsRequest$maxResults": "Maximum number of results to return. Default: 50.
" } }, "MaxPublicKeyResults": { "base": null, "refs": { "ListPublicKeysRequest$maxResults": "Maximum number of results to return. Default: 50.
" } }, "MaxStageResults": { "base": null, "refs": { "ListStagesRequest$maxResults": "Maximum number of results to return. Default: 50.
" } }, "MaxStageSessionResults": { "base": null, "refs": { "ListStageSessionsRequest$maxResults": "Maximum number of results to return. Default: 50.
" } }, "MaxStorageConfigurationResults": { "base": null, "refs": { "ListStorageConfigurationsRequest$maxResults": "Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.
" } }, "OmitStoppedVideo": { "base": null, "refs": { "GridConfiguration$omitStoppedVideo": "Determines whether to omit participants with stopped video in the composition. Default: false.
Determines whether to omit participants with stopped video in the composition. Default: false.
The first Composition to retrieve. This is used for pagination; see the nextToken response field.
If there are more compositions than maxResults, use nextToken in the request to get the next set.
The first encoder configuration to retrieve. This is used for pagination; see the nextToken response field.
If there are more encoder configurations than maxResults, use nextToken in the request to get the next set.
The first IngestConfiguration to retrieve. This is used for pagination; see the nextToken response field.
If there are more IngestConfigurations than maxResults, use nextToken in the request to get the next set.
The first participant event to retrieve. This is used for pagination; see the nextToken response field.
If there are more events than maxResults, use nextToken in the request to get the next set.
The first participant to retrieve. This is used for pagination; see the nextToken response field.
If there are more participants than maxResults, use nextToken in the request to get the next set.
The first participant to retrieve. This is used for pagination; see the nextToken response field.
If there are more participants than maxResults, use nextToken in the request to get the next set.
The first public key to retrieve. This is used for pagination; see the nextToken response field.
If there are more public keys than maxResults, use nextToken in the request to get the next set.
The first stage session to retrieve. This is used for pagination; see the nextToken response field.
If there are more stage sessions than maxResults, use nextToken in the request to get the next set.
The first stage to retrieve. This is used for pagination; see the nextToken response field.
If there are more stages than maxResults, use nextToken in the request to get the next set.
The first storage configuration to retrieve. This is used for pagination; see the nextToken response field.
If there are more storage configurations than maxResults, use nextToken in the request to get the next set.
Object describing a participant that has joined a stage.
", "refs": { "GetParticipantResponse$participant": "The participant that is returned.
" } }, "ParticipantAttributes": { "base": null, "refs": { "CreateIngestConfigurationRequest$attributes": "Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "IngestConfiguration$attributes": "Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "Participant$attributes": "Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "StartParticipantReplicationRequest$attributes": "Application-provided attributes to set on the replicated participant in the destination stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
These attributes are merged with any attributes set for this participant when creating the token. If there is overlap in keys, the values in these attributes are replaced.
" } }, "ParticipantClientAttribute": { "base": null, "refs": { "Participant$ispName": "The participant’s Internet Service Provider.
", "Participant$osName": "The participant’s operating system.
", "Participant$osVersion": "The participant’s operating system version.
", "Participant$browserName": "The participant’s browser.
", "Participant$browserVersion": "The participant’s browser version.
", "Participant$sdkVersion": "The participant’s SDK version.
" } }, "ParticipantId": { "base": null, "refs": { "Event$participantId": "Unique identifier for the participant who triggered the event. This is assigned by IVS.
", "Event$remoteParticipantId": "Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
", "GetParticipantRequest$participantId": "Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
", "IngestConfiguration$participantId": "ID of the participant within the stage.
", "IngestConfigurationSummary$participantId": "ID of the participant within the stage.
", "ListParticipantEventsRequest$participantId": "Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.
", "ListParticipantReplicasRequest$participantId": "Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.
Unique identifier for this participant, assigned by IVS.
", "ParticipantReplica$participantId": "Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.
Unique identifier for this participant, assigned by IVS.
", "StartParticipantReplicationRequest$participantId": "Participant ID of the publisher that will be replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.
Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by CreateParticipantToken or the jti (JWT ID) used to create a self signed token.
List of the matching participants (summary information only).
" } }, "ParticipantProtocol": { "base": null, "refs": { "Participant$protocol": "Type of ingest protocol that the participant employs for broadcasting.
" } }, "ParticipantRecordingFilterByRecordingState": { "base": null, "refs": { "ListParticipantsRequest$filterByRecordingState": "Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
An object representing a configuration of participant HLS recordings for individual participant recording.
", "refs": { "AutoParticipantRecordingConfiguration$hlsConfiguration": "HLS configuration object for individual participant recording.
" } }, "ParticipantRecordingMediaType": { "base": null, "refs": { "ParticipantRecordingMediaTypeList$member": null } }, "ParticipantRecordingMediaTypeList": { "base": null, "refs": { "AutoParticipantRecordingConfiguration$mediaTypes": "Types of media to be recorded. Default: AUDIO_VIDEO.
If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together.
The default value is 0, which disables merging.
" } }, "ParticipantRecordingS3BucketName": { "base": null, "refs": { "Participant$recordingS3BucketName": "Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or \"\" (empty string), if recording is not enabled.
S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or \"\" (empty string), if recording is not enabled. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See Merge Fragmented Individual Participant Recordings.
The participant’s recording state.
", "ParticipantSummary$recordingState": "The participant’s recording state.
" } }, "ParticipantRecordingTargetSegmentDurationSeconds": { "base": null, "refs": { "ParticipantRecordingHlsConfiguration$targetSegmentDurationSeconds": "Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.
" } }, "ParticipantReplica": { "base": "Information about the replicated destination stage for a participant.
", "refs": { "ParticipantReplicaList$member": null } }, "ParticipantReplicaList": { "base": null, "refs": { "ListParticipantReplicasResponse$replicas": "List of all participant replicas.
" } }, "ParticipantState": { "base": null, "refs": { "ListParticipantsRequest$filterByState": "Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
Whether the participant is connected to or disconnected from the stage.
", "ParticipantSummary$state": "Whether the participant is connected to or disconnected from the stage.
" } }, "ParticipantSummary": { "base": "Summary object describing a participant that has joined a stage.
", "refs": { "ParticipantList$member": null } }, "ParticipantThumbnailConfiguration": { "base": "An object representing a configuration of thumbnails for recorded video from an individual participant.
", "refs": { "AutoParticipantRecordingConfiguration$thumbnailConfiguration": "A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.
" } }, "ParticipantToken": { "base": "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.
", "refs": { "CreateParticipantTokenResponse$participantToken": "The participant token that was created.
", "ParticipantTokenList$member": null } }, "ParticipantTokenAttributes": { "base": null, "refs": { "CreateParticipantTokenRequest$attributes": "Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "ParticipantToken$attributes": "Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "ParticipantTokenConfiguration$attributes": "Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" } }, "ParticipantTokenCapabilities": { "base": null, "refs": { "CreateParticipantTokenRequest$capabilities": "Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.
Set of capabilities that the user is allowed to perform in the stage.
", "ParticipantTokenConfiguration$capabilities": "Set of capabilities that the user is allowed to perform in the stage.
" } }, "ParticipantTokenCapability": { "base": null, "refs": { "ParticipantTokenCapabilities$member": null } }, "ParticipantTokenConfiguration": { "base": "Object specifying a participant token configuration in a stage.
", "refs": { "ParticipantTokenConfigurations$member": null } }, "ParticipantTokenConfigurations": { "base": null, "refs": { "CreateStageRequest$participantTokenConfigurations": "Array of participant token configuration objects to attach to the new stage.
" } }, "ParticipantTokenDurationMinutes": { "base": null, "refs": { "CreateParticipantTokenRequest$duration": "Duration (in minutes), after which the token expires. Default: 720 (12 hours).
", "ParticipantToken$duration": "Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
", "ParticipantTokenConfiguration$duration": "Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
" } }, "ParticipantTokenExpirationTime": { "base": null, "refs": { "ParticipantToken$expirationTime": "ISO 8601 timestamp (returned as a string) for when this token expires.
" } }, "ParticipantTokenId": { "base": null, "refs": { "DisconnectParticipantRequest$participantId": "Identifier of the participant to be disconnected. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).
", "ParticipantToken$participantId": "Unique identifier for this participant token, assigned by IVS.
" } }, "ParticipantTokenList": { "base": null, "refs": { "CreateStageResponse$participantTokens": "Participant tokens attached to the stage. These correspond to the participants in the request.
The issued client token, encrypted.
" } }, "ParticipantTokenUserId": { "base": null, "refs": { "CreateParticipantTokenRequest$userId": "Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "ParticipantToken$userId": "Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "ParticipantTokenConfiguration$userId": "Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" } }, "PendingVerification": { "base": "", "refs": { } }, "PipBehavior": { "base": null, "refs": { "PipConfiguration$pipBehavior": "Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.
Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.
", "refs": { "LayoutConfiguration$pip": "Configuration related to PiP layout.
" } }, "PipHeight": { "base": null, "refs": { "PipConfiguration$pipHeight": "Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
Object specifying a public key used to sign stage participant tokens.
", "refs": { "GetPublicKeyResponse$publicKey": "The public key that is returned.
", "ImportPublicKeyResponse$publicKey": "The public key that was imported.
" } }, "PublicKeyArn": { "base": null, "refs": { "DeletePublicKeyRequest$arn": "ARN of the public key to be deleted.
", "GetPublicKeyRequest$arn": "ARN of the public key for which the information is to be retrieved.
", "PublicKey$arn": "Public key ARN.
", "PublicKeySummary$arn": "Public key ARN.
" } }, "PublicKeyFingerprint": { "base": null, "refs": { "PublicKey$fingerprint": "The public key fingerprint, a short string used to identify or verify the full public key.
" } }, "PublicKeyList": { "base": null, "refs": { "ListPublicKeysResponse$publicKeys": "List of the matching public keys (summary information only).
" } }, "PublicKeyMaterial": { "base": null, "refs": { "ImportPublicKeyRequest$publicKeyMaterial": "The content of the public key to be imported.
", "PublicKey$publicKeyMaterial": "Public key material.
" } }, "PublicKeyName": { "base": null, "refs": { "ImportPublicKeyRequest$name": "Name of the public key to be imported.
", "PublicKey$name": "Public key name.
", "PublicKeySummary$name": "Public key name.
" } }, "PublicKeySummary": { "base": "Summary information about a public key.
", "refs": { "PublicKeyList$member": null } }, "Published": { "base": null, "refs": { "ListParticipantsRequest$filterByPublished": "Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
Whether the participant ever published to the stage session.
", "ParticipantSummary$published": "Whether the participant ever published to the stage session.
" } }, "ReconnectWindowSeconds": { "base": null, "refs": { "StartParticipantReplicationRequest$reconnectWindowSeconds": "If the participant disconnects and then reconnects within the specified interval, replication will continue to be ACTIVE. Default: 0.
Optional field to disable replica participant recording. If this is set to false when a participant is a replica, replica participants are not recorded. Default: true.
An object representing a configuration to record a stage stream.
", "refs": { "S3DestinationConfiguration$recordingConfiguration": "Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.
The recording format for storing a recording in Amazon S3.
" } }, "Replica": { "base": null, "refs": { "Event$replica": "If true, this indicates the participantId is a replicated participant. If this is a subscribe event, then this flag refers to remoteParticipantId.
The participant's replication state.
", "ParticipantReplica$replicationState": "Replica’s current replication state.
", "ParticipantSummary$replicationState": "The participant's replication state.
" } }, "ReplicationType": { "base": null, "refs": { "Participant$replicationType": "Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
The ARN of the resource to be retrieved. The ARN must be URL-encoded.
", "TagResourceRequest$resourceArn": "The ARN of the resource to be tagged. The ARN must be URL-encoded.
", "UntagResourceRequest$resourceArn": "The ARN of the resource to be untagged. The ARN must be URL-encoded.
" } }, "ResourceNotFoundException": { "base": "", "refs": { } }, "S3BucketName": { "base": null, "refs": { "S3StorageConfiguration$bucketName": "Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.
" } }, "S3DestinationConfiguration": { "base": "A complex type that describes an S3 location where recorded videos will be stored.
", "refs": { "DestinationConfiguration$s3": "An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.
Complex data type that defines S3Detail objects.
", "refs": { "DestinationDetail$s3": "An S3 detail object to return information about the S3 destination.
" } }, "S3StorageConfiguration": { "base": "A complex type that describes an S3 location where recorded videos will be stored.
", "refs": { "CreateStorageConfigurationRequest$s3": "A complex type that contains a storage configuration for where recorded video will be stored.
", "StorageConfiguration$s3": "An S3 destination configuration where recorded videos will be stored.
", "StorageConfigurationSummary$s3": "An S3 destination configuration where recorded videos will be stored.
" } }, "ServiceQuotaExceededException": { "base": "", "refs": { } }, "Stage": { "base": "Object specifying a stage.
", "refs": { "CreateStageResponse$stage": "The stage that was created.
", "GetStageResponse$stage": "The stage that is returned.
", "UpdateStageResponse$stage": "The updated stage.
" } }, "StageArn": { "base": null, "refs": { "Composition$stageArn": "ARN of the stage used as input
", "CompositionSummary$stageArn": "ARN of the attached stage.
", "CreateParticipantTokenRequest$stageArn": "ARN of the stage to which this token is scoped.
", "DeleteStageRequest$arn": "ARN of the stage to be deleted.
", "DisconnectParticipantRequest$stageArn": "ARN of the stage to which the participant is attached.
", "Event$destinationStageArn": "ARN of the stage where the participant is replicated. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
Stage ARN.
", "GetStageRequest$arn": "ARN of the stage for which the information is to be retrieved.
", "GetStageSessionRequest$stageArn": "ARN of the stage for which the information is to be retrieved.
", "ListCompositionsRequest$filterByStageArn": "Filters the Composition list to match the specified Stage ARN.
", "ListIngestConfigurationsRequest$filterByStageArn": "Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.
", "ListParticipantEventsRequest$stageArn": "Stage ARN.
", "ListParticipantReplicasRequest$sourceStageArn": "ARN of the stage where the participant is publishing.
", "ListParticipantsRequest$stageArn": "Stage ARN.
", "ListStageSessionsRequest$stageArn": "Stage ARN.
", "Participant$sourceStageArn": "Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
ARN of the stage from which this participant is replicated.
", "ParticipantReplica$destinationStageArn": "ARN of the stage where the participant is replicated.
", "ParticipantSummary$sourceStageArn": "ARN of the stage from which this participant is replicated.
", "Stage$arn": "Stage ARN.
", "StageSummary$arn": "Stage ARN.
", "StartCompositionRequest$stageArn": "ARN of the stage to be used for compositing.
", "StartParticipantReplicationRequest$sourceStageArn": "ARN of the stage where the participant is publishing.
", "StartParticipantReplicationRequest$destinationStageArn": "ARN of the stage to which the participant will be replicated.
", "StopParticipantReplicationRequest$sourceStageArn": "ARN of the stage where the participant is publishing.
", "StopParticipantReplicationRequest$destinationStageArn": "ARN of the stage where the participant has been replicated.
", "UpdateStageRequest$arn": "ARN of the stage to be updated.
" } }, "StageEndpoint": { "base": null, "refs": { "StageEndpoints$events": "Events endpoint.
", "StageEndpoints$whip": "The endpoint to be used for IVS real-time streaming using the WHIP protocol.
", "StageEndpoints$rtmp": "The endpoint to be used for IVS real-time streaming using the RTMP protocol.
", "StageEndpoints$rtmps": "The endpoint to be used for IVS real-time streaming using the RTMPS protocol.
" } }, "StageEndpoints": { "base": "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.
", "refs": { "Stage$endpoints": "Summary information about various endpoints for a stage.
" } }, "StageName": { "base": null, "refs": { "CreateStageRequest$name": "Optional name that can be specified for the stage being created.
", "Stage$name": "Stage name.
", "StageSummary$name": "Stage name.
", "UpdateStageRequest$name": "Name of the stage to be updated.
" } }, "StageSession": { "base": "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.
", "refs": { "GetStageSessionResponse$stageSession": "The stage session that is returned.
" } }, "StageSessionId": { "base": null, "refs": { "Event$destinationSessionId": "ID of the session within the destination stage. Applicable only if the event name is REPLICATION_STARTED or REPLICATION_STOPPED.
ID of a session within the stage.
", "GetStageSessionRequest$sessionId": "ID of a session within the stage.
", "ListParticipantEventsRequest$sessionId": "ID of a session within the stage.
", "ListParticipantsRequest$sessionId": "ID of the session within the stage.
", "Participant$sourceSessionId": "ID of the session within the source stage, if replicationType is REPLICA.
ID of the session within the source stage.
", "ParticipantReplica$destinationSessionId": "ID of the session within the destination stage.
", "ParticipantSummary$sourceSessionId": "ID of the session within the source stage, if replicationType is REPLICA.
ID of the active session within the stage.
", "StageSession$sessionId": "ID of the session within the stage.
", "StageSessionSummary$sessionId": "ID of the session within the stage.
", "StageSummary$activeSessionId": "ID of the active session within the stage.
" } }, "StageSessionList": { "base": null, "refs": { "ListStageSessionsResponse$stageSessions": "List of matching stage sessions.
" } }, "StageSessionSummary": { "base": "Summary information about a stage session.
", "refs": { "StageSessionList$member": null } }, "StageSummary": { "base": "Summary information about a stage.
", "refs": { "StageSummaryList$member": null } }, "StageSummaryList": { "base": null, "refs": { "ListStagesResponse$stages": "List of the matching stages (summary information only).
" } }, "StartCompositionRequest": { "base": null, "refs": { } }, "StartCompositionResponse": { "base": null, "refs": { } }, "StartParticipantReplicationRequest": { "base": null, "refs": { } }, "StartParticipantReplicationResponse": { "base": null, "refs": { } }, "StopCompositionRequest": { "base": null, "refs": { } }, "StopCompositionResponse": { "base": null, "refs": { } }, "StopParticipantReplicationRequest": { "base": null, "refs": { } }, "StopParticipantReplicationResponse": { "base": null, "refs": { } }, "StorageConfiguration": { "base": "A complex type that describes a location where recorded videos will be stored.
", "refs": { "CreateStorageConfigurationResponse$storageConfiguration": "The StorageConfiguration that was created.
", "GetStorageConfigurationResponse$storageConfiguration": "The StorageConfiguration that was returned.
" } }, "StorageConfigurationArn": { "base": null, "refs": { "DeleteStorageConfigurationRequest$arn": "ARN of the storage configuration to be deleted.
", "GetStorageConfigurationRequest$arn": "ARN of the storage configuration to be retrieved.
", "S3DestinationConfiguration$storageConfigurationArn": "ARN of the StorageConfiguration where recorded videos will be stored.
", "StorageConfiguration$arn": "ARN of the storage configuration.
", "StorageConfigurationSummary$arn": "ARN of the storage configuration.
" } }, "StorageConfigurationName": { "base": null, "refs": { "CreateStorageConfigurationRequest$name": "Storage configuration name. The value does not need to be unique.
", "StorageConfiguration$name": "Name of the storage configuration.
", "StorageConfigurationSummary$name": "Name of the storage configuration.
" } }, "StorageConfigurationSummary": { "base": "Summary information about a storage configuration.
", "refs": { "StorageConfigurationSummaryList$member": null } }, "StorageConfigurationSummaryList": { "base": null, "refs": { "ListStorageConfigurationsResponse$storageConfigurations": "List of the matching storage configurations.
" } }, "StreamKey": { "base": null, "refs": { "IngestConfiguration$streamKey": "Ingest-key value for the RTMP(S) protocol.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$accessControlAllowOrigin": "", "AccessDeniedException$accessControlExposeHeaders": "", "AccessDeniedException$cacheControl": "", "AccessDeniedException$contentSecurityPolicy": "", "AccessDeniedException$strictTransportSecurity": "", "AccessDeniedException$xContentTypeOptions": "", "AccessDeniedException$xFrameOptions": "", "AccessDeniedException$xAmznErrorType": "", "ConflictException$accessControlAllowOrigin": "", "ConflictException$accessControlExposeHeaders": "", "ConflictException$cacheControl": "", "ConflictException$contentSecurityPolicy": "", "ConflictException$strictTransportSecurity": "", "ConflictException$xContentTypeOptions": "", "ConflictException$xFrameOptions": "", "ConflictException$xAmznErrorType": "", "Destination$id": "Unique identifier for this destination, assigned by IVS.
", "DestinationSummary$id": "Unique identifier for this destination, assigned by IVS.
", "InternalServerException$accessControlAllowOrigin": "", "InternalServerException$accessControlExposeHeaders": "", "InternalServerException$cacheControl": "", "InternalServerException$contentSecurityPolicy": "", "InternalServerException$strictTransportSecurity": "", "InternalServerException$xContentTypeOptions": "", "InternalServerException$xFrameOptions": "", "InternalServerException$xAmznErrorType": "", "ParticipantAttributes$key": null, "ParticipantAttributes$value": null, "ParticipantTokenAttributes$key": null, "ParticipantTokenAttributes$value": null, "PendingVerification$accessControlAllowOrigin": "", "PendingVerification$accessControlExposeHeaders": "", "PendingVerification$cacheControl": "", "PendingVerification$contentSecurityPolicy": "", "PendingVerification$strictTransportSecurity": "", "PendingVerification$xContentTypeOptions": "", "PendingVerification$xFrameOptions": "", "PendingVerification$xAmznErrorType": "", "ResourceNotFoundException$accessControlAllowOrigin": "", "ResourceNotFoundException$accessControlExposeHeaders": "", "ResourceNotFoundException$cacheControl": "", "ResourceNotFoundException$contentSecurityPolicy": "", "ResourceNotFoundException$strictTransportSecurity": "", "ResourceNotFoundException$xContentTypeOptions": "", "ResourceNotFoundException$xFrameOptions": "", "ResourceNotFoundException$xAmznErrorType": "", "S3Detail$recordingPrefix": "The S3 bucket prefix under which the recording is stored.
", "ServiceQuotaExceededException$accessControlAllowOrigin": "", "ServiceQuotaExceededException$accessControlExposeHeaders": "", "ServiceQuotaExceededException$cacheControl": "", "ServiceQuotaExceededException$contentSecurityPolicy": "", "ServiceQuotaExceededException$strictTransportSecurity": "", "ServiceQuotaExceededException$xContentTypeOptions": "", "ServiceQuotaExceededException$xFrameOptions": "", "ServiceQuotaExceededException$xAmznErrorType": "", "StartParticipantReplicationResponse$accessControlAllowOrigin": "", "StartParticipantReplicationResponse$accessControlExposeHeaders": "", "StartParticipantReplicationResponse$cacheControl": "", "StartParticipantReplicationResponse$contentSecurityPolicy": "", "StartParticipantReplicationResponse$strictTransportSecurity": "", "StartParticipantReplicationResponse$xContentTypeOptions": "", "StartParticipantReplicationResponse$xFrameOptions": "", "StopParticipantReplicationResponse$accessControlAllowOrigin": "", "StopParticipantReplicationResponse$accessControlExposeHeaders": "", "StopParticipantReplicationResponse$cacheControl": "", "StopParticipantReplicationResponse$contentSecurityPolicy": "", "StopParticipantReplicationResponse$strictTransportSecurity": "", "StopParticipantReplicationResponse$xContentTypeOptions": "", "StopParticipantReplicationResponse$xFrameOptions": "", "ValidationException$accessControlAllowOrigin": "", "ValidationException$accessControlExposeHeaders": "", "ValidationException$cacheControl": "", "ValidationException$contentSecurityPolicy": "", "ValidationException$strictTransportSecurity": "", "ValidationException$xContentTypeOptions": "", "ValidationException$xFrameOptions": "", "ValidationException$xAmznErrorType": "" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "Tags$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "Array of tag keys (strings) for the tags to be removed. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tags$value": null } }, "Tags": { "base": null, "refs": { "Composition$tags": "Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
The targeted thumbnail-generation interval in seconds. Default: 60.
", "ParticipantThumbnailConfiguration$targetIntervalSeconds": "The targeted thumbnail-generation interval in seconds. This is configurable only if recordingMode is INTERVAL. Default: 60.
Thumbnail recording mode. Default: DISABLED.
Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail. LATEST saves the latest thumbnail in media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. LATEST saves the latest thumbnail in media/latest_thumbnail/high/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.
UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
", "Composition$endTime": "UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CompositionSummary$startTime": "UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
", "CompositionSummary$endTime": "UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
", "Destination$startTime": "UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
", "Destination$endTime": "UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
", "DestinationSummary$startTime": "UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
", "DestinationSummary$endTime": "UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
", "Event$eventTime": "ISO 8601 timestamp (returned as a string) for when the event occurred.
", "Participant$firstJoinTime": "ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
", "ParticipantSummary$firstJoinTime": "ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
", "StageSession$startTime": "ISO 8601 timestamp (returned as a string) when this stage session began.
", "StageSession$endTime": "ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
", "StageSessionSummary$startTime": "ISO 8601 timestamp (returned as a string) when this stage session began.
", "StageSessionSummary$endTime": "ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateIngestConfigurationRequest": { "base": null, "refs": { } }, "UpdateIngestConfigurationResponse": { "base": null, "refs": { } }, "UpdateStageRequest": { "base": null, "refs": { } }, "UpdateStageResponse": { "base": null, "refs": { } }, "UserId": { "base": null, "refs": { "CreateIngestConfigurationRequest$userId": "Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "IngestConfiguration$userId": "Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "IngestConfigurationSummary$userId": "Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "ListParticipantsRequest$filterByUserId": "Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
", "ParticipantSummary$userId": "Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
" } }, "ValidationException": { "base": "", "refs": { } }, "Video": { "base": "Settings for video.
", "refs": { "CreateEncoderConfigurationRequest$video": "Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
", "EncoderConfiguration$video": "Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
" } }, "VideoAspectRatio": { "base": null, "refs": { "GridConfiguration$videoAspectRatio": "Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
Video-resolution width. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
User does not have sufficient access to perform this action.
", "ConflictException$exceptionMessage": "Updating or deleting a resource can cause an inconsistent state.
", "InternalServerException$exceptionMessage": "Unexpected error during processing of request.
", "PendingVerification$exceptionMessage": "Your account is pending verification.
", "ResourceNotFoundException$exceptionMessage": "Request references a resource which does not exist.
", "ServiceQuotaExceededException$exceptionMessage": "Request would cause a service quota to be exceeded.
", "ValidationException$exceptionMessage": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } } } }