types

package
v1.42.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 17, 2025 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AudioConfiguration added in v1.10.0 

type AudioConfiguration struct {

	// Number of audio channels.
	Channels int64

	// Codec used for the audio encoding.
	Codec *string

	// Number of audio samples recorded per second.
	SampleRate int64

	// The expected ingest bitrate (bits per second). This is configured in the
	// encoder.
	TargetBitrate int64

	// Name of the audio track (if the stream has an audio track). If multitrack is
	// not enabled, this is track0 (the sole track).
	Track *string
	// contains filtered or unexported fields
}

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

type BatchError 

type BatchError struct {

	// ARN of an IVS resource; e.g., channel.
	Arn *string

	// Error code.
	Code *string

	// Error message, determined by the application.
	Message *string
	// contains filtered or unexported fields
}

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

type BatchStartViewerSessionRevocationError added in v1.23.0 

type BatchStartViewerSessionRevocationError struct {

	// Channel ARN.
	//
	// This member is required.
	ChannelArn *string

	// The ID of the viewer session to revoke.
	//
	// This member is required.
	ViewerId *string

	// Error code.
	Code *string

	// Error message, determined by the application.
	Message *string
	// contains filtered or unexported fields
}

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

type BatchStartViewerSessionRevocationViewerSession added in v1.23.0 

type BatchStartViewerSessionRevocationViewerSession struct {

	// The ARN of the channel associated with the viewer session to revoke.
	//
	// This member is required.
	ChannelArn *string

	// The ID of the viewer associated with the viewer session to revoke. Do not use
	// this field for personally identifying, confidential, or sensitive information.
	//
	// This member is required.
	ViewerId *string

	// 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.
	ViewerSessionVersionsLessThanOrEqualTo int32
	// contains filtered or unexported fields
}

A viewer session to revoke in the call to BatchStartViewerSessionRevocation.

type Channel 

type Channel struct {

	// Channel ARN.
	Arn *string

	// Whether the channel is private (enabled for playback authorization). Default:
	// false .
	Authorized bool

	// Indicates which content-packaging format is used (MPEG-TS or fMP4). If
	// multitrackInputConfiguration is specified and enabled is true , then
	// containerFormat is required and must be set to FRAGMENTED_MP4 . Otherwise,
	// containerFormat may be set to TS or FRAGMENTED_MP4 . Default: TS .
	ContainerFormat ContainerFormat

	// Channel ingest endpoint, part of the definition of an ingest server, used when
	// you set up streaming software.
	IngestEndpoint *string

	// Whether the channel allows insecure RTMP ingest. Default: false .
	InsecureIngest bool

	// 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 .
	LatencyMode ChannelLatencyMode

	// Object specifying multitrack input configuration. Default: no multitrack input
	// configuration is specified.
	MultitrackInputConfiguration *MultitrackInputConfiguration

	// Channel name.
	Name *string

	// 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).
	PlaybackRestrictionPolicyArn *string

	// Channel playback URL.
	PlaybackUrl *string

	// 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 ( "" ).
	Preset TranscodePreset

	// Recording-configuration ARN. A valid ARN value here both specifies the ARN and
	// enables recording. Default: "" (empty string, recording is disabled).
	RecordingConfigurationArn *string

	// Specifies the endpoint and optional passphrase for streaming with the SRT
	// protocol.
	Srt *Srt

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string

	// 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 Types]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
	Type ChannelType
	// contains filtered or unexported fields
}

Object specifying a channel.

type ChannelLatencyMode 

type ChannelLatencyMode string
const (
	ChannelLatencyModeNormalLatency ChannelLatencyMode = "NORMAL"
	ChannelLatencyModeLowLatency    ChannelLatencyMode = "LOW"
)

Enum values for ChannelLatencyMode

func (ChannelLatencyMode) Values added in v0.29.0 

func (ChannelLatencyMode) Values() []ChannelLatencyMode

Values returns all known values for ChannelLatencyMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChannelNotBroadcasting 

