types

package
v1.20.5 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2023 License: Apache-2.0 Imports: 4 Imported by: 2

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"
	APINameGetImages                  APIName = "GET_IMAGES"
)

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*AccountChannelLimitExceededException) Error 

func (e *AccountChannelLimitExceededException) Error() string

func (*AccountChannelLimitExceededException) ErrorCode 

func (e *AccountChannelLimitExceededException) ErrorCode() string

func (*AccountChannelLimitExceededException) ErrorFault 

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

func (*AccountChannelLimitExceededException) ErrorMessage 

func (e *AccountChannelLimitExceededException) ErrorMessage() string

type AccountStreamLimitExceededException 

type AccountStreamLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*AccountStreamLimitExceededException) Error 

func (e *AccountStreamLimitExceededException) Error() string

func (*AccountStreamLimitExceededException) ErrorCode 

func (e *AccountStreamLimitExceededException) ErrorCode() string

func (*AccountStreamLimitExceededException) ErrorFault 

func (e *AccountStreamLimitExceededException) ErrorFault() smithy.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
	// contains filtered or unexported fields
}

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

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"
	ChannelProtocolWebrtc ChannelProtocol = "WEBRTC"
)

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"
	ChannelTypeFullMesh     ChannelType = "FULL_MESH"
)

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 (e *ClientLimitExceededException) Error() string

func (*ClientLimitExceededException) ErrorCode 

func (e *ClientLimitExceededException) ErrorCode() string

func (*ClientLimitExceededException) ErrorFault 

func (e *ClientLimitExceededException) ErrorFault() smithy.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 

func (ComparisonOperator) Values() []ComparisonOperator

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

type ConfigurationStatus string
const (
	ConfigurationStatusEnabled  ConfigurationStatus = "ENABLED"
	ConfigurationStatusDisabled ConfigurationStatus = "DISABLED"
)

Enum values for ConfigurationStatus

func (ConfigurationStatus) Values added in v1.12.0 

func (ConfigurationStatus) Values() []ConfigurationStatus

Values returns all known values for ConfigurationStatus. 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 DeletionConfig added in v1.13.0 

type DeletionConfig struct {

	// The boolean value used to indicate whether or not you want to mark the media
	// for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The
	// media files can be deleted if any of the deletion configuration values are set
	// to true , such as when the limit for the EdgeRetentionInHours , or the
	// MaxLocalMediaSizeInMB , has been reached. Since the default value is set to true
	// , configure the uploader schedule such that the media files are not being
	// deleted before they are initially uploaded to the Amazon Web Services cloud.
	DeleteAfterUpload *bool

	// The number of hours that you want to retain the data in the stream on the Edge
	// Agent. The default value of the retention time is 720 hours, which translates to
	// 30 days.
	EdgeRetentionInHours *int32

	// The value of the local size required in order to delete the edge configuration.
	LocalSizeConfig *LocalSizeConfig
	// contains filtered or unexported fields
}

The configuration details required to delete the connection of the stream from the Edge Agent.

type DeviceStreamLimitExceededException 

type DeviceStreamLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Not implemented.

func (*DeviceStreamLimitExceededException) Error 

func (e *DeviceStreamLimitExceededException) Error() string

func (*DeviceStreamLimitExceededException) ErrorCode 

func (e *DeviceStreamLimitExceededException) ErrorCode() string

func (*DeviceStreamLimitExceededException) ErrorFault 

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

func (*DeviceStreamLimitExceededException) ErrorMessage 

func (e *DeviceStreamLimitExceededException) ErrorMessage() string

type EdgeAgentStatus added in v1.16.0 

type EdgeAgentStatus struct {

	// The latest status of a stream’s edge recording job.
	LastRecorderStatus *LastRecorderStatus

	// The latest status of a stream’s edge to cloud uploader job.
	LastUploaderStatus *LastUploaderStatus
	// contains filtered or unexported fields
}

An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.

type EdgeConfig added in v1.13.0 

type EdgeConfig struct {

	// The "Internet of Things (IoT) Thing" Arn of the stream.
	//
	// This member is required.
	HubDeviceArn *string

	// The recorder configuration consists of the local MediaSourceConfig details,
	// that are used as credentials to access the local media files streamed on the
	// camera.
	//
	// This member is required.
	RecorderConfig *RecorderConfig

	// The deletion configuration is made up of the retention time (
	// EdgeRetentionInHours ) and local size configuration ( LocalSizeConfig ) details
	// that are used to make the deletion.
	DeletionConfig *DeletionConfig

	// The uploader configuration contains the ScheduleExpression details that are
	// used to schedule upload jobs for the recorded media files from the Edge Agent to
	// a Kinesis Video Stream.
	UploaderConfig *UploaderConfig
	// contains filtered or unexported fields
}

