String exceptionMessage
User does not have sufficient access to perform this action.
String 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.
List<E> mediaTypes
Types of media to be recorded. Default: AUDIO_VIDEO.
String channelArn
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).
String encoderConfigurationArn
ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
String arn
ARN of the Composition resource.
String stageArn
ARN of the stage used as input
String state
State of the Composition.
LayoutConfiguration layout
Layout object to configure composition parameters.
List<E> destinations
Array of Destination objects. A Composition can contain either one destination (channel or
s3) or two (one channel and one s3).
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
Date startTime
UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
Date endTime
UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
String arn
ARN of the Composition resource.
String stageArn
ARN of the attached stage.
List<E> destinations
Array of Destination objects.
String state
State of the Composition resource.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
Date startTime
UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
Date endTime
UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
String exceptionMessage
Updating or deleting a resource can cause an inconsistent state.
String name
Optional name to identify the resource.
Video video
Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
EncoderConfiguration encoderConfiguration
The EncoderConfiguration that was created.
String stageArn
ARN of the stage to which this token is scoped.
Integer duration
Duration (in minutes), after which the token expires. Default: 720 (12 hours).
String 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.
Map<K,V> 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.
List<E> capabilities
Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.
ParticipantToken participantToken
The participant token that was created.
String name
Optional name that can be specified for the stage being created.
List<E> participantTokenConfigurations
Array of participant token configuration objects to attach to the new stage.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
AutoParticipantRecordingConfiguration autoParticipantRecordingConfiguration
Configuration object for individual participant recording, to attach to the new stage.
String name
Storage configuration name. The value does not need to be unique.
S3StorageConfiguration s3
A complex type that contains a storage configuration for where recorded video will be stored.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
StorageConfiguration storageConfiguration
The StorageConfiguration that was created.
String arn
ARN of the EncoderConfiguration.
String arn
ARN of the public key to be deleted.
String arn
ARN of the stage to be deleted.
String arn
ARN of the storage configuration to be deleted.
String id
Unique identifier for this destination, assigned by IVS.
String state
State of the Composition Destination.
Date startTime
UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
Date endTime
UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
DestinationConfiguration configuration
Configuration used to create this destination.
DestinationDetail detail
Optional details regarding the status of the destination.
String name
Name that can be specified to help identify the destination.
ChannelDestinationConfiguration channel
An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an
s3 must be specified.
S3DestinationConfiguration s3
An S3 storage configuration to be used for recording video data. Either a channel or an
s3 must be specified.
S3Detail s3
An S3 detail object to return information about the S3 destination.
String id
Unique identifier for this destination, assigned by IVS.
String state
State of the Composition Destination.
Date startTime
UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.
Date endTime
UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.
String stageArn
ARN of the stage to which the participant is attached.
String participantId
Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.
String reason
Description of why this participant is being disconnected.
String arn
ARN of the EncoderConfiguration resource.
String name
Optional name to identify the resource.
Video video
Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
String arn
ARN of the EncoderConfiguration resource.
String name
Optional name to identify the resource.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
String name
The name of the event.
String participantId
Unique identifier for the participant who triggered the event. This is assigned by IVS.
Date eventTime
ISO 8601 timestamp (returned as a string) for when the event occurred.
String 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.
String 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. INSUFFICIENT_CAPABILITIES indicates that the
participant tried to take an action that the participant’s token is not allowed to do. For more information about
participant capabilities, see the capabilities field in CreateParticipantToken.
QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage
exceeds the quota; for more information, see Service Quotas.
PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t
exist.
String arn
ARN of the Composition resource.
Composition composition
The Composition that was returned.
String arn
ARN of the EncoderConfiguration resource.
EncoderConfiguration encoderConfiguration
The EncoderConfiguration that was returned.
String stageArn
Stage ARN.
String sessionId
ID of a session within the stage.
String participantId
Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
Participant participant
The participant that is returned.
String arn
ARN of the public key for which the information is to be retrieved.
PublicKey publicKey
The public key that is returned.
String arn
ARN of the stage for which the information is to be retrieved.
Stage stage
The stage that is returned.
StageSession stageSession
The stage session that is returned.
String arn
ARN of the storage configuration to be retrieved.
StorageConfiguration storageConfiguration
The StorageConfiguration that was returned.
String 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).
Boolean omitStoppedVideo
Determines whether to omit participants with stopped video in the composition. Default: false.
String 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.
String videoFillMode
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.
Integer gridGap
Specifies the spacing between participant tiles in pixels. Default: 2.
String publicKeyMaterial
The content of the public key to be imported.
String name
Name of the public key to be imported.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
PublicKey publicKey
The public key that was imported.
String exceptionMessage
Unexpected error during processing of request.
GridConfiguration grid
Configuration related to grid layout. Default: Grid layout.
PipConfiguration pip
Configuration related to PiP layout.
String filterByStageArn
Filters the Composition list to match the specified Stage ARN.
String filterByEncoderConfigurationArn
Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
String nextToken
The first Composition to retrieve. This is used for pagination; see the nextToken response field.
Integer maxResults
Maximum number of results to return. Default: 100.
String stageArn
Stage ARN.
String sessionId
ID of a session within the stage.
String participantId
Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.
String nextToken
The first participant event to retrieve. This is used for pagination; see the nextToken response
field.
Integer maxResults
Maximum number of results to return. Default: 50.
String stageArn
Stage ARN.
String sessionId
ID of the session within the stage.
String 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.
Boolean 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.
String 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.
String nextToken
The first participant to retrieve. This is used for pagination; see the nextToken response field.
Integer maxResults
Maximum number of results to return. Default: 50.
String 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.
String resourceArn
The ARN of the resource to be retrieved. The ARN must be URL-encoded.
String participantId
Unique identifier for this participant, assigned by IVS.
String 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.
String state
Whether the participant is connected to or disconnected from the stage.
Date firstJoinTime
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
Map<K,V> 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.
Boolean published
Whether the participant ever published to the stage session.
String ispName
The participant’s Internet Service Provider.
String osName
The participant’s operating system.
String osVersion
The participant’s operating system version.
String browserName
The participant’s browser.
String browserVersion
The participant’s browser version.
String sdkVersion
The participant’s SDK version.
String 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.
String recordingS3Prefix
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.
String recordingState
The participant’s recording state.
String participantId
Unique identifier for this participant, assigned by IVS.
String 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.
String state
Whether the participant is connected to or disconnected from the stage.
Date firstJoinTime
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
Boolean published
Whether the participant ever published to the stage session.
String recordingState
The participant’s recording state.
String participantId
Unique identifier for this participant token, assigned by IVS.
String token
The issued client token, encrypted.
String 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.
Map<K,V> 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.
Integer duration
Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).
List<E> capabilities
Set of capabilities that the user is allowed to perform in the stage.
Date expirationTime
ISO 8601 timestamp (returned as a string) for when this token expires.
Integer duration
Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
String 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.
Map<K,V> 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.
List<E> capabilities
Set of capabilities that the user is allowed to perform in the stage.
String exceptionMessage
Your account is pending verification.
String 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).
Boolean omitStoppedVideo
Determines whether to omit participants with stopped video in the composition. Default: false.
String videoFillMode
Defines how video content fits within the participant tile: FILL (stretched), COVER
(cropped), or CONTAIN (letterboxed). Default: COVER.
Integer gridGap
Specifies the spacing between participant tiles in pixels. Default: 0.
String pipParticipantAttribute
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).
String pipBehavior
Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or
DYNAMIC (expands to full composition). Default: STATIC.
Integer pipOffset
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition.
Default: 0.
String pipPosition
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
Integer pipWidth
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.
Integer 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.
String arn
Public key ARN.
String name
Public key name.
String publicKeyMaterial
Public key material.
String fingerprint
The public key fingerprint, a short string used to identify or verify the full public key.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
String arn
Public key ARN.
String name
Public key name.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
String format
The recording format for storing a recording in Amazon S3.
String exceptionMessage
Request references a resource which does not exist.
String storageConfigurationArn
ARN of the StorageConfiguration where recorded videos will be stored.
List<E> encoderConfigurationArns
ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.
RecordingConfiguration 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.
String recordingPrefix
The S3 bucket prefix under which the recording is stored.
String 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.
String exceptionMessage
Request would cause a service quota to be exceeded.
String arn
Stage ARN.
String name
Stage name.
String activeSessionId
ID of the active session within the stage.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
AutoParticipantRecordingConfiguration autoParticipantRecordingConfiguration
Configuration object for individual participant recording, attached to the stage.
StageEndpoints endpoints
Summary information about various endpoints for a stage.
String arn
Stage ARN.
String name
Stage name.
String activeSessionId
ID of the active session within the stage.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
String stageArn
ARN of the stage to be used for compositing.
String idempotencyToken
Idempotency token.
LayoutConfiguration layout
Layout object to configure composition parameters.
List<E> destinations
Array of destination configuration.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
Composition composition
The Composition that was created.
String arn
ARN of the Composition.
String arn
ARN of the storage configuration.
String name
Name of the storage configuration.
S3StorageConfiguration s3
An S3 destination configuration where recorded videos will be stored.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
String arn
ARN of the storage configuration.
String name
Name of the storage configuration.
S3StorageConfiguration s3
An S3 destination configuration where recorded videos will be stored.
Map<K,V> tags
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.
String resourceArn
The ARN of the resource to be tagged. The ARN must be URL-encoded.
Map<K,V> tags
Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See
Tagging AWS Resources for details,
including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints
beyond what is documented there.
String resourceArn
The ARN of the resource to be untagged. The ARN must be URL-encoded.
List<E> tagKeys
Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details,
including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints
beyond what is documented there.
String arn
ARN of the stage to be updated.
String name
Name of the stage to be updated.
AutoParticipantRecordingConfiguration autoParticipantRecordingConfiguration
Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.
Stage stage
The updated stage.
String exceptionMessage
The input fails to satisfy the constraints specified by an Amazon Web Services service.
Integer width
Video-resolution width. Note that the maximum value is determined by width times height
, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
Integer height
Video-resolution height. Note that the maximum value is determined by width times
height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
Float framerate
Video frame rate, in fps. Default: 30.
Integer bitrate
Bitrate for generated output, in bps. Default: 2500000.
Copyright © 2024. All rights reserved.