types

package
v1.20.0 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

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 AutoParticipantRecordingConfiguration added in v1.15.0 

type AutoParticipantRecordingConfiguration struct {

	// 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.
	//
	// This member is required.
	StorageConfigurationArn *string

	// Types of media to be recorded. Default: AUDIO_VIDEO .
	MediaTypes []ParticipantRecordingMediaType
	// contains filtered or unexported fields
}

Object specifying a configuration for individual participant recording.

type ChannelDestinationConfiguration added in v1.8.0 

type ChannelDestinationConfiguration struct {

	// 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).
	//
	// This member is required.
	ChannelArn *string

	// ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in
	// the same AWS account and region.
	EncoderConfigurationArn *string
	// contains filtered or unexported fields
}

Object specifying a channel as a destination.

type Composition added in v1.8.0 

type Composition struct {

	// ARN of the Composition resource.
	//
	// This member is required.
	Arn *string

	// Array of Destination objects. A Composition can contain either one destination (
	// channel or s3 ) or two (one channel and one s3 ).
	//
	// This member is required.
	Destinations []Destination

	// Layout object to configure composition parameters.
	//
	// This member is required.
	Layout *LayoutConfiguration

	// ARN of the stage used as input
	//
	// This member is required.
	StageArn *string

	// State of the Composition.
	//
	// This member is required.
	State CompositionState

	// UTC time of the Composition end. This is an ISO 8601 timestamp; note that this
	// is returned as a string.
	EndTime *time.Time

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

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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
}

Object specifying a Composition resource.

type CompositionState added in v1.8.0 

type CompositionState string
const (
	CompositionStateStarting CompositionState = "STARTING"
	CompositionStateActive   CompositionState = "ACTIVE"
	CompositionStateStopping CompositionState = "STOPPING"
	CompositionStateFailed   CompositionState = "FAILED"
	CompositionStateStopped  CompositionState = "STOPPED"
)

Enum values for CompositionState

func (CompositionState) Values added in v1.8.0 

func (CompositionState) Values() []CompositionState

Values returns all known values for CompositionState. 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 CompositionSummary added in v1.8.0 

