Module aws_sdk_ivs::types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that Amazon Interactive Video Service can respond with.

Structs

• AudioConfiguration

  Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.

• BatchError

  Error related to a specific channel, specified by its ARN.

• BatchStartViewerSessionRevocationError

  Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.

• BatchStartViewerSessionRevocationViewerSession

  A viewer session to revoke in the call to BatchStartViewerSessionRevocation.

• Channel

  Object specifying a channel.

• ChannelSummary

  Summary information about a channel.

• DestinationConfiguration

  A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.

• IngestConfiguration

  Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.

• PlaybackKeyPair

  A key pair used to sign and validate a playback authorization token.

• PlaybackKeyPairSummary

  Summary information about a playback key pair.

• PlaybackRestrictionPolicy

  An object representing a policy to constrain playback by country and/or origin sites.

• PlaybackRestrictionPolicySummary

  Summary information about a PlaybackRestrictionPolicy.

• RecordingConfiguration

  An object representing a configuration to record a channel stream.

• RecordingConfigurationSummary

  Summary information about a RecordingConfiguration.

• RenditionConfiguration

  Object that describes which renditions should be recorded for a stream.

• S3DestinationConfiguration

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

• Srt

  Specifies information needed to stream using the SRT protocol.

• Stream

  Specifies a live video stream that has been ingested and distributed.

• StreamEvent

  Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.

• StreamFilters

  Object specifying the stream attribute on which to filter.

• StreamKey

  Object specifying a stream key.

• StreamKeySummary

  Summary information about a stream key.

• StreamSession

  Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

• StreamSessionSummary

  Summary information about a stream session.

• StreamSummary

  Summary information about a stream.

• ThumbnailConfiguration

  An object representing a configuration of thumbnails for recorded video.

• VideoConfiguration

  Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.

Enums

• ChannelLatencyMode
  When writing a match expression against ChannelLatencyMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ChannelType
  When writing a match expression against ChannelType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RecordingConfigurationState
  When writing a match expression against RecordingConfigurationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RecordingMode
  When writing a match expression against RecordingMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RenditionConfigurationRendition
  When writing a match expression against RenditionConfigurationRendition, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RenditionConfigurationRenditionSelection
  When writing a match expression against RenditionConfigurationRenditionSelection, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• StreamHealth
  When writing a match expression against StreamHealth, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• StreamState
  When writing a match expression against StreamState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ThumbnailConfigurationResolution
  When writing a match expression against ThumbnailConfigurationResolution, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ThumbnailConfigurationStorage
  When writing a match expression against ThumbnailConfigurationStorage, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• TranscodePreset
  When writing a match expression against TranscodePreset, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.