types

package
v1.5.2 Latest Latest
Warning

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

 Go to latest Published: Aug 4, 2021 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

	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 BatchError 

type BatchError struct {

	// Channel ARN.
	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 Channel 

type Channel struct {

	// Channel ARN.
	Arn *string

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

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

	// 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. (Note: In
	// the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,
	// respectively.)
	LatencyMode ChannelLatencyMode

	// Channel name.
	Name *string

	// Channel playback URL.
	PlaybackUrl *string

	// Recording-configuration ARN. A value other than an empty string indicates that
	// recording is enabled. Default: "" (empty string, recording is disabled).
	RecordingConfigurationArn *string

	// Array of 1-50 maps, each of the form string:string (key:value).
	Tags map[string]string

	// Channel type, which determines the allowable resolution and bitrate. If you
	// exceed the allowable resolution or bitrate, the stream probably will disconnect
	// immediately. Default: STANDARD. Valid values:
	//
	// * STANDARD: Multiple qualities
	// are generated from the original input, to automatically give viewers the best
	// experience for their devices and network conditions. Vertical resolution can be
	// up to 1080 and bitrate can be up to 8.5 Mbps.
	//
	// * BASIC: Amazon IVS delivers the
	// original input to viewers. The viewer’s video-quality choice is limited to the
	// original input. Vertical resolution can be up to 480 and bitrate can be up to
	// 1.5 Mbps.
	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

	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

	// 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. (Note: In
	// the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,
	// respectively.)
	LatencyMode ChannelLatencyMode

	// Channel name.
	Name *string

	// Recording-configuration ARN. A value other than an empty string indicates that
	// recording is enabled. Default: "" (empty string, recording is disabled).
	RecordingConfigurationArn *string

	// Array of 1-50 maps, each of the form string:string (key:value).
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a channel.

type ChannelType 

type ChannelType string
const (
	ChannelTypeBasicChannelType    ChannelType = "BASIC"
	ChannelTypeStandardChannelType ChannelType = "STANDARD"
)

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

	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 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 InternalServerException 

type InternalServerException struct {
	Message *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 PendingVerification 

type PendingVerification struct {
	Message *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

	// An arbitrary string (a nickname) assigned to a playback key pair that helps the
	// customer identify that resource. The value does not need to be unique.
	Name *string

	// Array of 1-50 maps, each of the form string:string (key:value).
	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

	// An arbitrary string (a nickname) assigned to a playback key pair that helps the
	// customer identify that resource. The value does not need to be unique.
	Name *string

	// Array of 1-50 maps, each of the form string:string (key:value).
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a playback key pair.

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

	// An arbitrary string (a nickname) assigned to a recording configuration that
	// helps the customer identify that resource. The value does not need to be unique.
	Name *string

	// Array of 1-50 maps, each of the form string:string (key:value).
	Tags map[string]string
	// 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

	// An arbitrary string (a nickname) assigned to a recording configuration that
	// helps the customer identify that resource. The value does not need to be unique.
	Name *string

	// Array of 1-50 maps, each of the form string:string (key:value).
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a RecordingConfiguration.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *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

	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 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

	// ISO-8601 formatted timestamp of the stream’s start.
	StartTime *time.Time

	// The stream’s state.
	State StreamState

	// Number of current viewers of the stream. 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 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

	// Array of 1-50 maps, each of the form string:string (key:value).
	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

	// Array of 1-50 maps, each of the form string:string (key:value).
	Tags map[string]string
	// contains filtered or unexported fields
}

Summary information about a stream key.

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

	// ISO-8601 formatted timestamp of the stream’s start.
	StartTime *time.Time

	// The stream’s state.
	State StreamState

	// Number of current viewers of the stream. 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

	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

	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 ValidationException 

type ValidationException struct {
	Message *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

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.