type ChannelNotBroadcasting struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*ChannelNotBroadcasting) Error 

func (e *ChannelNotBroadcasting) Error() string

func (*ChannelNotBroadcasting) ErrorCode 

func (e *ChannelNotBroadcasting) ErrorCode() string

func (*ChannelNotBroadcasting) ErrorFault 

func (e *ChannelNotBroadcasting) ErrorFault() smithy.ErrorFault

func (*ChannelNotBroadcasting) ErrorMessage 

func (e *ChannelNotBroadcasting) ErrorMessage() string

type ChannelSummary 

type ChannelSummary struct {

	// Channel ARN.
	Arn *string

	// Whether the channel is private (enabled for playback authorization). Default:
	// false .
	Authorized bool

	// Whether the channel allows insecure RTMP ingest. Default: false .
	InsecureIngest bool

	// 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 .
	LatencyMode ChannelLatencyMode

	// Channel name.
	Name *string

	// 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).
	PlaybackRestrictionPolicyArn *string

	// 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 ( "" ).
	Preset TranscodePreset

	// Recording-configuration ARN. A valid ARN value here both specifies the ARN and
	// enables recording. Default: "" (empty string, recording is disabled).
	RecordingConfigurationArn *string

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string

	// 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 Types]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
	Type ChannelType
	// contains filtered or unexported fields
}

Summary information about a channel.

type ChannelType 

type ChannelType string
const (
	ChannelTypeBasicChannelType      ChannelType = "BASIC"
	ChannelTypeStandardChannelType   ChannelType = "STANDARD"
	ChannelTypeAdvancedSDChannelType ChannelType = "ADVANCED_SD"
	ChannelTypeAdvancedHDChannelType ChannelType = "ADVANCED_HD"
)

Enum values for ChannelType

func (ChannelType) Values added in v0.29.0 

func (ChannelType) Values() []ChannelType

Values returns all known values for ChannelType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ContainerFormat added in v1.42.0 

type ContainerFormat string
const (
	ContainerFormatTs            ContainerFormat = "TS"
	ContainerFormatFragmentedMP4 ContainerFormat = "FRAGMENTED_MP4"
)

Enum values for ContainerFormat

func (ContainerFormat) Values added in v1.42.0 

func (ContainerFormat) Values() []ContainerFormat

Values returns all known values for ContainerFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DestinationConfiguration added in v1.3.0 

type DestinationConfiguration struct {

	// An S3 destination configuration where recorded videos will be stored.
	S3 *S3DestinationConfiguration
	// contains filtered or unexported fields
}

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.

type IngestConfiguration added in v1.10.0 

type IngestConfiguration struct {

	// Encoder settings for audio.
	Audio *AudioConfiguration

	// Encoder settings for video.
	Video *VideoConfiguration
	// contains filtered or unexported fields
}

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

Note: IngestConfiguration is deprecated in favor of IngestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, IngestConfiguration and IngestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, IngestConfiguration contains data for only the first track (track0) and IngestConfigurations contains data for all tracks.

type IngestConfigurations added in v1.42.0 

type IngestConfigurations struct {

	// Encoder settings for audio.
	//
	// This member is required.
	AudioConfigurations []AudioConfiguration

	// Encoder settings for video
	//
	// This member is required.
	VideoConfigurations []VideoConfiguration
	// contains filtered or unexported fields
}

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

Note: Use IngestConfigurations instead of IngestConfiguration (which is deprecated). If multitrack is not enabled, IngestConfiguration and IngestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, IngestConfiguration contains data for only the first track (track0) and IngestConfigurations contains data for all tracks.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type MultitrackInputConfiguration added in v1.42.0 

type MultitrackInputConfiguration struct {

	// Indicates whether multitrack input is enabled. Can be set to true only if
	// channel type is STANDARD . Setting enabled to true with any other channel type
	// will cause an exception. If true , then policy , maximumResolution , and
	// containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4
	// . Default: false .
	Enabled bool

	// Maximum resolution for multitrack input. Required if enabled is true .
	MaximumResolution MultitrackMaximumResolution

	// Indicates whether multitrack input is allowed or required. Required if enabled
	// is true .
	Policy MultitrackPolicy
	// contains filtered or unexported fields
}

A complex type that specifies multitrack input configuration.

type MultitrackMaximumResolution added in v1.42.0 

type MultitrackMaximumResolution string
const (
	MultitrackMaximumResolutionSd     MultitrackMaximumResolution = "SD"
	MultitrackMaximumResolutionHd     MultitrackMaximumResolution = "HD"
	MultitrackMaximumResolutionFullHd MultitrackMaximumResolution = "FULL_HD"
)

Enum values for MultitrackMaximumResolution

func (MultitrackMaximumResolution) Values added in v1.42.0 

func (MultitrackMaximumResolution) Values() []MultitrackMaximumResolution

Values returns all known values for MultitrackMaximumResolution. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MultitrackPolicy added in v1.42.0 

type MultitrackPolicy string
const (
	MultitrackPolicyAllow   MultitrackPolicy = "ALLOW"
	MultitrackPolicyRequire MultitrackPolicy = "REQUIRE"
)

Enum values for MultitrackPolicy

func (MultitrackPolicy) Values added in v1.42.0 

func (MultitrackPolicy) Values() []MultitrackPolicy

Values returns all known values for MultitrackPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PendingVerification 

type PendingVerification struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*PendingVerification) Error 

func (e *PendingVerification) Error() string

func (*PendingVerification) ErrorCode 

func (e *PendingVerification) ErrorCode() string

func (*PendingVerification) ErrorFault 

func (e *PendingVerification) ErrorFault() smithy.ErrorFault

func (*PendingVerification) ErrorMessage 

func (e *PendingVerification) ErrorMessage() string

type PlaybackKeyPair added in v0.29.0 