A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

type Format added in v1.12.0 

type Format string
const (
	FormatJpeg Format = "JPEG"
	FormatPng  Format = "PNG"
)

Enum values for Format

func (Format) Values added in v1.12.0 

func (Format) Values() []Format

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

type FormatConfigKey string
const (
	FormatConfigKeyJPEGQuality FormatConfigKey = "JPEGQuality"
)

Enum values for FormatConfigKey

func (FormatConfigKey) Values added in v1.12.0 

func (FormatConfigKey) Values() []FormatConfigKey

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

type ImageGenerationConfiguration struct {

	// The structure that contains the information required to deliver images to a
	// customer.
	//
	// This member is required.
	DestinationConfig *ImageGenerationDestinationConfig

	// The accepted image format.
	//
	// This member is required.
	Format Format

	// The origin of the Server or Producer timestamps to use to generate the images.
	//
	// This member is required.
	ImageSelectorType ImageSelectorType

	// The time interval in milliseconds (ms) at which the images need to be generated
	// from the stream. The minimum value that can be provided is 200 ms. If the
	// timestamp range is less than the sampling interval, the Image from the
	// StartTimestamp will be returned if available.
	//
	// This member is required.
	SamplingInterval *int32

	// Indicates whether the ContinuousImageGenerationConfigurations API is enabled or
	// disabled.
	//
	// This member is required.
	Status ConfigurationStatus

	// The list of a key-value pair structure that contains extra parameters that can
	// be applied when the image is generated. The FormatConfig key is the JPEGQuality
	// , which indicates the JPEG quality key to be used to generate the image. The
	// FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will
	// be generated with less quality and the best compression. If the value is 100,
	// the image will be generated with the best quality and less compression. If no
	// value is provided, the default value of the JPEGQuality key will be set to 80.
	FormatConfig map[string]string

	// The height of the output image that is used in conjunction with the WidthPixels
	// parameter. When both HeightPixels and WidthPixels parameters are provided, the
	// image will be stretched to fit the specified aspect ratio. If only the
	// HeightPixels parameter is provided, its original aspect ratio will be used to
	// calculate the WidthPixels ratio. If neither parameter is provided, the original
	// image size will be returned.
	HeightPixels *int32

	// The width of the output image that is used in conjunction with the HeightPixels
	// parameter. When both WidthPixels and HeightPixels parameters are provided, the
	// image will be stretched to fit the specified aspect ratio. If only the
	// WidthPixels parameter is provided, its original aspect ratio will be used to
	// calculate the HeightPixels ratio. If neither parameter is provided, the
	// original image size will be returned.
	WidthPixels *int32
	// contains filtered or unexported fields
}

The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.

type ImageGenerationDestinationConfig added in v1.12.0 

type ImageGenerationDestinationConfig struct {

	// The Amazon Web Services Region of the S3 bucket where images will be delivered.
	// This DestinationRegion must match the Region where the stream is located.
	//
	// This member is required.
	DestinationRegion *string

	// The Uniform Resource Identifier (URI) that identifies where the images will be
	// delivered.
	//
	// This member is required.
	Uri *string
	// contains filtered or unexported fields
}

The structure that contains the information required to deliver images to a customer.

type ImageSelectorType added in v1.12.0 

type ImageSelectorType string
const (
	ImageSelectorTypeServerTimestamp   ImageSelectorType = "SERVER_TIMESTAMP"
	ImageSelectorTypeProducerTimestamp ImageSelectorType = "PRODUCER_TIMESTAMP"
)

Enum values for ImageSelectorType

func (ImageSelectorType) Values added in v1.12.0 

func (ImageSelectorType) Values() []ImageSelectorType

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

type InvalidArgumentException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The format of the StreamARN is invalid.

func (*InvalidResourceFormatException) Error 

func (e *InvalidResourceFormatException) Error() string

func (*InvalidResourceFormatException) ErrorCode 

func (e *InvalidResourceFormatException) ErrorCode() string

func (*InvalidResourceFormatException) ErrorFault 

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