type CompositionSummary struct {

	// ARN of the Composition resource.
	//
	// This member is required.
	Arn *string

	// Array of Destination objects.
	//
	// This member is required.
	Destinations []DestinationSummary

	// ARN of the attached stage.
	//
	// This member is required.
	StageArn *string

	// State of the Composition resource.
	//
	// This member is required.
	State CompositionState

	// UTC time of the Composition end. This is an ISO 8601 timestamp; note that this
	// is returned as a string.
	EndTime *time.Time

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

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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 Composition.

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 Destination added in v1.8.0 

type Destination struct {

	// Configuration used to create this destination.
	//
	// This member is required.
	Configuration *DestinationConfiguration

	// Unique identifier for this destination, assigned by IVS.
	//
	// This member is required.
	Id *string

	// State of the Composition Destination.
	//
	// This member is required.
	State DestinationState

	// Optional details regarding the status of the destination.
	Detail *DestinationDetail

	// UTC time of the destination end. This is an ISO 8601 timestamp; note that this
	// is returned as a string.
	EndTime *time.Time

	// UTC time of the destination start. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Object specifying the status of a Destination.

type DestinationConfiguration added in v1.8.0 

type DestinationConfiguration struct {

	// An IVS channel to be used for broadcasting, for server-side composition. Either
	// a channel or an s3 must be specified.
	Channel *ChannelDestinationConfiguration

	// Name that can be specified to help identify the destination.
	Name *string

	// An S3 storage configuration to be used for recording video data. Either a
	// channel or an s3 must be specified.
	S3 *S3DestinationConfiguration
	// contains filtered or unexported fields
}

Complex data type that defines destination-configuration objects.

type DestinationDetail added in v1.8.0 

type DestinationDetail struct {

	// An S3 detail object to return information about the S3 destination.
	S3 *S3Detail
	// contains filtered or unexported fields
}

Complex data type that defines destination-detail objects.

type DestinationState added in v1.8.0 

type DestinationState string
const (
	DestinationStateStarting     DestinationState = "STARTING"
	DestinationStateActive       DestinationState = "ACTIVE"
	DestinationStateStopping     DestinationState = "STOPPING"
	DestinationStateReconnecting DestinationState = "RECONNECTING"
	DestinationStateFailed       DestinationState = "FAILED"
	DestinationStateStopped      DestinationState = "STOPPED"
)

Enum values for DestinationState

func (DestinationState) Values added in v1.8.0 

func (DestinationState) Values() []DestinationState

Values returns all known values for DestinationState. 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 DestinationSummary added in v1.8.0 

type DestinationSummary struct {

	// Unique identifier for this destination, assigned by IVS.
	//
	// This member is required.
	Id *string

	// State of the Composition Destination.
	//
	// This member is required.
	State DestinationState

	// UTC time of the destination end. This is an ISO 8601 timestamp; note that this
	// is returned as a string.
	EndTime *time.Time

	// UTC time of the destination start. This is an ISO 8601 timestamp; note that
	// this is returned as a string.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Summary information about a Destination.

type EncoderConfiguration added in v1.8.0 

type EncoderConfiguration struct {

	// ARN of the EncoderConfiguration resource.
	//
	// This member is required.
	Arn *string

	// Optional name to identify the resource.
	Name *string

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

	// Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
	// fps
	Video *Video
	// contains filtered or unexported fields
}

Settings for transcoding.

type EncoderConfigurationSummary added in v1.8.0 

type EncoderConfigurationSummary struct {

	// ARN of the EncoderConfiguration resource.
	//
	// This member is required.
	Arn *string

	// Optional name to identify the resource.
	Name *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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 an EncoderConfiguration.

type Event added in v1.2.0 

type Event struct {

	// If the event is an error event, the error code is provided to give insight into
	// the specific error that occurred. If the event is not an error event, this field
	// is null.
	//
	//   - B_FRAME_PRESENT — The participant's stream includes B-frames. For details,
	//   see [IVS RTMP Publishing].
	//
	//   - BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate.
	//   For details, see [Service Quotas].
	//
	//   - INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the
	//   participant’s token is not allowed to do. For details on participant
	//   capabilities, see the capabilities field in CreateParticipantToken.
	//
	//   - INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage
	//   due to an internal server error.
	//
	//   - INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For
	//   details, see [Stream Ingest].
	//
	//   - INVALID_INPUT — The participant is using an invalid input stream.
	//
	//   - INVALID_PROTOCOL — The participant's IngestConfiguration resource is
	//   configured for RTMPS but they tried streaming with RTMP. For details, see [IVS RTMP Publishing].
	//
	//   - INVALID_STREAM_KEY — The participant is using an invalid stream key. For
	//   details, see [IVS RTMP Publishing].
	//
	//   - INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For
	//   details, see [Stream Ingest].
	//
	//   - PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that
	//   doesn’t exist.
	//
	//   - QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to
	//   a stage exceeds the quota. For details, see [Service Quotas].
	//
	//   - RESOLUTION_EXCEEDED — The participant exceeded the maximum supported
	//   resolution. For details, see [Service Quotas].
	//
	//   - REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is
	//   associated with another active stage session.
	//
	//   - STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed
	//   stream duration. For details, see [Service Quotas].
	//
	// [Stream Ingest]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html
	// [Service Quotas]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html
	// [IVS RTMP Publishing]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html
	ErrorCode EventErrorCode

	// ISO 8601 timestamp (returned as a string) for when the event occurred.
	EventTime *time.Time

	// The name of the event.
	Name EventName

	// Unique identifier for the participant who triggered the event. This is assigned
	// by IVS.
	ParticipantId *string

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

An occurrence during a stage session.

type EventErrorCode added in v1.2.0 

type EventErrorCode string
const (
	EventErrorCodeInsufficientCapabilities EventErrorCode = "INSUFFICIENT_CAPABILITIES"
	EventErrorCodeQuotaExceeded            EventErrorCode = "QUOTA_EXCEEDED"
	EventErrorCodePublisherNotFound        EventErrorCode = "PUBLISHER_NOT_FOUND"
	EventErrorCodeBitrateExceeded          EventErrorCode = "BITRATE_EXCEEDED"
	EventErrorCodeResolutionExceeded       EventErrorCode = "RESOLUTION_EXCEEDED"
	EventErrorCodeStreamDurationExceeded   EventErrorCode = "STREAM_DURATION_EXCEEDED"
	EventErrorCodeInvalidAudioCodec        EventErrorCode = "INVALID_AUDIO_CODEC"
	EventErrorCodeInvalidVideoCodec        EventErrorCode = "INVALID_VIDEO_CODEC"
	EventErrorCodeInvalidProtocol          EventErrorCode = "INVALID_PROTOCOL"
	EventErrorCodeInvalidStreamKey         EventErrorCode = "INVALID_STREAM_KEY"
	EventErrorCodeReuseOfStreamKey         EventErrorCode = "REUSE_OF_STREAM_KEY"
	EventErrorCodeBFramePresent            EventErrorCode = "B_FRAME_PRESENT"
	EventErrorCodeInvalidInput             EventErrorCode = "INVALID_INPUT"
	EventErrorCodeInternalServerException  EventErrorCode = "INTERNAL_SERVER_EXCEPTION"
)

Enum values for EventErrorCode

func (EventErrorCode) Values added in v1.2.0 

func (EventErrorCode) Values() []EventErrorCode

Values returns all known values for EventErrorCode. 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 EventName added in v1.2.0 

type EventName string
const (
	EventNameJoined           EventName = "JOINED"
	EventNameLeft             EventName = "LEFT"
	EventNamePublishStarted   EventName = "PUBLISH_STARTED"
	EventNamePublishStopped   EventName = "PUBLISH_STOPPED"
	EventNameSubscribeStarted EventName = "SUBSCRIBE_STARTED"
	EventNameSubscribeStopped EventName = "SUBSCRIBE_STOPPED"
	EventNamePublishError     EventName = "PUBLISH_ERROR"
	EventNameSubscribeError   EventName = "SUBSCRIBE_ERROR"
	EventNameJoinError        EventName = "JOIN_ERROR"
)

Enum values for EventName

func (EventName) Values added in v1.2.0 

func (EventName) Values() []EventName

Values returns all known values for EventName. 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 GridConfiguration added in v1.8.0 

type GridConfiguration struct {

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

	// Specifies the spacing between participant tiles in pixels. Default: 2 .
	GridGap int32

	// Determines whether to omit participants with stopped video in the composition.
	// Default: false .
	OmitStoppedVideo bool

	// 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 .
	VideoAspectRatio VideoAspectRatio

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

Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition.

type IngestConfiguration added in v1.17.0 

type IngestConfiguration struct {

	// Ingest configuration ARN.
	//
	// This member is required.
	Arn *string

	// Type of ingest protocol that the user employs for broadcasting.
	//
	// This member is required.
	IngestProtocol IngestProtocol

	// ID of the participant within the stage.
	//
	// This member is required.
	ParticipantId *string

	// ARN of the stage with which the IngestConfiguration is associated.
	//
	// This member is required.
	StageArn *string

	// State of the ingest configuration. It is ACTIVE if a publisher currently is
	// publishing to the stage associated with the ingest configuration.
	//
	// This member is required.
	State IngestConfigurationState

	// Ingest-key value for the RTMP(S) protocol.
	//
	// This member is required.
	StreamKey *string

	// Application-provided attributes to to store in the IngestConfiguration and
	// attach to a stage. Map keys and values can contain UTF-8 encoded text. The
	// maximum length of this field is 1 KB total. This field is exposed to all stage
	// participants and should not be used for personally identifying, confidential, or
	// sensitive information.
	Attributes map[string]string

	// Ingest name
	Name *string

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

	// Customer-assigned name to help identify the participant using the
	// IngestConfiguration; this can be used to link a participant to a user in the
	// customer’s own systems. This can be any UTF-8 encoded text. This field is
	// exposed to all stage participants and should not be used for personally
	// identifying, confidential, or sensitive information.
	UserId *string
	// contains filtered or unexported fields
}

Object specifying an ingest configuration.

type IngestConfigurationState added in v1.17.0 

type IngestConfigurationState string
const (
	IngestConfigurationStateActive   IngestConfigurationState = "ACTIVE"
	IngestConfigurationStateInactive IngestConfigurationState = "INACTIVE"
)

Enum values for IngestConfigurationState

func (IngestConfigurationState) Values added in v1.17.0 

func (IngestConfigurationState) Values() []IngestConfigurationState

Values returns all known values for IngestConfigurationState. 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 IngestConfigurationSummary added in v1.17.0 

type IngestConfigurationSummary struct {

	// Ingest configuration ARN.
	//
	// This member is required.
	Arn *string

	// Type of ingest protocol that the user employs for broadcasting.
	//
	// This member is required.
	IngestProtocol IngestProtocol

	// ID of the participant within the stage.
	//
	// This member is required.
	ParticipantId *string

	// ARN of the stage with which the IngestConfiguration is associated.
	//
	// This member is required.
	StageArn *string

	// State of the ingest configuration. It is ACTIVE if a publisher currently is
	// publishing to the stage associated with the ingest configuration.
	//
	// This member is required.
	State IngestConfigurationState

	// Ingest name.
	Name *string

	// Customer-assigned name to help identify the participant using the
	// IngestConfiguration; this can be used to link a participant to a user in the
	// customer’s own systems. This can be any UTF-8 encoded text. This field is
	// exposed to all stage participants and should not be used for personally
	// identifying, confidential, or sensitive information.
	UserId *string
	// contains filtered or unexported fields
}

Summary information about an IngestConfiguration.

type IngestProtocol added in v1.17.0 

type IngestProtocol string
const (
	IngestProtocolRtmp  IngestProtocol = "RTMP"
	IngestProtocolRtmps IngestProtocol = "RTMPS"
)

Enum values for IngestProtocol

func (IngestProtocol) Values added in v1.17.0 

func (IngestProtocol) Values() []IngestProtocol

Values returns all known values for IngestProtocol. 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 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 LayoutConfiguration added in v1.8.0 

type LayoutConfiguration struct {

	// Configuration related to grid layout. Default: Grid layout.
	Grid *GridConfiguration

	// Configuration related to PiP layout.
	Pip *PipConfiguration
	// contains filtered or unexported fields
}

Configuration information of supported layouts for server-side composition.

type Participant added in v1.2.0 

type Participant struct {

	// 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.
	Attributes map[string]string

	// The participant’s browser.
	BrowserName *string

	// The participant’s browser version.
	BrowserVersion *string

	// ISO 8601 timestamp (returned as a string) when the participant first joined the
	// stage session.
	FirstJoinTime *time.Time

	// The participant’s Internet Service Provider.
	IspName *string

	// The participant’s operating system.
	OsName *string

	// The participant’s operating system version.
	OsVersion *string

	// Unique identifier for this participant, assigned by IVS.
	ParticipantId *string

	// Type of ingest protocol that the participant employs for broadcasting.
	Protocol ParticipantProtocol

	// Whether the participant ever published to the stage session.
	Published bool

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

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

	// The participant’s recording state.
	RecordingState ParticipantRecordingState

	// The participant’s SDK version.
	SdkVersion *string

	// Whether the participant is connected to or disconnected from the stage.
	State ParticipantState

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

Object describing a participant that has joined a stage.

type ParticipantProtocol added in v1.17.0 

type ParticipantProtocol string
const (
	ParticipantProtocolUnknown ParticipantProtocol = "UNKNOWN"
	ParticipantProtocolWhip    ParticipantProtocol = "WHIP"
	ParticipantProtocolRtmp    ParticipantProtocol = "RTMP"
	ParticipantProtocolRtmps   ParticipantProtocol = "RTMPS"
)

Enum values for ParticipantProtocol

func (ParticipantProtocol) Values added in v1.17.0 

func (ParticipantProtocol) Values() []ParticipantProtocol

Values returns all known values for ParticipantProtocol. 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 ParticipantRecordingFilterByRecordingState added in v1.15.0 

type ParticipantRecordingFilterByRecordingState string
const (
	ParticipantRecordingFilterByRecordingStateStarting ParticipantRecordingFilterByRecordingState = "STARTING"
	ParticipantRecordingFilterByRecordingStateActive   ParticipantRecordingFilterByRecordingState = "ACTIVE"
	ParticipantRecordingFilterByRecordingStateStopping ParticipantRecordingFilterByRecordingState = "STOPPING"
	ParticipantRecordingFilterByRecordingStateStopped  ParticipantRecordingFilterByRecordingState = "STOPPED"
	ParticipantRecordingFilterByRecordingStateFailed   ParticipantRecordingFilterByRecordingState = "FAILED"
)

Enum values for ParticipantRecordingFilterByRecordingState

func (ParticipantRecordingFilterByRecordingState) Values added in v1.15.0 

func (ParticipantRecordingFilterByRecordingState) Values() []ParticipantRecordingFilterByRecordingState

Values returns all known values for ParticipantRecordingFilterByRecordingState. 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 ParticipantRecordingMediaType added in v1.15.0 

type ParticipantRecordingMediaType string
const (
	ParticipantRecordingMediaTypeAudioVideo ParticipantRecordingMediaType = "AUDIO_VIDEO"
	ParticipantRecordingMediaTypeAudioOnly  ParticipantRecordingMediaType = "AUDIO_ONLY"
)

Enum values for ParticipantRecordingMediaType

func (ParticipantRecordingMediaType) Values added in v1.15.0 

func (ParticipantRecordingMediaType) Values() []ParticipantRecordingMediaType

Values returns all known values for ParticipantRecordingMediaType. 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 ParticipantRecordingState added in v1.15.0 

type ParticipantRecordingState string
const (
	ParticipantRecordingStateStarting ParticipantRecordingState = "STARTING"
	ParticipantRecordingStateActive   ParticipantRecordingState = "ACTIVE"
	ParticipantRecordingStateStopping ParticipantRecordingState = "STOPPING"
	ParticipantRecordingStateStopped  ParticipantRecordingState = "STOPPED"
	ParticipantRecordingStateFailed   ParticipantRecordingState = "FAILED"
	ParticipantRecordingStateDisabled ParticipantRecordingState = "DISABLED"
)

Enum values for ParticipantRecordingState

func (ParticipantRecordingState) Values added in v1.15.0 

func (ParticipantRecordingState) Values() []ParticipantRecordingState

Values returns all known values for ParticipantRecordingState. 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 ParticipantState added in v1.2.0 

type ParticipantState string
const (
	ParticipantStateConnected    ParticipantState = "CONNECTED"
	ParticipantStateDisconnected ParticipantState = "DISCONNECTED"
)

Enum values for ParticipantState

func (ParticipantState) Values added in v1.2.0 

func (ParticipantState) Values() []ParticipantState

Values returns all known values for ParticipantState. 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 ParticipantSummary added in v1.2.0 

type ParticipantSummary struct {

	// ISO 8601 timestamp (returned as a string) when the participant first joined the
	// stage session.
	FirstJoinTime *time.Time

	// Unique identifier for this participant, assigned by IVS.
	ParticipantId *string

	// Whether the participant ever published to the stage session.
	Published bool

	// The participant’s recording state.
	RecordingState ParticipantRecordingState

	// Whether the participant is connected to or disconnected from the stage.
	State ParticipantState

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

Summary object describing a participant that has joined a stage.

type ParticipantToken 

type ParticipantToken struct {

	// 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.
	Attributes map[string]string

	// Set of capabilities that the user is allowed to perform in the stage.
	Capabilities []ParticipantTokenCapability

	// Duration (in minutes), after which the participant token expires. Default: 720
	// (12 hours).
	Duration *int32

	// ISO 8601 timestamp (returned as a string) for when this token expires.
	ExpirationTime *time.Time

	// Unique identifier for this participant token, assigned by IVS.
	ParticipantId *string

	// The issued client token, encrypted.
	Token *string

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

Object specifying a participant token in a stage.

Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.

type ParticipantTokenCapability 

type ParticipantTokenCapability string
const (
	ParticipantTokenCapabilityPublish   ParticipantTokenCapability = "PUBLISH"
	ParticipantTokenCapabilitySubscribe ParticipantTokenCapability = "SUBSCRIBE"
)

Enum values for ParticipantTokenCapability

func (ParticipantTokenCapability) Values 

func (ParticipantTokenCapability) Values() []ParticipantTokenCapability

Values returns all known values for ParticipantTokenCapability. 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 ParticipantTokenConfiguration 

type ParticipantTokenConfiguration struct {

	// 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.
	Attributes map[string]string

	// Set of capabilities that the user is allowed to perform in the stage.
	Capabilities []ParticipantTokenCapability

	// Duration (in minutes), after which the corresponding participant token expires.
	// Default: 720 (12 hours).
	Duration *int32

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

Object specifying a participant token configuration in a stage.

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 PipBehavior added in v1.12.0 

type PipBehavior string
const (
	PipBehaviorStatic  PipBehavior = "STATIC"
	PipBehaviorDynamic PipBehavior = "DYNAMIC"
)

Enum values for PipBehavior

func (PipBehavior) Values added in v1.12.0 

func (PipBehavior) Values() []PipBehavior

Values returns all known values for PipBehavior. 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 PipConfiguration added in v1.12.0 

type PipConfiguration struct {

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

	// Specifies the spacing between participant tiles in pixels. Default: 0 .
	GridGap int32

	// Determines whether to omit participants with stopped video in the composition.
	// Default: false .
	OmitStoppedVideo bool

	// Defines PiP behavior when all participants have left: STATIC (maintains
	// original position/size) or DYNAMIC (expands to full composition). Default:
	// STATIC .
	PipBehavior PipBehavior

	// 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.
	PipHeight *int32

	// Sets the PiP window’s offset position in pixels from the closest edges
	// determined by PipPosition . Default: 0 .
	PipOffset int32

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

	// Determines the corner position of the PiP window. Default: BOTTOM_RIGHT .
	PipPosition PipPosition

	// 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.
	PipWidth *int32

	// Defines how video content fits within the participant tile: FILL (stretched),
	// COVER (cropped), or CONTAIN (letterboxed). Default: COVER .
	VideoFillMode VideoFillMode
	// contains filtered or unexported fields
}

Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.

type PipPosition added in v1.12.0 

type PipPosition string
const (
	PipPositionTopLeft     PipPosition = "TOP_LEFT"
	PipPositionTopRight    PipPosition = "TOP_RIGHT"
	PipPositionBottomLeft  PipPosition = "BOTTOM_LEFT"
	PipPositionBottomRight PipPosition = "BOTTOM_RIGHT"
)

Enum values for PipPosition

func (PipPosition) Values added in v1.12.0 

func (PipPosition) Values() []PipPosition

Values returns all known values for PipPosition. 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 PublicKey added in v1.16.0 

type PublicKey struct {

	// Public key ARN.
	Arn *string

	// The public key fingerprint, a short string used to identify or verify the full
	// public key.
	Fingerprint *string

	// Public key name.
	Name *string

	// Public key material.
	PublicKeyMaterial *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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
}

Object specifying a public key used to sign stage participant tokens.

type PublicKeySummary added in v1.16.0 

type PublicKeySummary struct {

	// Public key ARN.
	Arn *string

	// Public key name.
	Name *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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 public key.

type RecordingConfiguration added in v1.8.0 

type RecordingConfiguration struct {

	// The recording format for storing a recording in Amazon S3.
	Format RecordingConfigurationFormat
	// contains filtered or unexported fields
}

An object representing a configuration to record a stage stream.

type RecordingConfigurationFormat added in v1.8.0 

type RecordingConfigurationFormat string
const (
	RecordingConfigurationFormatHls RecordingConfigurationFormat = "HLS"
)

Enum values for RecordingConfigurationFormat

func (RecordingConfigurationFormat) Values added in v1.8.0 

func (RecordingConfigurationFormat) Values() []RecordingConfigurationFormat

Values returns all known values for RecordingConfigurationFormat. 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.8.0 

type S3DestinationConfiguration struct {

	// ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in
	// the same AWS account and region.
	//
	// This member is required.
	EncoderConfigurationArns []string

	// ARN of the StorageConfiguration where recorded videos will be stored.
	//
	// This member is required.
	StorageConfigurationArn *string

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

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

type S3Detail added in v1.8.0 

type S3Detail struct {

	// The S3 bucket prefix under which the recording is stored.
	//
	// This member is required.
	RecordingPrefix *string
	// contains filtered or unexported fields
}

Complex data type that defines S3Detail objects.

type S3StorageConfiguration added in v1.8.0 

type S3StorageConfiguration struct {

	// 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.
	//
	// 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 Stage 

type Stage struct {

	// Stage ARN.
	//
	// This member is required.
	Arn *string

	// ID of the active session within the stage.
	ActiveSessionId *string

	// Configuration object for individual participant recording, attached to the
	// stage.
	AutoParticipantRecordingConfiguration *AutoParticipantRecordingConfiguration

	// Summary information about various endpoints for a stage.
	Endpoints *StageEndpoints

	// Stage name.
	Name *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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
}

Object specifying a stage.

type StageEndpoints added in v1.16.0 

type StageEndpoints struct {

	// Events endpoint.
	Events *string

	// The endpoint to be used for IVS real-time streaming using the RTMP protocol.
	Rtmp *string

	// The endpoint to be used for IVS real-time streaming using the RTMPS protocol.
	Rtmps *string

	// The endpoint to be used for IVS real-time streaming using the WHIP protocol.
	Whip *string
	// contains filtered or unexported fields
}

Summary information about various endpoints for a stage. We recommend that you cache these values at stage creation; the values can be cached for up to 14 days.

type StageSession added in v1.2.0 

type StageSession struct {

	// ISO 8601 timestamp (returned as a string) when the stage session ended. This is
	// null if the stage is active.
	EndTime *time.Time

	// ID of the session within the stage.
	SessionId *string

	//  ISO 8601 timestamp (returned as a string) when this stage session began.
	StartTime *time.Time
	// contains filtered or unexported fields
}

A stage session begins when the first participant joins a stage and ends after the last participant leaves the stage. A stage session helps with debugging stages by grouping events and participants into shorter periods of time (i.e., a session), which is helpful when stages are used over long periods of time.

type StageSessionSummary added in v1.2.0 

type StageSessionSummary struct {

	// ISO 8601 timestamp (returned as a string) when the stage session ended. This is
	// null if the stage is active.
	EndTime *time.Time

	// ID of the session within the stage.
	SessionId *string

	//  ISO 8601 timestamp (returned as a string) when this stage session began.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Summary information about a stage session.

type StageSummary 

type StageSummary struct {

	// Stage ARN.
	//
	// This member is required.
	Arn *string

	// ID of the active session within the stage.
	ActiveSessionId *string

	// Stage name.
	Name *string

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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 stage.

type StorageConfiguration added in v1.8.0 

type StorageConfiguration struct {

	// ARN of the storage configuration.
	//
	// This member is required.
	Arn *string

	// Name of the storage configuration.
	Name *string

	// An S3 destination configuration where recorded videos will be stored.
	S3 *S3StorageConfiguration

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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 complex type that describes a location where recorded videos will be stored.

type StorageConfigurationSummary added in v1.8.0 

type StorageConfigurationSummary struct {

	// ARN of the storage configuration.
	//
	// This member is required.
	Arn *string

	// Name of the storage configuration.
	Name *string

	// An S3 destination configuration where recorded videos will be stored.
	S3 *S3StorageConfiguration

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) . See [Best practices and strategies] in Tagging AWS Resources and Tag Editor for details,
	// including restrictions that apply to tags and "Tag naming limits and
	// requirements"; Amazon IVS has no constraints on tags beyond what is documented
	// there.
	//
	// [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 storage configuration.

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 Video added in v1.8.0 

type Video struct {

	// Bitrate for generated output, in bps. Default: 2500000.
	Bitrate *int32

	// Video frame rate, in fps. Default: 30.
	Framerate *float32

	// Video-resolution height. This must be an even number. Note that the maximum
	// value is determined by width times height , such that the maximum total pixels
	// is 2073600 (1920x1080 or 1080x1920). Default: 720.
	Height *int32

	// Video-resolution width. This must be an even number. Note that the maximum
	// value is determined by width times height , such that the maximum total pixels
	// is 2073600 (1920x1080 or 1080x1920). Default: 1280.
	Width *int32
	// contains filtered or unexported fields
}

Settings for video.

type VideoAspectRatio added in v1.12.0 

type VideoAspectRatio string
const (
	VideoAspectRatioAuto     VideoAspectRatio = "AUTO"
	VideoAspectRatioVideo    VideoAspectRatio = "VIDEO"
	VideoAspectRatioSquare   VideoAspectRatio = "SQUARE"
	VideoAspectRatioPortrait VideoAspectRatio = "PORTRAIT"
)

Enum values for VideoAspectRatio

func (VideoAspectRatio) Values added in v1.12.0 

func (VideoAspectRatio) Values() []VideoAspectRatio

Values returns all known values for VideoAspectRatio. 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 VideoFillMode added in v1.12.0 

type VideoFillMode string
const (
	VideoFillModeFill    VideoFillMode = "FILL"
	VideoFillModeCover   VideoFillMode = "COVER"
	VideoFillModeContain VideoFillMode = "CONTAIN"
)

Enum values for VideoFillMode

func (VideoFillMode) Values added in v1.12.0 

func (VideoFillMode) Values() []VideoFillMode

Values returns all known values for VideoFillMode. 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.

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.