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
}

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
}

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

    type Channel

    type Channel struct {
    
    	// Channel ARN.
    	Arn *string
    
    	// Whether the channel is authorized.
    	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. Default: LOW.
    	LatencyMode ChannelLatencyMode
    
    	// Channel name.
    	Name *string
    
    	// Channel playback URL.
    	PlaybackUrl *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. 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.
    	//
    	// Default: STANDARD.
    	Type ChannelType
    }

      Object specifying a channel.

      type ChannelLatencyMode

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

        Enum values for ChannelLatencyMode

        func (ChannelLatencyMode) Values

          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
          }

          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 authorized.
          	Authorized bool
          
          	// Channel latency mode. Default: LOW.
          	LatencyMode ChannelLatencyMode
          
          	// Channel name.
          	Name *string
          
          	// Array of 1-50 maps, each of the form string:string (key:value).
          	Tags map[string]string
          }

            Summary information about a channel.

            type ChannelType

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

              Enum values for ChannelType

              func (ChannelType) Values

              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
                }

                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 InternalServerException

                type InternalServerException struct {
                	Message *string
                
                	ExceptionMessage *string
                }

                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
                }

                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

                type PlaybackKeyPair struct {
                
                	// Key-pair ARN.
                	Arn *string
                
                	// Key-pair identifier.
                	Fingerprint *string
                
                	// Key-pair name.
                	Name *string
                
                	// Array of 1-50 maps, each of the form string:string (key:value).
                	Tags map[string]string
                }

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

                  type PlaybackKeyPairSummary

                  type PlaybackKeyPairSummary struct {
                  
                  	// Key-pair ARN.
                  	Arn *string
                  
                  	// Key-pair name.
                  	Name *string
                  
                  	// Array of 1-50 maps, each of the form string:string (key:value)
                  	Tags map[string]string
                  }

                    Summary information about a playback key pair.

                    type ResourceNotFoundException

                    type ResourceNotFoundException struct {
                    	Message *string
                    
                    	ExceptionMessage *string
                    }

                    func (*ResourceNotFoundException) Error

                    func (e *ResourceNotFoundException) Error() string

                    func (*ResourceNotFoundException) ErrorCode

                    func (e *ResourceNotFoundException) ErrorCode() string

                    func (*ResourceNotFoundException) ErrorFault

                    func (*ResourceNotFoundException) ErrorMessage

                    func (e *ResourceNotFoundException) ErrorMessage() string

                    type ServiceQuotaExceededException

                    type ServiceQuotaExceededException struct {
                    	Message *string
                    
                    	ExceptionMessage *string
                    }

                    func (*ServiceQuotaExceededException) Error

                    func (*ServiceQuotaExceededException) ErrorCode

                    func (e *ServiceQuotaExceededException) ErrorCode() string

                    func (*ServiceQuotaExceededException) 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 video master manifest, 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.
                    	ViewerCount int64
                    }

                      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

                        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
                          }

                            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
                            }

                              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

                                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.
                                  	ViewerCount int64
                                  }

                                    Summary information about a stream.

                                    type StreamUnavailable

                                    type StreamUnavailable struct {
                                    	Message *string
                                    
                                    	ExceptionMessage *string
                                    }

                                    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
                                    }

                                    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
                                    }

                                    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