String exceptionMessage
User does not have sufficient access to perform this action.
String channelArn
The ARN of the channel associated with the viewer session to revoke.
String viewerId
The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.
Integer viewerSessionVersionsLessThanOrEqualTo
An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.
String arn
Channel ARN.
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
String ingestEndpoint
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
Boolean insecureIngest
Whether the channel allows insecure RTMP ingest. Default: false.
String latencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
LOW for near-real-time interaction with viewers. Default: LOW.
String name
Channel name.
String playbackRestrictionPolicyArn
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
String playbackUrl
Channel playback URL.
String preset
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and
ADVANCED_SD channel types. For those channel types, the default preset is
HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD),
preset is the empty string ("").
String recordingConfigurationArn
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
String type
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input
resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For
details, see Channel
Types.
String exceptionMessage
The stream is offline for the given channel ARN.
String arn
Channel ARN.
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
Boolean insecureIngest
Whether the channel allows insecure RTMP ingest. Default: false.
String latencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
LOW for near-real-time interaction with viewers. Default: LOW.
String name
Channel name.
String playbackRestrictionPolicyArn
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
String preset
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and
ADVANCED_SD channel types. For those channel types, the default preset is
HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD),
preset is the empty string ("").
String recordingConfigurationArn
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
String type
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input
resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For
details, see Channel
Types.
String exceptionMessage
Updating or deleting a resource can cause an inconsistent state.
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
Boolean insecureIngest
Whether the channel allows insecure RTMP ingest. Default: false.
String latencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
LOW for near-real-time interaction with viewers. Default: LOW.
String name
Channel name.
String playbackRestrictionPolicyArn
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
String preset
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and
ADVANCED_SD channel types. For those channel types, the default preset is
HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD),
preset is the empty string ("").
String recordingConfigurationArn
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon
IVS has no service-specific constraints beyond what is documented there.
String type
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input
resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For
details, see Channel
Types.
List<E> allowedCountries
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
List<E> allowedOrigins
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla .org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
Boolean enableStrictOriginEnforcement
Whether channel playback is constrained by origin site. Default: false.
String name
Playback-restriction-policy name. The value does not need to be unique.
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon
IVS has no service-specific constraints beyond what is documented there.
PlaybackRestrictionPolicy playbackRestrictionPolicy
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where recorded video will be stored.
String name
Recording-configuration name. The value does not need to be unique.
Integer recordingReconnectWindowSeconds
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
RenditionConfiguration renditionConfiguration
Object that describes which renditions should be recorded for a stream.
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon
IVS has no service-specific constraints beyond what is documented there.
ThumbnailConfiguration thumbnailConfiguration
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
RecordingConfiguration recordingConfiguration
String channelArn
ARN of the channel for which to create the stream key.
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources
for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon
IVS has no service-specific constraints beyond what is documented there.
StreamKey streamKey
Stream key used to authenticate an RTMPS stream for ingestion.
String arn
ARN of the channel to be deleted.
String arn
ARN of the key pair to be deleted.
String arn
ARN of the playback restriction policy to be deleted.
String arn
ARN of the recording configuration to be deleted.
String arn
ARN of the stream key to be deleted.
S3DestinationConfiguration s3
An S3 destination configuration where recorded videos will be stored.
String arn
ARN of the channel for which the configuration is to be retrieved.
Channel channel
String arn
ARN of the key pair to be returned.
PlaybackKeyPair keyPair
String arn
ARN of the playback restriction policy to be returned.
PlaybackRestrictionPolicy playbackRestrictionPolicy
String arn
ARN of the recording configuration to be retrieved.
RecordingConfiguration recordingConfiguration
String arn
ARN for the stream key to be retrieved.
StreamKey streamKey
String channelArn
Channel ARN for stream to be accessed.
Stream stream
StreamSession streamSession
List of stream details.
String name
Playback-key-pair name. The value does not need to be unique.
String publicKeyMaterial
The public portion of a customer-generated key pair.
Map<K,V> tags
Any tags provided with the request are added to the playback key pair tags. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
PlaybackKeyPair keyPair
AudioConfiguration audio
Encoder settings for audio.
VideoConfiguration video
Encoder settings for video.
String exceptionMessage
Unexpected error during processing of request.
String filterByName
Filters the channel list to match the specified name.
String filterByPlaybackRestrictionPolicyArn
Filters the channel list to match the specified policy.
String filterByRecordingConfigurationArn
Filters the channel list to match the specified recording-configuration ARN.
Integer maxResults
Maximum number of channels to return. Default: 100.
String nextToken
The first channel to retrieve. This is used for pagination; see the nextToken response field.
StreamFilters filterBy
Filters the stream list to match the specified criterion.
Integer maxResults
Maximum number of streams to return. Default: 100.
String nextToken
The first stream to retrieve. This is used for pagination; see the nextToken response field.
String resourceArn
The ARN of the resource to be retrieved. The ARN must be URL-encoded.
String exceptionMessage
Your account is pending verification.
String arn
Key-pair ARN.
String fingerprint
Key-pair identifier.
String name
Playback-key-pair name. The value does not need to be unique.
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
String arn
Key-pair ARN.
String name
Playback-key-pair name. The value does not need to be unique.
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
List<E> allowedCountries
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
List<E> allowedOrigins
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla .org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
String arn
Playback-restriction-policy ARN
Boolean enableStrictOriginEnforcement
Whether channel playback is constrained by origin site. Default: false.
String name
Playback-restriction-policy name. The value does not need to be unique.
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
List<E> allowedCountries
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
List<E> allowedOrigins
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla .org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
String arn
Playback-restriction-policy ARN
Boolean enableStrictOriginEnforcement
Whether channel playback is constrained by origin site. Default: false.
String name
Playback-restriction-policy name. The value does not need to be unique.
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
String arn
Recording-configuration ARN.
DestinationConfiguration destinationConfiguration
A complex type that contains information about where recorded video will be stored.
String name
Recording-configuration name. The value does not need to be unique.
Integer recordingReconnectWindowSeconds
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
RenditionConfiguration renditionConfiguration
Object that describes which renditions should be recorded for a stream.
String state
Indicates the current state of the recording configuration. When the state is ACTIVE, the
configuration is ready for recording a channel stream.
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
ThumbnailConfiguration thumbnailConfiguration
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
String arn
Recording-configuration ARN.
DestinationConfiguration destinationConfiguration
A complex type that contains information about where recorded video will be stored.
String name
Recording-configuration name. The value does not need to be unique.
String state
Indicates the current state of the recording configuration. When the state is ACTIVE, the
configuration is ready for recording a channel stream.
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
String renditionSelection
Indicates which set of renditions are recorded for a stream. For BASIC channels, the
CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be
specified in the renditions field. Default: ALL.
List<E> renditions
Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM;
otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the
stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the
resolution dimensions of each rendition, see Auto-Record to Amazon S3.
String exceptionMessage
Request references a resource which does not exist.
String bucketName
Location (S3 bucket name) where recorded videos will be stored.
String exceptionMessage
Request would cause a service quota to be exceeded.
String channelArn
The ARN of the channel associated with the viewer session to revoke.
String viewerId
The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.
Integer viewerSessionVersionsLessThanOrEqualTo
An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.
String channelArn
ARN of the channel for which the stream is to be stopped.
String channelArn
Channel ARN for the stream.
String health
The stream’s health.
String playbackUrl
URL of the master playlist, required by the video player to play the HLS stream.
Date startTime
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
String state
The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a
"NotBroadcasting" error will indicate that the stream is not live.
String streamId
Unique identifier for a live or previously live stream in the specified channel.
Long viewerCount
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15
seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when
video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
String health
The stream’s health.
String arn
Stream-key ARN.
String channelArn
Channel ARN for the stream.
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
String value
Stream-key value.
String arn
Stream-key ARN.
String channelArn
Channel ARN for the stream.
Map<K,V> tags
Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See
Tagging Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
Channel channel
The properties of the channel at the time of going live.
Date endTime
Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string.
For live streams, this is NULL.
IngestConfiguration ingestConfiguration
The properties of the incoming RTMP stream for the stream.
RecordingConfiguration recordingConfiguration
The properties of recording the live stream.
Date startTime
Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
String streamId
Unique identifier for a live or previously live stream in the specified channel.
List<E> truncatedEvents
List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
Date endTime
Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string.
For live streams, this is NULL.
Boolean hasErrorEvent
If true, this stream encountered a quota breach or failure.
Date startTime
Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
String streamId
Unique identifier for a live or previously live stream in the specified channel.
String channelArn
Channel ARN for the stream.
String health
The stream’s health.
Date startTime
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
String state
The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a
"NotBroadcasting" error will indicate that the stream is not live.
String streamId
Unique identifier for a live or previously live stream in the specified channel.
Long viewerCount
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15
seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when
video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
String exceptionMessage
The stream is temporarily unavailable.
String resourceArn
ARN of the resource for which tags are to be added or updated. 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 Amazon Web Services
Resources for more information, including restrictions that apply to tags and
"Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented
there.
String exceptionMessage
Request was denied due to request throttling.
String recordingMode
Thumbnail recording mode. Default: INTERVAL.
String resolution
Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3. Default: Null (source resolution is returned).
List<E> storage
Indicates the format in which thumbnails are recorded. SEQUENTIAL records all generated thumbnails
in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in
media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by
targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default:
SEQUENTIAL.
Long targetIntervalSeconds
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if
recordingMode is INTERVAL. Default: 60.
Important: For the BASIC channel type, setting a value for targetIntervalSeconds
does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the
targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less
than the targetIntervalSeconds value. See Amazon IVS Streaming
Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder
settings.
String resourceArn
ARN of the resource for which tags are to be removed. 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 Amazon Web Services Resources
for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon
IVS has no service-specific constraints beyond what is documented there.
String arn
ARN of the channel to be updated.
Boolean authorized
Whether the channel is private (enabled for playback authorization).
Boolean insecureIngest
Whether the channel allows insecure RTMP ingest. Default: false.
String latencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
LOW for near-real-time interaction with viewers.
String name
Channel name.
String playbackRestrictionPolicyArn
Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
String preset
Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and
ADVANCED_SD channel types. For those channel types, the default preset is
HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD),
preset is the empty string ("").
String recordingConfigurationArn
Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
String type
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input
resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For
details, see Channel
Types.
Channel channel
Object specifying the updated channel.
List<E> allowedCountries
A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
List<E> allowedOrigins
A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla .org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
String arn
ARN of the playback-restriction-policy to be updated.
Boolean enableStrictOriginEnforcement
Whether channel playback is constrained by origin site. Default: false.
String name
Playback-restriction-policy name. The value does not need to be unique.
PlaybackRestrictionPolicy playbackRestrictionPolicy
Object specifying the updated policy.
String exceptionMessage
The input fails to satisfy the constraints specified by an Amazon Web Services service.
String avcLevel
Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
String avcProfile
Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
String codec
Codec used for the video encoding.
String encoder
Software or hardware used to encode the video.
Long targetBitrate
The expected ingest bitrate (bits per second). This is configured in the encoder.
Long targetFramerate
The expected ingest framerate. This is configured in the encoder.
Long videoHeight
Video-resolution height in pixels.
Long videoWidth
Video-resolution width in pixels.
Copyright © 2024. All rights reserved.