func (*InvalidResourceFormatException) ErrorMessage 

func (e *InvalidResourceFormatException) ErrorMessage() string

type LastRecorderStatus added in v1.16.0 

type LastRecorderStatus struct {

	// A description of a recorder job’s latest status.
	JobStatusDetails *string

	// The timestamp at which the recorder job was last executed and media stored to
	// local disk.
	LastCollectedTime *time.Time

	// The timestamp at which the recorder status was last updated.
	LastUpdatedTime *time.Time

	// The status of the latest recorder job.
	RecorderStatus RecorderStatus
	// contains filtered or unexported fields
}

The latest status of a stream's edge recording job.

type LastUploaderStatus added in v1.16.0 

type LastUploaderStatus struct {

	// A description of an uploader job’s latest status.
	JobStatusDetails *string

	// The timestamp at which the uploader job was last executed and media collected
	// to the cloud.
	LastCollectedTime *time.Time

	// The timestamp at which the uploader status was last updated.
	LastUpdatedTime *time.Time

	// The status of the latest uploader job.
	UploaderStatus UploaderStatus
	// contains filtered or unexported fields
}

The latest status of a stream’s edge to cloud uploader job.

type ListEdgeAgentConfigurationsEdgeConfig added in v1.16.0 

type ListEdgeAgentConfigurationsEdgeConfig struct {

	// The timestamp when the stream first created the edge config.
	CreationTime *time.Time

	// A description of the stream's edge configuration that will be used to sync with
	// the Edge Agent IoT Greengrass component. The Edge Agent component will run on an
	// IoT Hub Device setup at your premise.
	EdgeConfig *EdgeConfig

	// A description of the generated failure status.
	FailedStatusDetails *string

	// The timestamp when the stream last updated the edge config.
	LastUpdatedTime *time.Time

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

	// The name of the stream.
	StreamName *string

	// The current sync status of the stream's edge configuration.
	SyncStatus SyncStatus
	// contains filtered or unexported fields
}

A description of a single stream's edge configuration.

type LocalSizeConfig added in v1.13.0 

type LocalSizeConfig struct {

	// The overall maximum size of the media that you want to store for a stream on
	// the Edge Agent.
	MaxLocalMediaSizeInMB *int32

	// The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is reached.
	StrategyOnFullSize StrategyOnFullSize
	// contains filtered or unexported fields
}

The configuration details that include the maximum size of the media ( MaxLocalMediaSizeInMB ) that you want to store for a stream on the Edge Agent, as well as the strategy that should be used ( StrategyOnFullSize ) when a stream's maximum size has been reached.

type MappedResourceConfigurationListItem added in v1.14.0 

type MappedResourceConfigurationListItem struct {

	// The Amazon Resource Name (ARN) of the Kinesis Video Stream resource, associated
	// with the stream.
	ARN *string

	// The type of the associated resource for the kinesis video stream.
	Type *string
	// contains filtered or unexported fields
}

A structure that encapsulates, or contains, the media storage configuration properties.

type MediaSourceConfig added in v1.13.0 

type MediaSourceConfig struct {

	// The Amazon Web Services Secrets Manager ARN for the username and password of
	// the camera, or a local media file location.
	//
	// This member is required.
	MediaUriSecretArn *string

	// The Uniform Resource Identifier (URI) type. The FILE_URI value can be used to
	// stream local media files. Preview only supports the RTSP_URI media source URI
	// format .
	//
	// This member is required.
	MediaUriType MediaUriType
	// contains filtered or unexported fields
}

The configuration details that consist of the credentials required ( MediaUriSecretArn and MediaUriType ) to access the media files that are streamed to the camera.

type MediaStorageConfiguration added in v1.14.0 

type MediaStorageConfiguration struct {

	// The status of the media storage configuration.
	//
	// This member is required.
	Status MediaStorageConfigurationStatus

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string
	// contains filtered or unexported fields
}

A structure that encapsulates, or contains, the media storage configuration properties.

  • If StorageStatus is enabled, the data will be stored in the StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled.
  • If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

type MediaStorageConfigurationStatus added in v1.14.0 

type MediaStorageConfigurationStatus string
const (
	MediaStorageConfigurationStatusEnabled  MediaStorageConfigurationStatus = "ENABLED"
	MediaStorageConfigurationStatusDisabled MediaStorageConfigurationStatus = "DISABLED"
)

Enum values for MediaStorageConfigurationStatus

func (MediaStorageConfigurationStatus) Values added in v1.14.0 

func (MediaStorageConfigurationStatus) Values() []MediaStorageConfigurationStatus

Values returns all known values for MediaStorageConfigurationStatus. 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 MediaUriType added in v1.13.0 

type MediaUriType string
const (
	MediaUriTypeRtspUri MediaUriType = "RTSP_URI"
	MediaUriTypeFileUri MediaUriType = "FILE_URI"
)

Enum values for MediaUriType

func (MediaUriType) Values added in v1.13.0 

func (MediaUriType) Values() []MediaUriType

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

type NoDataRetentionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Stream data retention in hours is equal to zero.

func (*NoDataRetentionException) Error added in v1.12.0 

func (e *NoDataRetentionException) Error() string

func (*NoDataRetentionException) ErrorCode added in v1.12.0 

func (e *NoDataRetentionException) ErrorCode() string

func (*NoDataRetentionException) ErrorFault added in v1.12.0 

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

func (*NoDataRetentionException) ErrorMessage added in v1.12.0 

func (e *NoDataRetentionException) ErrorMessage() string

type NotAuthorizedException 

type NotAuthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

type NotificationConfiguration struct {

	// The destination information required to deliver a notification to a customer.
	//
	// This member is required.
	DestinationConfig *NotificationDestinationConfig

	// Indicates if a notification configuration is enabled or disabled.
	//
	// This member is required.
	Status ConfigurationStatus
	// contains filtered or unexported fields
}

The structure that contains the notification information for the KVS images delivery. If this parameter is null, the configuration will be deleted from the stream.

type NotificationDestinationConfig added in v1.12.0 

type NotificationDestinationConfig struct {

	// The Uniform Resource Identifier (URI) that identifies where the images will be
	// delivered.
	//
	// This member is required.
	Uri *string
	// contains filtered or unexported fields
}

The structure that contains the information required to deliver a notification to a customer.

type RecorderConfig added in v1.13.0 

type RecorderConfig struct {

	// The configuration details that consist of the credentials required (
	// MediaUriSecretArn and MediaUriType ) to access the media files streamed to the
	// camera.
	//
	// This member is required.
	MediaSourceConfig *MediaSourceConfig

	// The configuration that consists of the ScheduleExpression and the
	// DurationInMinutes details that specify the scheduling to record from a camera,
	// or local media file, onto the Edge Agent. If the ScheduleExpression attribute
	// is not provided, then the Edge Agent will always be set to recording mode.
	ScheduleConfig *ScheduleConfig
	// contains filtered or unexported fields
}

The recorder configuration consists of the local MediaSourceConfig details that are used as credentials to accesss the local media files streamed on the camera.

type RecorderStatus added in v1.16.0 

type RecorderStatus string
const (
	RecorderStatusSuccess     RecorderStatus = "SUCCESS"
	RecorderStatusUserError   RecorderStatus = "USER_ERROR"
	RecorderStatusSystemError RecorderStatus = "SYSTEM_ERROR"
)

Enum values for RecorderStatus

func (RecorderStatus) Values added in v1.16.0 

func (RecorderStatus) Values() []RecorderStatus

Values returns all known values for RecorderStatus. 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 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
	// contains filtered or unexported fields
}

An object that describes the endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API. The media server endpoint will correspond to the WEBRTC Protocol.

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

  • The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.
  • The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.
  • The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ScheduleConfig added in v1.13.0 

type ScheduleConfig struct {

	// The total duration to record the media. If the ScheduleExpression attribute is
	// provided, then the DurationInSeconds attribute should also be specified.
	//
	// This member is required.
	DurationInSeconds *int32

	// The Quartz cron expression that takes care of scheduling jobs to record from
	// the camera, or local media file, onto the Edge Agent. If the ScheduleExpression
	// is not provided for the RecorderConfig , then the Edge Agent will always be set
	// to recording mode. For more information about Quartz, refer to the Cron Trigger
	// Tutorial  (http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html)
	// page to understand the valid expressions and its use.
	//
	// This member is required.
	ScheduleExpression *string
	// contains filtered or unexported fields
}

