types

package
v1.2.1 Latest Latest
Warning

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

Go to latest
Published: May 20, 2021 License: Apache-2.0 Imports: 3 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIName

type APIName string
const (
	APINamePutMedia                   APIName = "PUT_MEDIA"
	APINameGetMedia                   APIName = "GET_MEDIA"
	APINameListFragments              APIName = "LIST_FRAGMENTS"
	APINameGetMediaForFragmentList    APIName = "GET_MEDIA_FOR_FRAGMENT_LIST"
	APINameGetHlsStreamingSessionUrl  APIName = "GET_HLS_STREAMING_SESSION_URL"
	APINameGetDashStreamingSessionUrl APIName = "GET_DASH_STREAMING_SESSION_URL"
	APINameGetClip                    APIName = "GET_CLIP"
)

Enum values for APIName

func (APIName) Values added in v0.29.0

func (APIName) Values() []APIName

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

type AccessDeniedException struct {
	Message *string
}

You do not have required permissions to perform this operation.

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 AccountChannelLimitExceededException

type AccountChannelLimitExceededException struct {
	Message *string
}

You have reached the maximum limit of active signaling channels for this AWS account in this region.

func (*AccountChannelLimitExceededException) Error

func (*AccountChannelLimitExceededException) ErrorCode

func (*AccountChannelLimitExceededException) ErrorFault

func (*AccountChannelLimitExceededException) ErrorMessage

func (e *AccountChannelLimitExceededException) ErrorMessage() string

type AccountStreamLimitExceededException

type AccountStreamLimitExceededException struct {
	Message *string
}

The number of streams created for the account is too high.

func (*AccountStreamLimitExceededException) Error

func (*AccountStreamLimitExceededException) ErrorCode

func (*AccountStreamLimitExceededException) ErrorFault

func (*AccountStreamLimitExceededException) ErrorMessage

func (e *AccountStreamLimitExceededException) ErrorMessage() string

type ChannelInfo

type ChannelInfo struct {

	// The Amazon Resource Name (ARN) of the signaling channel.
	ChannelARN *string

	// The name of the signaling channel.
	ChannelName *string

	// Current status of the signaling channel.
	ChannelStatus Status

	// The type of the signaling channel.
	ChannelType ChannelType

	// The time at which the signaling channel was created.
	CreationTime *time.Time

	// A structure that contains the configuration for the SINGLE_MASTER channel type.
	SingleMasterConfiguration *SingleMasterConfiguration

	// The current version of the signaling channel.
	Version *string
}

A structure that encapsulates a signaling channel's metadata and properties.

type ChannelNameCondition

type ChannelNameCondition struct {

	// A comparison operator. Currently, you can only specify the BEGINS_WITH operator,
	// which finds signaling channels whose names begin with a given prefix.
	ComparisonOperator ComparisonOperator

	// A value to compare.
	ComparisonValue *string
}

An optional input parameter for the ListSignalingChannels API. When this parameter is specified while invoking ListSignalingChannels, the API returns only the channels that satisfy a condition specified in ChannelNameCondition.

type ChannelProtocol

type ChannelProtocol string
const (
	ChannelProtocolWss   ChannelProtocol = "WSS"
	ChannelProtocolHttps ChannelProtocol = "HTTPS"
)

Enum values for ChannelProtocol

func (ChannelProtocol) Values added in v0.29.0

func (ChannelProtocol) Values() []ChannelProtocol

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

type ChannelRole string
const (
	ChannelRoleMaster ChannelRole = "MASTER"
	ChannelRoleViewer ChannelRole = "VIEWER"
)

Enum values for ChannelRole

func (ChannelRole) Values added in v0.29.0

func (ChannelRole) Values() []ChannelRole

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

type ChannelType string
const (
	ChannelTypeSingleMaster ChannelType = "SINGLE_MASTER"
)

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 ClientLimitExceededException

type ClientLimitExceededException struct {
	Message *string
}

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

func (*ClientLimitExceededException) Error

func (*ClientLimitExceededException) ErrorCode

func (e *ClientLimitExceededException) ErrorCode() string

func (*ClientLimitExceededException) ErrorFault

func (*ClientLimitExceededException) ErrorMessage

func (e *ClientLimitExceededException) ErrorMessage() string

type ComparisonOperator

type ComparisonOperator string
const (
	ComparisonOperatorBeginsWith ComparisonOperator = "BEGINS_WITH"
)

Enum values for ComparisonOperator

func (ComparisonOperator) Values added in v0.29.0

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

type DeviceStreamLimitExceededException struct {
	Message *string
}

Not implemented.

func (*DeviceStreamLimitExceededException) Error

func (*DeviceStreamLimitExceededException) ErrorCode

func (*DeviceStreamLimitExceededException) ErrorFault

func (*DeviceStreamLimitExceededException) ErrorMessage

func (e *DeviceStreamLimitExceededException) ErrorMessage() string

type InvalidArgumentException

type InvalidArgumentException struct {
	Message *string
}

The value for this input parameter is invalid.

func (*InvalidArgumentException) Error

func (e *InvalidArgumentException) Error() string

func (*InvalidArgumentException) ErrorCode

func (e *InvalidArgumentException) ErrorCode() string

func (*InvalidArgumentException) ErrorFault

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

func (*InvalidArgumentException) ErrorMessage

func (e *InvalidArgumentException) ErrorMessage() string

type InvalidDeviceException

type InvalidDeviceException struct {
	Message *string
}

Not implemented.

func (*InvalidDeviceException) Error

func (e *InvalidDeviceException) Error() string

func (*InvalidDeviceException) ErrorCode