type PlaybackKeyPair struct {

	// Key-pair ARN.
	Arn *string

	// Key-pair identifier.
	Fingerprint *string

	// Playback-key-pair name. The value does not need to be unique.
	Name *string

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

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

type PlaybackKeyPairSummary added in v0.29.0 

type PlaybackKeyPairSummary struct {

	// Key-pair ARN.
	Arn *string

	// Playback-key-pair name. The value does not need to be unique.
	Name *string

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a playback key pair.

type PlaybackRestrictionPolicy added in v1.31.0 

type PlaybackRestrictionPolicy struct {

	// 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).
	//
	// [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
	//
	// This member is required.
	AllowedCountries []string

	// 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).
	//
	// [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
	//
	// This member is required.
	AllowedOrigins []string

	// Playback-restriction-policy ARN
	//
	// This member is required.
	Arn *string

	// Whether channel playback is constrained by origin site. Default: false .
	EnableStrictOriginEnforcement *bool

	// Playback-restriction-policy name. The value does not need to be unique.
	Name *string

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

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

type PlaybackRestrictionPolicySummary added in v1.31.0 

type PlaybackRestrictionPolicySummary struct {

	// 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).
	//
	// [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
	//
	// This member is required.
	AllowedCountries []string

	// 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).
	//
	// [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
	//
	// This member is required.
	AllowedOrigins []string

	// Playback-restriction-policy ARN
	//
	// This member is required.
	Arn *string

	// Whether channel playback is constrained by origin site. Default: false .
	EnableStrictOriginEnforcement *bool

	// Playback-restriction-policy name. The value does not need to be unique.
	Name *string

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a PlaybackRestrictionPolicy.

type RecordingConfiguration added in v1.3.0 

type RecordingConfiguration struct {

	// Recording-configuration ARN.
	//
	// This member is required.
	Arn *string

	// A complex type that contains information about where recorded video will be
	// stored.
	//
	// This member is required.
	DestinationConfiguration *DestinationConfiguration

	// Indicates the current state of the recording configuration. When the state is
	// ACTIVE , the configuration is ready for recording a channel stream.
	//
	// This member is required.
	State RecordingConfigurationState

	// Recording-configuration name. The value does not need to be unique.
	Name *string

	// 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.
	RecordingReconnectWindowSeconds int32

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

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string

	// 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.
	ThumbnailConfiguration *ThumbnailConfiguration
	// contains filtered or unexported fields
}

An object representing a configuration to record a channel stream.

type RecordingConfigurationState added in v1.3.0 

type RecordingConfigurationState string
const (
	RecordingConfigurationStateCreating     RecordingConfigurationState = "CREATING"
	RecordingConfigurationStateCreateFailed RecordingConfigurationState = "CREATE_FAILED"
	RecordingConfigurationStateActive       RecordingConfigurationState = "ACTIVE"
)

Enum values for RecordingConfigurationState

func (RecordingConfigurationState) Values added in v1.3.0 

func (RecordingConfigurationState) Values() []RecordingConfigurationState

Values returns all known values for RecordingConfigurationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecordingConfigurationSummary added in v1.3.0 

type RecordingConfigurationSummary struct {

	// Recording-configuration ARN.
	//
	// This member is required.
	Arn *string

	// A complex type that contains information about where recorded video will be
	// stored.
	//
	// This member is required.
	DestinationConfiguration *DestinationConfiguration

	// Indicates the current state of the recording configuration. When the state is
	// ACTIVE , the configuration is ready for recording a channel stream.
	//
	// This member is required.
	State RecordingConfigurationState

	// Recording-configuration name. The value does not need to be unique.
	Name *string

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a RecordingConfiguration.

type RecordingMode added in v1.14.0 

type RecordingMode string
const (
	RecordingModeDisabled RecordingMode = "DISABLED"
	RecordingModeInterval RecordingMode = "INTERVAL"
)

Enum values for RecordingMode

func (RecordingMode) Values added in v1.14.0 

func (RecordingMode) Values() []RecordingMode

Values returns all known values for RecordingMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RenditionConfiguration added in v1.24.0 

type RenditionConfiguration struct {

	// 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 .
	RenditionSelection RenditionConfigurationRenditionSelection

	// 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].
	//
	// [Auto-Record to Amazon S3]: https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html
	Renditions []RenditionConfigurationRendition
	// contains filtered or unexported fields
}

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

type RenditionConfigurationRendition added in v1.24.0 

type RenditionConfigurationRendition string
const (
	RenditionConfigurationRenditionSd               RenditionConfigurationRendition = "SD"
	RenditionConfigurationRenditionHd               RenditionConfigurationRendition = "HD"
	RenditionConfigurationRenditionFullHd           RenditionConfigurationRendition = "FULL_HD"
	RenditionConfigurationRenditionLowestResolution RenditionConfigurationRendition = "LOWEST_RESOLUTION"
)

Enum values for RenditionConfigurationRendition

func (RenditionConfigurationRendition) Values added in v1.24.0 

func (RenditionConfigurationRendition) Values() []RenditionConfigurationRendition

Values returns all known values for RenditionConfigurationRendition. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RenditionConfigurationRenditionSelection added in v1.24.0 

type RenditionConfigurationRenditionSelection string
const (
	RenditionConfigurationRenditionSelectionAll    RenditionConfigurationRenditionSelection = "ALL"
	RenditionConfigurationRenditionSelectionNone   RenditionConfigurationRenditionSelection = "NONE"
	RenditionConfigurationRenditionSelectionCustom RenditionConfigurationRenditionSelection = "CUSTOM"
)

Enum values for RenditionConfigurationRenditionSelection

func (RenditionConfigurationRenditionSelection) Values added in v1.24.0 

func (RenditionConfigurationRenditionSelection) Values() []RenditionConfigurationRenditionSelection

Values returns all known values for RenditionConfigurationRenditionSelection. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3DestinationConfiguration added in v1.3.0 

type S3DestinationConfiguration struct {

	// Location (S3 bucket name) where recorded videos will be stored.
	//
	// This member is required.
	BucketName *string
	// contains filtered or unexported fields
}

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

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Srt added in v1.34.0 

type Srt struct {

	// The endpoint to be used when streaming with IVS using the SRT protocol.
	Endpoint *string

	// Auto-generated passphrase to enable encryption. This field is applicable only
	// if the end user has not enabled the insecureIngest option for the channel.
	Passphrase *string
	// contains filtered or unexported fields
}

Specifies information needed to stream using the SRT protocol.

type Stream 

type Stream struct {

	// Channel ARN for the stream.
	ChannelArn *string

	// The stream’s health.
	Health StreamHealth

	// URL of the master playlist, required by the video player to play the HLS stream.
	PlaybackUrl *string

	// Time of the stream’s start. This is an ISO 8601 timestamp; note that this is
	// returned as a string.
	StartTime *time.Time

	// 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.
	State StreamState

	// Unique identifier for a live or previously live stream in the specified channel.
	StreamId *string

	// 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.
	ViewerCount int64
	// contains filtered or unexported fields
}

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

type StreamEvent added in v1.10.0 

type StreamEvent struct {

	// Provides additional details about the stream event. There are several values;
	// the long descriptions are provided in the IVS console but not delivered through
	// the IVS API or EventBridge. Multitrack-related codes are used only for certain
	// Session Ended events.
	//
	//   - MultitrackInputNotAllowed — The broadcast client attempted to connect with
	//   multitrack input, but multitrack input was not enabled on the channel. Check
	//   your broadcast software settings or set MultitrackInputConfiguration.Policy to
	//   ALLOW or REQUIRE .
	//
	//   - MultitrackInputRequired — The broadcast client attempted to connect with
	//   single-track video, but multitrack input is required on this channel. Enable
	//   multitrack video in your broadcast software or configure the channel’s
	//   MultitrackInputConfiguration.Policy to ALLOW .
	//
	//   - InvalidGetClientConfigurationStreamKey — The broadcast client attempted to
	//   connect with an invalid, expired, or corrupt stream key.
	//
	//   - GetClientConfigurationStreamKeyRequired — The broadcast client attempted to
	//   stream multitrack video without providing an authenticated stream key from
	//   GetClientConfiguration.
	//
	//   - InvalidMultitrackInputTrackCount — The multitrack input stream contained an
	//   invalid number of tracks.
	//
	//   - InvalidMultitrackInputVideoTrackMediaProperties — The multitrack input
	//   stream contained one or more tracks with an invalid codec, resolution, bitrate,
	//   or framerate.
	//
	//   - StreamTakeoverMediaMismatch — The broadcast client attempted to take over
	//   with different media properties (e.g., codec, resolution, or video track type)
	//   from the original stream.
	//
	//   - StreamTakeoverInvalidPriority — The broadcast client attempted a takeover
	//   with either a priority integer value equal to or lower than the original
	//   stream's value or a value outside the allowed range of 1 to 2,147,483,647.
	//
	// StreamTakeoverLimitBreached — The broadcast client reached the maximum allowed
	//   takeover attempts for this stream.
	Code *string

	// Time when the event occurred. This is an ISO 8601 timestamp; note that this is
	// returned as a string.
	EventTime *time.Time

	// Name that identifies the stream event within a type .
	Name *string

	// Logical group for certain events.
	Type *string
	// contains filtered or unexported fields
}

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

type StreamFilters added in v1.10.0 

type StreamFilters struct {

	// The stream’s health.
	Health StreamHealth
	// contains filtered or unexported fields
}

Object specifying the stream attribute on which to filter.

type StreamHealth 

type StreamHealth string
const (
	StreamHealthStreamHealthy StreamHealth = "HEALTHY"
	StreamHealthStarving      StreamHealth = "STARVING"
	StreamHealthUnknown       StreamHealth = "UNKNOWN"
)

Enum values for StreamHealth

func (StreamHealth) Values added in v0.29.0 

func (StreamHealth) Values() []StreamHealth

Values returns all known values for StreamHealth. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamKey 

type StreamKey struct {

	// Stream-key ARN.
	Arn *string

	// Channel ARN for the stream.
	ChannelArn *string

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string

	// Stream-key value.
	Value *string
	// contains filtered or unexported fields
}

Object specifying a stream key.

type StreamKeySummary 

type StreamKeySummary struct {

	// Stream-key ARN.
	Arn *string

	// Channel ARN for the stream.
	ChannelArn *string

	// Tags attached to the resource. Array of 1-50 maps, each of the form
	// string:string (key:value) . See [Best practices and strategies] in Tagging Amazon Web Services Resources and
	// Tag Editor for details, including restrictions that apply to tags and "Tag
	// naming limits and requirements"; Amazon IVS has no service-specific constraints
	// beyond what is documented there.
	//
	// [Best practices and strategies]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a stream key.

type StreamSession added in v1.10.0 

type StreamSession struct {

	// The properties of the channel at the time of going live.
	Channel *Channel

	// 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 .
	EndTime *time.Time

	// The properties of the incoming RTMP stream.
	//
	// Note: ingestConfiguration is deprecated in favor of ingestConfigurations but
	// retained to ensure backward compatibility. If multitrack is not enabled,
	// ingestConfiguration and ingestConfigurations contain the same data, namely
	// information about track0 (the sole track). If multitrack is enabled,
	// ingestConfiguration contains data for only the first track (track0) and
	// ingestConfigurations contains data for all tracks.
	IngestConfiguration *IngestConfiguration

	// The properties of the incoming RTMP stream. If multitrack is enabled,
	// ingestConfigurations contains data for all tracks; otherwise, it contains data
	// only for track0 (the sole track).
	IngestConfigurations *IngestConfigurations

	// The properties of recording the live stream.
	RecordingConfiguration *RecordingConfiguration

	// Time when the channel went live. This is an ISO 8601 timestamp; note that this
	// is returned as a string.
	StartTime *time.Time

	// Unique identifier for a live or previously live stream in the specified channel.
	StreamId *string

	// 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].
	//
	// [Using Amazon EventBridge with Amazon IVS]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html
	TruncatedEvents []StreamEvent
	// contains filtered or unexported fields
}

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.

type StreamSessionSummary added in v1.10.0 

type StreamSessionSummary struct {

	// 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 .
	EndTime *time.Time

	// If true , this stream encountered a quota breach or failure.
	HasErrorEvent bool

	// Time when the channel went live. This is an ISO 8601 timestamp; note that this
	// is returned as a string.
	StartTime *time.Time

	// Unique identifier for a live or previously live stream in the specified channel.
	StreamId *string
	// contains filtered or unexported fields
}

Summary information about a stream session.

type StreamState 

type StreamState string
const (
	StreamStateStreamLive    StreamState = "LIVE"
	StreamStateStreamOffline StreamState = "OFFLINE"
)

Enum values for StreamState

func (StreamState) Values added in v0.29.0 

func (StreamState) Values() []StreamState

Values returns all known values for StreamState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StreamSummary 

type StreamSummary struct {

	// Channel ARN for the stream.
	ChannelArn *string

	// The stream’s health.
	Health StreamHealth

	// Time of the stream’s start. This is an ISO 8601 timestamp; note that this is
	// returned as a string.
	StartTime *time.Time

	// 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.
	State StreamState

	// Unique identifier for a live or previously live stream in the specified channel.
	StreamId *string

	// 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.
	ViewerCount int64
	// contains filtered or unexported fields
}

Summary information about a stream.

type StreamUnavailable 

type StreamUnavailable struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*StreamUnavailable) Error 

func (e *StreamUnavailable) Error() string

func (*StreamUnavailable) ErrorCode 

func (e *StreamUnavailable) ErrorCode() string

func (*StreamUnavailable) ErrorFault 

func (e *StreamUnavailable) ErrorFault() smithy.ErrorFault

func (*StreamUnavailable) ErrorMessage 

func (e *StreamUnavailable) ErrorMessage() string

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type ThumbnailConfiguration added in v1.14.0 

type ThumbnailConfiguration struct {

	// Thumbnail recording mode. Default: INTERVAL .
	RecordingMode RecordingMode

	// 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).
	//
	// [Auto-Record to Amazon S3]: https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html
	Resolution ThumbnailConfigurationResolution

	// 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 .
	Storage []ThumbnailConfigurationStorage

	// 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, or the STANDARD channel type with
	// multitrack input, 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.
	//
	// [Amazon IVS Streaming Configuration]: https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html
	TargetIntervalSeconds *int64
	// contains filtered or unexported fields
}

An object representing a configuration of thumbnails for recorded video.

type ThumbnailConfigurationResolution added in v1.24.0 

type ThumbnailConfigurationResolution string
const (
	ThumbnailConfigurationResolutionSd               ThumbnailConfigurationResolution = "SD"
	ThumbnailConfigurationResolutionHd               ThumbnailConfigurationResolution = "HD"
	ThumbnailConfigurationResolutionFullHd           ThumbnailConfigurationResolution = "FULL_HD"
	ThumbnailConfigurationResolutionLowestResolution ThumbnailConfigurationResolution = "LOWEST_RESOLUTION"
)

Enum values for ThumbnailConfigurationResolution

func (ThumbnailConfigurationResolution) Values added in v1.24.0 

func (ThumbnailConfigurationResolution) Values() []ThumbnailConfigurationResolution

Values returns all known values for ThumbnailConfigurationResolution. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThumbnailConfigurationStorage added in v1.24.0 

type ThumbnailConfigurationStorage string
const (
	ThumbnailConfigurationStorageSequential ThumbnailConfigurationStorage = "SEQUENTIAL"
	ThumbnailConfigurationStorageLatest     ThumbnailConfigurationStorage = "LATEST"
)

Enum values for ThumbnailConfigurationStorage

func (ThumbnailConfigurationStorage) Values added in v1.24.0 

func (ThumbnailConfigurationStorage) Values() []ThumbnailConfigurationStorage

Values returns all known values for ThumbnailConfigurationStorage. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TranscodePreset added in v1.22.0 

type TranscodePreset string
const (
	TranscodePresetHigherBandwidthTranscodePreset      TranscodePreset = "HIGHER_BANDWIDTH_DELIVERY"
	TranscodePresetConstrainedBandwidthTranscodePreset TranscodePreset = "CONSTRAINED_BANDWIDTH_DELIVERY"
)

Enum values for TranscodePreset

func (TranscodePreset) Values added in v1.22.0 

func (TranscodePreset) Values() []TranscodePreset

Values returns all known values for TranscodePreset. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	ExceptionMessage *string
	// contains filtered or unexported fields
}

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VideoConfiguration added in v1.10.0 

type VideoConfiguration struct {

	// 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.
	AvcLevel *string

	// Indicates to the decoder the requirements for decoding the stream. For
	// definitions of the valid values, see the H.264 specification.
	AvcProfile *string

	// Codec used for the video encoding.
	Codec *string

	// Software or hardware used to encode the video.
	Encoder *string

	// Indicates the degree of required decoder performance for a profile. Normally
	// this is set automatically by the encoder. When an AVC codec is used, this field
	// has the same value as avcLevel .
	Level *string

	// Indicates to the decoder the requirements for decoding the stream. When an AVC
	// codec is used, this field has the same value as avcProfile .
	Profile *string

	// The expected ingest bitrate (bits per second). This is configured in the
	// encoder.
	TargetBitrate int64

	// The expected ingest framerate. This is configured in the encoder.
	TargetFramerate int64

	// Name of the video track. If multitrack is not enabled, this is track0 (the sole
	// track).
	Track *string

	// Video-resolution height in pixels.
	VideoHeight int64

	// Video-resolution width in pixels.
	VideoWidth int64
	// contains filtered or unexported fields
}

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.