This API enables you to specify the duration that the camera, or local media file, should record onto the Edge Agent. The ScheduleConfig consists of the ScheduleExpression and the DurationInMinutes attributes. If the ScheduleConfig is not provided in the RecorderConfig , then the Edge Agent will always be set to recording mode. If the ScheduleConfig is not provided in the UploaderConfig , then the Edge Agent will upload at regular intervals (every 1 hour).

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

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 undelivered messages before they
	// are discarded.
	MessageTtlSeconds *int32
	// contains filtered or unexported fields
}

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 StrategyOnFullSize added in v1.13.0 

type StrategyOnFullSize string
const (
	StrategyOnFullSizeDeleteOldestMedia StrategyOnFullSize = "DELETE_OLDEST_MEDIA"
	StrategyOnFullSizeDenyNewMedia      StrategyOnFullSize = "DENY_NEW_MEDIA"
)

Enum values for StrategyOnFullSize

func (StrategyOnFullSize) Values added in v1.13.0 

func (StrategyOnFullSize) Values() []StrategyOnFullSize

Values returns all known values for StrategyOnFullSize. 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 StreamEdgeConfigurationNotFoundException added in v1.13.0 

type StreamEdgeConfigurationNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.

func (*StreamEdgeConfigurationNotFoundException) Error added in v1.13.0 

func (e *StreamEdgeConfigurationNotFoundException) Error() string

func (*StreamEdgeConfigurationNotFoundException) ErrorCode added in v1.13.0 

func (e *StreamEdgeConfigurationNotFoundException) ErrorCode() string

func (*StreamEdgeConfigurationNotFoundException) ErrorFault added in v1.13.0 

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

func (*StreamEdgeConfigurationNotFoundException) ErrorMessage added in v1.13.0 

func (e *StreamEdgeConfigurationNotFoundException) ErrorMessage() string

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 Key Management Service (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
	// contains filtered or unexported fields
}

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

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 SyncStatus added in v1.13.0 

type SyncStatus string
const (
	SyncStatusSyncing              SyncStatus = "SYNCING"
	SyncStatusAcknowledged         SyncStatus = "ACKNOWLEDGED"
	SyncStatusInSync               SyncStatus = "IN_SYNC"
	SyncStatusSyncFailed           SyncStatus = "SYNC_FAILED"
	SyncStatusDeleting             SyncStatus = "DELETING"
	SyncStatusDeleteFailed         SyncStatus = "DELETE_FAILED"
	SyncStatusDeletingAcknowledged SyncStatus = "DELETING_ACKNOWLEDGED"
)

Enum values for SyncStatus

func (SyncStatus) Values added in v1.13.0 

func (SyncStatus) Values() []SyncStatus

Values returns all known values for SyncStatus. 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 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
	// contains filtered or unexported fields
}

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

type TagsPerResourceExceededLimitException 

type TagsPerResourceExceededLimitException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*TagsPerResourceExceededLimitException) Error 

func (e *TagsPerResourceExceededLimitException) Error() string

func (*TagsPerResourceExceededLimitException) ErrorCode 

func (e *TagsPerResourceExceededLimitException) ErrorCode() string

func (*TagsPerResourceExceededLimitException) ErrorFault 

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

func (*TagsPerResourceExceededLimitException) ErrorMessage 

func (e *TagsPerResourceExceededLimitException) ErrorMessage() string

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 

func (UpdateDataRetentionOperation) Values() []UpdateDataRetentionOperation

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 UploaderConfig added in v1.13.0 

type UploaderConfig struct {

	// The configuration that consists of the ScheduleExpression and the
	// DurationInMinutes details that specify the scheduling to record from a camera,
	// or local media file, onto the Edge Agent. If the ScheduleConfig is not provided
	// in this UploaderConfig , then the Edge Agent will upload at regular intervals
	// (every 1 hour).
	//
	// This member is required.
	ScheduleConfig *ScheduleConfig
	// contains filtered or unexported fields
}

The configuration that consists of the ScheduleExpression and the DurationInMinutes details that specify the scheduling to record from a camera, or local media file, onto the Edge Agent. If the ScheduleConfig is not provided in the UploaderConfig , then the Edge Agent will upload at regular intervals (every 1 hour).

type UploaderStatus added in v1.16.0 

type UploaderStatus string
const (
	UploaderStatusSuccess     UploaderStatus = "SUCCESS"
	UploaderStatusUserError   UploaderStatus = "USER_ERROR"
	UploaderStatusSystemError UploaderStatus = "SYSTEM_ERROR"
)

Enum values for UploaderStatus

func (UploaderStatus) Values added in v1.16.0 

func (UploaderStatus) Values() []UploaderStatus

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

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.