func (e *InvalidDeviceException) ErrorCode() string

func (*InvalidDeviceException) ErrorFault

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

func (*InvalidDeviceException) ErrorMessage

func (e *InvalidDeviceException) ErrorMessage() string

type InvalidResourceFormatException

type InvalidResourceFormatException struct {
	Message *string
}

The format of the StreamARN is invalid.

func (*InvalidResourceFormatException) Error

func (*InvalidResourceFormatException) ErrorCode

func (e *InvalidResourceFormatException) ErrorCode() string

func (*InvalidResourceFormatException) ErrorFault

func (*InvalidResourceFormatException) ErrorMessage

func (e *InvalidResourceFormatException) ErrorMessage() string

type NotAuthorizedException

type NotAuthorizedException struct {
	Message *string
}

The caller is not authorized to perform this operation.

func (*NotAuthorizedException) Error

func (e *NotAuthorizedException) Error() string

func (*NotAuthorizedException) ErrorCode

func (e *NotAuthorizedException) ErrorCode() string

func (*NotAuthorizedException) ErrorFault

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

func (*NotAuthorizedException) ErrorMessage

func (e *NotAuthorizedException) ErrorMessage() string

type ResourceEndpointListItem

type ResourceEndpointListItem struct {

	// The protocol of the signaling channel returned by the
	// GetSignalingChannelEndpoint API.
	Protocol ChannelProtocol

	// The endpoint of the signaling channel returned by the
	// GetSignalingChannelEndpoint API.
	ResourceEndpoint *string
}

An object that describes the endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.

type ResourceInUseException

type ResourceInUseException struct {
	Message *string
}

The signaling channel is currently not available for this operation.

func (*ResourceInUseException) Error

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault

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

func (*ResourceInUseException) ErrorMessage

func (e *ResourceInUseException) ErrorMessage() string

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
}

Amazon Kinesis Video Streams can't find the stream that you specified.

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 SingleMasterChannelEndpointConfiguration

type SingleMasterChannelEndpointConfiguration struct {

	// This property is used to determine the nature of communication over this
	// SINGLE_MASTER signaling channel. If WSS is specified, this API returns a
	// websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.
	Protocols []ChannelProtocol

	// This property is used to determine messaging permissions in this SINGLE_MASTER
	// signaling channel. If MASTER is specified, this API returns an endpoint that a
	// client can use to receive offers from and send answers to any of the viewers on
	// this signaling channel. If VIEWER is specified, this API returns an endpoint
	// that a client can use only to send offers to another MASTER client on this
	// signaling channel.
	Role ChannelRole
}

An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

type SingleMasterConfiguration

type SingleMasterConfiguration struct {

	// The period of time a signaling channel retains underlivered messages before they
	// are discarded.
	MessageTtlSeconds *int32
}

A structure that contains the configuration for the SINGLE_MASTER channel type.

type Status

type Status string
const (
	StatusCreating Status = "CREATING"
	StatusActive   Status = "ACTIVE"
	StatusUpdating Status = "UPDATING"
	StatusDeleting Status = "DELETING"
)

Enum values for Status

func (Status) Values added in v0.29.0

func (Status) Values() []Status

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

type StreamInfo struct {

	// A time stamp that indicates when the stream was created.
	CreationTime *time.Time

	// How long the stream retains data, in hours.
	DataRetentionInHours *int32

	// The name of the device that is associated with the stream.
	DeviceName *string

	// The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
	// Streams uses to encrypt data on the stream.
	KmsKeyId *string

	// The MediaType of the stream.
	MediaType *string

	// The status of the stream.
	Status Status

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string

	// The name of the stream.
	StreamName *string

	// The version of the stream.
	Version *string
}

An object describing a Kinesis video stream.

type StreamNameCondition

type StreamNameCondition struct {

	// A comparison operator. Currently, you can specify only the BEGINS_WITH operator,
	// which finds streams whose names start with a given prefix.
	ComparisonOperator ComparisonOperator

	// A value to compare.
	ComparisonValue *string
}

Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

type Tag

type Tag struct {

	// The key of the tag that is associated with the specified signaling channel.
	//
	// This member is required.
	Key *string

	// The value of the tag that is associated with the specified signaling channel.
	//
	// This member is required.
	Value *string
}

A key and value pair that is associated with the specified signaling channel.

type TagsPerResourceExceededLimitException

type TagsPerResourceExceededLimitException struct {
	Message *string
}

You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams support up to 50 tags.

func (*TagsPerResourceExceededLimitException) Error

func (*TagsPerResourceExceededLimitException) ErrorCode

func (*TagsPerResourceExceededLimitException) ErrorFault

func (*TagsPerResourceExceededLimitException) ErrorMessage

type UpdateDataRetentionOperation

type UpdateDataRetentionOperation string
const (
	UpdateDataRetentionOperationIncreaseDataRetention UpdateDataRetentionOperation = "INCREASE_DATA_RETENTION"
	UpdateDataRetentionOperationDecreaseDataRetention UpdateDataRetentionOperation = "DECREASE_DATA_RETENTION"
)

Enum values for UpdateDataRetentionOperation

func (UpdateDataRetentionOperation) Values added in v0.29.0

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

type VersionMismatchException struct {
	Message *string
}

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html) API.

func (*VersionMismatchException) Error

func (e *VersionMismatchException) Error() string

func (*VersionMismatchException) ErrorCode

func (e *VersionMismatchException) ErrorCode() string

func (*VersionMismatchException) ErrorFault

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

func (*VersionMismatchException) ErrorMessage

func (e *VersionMismatchException) ErrorMessage() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL