kinesisvideo

package
v1.48.11 Latest Latest
Warning

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

 Go to latest Published: Dec 1, 2023 License: Apache-2.0 Imports: 10 Imported by: 74

Documentation

Overview

Package kinesisvideo provides the client and types for making API requests to Amazon Kinesis Video Streams.

See https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30 for more information on this service.

See kinesisvideo package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisvideo/

Using the Client

To contact Amazon Kinesis Video Streams with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Kinesis Video Streams client KinesisVideo for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisvideo/#New

Index

Constants

View Source 
const (
	// APINamePutMedia is a APIName enum value
	APINamePutMedia = "PUT_MEDIA"

	// APINameGetMedia is a APIName enum value
	APINameGetMedia = "GET_MEDIA"

	// APINameListFragments is a APIName enum value
	APINameListFragments = "LIST_FRAGMENTS"

	// APINameGetMediaForFragmentList is a APIName enum value
	APINameGetMediaForFragmentList = "GET_MEDIA_FOR_FRAGMENT_LIST"

	// APINameGetHlsStreamingSessionUrl is a APIName enum value
	APINameGetHlsStreamingSessionUrl = "GET_HLS_STREAMING_SESSION_URL"

	// APINameGetDashStreamingSessionUrl is a APIName enum value
	APINameGetDashStreamingSessionUrl = "GET_DASH_STREAMING_SESSION_URL"

	// APINameGetClip is a APIName enum value
	APINameGetClip = "GET_CLIP"

	// APINameGetImages is a APIName enum value
	APINameGetImages = "GET_IMAGES"
)
View Source 
const (
	// ChannelProtocolWss is a ChannelProtocol enum value
	ChannelProtocolWss = "WSS"

	// ChannelProtocolHttps is a ChannelProtocol enum value
	ChannelProtocolHttps = "HTTPS"

	// ChannelProtocolWebrtc is a ChannelProtocol enum value
	ChannelProtocolWebrtc = "WEBRTC"
)
View Source 
const (
	// ChannelRoleMaster is a ChannelRole enum value
	ChannelRoleMaster = "MASTER"

	// ChannelRoleViewer is a ChannelRole enum value
	ChannelRoleViewer = "VIEWER"
)
View Source 
const (
	// ChannelTypeSingleMaster is a ChannelType enum value
	ChannelTypeSingleMaster = "SINGLE_MASTER"

	// ChannelTypeFullMesh is a ChannelType enum value
	ChannelTypeFullMesh = "FULL_MESH"
)
View Source 
const (
	// ConfigurationStatusEnabled is a ConfigurationStatus enum value
	ConfigurationStatusEnabled = "ENABLED"

	// ConfigurationStatusDisabled is a ConfigurationStatus enum value
	ConfigurationStatusDisabled = "DISABLED"
)
View Source 
const (
	// FormatJpeg is a Format enum value
	FormatJpeg = "JPEG"

	// FormatPng is a Format enum value
	FormatPng = "PNG"
)
View Source 
const (
	// ImageSelectorTypeServerTimestamp is a ImageSelectorType enum value
	ImageSelectorTypeServerTimestamp = "SERVER_TIMESTAMP"

	// ImageSelectorTypeProducerTimestamp is a ImageSelectorType enum value
	ImageSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"
)
View Source 
const (
	// MediaStorageConfigurationStatusEnabled is a MediaStorageConfigurationStatus enum value
	MediaStorageConfigurationStatusEnabled = "ENABLED"

	// MediaStorageConfigurationStatusDisabled is a MediaStorageConfigurationStatus enum value
	MediaStorageConfigurationStatusDisabled = "DISABLED"
)
View Source 
const (
	// MediaUriTypeRtspUri is a MediaUriType enum value
	MediaUriTypeRtspUri = "RTSP_URI"

	// MediaUriTypeFileUri is a MediaUriType enum value
	MediaUriTypeFileUri = "FILE_URI"
)
View Source 
const (
	// RecorderStatusSuccess is a RecorderStatus enum value
	RecorderStatusSuccess = "SUCCESS"

	// RecorderStatusUserError is a RecorderStatus enum value
	RecorderStatusUserError = "USER_ERROR"

	// RecorderStatusSystemError is a RecorderStatus enum value
	RecorderStatusSystemError = "SYSTEM_ERROR"
)
View Source 
const (
	// StatusCreating is a Status enum value
	StatusCreating = "CREATING"

	// StatusActive is a Status enum value
	StatusActive = "ACTIVE"

	// StatusUpdating is a Status enum value
	StatusUpdating = "UPDATING"

	// StatusDeleting is a Status enum value
	StatusDeleting = "DELETING"
)
View Source 
const (
	// StrategyOnFullSizeDeleteOldestMedia is a StrategyOnFullSize enum value
	StrategyOnFullSizeDeleteOldestMedia = "DELETE_OLDEST_MEDIA"

	// StrategyOnFullSizeDenyNewMedia is a StrategyOnFullSize enum value
	StrategyOnFullSizeDenyNewMedia = "DENY_NEW_MEDIA"
)
View Source 
const (
	// SyncStatusSyncing is a SyncStatus enum value
	SyncStatusSyncing = "SYNCING"

	// SyncStatusAcknowledged is a SyncStatus enum value
	SyncStatusAcknowledged = "ACKNOWLEDGED"

	// SyncStatusInSync is a SyncStatus enum value
	SyncStatusInSync = "IN_SYNC"

	// SyncStatusSyncFailed is a SyncStatus enum value
	SyncStatusSyncFailed = "SYNC_FAILED"

	// SyncStatusDeleting is a SyncStatus enum value
	SyncStatusDeleting = "DELETING"

	// SyncStatusDeleteFailed is a SyncStatus enum value
	SyncStatusDeleteFailed = "DELETE_FAILED"

	// SyncStatusDeletingAcknowledged is a SyncStatus enum value
	SyncStatusDeletingAcknowledged = "DELETING_ACKNOWLEDGED"
)
View Source 
const (
	// UpdateDataRetentionOperationIncreaseDataRetention is a UpdateDataRetentionOperation enum value
	UpdateDataRetentionOperationIncreaseDataRetention = "INCREASE_DATA_RETENTION"

	// UpdateDataRetentionOperationDecreaseDataRetention is a UpdateDataRetentionOperation enum value
	UpdateDataRetentionOperationDecreaseDataRetention = "DECREASE_DATA_RETENTION"
)
View Source 
const (
	// UploaderStatusSuccess is a UploaderStatus enum value
	UploaderStatusSuccess = "SUCCESS"

	// UploaderStatusUserError is a UploaderStatus enum value
	UploaderStatusUserError = "USER_ERROR"

	// UploaderStatusSystemError is a UploaderStatus enum value
	UploaderStatusSystemError = "SYSTEM_ERROR"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have required permissions to perform this operation.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeAccountChannelLimitExceededException for service response error code
	// "AccountChannelLimitExceededException".
	//
	// You have reached the maximum limit of active signaling channels for this
	// Amazon Web Services account in this region.
	ErrCodeAccountChannelLimitExceededException = "AccountChannelLimitExceededException"

	// ErrCodeAccountStreamLimitExceededException for service response error code
	// "AccountStreamLimitExceededException".
	//
	// The number of streams created for the account is too high.
	ErrCodeAccountStreamLimitExceededException = "AccountStreamLimitExceededException"

	// ErrCodeClientLimitExceededException for service response error code
	// "ClientLimitExceededException".
	//
	// Kinesis Video Streams has throttled the request because you have exceeded
	// the limit of allowed client calls. Try making the call later.
	ErrCodeClientLimitExceededException = "ClientLimitExceededException"

	// ErrCodeDeviceStreamLimitExceededException for service response error code
	// "DeviceStreamLimitExceededException".
	//
	// Not implemented.
	ErrCodeDeviceStreamLimitExceededException = "DeviceStreamLimitExceededException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// The value for this input parameter is invalid.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeInvalidDeviceException for service response error code
	// "InvalidDeviceException".
	//
	// Not implemented.
	ErrCodeInvalidDeviceException = "InvalidDeviceException"

	// ErrCodeInvalidResourceFormatException for service response error code
	// "InvalidResourceFormatException".
	//
	// The format of the StreamARN is invalid.
	ErrCodeInvalidResourceFormatException = "InvalidResourceFormatException"

	// ErrCodeNoDataRetentionException for service response error code
	// "NoDataRetentionException".
	//
	// The Stream data retention in hours is equal to zero.
	ErrCodeNoDataRetentionException = "NoDataRetentionException"

	// ErrCodeNotAuthorizedException for service response error code
	// "NotAuthorizedException".
	//
	// The caller is not authorized to perform this operation.
	ErrCodeNotAuthorizedException = "NotAuthorizedException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// 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.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Amazon Kinesis Video Streams can't find the stream that you specified.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeStreamEdgeConfigurationNotFoundException for service response error code
	// "StreamEdgeConfigurationNotFoundException".
	//
	// The Exception rendered when the Amazon Kinesis Video Stream can't find a
	// stream's edge configuration that you specified.
	ErrCodeStreamEdgeConfigurationNotFoundException = "StreamEdgeConfigurationNotFoundException"

	// ErrCodeTagsPerResourceExceededLimitException for service response error code
	// "TagsPerResourceExceededLimitException".
	//
	// You have exceeded the limit of tags that you can associate with the resource.
	// A Kinesis video stream can support up to 50 tags.
	ErrCodeTagsPerResourceExceededLimitException = "TagsPerResourceExceededLimitException"

	// ErrCodeVersionMismatchException for service response error code
	// "VersionMismatchException".
	//
	// 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.
	ErrCodeVersionMismatchException = "VersionMismatchException"
)
View Source 
const (
	ServiceName = "kinesisvideo"  // Name of service.
	EndpointsID = ServiceName     // ID to lookup a service endpoint with.
	ServiceID   = "Kinesis Video" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ComparisonOperatorBeginsWith is a ComparisonOperator enum value
	ComparisonOperatorBeginsWith = "BEGINS_WITH"
)
View Source 
const (
	// FormatConfigKeyJpegquality is a FormatConfigKey enum value
	FormatConfigKeyJpegquality = "JPEGQuality"
)

Variables

This section is empty.

Functions

func APIName_Values added in v1.34.3 

func APIName_Values() []string

APIName_Values returns all elements of the APIName enum

func ChannelProtocol_Values added in v1.34.3 

func ChannelProtocol_Values() []string

ChannelProtocol_Values returns all elements of the ChannelProtocol enum

func ChannelRole_Values added in v1.34.3 

func ChannelRole_Values() []string

ChannelRole_Values returns all elements of the ChannelRole enum

func ChannelType_Values added in v1.34.3 

func ChannelType_Values() []string

ChannelType_Values returns all elements of the ChannelType enum

func ComparisonOperator_Values added in v1.34.3 

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func ConfigurationStatus_Values added in v1.44.6 

func ConfigurationStatus_Values() []string

ConfigurationStatus_Values returns all elements of the ConfigurationStatus enum

func FormatConfigKey_Values added in v1.44.6 

func FormatConfigKey_Values() []string

FormatConfigKey_Values returns all elements of the FormatConfigKey enum

func Format_Values added in v1.44.6 

func Format_Values() []string

Format_Values returns all elements of the Format enum

func ImageSelectorType_Values added in v1.44.6 

func ImageSelectorType_Values() []string

ImageSelectorType_Values returns all elements of the ImageSelectorType enum

func MediaStorageConfigurationStatus_Values added in v1.44.163 

func MediaStorageConfigurationStatus_Values() []string

MediaStorageConfigurationStatus_Values returns all elements of the MediaStorageConfigurationStatus enum

func MediaUriType_Values added in v1.44.158 

func MediaUriType_Values() []string

MediaUriType_Values returns all elements of the MediaUriType enum

func RecorderStatus_Values added in v1.44.291 

func RecorderStatus_Values() []string

RecorderStatus_Values returns all elements of the RecorderStatus enum

func Status_Values added in v1.34.3 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func StrategyOnFullSize_Values added in v1.44.158 

func StrategyOnFullSize_Values() []string

StrategyOnFullSize_Values returns all elements of the StrategyOnFullSize enum

func SyncStatus_Values added in v1.44.158 

func SyncStatus_Values() []string

SyncStatus_Values returns all elements of the SyncStatus enum

func UpdateDataRetentionOperation_Values added in v1.34.3 

func UpdateDataRetentionOperation_Values() []string

UpdateDataRetentionOperation_Values returns all elements of the UpdateDataRetentionOperation enum

func UploaderStatus_Values added in v1.44.291 

func UploaderStatus_Values() []string

UploaderStatus_Values returns all elements of the UploaderStatus enum

Types

type AccessDeniedException added in v1.28.0 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You do not have required permissions to perform this operation.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountChannelLimitExceededException added in v1.28.0 

type AccountChannelLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"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) Code added in v1.28.0 

func (s *AccountChannelLimitExceededException) Code() string

Code returns the exception type name.

func (*AccountChannelLimitExceededException) Error added in v1.28.0 

func (s *AccountChannelLimitExceededException) Error() string

func (AccountChannelLimitExceededException) GoString added in v1.28.0 

func (s AccountChannelLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountChannelLimitExceededException) Message added in v1.28.0 

func (s *AccountChannelLimitExceededException) Message() string

Message returns the exception's message.

func (*AccountChannelLimitExceededException) OrigErr added in v1.28.0 

func (s *AccountChannelLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccountChannelLimitExceededException) RequestID added in v1.28.0 

func (s *AccountChannelLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccountChannelLimitExceededException) StatusCode added in v1.28.0 

func (s *AccountChannelLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccountChannelLimitExceededException) String added in v1.28.0 

func (s AccountChannelLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountStreamLimitExceededException added in v1.28.0 

type AccountStreamLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*AccountStreamLimitExceededException) Code added in v1.28.0 

func (s *AccountStreamLimitExceededException) Code() string

Code returns the exception type name.

func (*AccountStreamLimitExceededException) Error added in v1.28.0 

func (s *AccountStreamLimitExceededException) Error() string

func (AccountStreamLimitExceededException) GoString added in v1.28.0 

func (s AccountStreamLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountStreamLimitExceededException) Message added in v1.28.0 

func (s *AccountStreamLimitExceededException) Message() string

Message returns the exception's message.

func (*AccountStreamLimitExceededException) OrigErr added in v1.28.0 

func (s *AccountStreamLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccountStreamLimitExceededException) RequestID added in v1.28.0 

func (s *AccountStreamLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccountStreamLimitExceededException) StatusCode added in v1.28.0 

func (s *AccountStreamLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccountStreamLimitExceededException) String added in v1.28.0 

func (s AccountStreamLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChannelInfo added in v1.25.48 

type ChannelInfo struct {

	// The Amazon Resource Name (ARN) of the signaling channel.
	ChannelARN *string `min:"1" type:"string"`

	// The name of the signaling channel.
	ChannelName *string `min:"1" type:"string"`

	// Current status of the signaling channel.
	ChannelStatus *string `type:"string" enum:"Status"`

	// The type of the signaling channel.
	ChannelType *string `type:"string" enum:"ChannelType"`

	// The time at which the signaling channel was created.
	CreationTime *time.Time `type:"timestamp"`

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

	// The current version of the signaling channel.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (ChannelInfo) GoString added in v1.25.48 

func (s ChannelInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelInfo) SetChannelARN added in v1.25.48 

func (s *ChannelInfo) SetChannelARN(v string) *ChannelInfo

SetChannelARN sets the ChannelARN field's value.

func (*ChannelInfo) SetChannelName added in v1.25.48 

func (s *ChannelInfo) SetChannelName(v string) *ChannelInfo

SetChannelName sets the ChannelName field's value.

func (*ChannelInfo) SetChannelStatus added in v1.25.48 

func (s *ChannelInfo) SetChannelStatus(v string) *ChannelInfo

SetChannelStatus sets the ChannelStatus field's value.

func (*ChannelInfo) SetChannelType added in v1.25.48 

func (s *ChannelInfo) SetChannelType(v string) *ChannelInfo

SetChannelType sets the ChannelType field's value.

func (*ChannelInfo) SetCreationTime added in v1.25.48 

func (s *ChannelInfo) SetCreationTime(v time.Time) *ChannelInfo

SetCreationTime sets the CreationTime field's value.

func (*ChannelInfo) SetSingleMasterConfiguration added in v1.25.48 

func (s *ChannelInfo) SetSingleMasterConfiguration(v *SingleMasterConfiguration) *ChannelInfo

SetSingleMasterConfiguration sets the SingleMasterConfiguration field's value.

func (*ChannelInfo) SetVersion added in v1.25.48 

func (s *ChannelInfo) SetVersion(v string) *ChannelInfo

SetVersion sets the Version field's value.

func (ChannelInfo) String added in v1.25.48 

func (s ChannelInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChannelNameCondition added in v1.25.48 

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 *string `type:"string" enum:"ComparisonOperator"`

	// A value to compare.
	ComparisonValue *string `min:"1" type:"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.

func (ChannelNameCondition) GoString added in v1.25.48 

func (s ChannelNameCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelNameCondition) SetComparisonOperator added in v1.25.48 

func (s *ChannelNameCondition) SetComparisonOperator(v string) *ChannelNameCondition

SetComparisonOperator sets the ComparisonOperator field's value.

func (*ChannelNameCondition) SetComparisonValue added in v1.25.48 

func (s *ChannelNameCondition) SetComparisonValue(v string) *ChannelNameCondition

SetComparisonValue sets the ComparisonValue field's value.

func (ChannelNameCondition) String added in v1.25.48 

func (s ChannelNameCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChannelNameCondition) Validate added in v1.25.48 

func (s *ChannelNameCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ClientLimitExceededException added in v1.28.0 

type ClientLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"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) Code added in v1.28.0 

func (s *ClientLimitExceededException) Code() string

Code returns the exception type name.

func (*ClientLimitExceededException) Error added in v1.28.0 

func (s *ClientLimitExceededException) Error() string

func (ClientLimitExceededException) GoString added in v1.28.0 

func (s ClientLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClientLimitExceededException) Message added in v1.28.0 

func (s *ClientLimitExceededException) Message() string

Message returns the exception's message.

func (*ClientLimitExceededException) OrigErr added in v1.28.0 

func (s *ClientLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClientLimitExceededException) RequestID added in v1.28.0 

func (s *ClientLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClientLimitExceededException) StatusCode added in v1.28.0 

func (s *ClientLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClientLimitExceededException) String added in v1.28.0 

func (s ClientLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSignalingChannelInput added in v1.25.48 

type CreateSignalingChannelInput struct {

	// A name for the signaling channel that you are creating. It must be unique
	// for each Amazon Web Services account and Amazon Web Services Region.
	//
	// ChannelName is a required field
	ChannelName *string `min:"1" type:"string" required:"true"`

	// A type of the signaling channel that you are creating. Currently, SINGLE_MASTER
	// is the only supported channel type.
	ChannelType *string `type:"string" enum:"ChannelType"`

	// A structure containing the configuration for the SINGLE_MASTER channel type.
	SingleMasterConfiguration *SingleMasterConfiguration `type:"structure"`

	// A set of tags (key-value pairs) that you want to associate with this channel.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateSignalingChannelInput) GoString added in v1.25.48 

func (s CreateSignalingChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSignalingChannelInput) SetChannelName added in v1.25.48 

func (s *CreateSignalingChannelInput) SetChannelName(v string) *CreateSignalingChannelInput

SetChannelName sets the ChannelName field's value.

func (*CreateSignalingChannelInput) SetChannelType added in v1.25.48 

func (s *CreateSignalingChannelInput) SetChannelType(v string) *CreateSignalingChannelInput

SetChannelType sets the ChannelType field's value.

func (*CreateSignalingChannelInput) SetSingleMasterConfiguration added in v1.25.48 

func (s *CreateSignalingChannelInput) SetSingleMasterConfiguration(v *SingleMasterConfiguration) *CreateSignalingChannelInput

SetSingleMasterConfiguration sets the SingleMasterConfiguration field's value.

func (*CreateSignalingChannelInput) SetTags added in v1.25.48 

func (s *CreateSignalingChannelInput) SetTags(v []*Tag) *CreateSignalingChannelInput

SetTags sets the Tags field's value.

func (CreateSignalingChannelInput) String added in v1.25.48 

func (s CreateSignalingChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSignalingChannelInput) Validate added in v1.25.48 

func (s *CreateSignalingChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSignalingChannelOutput added in v1.25.48 

type CreateSignalingChannelOutput struct {

	// The Amazon Resource Name (ARN) of the created channel.
	ChannelARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateSignalingChannelOutput) GoString added in v1.25.48 

func (s CreateSignalingChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSignalingChannelOutput) SetChannelARN added in v1.25.48 

func (s *CreateSignalingChannelOutput) SetChannelARN(v string) *CreateSignalingChannelOutput

SetChannelARN sets the ChannelARN field's value.

func (CreateSignalingChannelOutput) String added in v1.25.48 

func (s CreateSignalingChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStreamInput 

type CreateStreamInput struct {

	// The number of hours that you want to retain the data in the stream. Kinesis
	// Video Streams retains the data in a data store that is associated with the
	// stream.
	//
	// The default value is 0, indicating that the stream does not persist data.
	//
	// When the DataRetentionInHours value is 0, consumers can still consume the
	// fragments that remain in the service host buffer, which has a retention time
	// limit of 5 minutes and a retention memory limit of 200 MB. Fragments are
	// removed from the buffer when either limit is reached.
	DataRetentionInHours *int64 `type:"integer"`

	// The name of the device that is writing to the stream.
	//
	// In the current implementation, Kinesis Video Streams does not use this name.
	DeviceName *string `min:"1" type:"string"`

	// The ID of the Key Management Service (KMS) key that you want Kinesis Video
	// Streams to use to encrypt stream data.
	//
	// If no key ID is specified, the default, Kinesis Video-managed key (Amazon
	// Web Services/kinesisvideo) is used.
	//
	// For more information, see DescribeKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters).
	KmsKeyId *string `min:"1" type:"string"`

	// The media type of the stream. Consumers of the stream can use this information
	// when processing the stream. For more information about media types, see Media
	// Types (http://www.iana.org/assignments/media-types/media-types.xhtml). If
	// you choose to specify the MediaType, see Naming Requirements (https://tools.ietf.org/html/rfc6838#section-4.2)
	// for guidelines.
	//
	// Example valid values include "video/h264" and "video/h264,audio/aac".
	//
	// This parameter is optional; the default value is null (or empty in JSON).
	MediaType *string `min:"1" type:"string"`

	// A name for the stream that you are creating.
	//
	// The stream name is an identifier for the stream, and must be unique for each
	// account and region.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`

	// A list of tags to associate with the specified stream. Each tag is a key-value
	// pair (the value is optional).
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateStreamInput) GoString 

func (s CreateStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStreamInput) SetDataRetentionInHours 

func (s *CreateStreamInput) SetDataRetentionInHours(v int64) *CreateStreamInput

SetDataRetentionInHours sets the DataRetentionInHours field's value.

func (*CreateStreamInput) SetDeviceName 

func (s *CreateStreamInput) SetDeviceName(v string) *CreateStreamInput

SetDeviceName sets the DeviceName field's value.

func (*CreateStreamInput) SetKmsKeyId 

func (s *CreateStreamInput) SetKmsKeyId(v string) *CreateStreamInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateStreamInput) SetMediaType 

func (s *CreateStreamInput) SetMediaType(v string) *CreateStreamInput

SetMediaType sets the MediaType field's value.

func (*CreateStreamInput) SetStreamName 

func (s *CreateStreamInput) SetStreamName(v string) *CreateStreamInput

SetStreamName sets the StreamName field's value.

func (*CreateStreamInput) SetTags added in v1.16.35 

func (s *CreateStreamInput) SetTags(v map[string]*string) *CreateStreamInput

SetTags sets the Tags field's value.

func (CreateStreamInput) String 

func (s CreateStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStreamInput) Validate 

func (s *CreateStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateStreamOutput 

type CreateStreamOutput struct {

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateStreamOutput) GoString 

func (s CreateStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStreamOutput) SetStreamARN 

func (s *CreateStreamOutput) SetStreamARN(v string) *CreateStreamOutput

SetStreamARN sets the StreamARN field's value.

func (CreateStreamOutput) String 

func (s CreateStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEdgeConfigurationInput added in v1.44.291 

type DeleteEdgeConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the stream. Specify either the StreamName
	// or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which to delete the edge configuration. Specify
	// either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteEdgeConfigurationInput) GoString added in v1.44.291 

func (s DeleteEdgeConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEdgeConfigurationInput) SetStreamARN added in v1.44.291 

func (s *DeleteEdgeConfigurationInput) SetStreamARN(v string) *DeleteEdgeConfigurationInput

SetStreamARN sets the StreamARN field's value.

func (*DeleteEdgeConfigurationInput) SetStreamName added in v1.44.291 

func (s *DeleteEdgeConfigurationInput) SetStreamName(v string) *DeleteEdgeConfigurationInput

SetStreamName sets the StreamName field's value.

func (DeleteEdgeConfigurationInput) String added in v1.44.291 

func (s DeleteEdgeConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEdgeConfigurationInput) Validate added in v1.44.291 

func (s *DeleteEdgeConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEdgeConfigurationOutput added in v1.44.291 

type DeleteEdgeConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteEdgeConfigurationOutput) GoString added in v1.44.291 

func (s DeleteEdgeConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEdgeConfigurationOutput) String added in v1.44.291 

func (s DeleteEdgeConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSignalingChannelInput added in v1.25.48 

type DeleteSignalingChannelInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel that you want to
	// delete.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// The current version of the signaling channel that you want to delete. You
	// can obtain the current version by invoking the DescribeSignalingChannel or
	// ListSignalingChannels API operations.
	CurrentVersion *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSignalingChannelInput) GoString added in v1.25.48 

func (s DeleteSignalingChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSignalingChannelInput) SetChannelARN added in v1.25.48 

func (s *DeleteSignalingChannelInput) SetChannelARN(v string) *DeleteSignalingChannelInput

SetChannelARN sets the ChannelARN field's value.

func (*DeleteSignalingChannelInput) SetCurrentVersion added in v1.25.48 

func (s *DeleteSignalingChannelInput) SetCurrentVersion(v string) *DeleteSignalingChannelInput

SetCurrentVersion sets the CurrentVersion field's value.

func (DeleteSignalingChannelInput) String added in v1.25.48 

func (s DeleteSignalingChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSignalingChannelInput) Validate added in v1.25.48 

func (s *DeleteSignalingChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSignalingChannelOutput added in v1.25.48 

type DeleteSignalingChannelOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSignalingChannelOutput) GoString added in v1.25.48 

func (s DeleteSignalingChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSignalingChannelOutput) String added in v1.25.48 

func (s DeleteSignalingChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStreamInput 

type DeleteStreamInput struct {

	// Optional: The version of the stream that you want to delete.
	//
	// Specify the version as a safeguard to ensure that your are deleting the correct
	// stream. To get the stream version, use the DescribeStream API.
	//
	// If not specified, only the CreationTime is checked before deleting the stream.
	CurrentVersion *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the stream that you want to delete.
	//
	// StreamARN is a required field
	StreamARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStreamInput) GoString 

func (s DeleteStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStreamInput) SetCurrentVersion 

func (s *DeleteStreamInput) SetCurrentVersion(v string) *DeleteStreamInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*DeleteStreamInput) SetStreamARN 

func (s *DeleteStreamInput) SetStreamARN(v string) *DeleteStreamInput

SetStreamARN sets the StreamARN field's value.

func (DeleteStreamInput) String 

func (s DeleteStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStreamInput) Validate 

func (s *DeleteStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteStreamOutput 

type DeleteStreamOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStreamOutput) GoString 

func (s DeleteStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStreamOutput) String 

func (s DeleteStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletionConfig added in v1.44.158 

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 `type:"boolean"`

	// 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 *int64 `min:"1" type:"integer"`

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

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

func (DeletionConfig) GoString added in v1.44.158 

func (s DeletionConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletionConfig) SetDeleteAfterUpload added in v1.44.158 

func (s *DeletionConfig) SetDeleteAfterUpload(v bool) *DeletionConfig

SetDeleteAfterUpload sets the DeleteAfterUpload field's value.

func (*DeletionConfig) SetEdgeRetentionInHours added in v1.44.158 

func (s *DeletionConfig) SetEdgeRetentionInHours(v int64) *DeletionConfig

SetEdgeRetentionInHours sets the EdgeRetentionInHours field's value.

func (*DeletionConfig) SetLocalSizeConfig added in v1.44.158 

func (s *DeletionConfig) SetLocalSizeConfig(v *LocalSizeConfig) *DeletionConfig

SetLocalSizeConfig sets the LocalSizeConfig field's value.

func (DeletionConfig) String added in v1.44.158 

func (s DeletionConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletionConfig) Validate added in v1.44.158 

func (s *DeletionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEdgeConfigurationInput added in v1.44.158 

type DescribeEdgeConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the stream. Specify either the StreamNameor
	// the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream whose edge configuration you want to update. Specify
	// either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEdgeConfigurationInput) GoString added in v1.44.158 

func (s DescribeEdgeConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEdgeConfigurationInput) SetStreamARN added in v1.44.158 

func (s *DescribeEdgeConfigurationInput) SetStreamARN(v string) *DescribeEdgeConfigurationInput

SetStreamARN sets the StreamARN field's value.

func (*DescribeEdgeConfigurationInput) SetStreamName added in v1.44.158 

func (s *DescribeEdgeConfigurationInput) SetStreamName(v string) *DescribeEdgeConfigurationInput

SetStreamName sets the StreamName field's value.

func (DescribeEdgeConfigurationInput) String added in v1.44.158 

func (s DescribeEdgeConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEdgeConfigurationInput) Validate added in v1.44.158 

func (s *DescribeEdgeConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEdgeConfigurationOutput added in v1.44.158 

type DescribeEdgeConfigurationOutput struct {

	// The timestamp at which a stream’s edge configuration was first created.
	CreationTime *time.Time `type:"timestamp"`

	// 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.
	EdgeAgentStatus *EdgeAgentStatus `type:"structure"`

	// 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 `type:"structure"`

	// A description of the generated failure status.
	FailedStatusDetails *string `type:"string"`

	// The timestamp at which a stream’s edge configuration was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which the edge configuration was updated.
	StreamName *string `min:"1" type:"string"`

	// The latest status of the edge configuration update.
	SyncStatus *string `type:"string" enum:"SyncStatus"`
	// contains filtered or unexported fields
}

func (DescribeEdgeConfigurationOutput) GoString added in v1.44.158 

func (s DescribeEdgeConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEdgeConfigurationOutput) SetCreationTime added in v1.44.158 

func (s *DescribeEdgeConfigurationOutput) SetCreationTime(v time.Time) *DescribeEdgeConfigurationOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeEdgeConfigurationOutput) SetEdgeAgentStatus added in v1.44.291 

func (s *DescribeEdgeConfigurationOutput) SetEdgeAgentStatus(v *EdgeAgentStatus) *DescribeEdgeConfigurationOutput

SetEdgeAgentStatus sets the EdgeAgentStatus field's value.

func (*DescribeEdgeConfigurationOutput) SetEdgeConfig added in v1.44.158 

func (s *DescribeEdgeConfigurationOutput) SetEdgeConfig(v *EdgeConfig) *DescribeEdgeConfigurationOutput

SetEdgeConfig sets the EdgeConfig field's value.

func (*DescribeEdgeConfigurationOutput) SetFailedStatusDetails added in v1.44.158 

func (s *DescribeEdgeConfigurationOutput) SetFailedStatusDetails(v string) *DescribeEdgeConfigurationOutput

SetFailedStatusDetails sets the FailedStatusDetails field's value.

func (*DescribeEdgeConfigurationOutput) SetLastUpdatedTime added in v1.44.158 

func (s *DescribeEdgeConfigurationOutput) SetLastUpdatedTime(v time.Time) *DescribeEdgeConfigurationOutput

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*DescribeEdgeConfigurationOutput) SetStreamARN added in v1.44.158 

func (s *DescribeEdgeConfigurationOutput) SetStreamARN(v string) *DescribeEdgeConfigurationOutput

SetStreamARN sets the StreamARN field's value.

func (*DescribeEdgeConfigurationOutput) SetStreamName added in v1.44.158 

func (s *DescribeEdgeConfigurationOutput) SetStreamName(v string) *DescribeEdgeConfigurationOutput

SetStreamName sets the StreamName field's value.

func (*DescribeEdgeConfigurationOutput) SetSyncStatus added in v1.44.158 

func (s *DescribeEdgeConfigurationOutput) SetSyncStatus(v string) *DescribeEdgeConfigurationOutput

SetSyncStatus sets the SyncStatus field's value.

func (DescribeEdgeConfigurationOutput) String added in v1.44.158 

func (s DescribeEdgeConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeImageGenerationConfigurationInput added in v1.44.6 

type DescribeImageGenerationConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the Kinesis video stream from which to
	// retrieve the image generation configuration. You must specify either the
	// StreamName or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which to retrieve the image generation configuration.
	// You must specify either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeImageGenerationConfigurationInput) GoString added in v1.44.6 

func (s DescribeImageGenerationConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeImageGenerationConfigurationInput) SetStreamARN added in v1.44.6 

func (s *DescribeImageGenerationConfigurationInput) SetStreamARN(v string) *DescribeImageGenerationConfigurationInput

SetStreamARN sets the StreamARN field's value.

func (*DescribeImageGenerationConfigurationInput) SetStreamName added in v1.44.6 

func (s *DescribeImageGenerationConfigurationInput) SetStreamName(v string) *DescribeImageGenerationConfigurationInput

SetStreamName sets the StreamName field's value.

func (DescribeImageGenerationConfigurationInput) String added in v1.44.6 

func (s DescribeImageGenerationConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeImageGenerationConfigurationInput) Validate added in v1.44.6 

func (s *DescribeImageGenerationConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeImageGenerationConfigurationOutput added in v1.44.6 

type DescribeImageGenerationConfigurationOutput struct {

	// The structure that contains the information required for the Kinesis video
	// stream (KVS) images delivery. If this structure is null, the configuration
	// will be deleted from the stream.
	ImageGenerationConfiguration *ImageGenerationConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeImageGenerationConfigurationOutput) GoString added in v1.44.6 

func (s DescribeImageGenerationConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeImageGenerationConfigurationOutput) SetImageGenerationConfiguration added in v1.44.6 

func (s *DescribeImageGenerationConfigurationOutput) SetImageGenerationConfiguration(v *ImageGenerationConfiguration) *DescribeImageGenerationConfigurationOutput

SetImageGenerationConfiguration sets the ImageGenerationConfiguration field's value.

func (DescribeImageGenerationConfigurationOutput) String added in v1.44.6 

func (s DescribeImageGenerationConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMappedResourceConfigurationInput added in v1.44.163 

type DescribeMappedResourceConfigurationInput struct {

	// The maximum number of results to return in the response.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to provide in your next request, to get another batch of results.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMappedResourceConfigurationInput) GoString added in v1.44.163 

func (s DescribeMappedResourceConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMappedResourceConfigurationInput) SetMaxResults added in v1.44.163 

func (s *DescribeMappedResourceConfigurationInput) SetMaxResults(v int64) *DescribeMappedResourceConfigurationInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeMappedResourceConfigurationInput) SetNextToken added in v1.44.163 

func (s *DescribeMappedResourceConfigurationInput) SetNextToken(v string) *DescribeMappedResourceConfigurationInput

SetNextToken sets the NextToken field's value.

func (*DescribeMappedResourceConfigurationInput) SetStreamARN added in v1.44.163 

func (s *DescribeMappedResourceConfigurationInput) SetStreamARN(v string) *DescribeMappedResourceConfigurationInput

SetStreamARN sets the StreamARN field's value.

func (*DescribeMappedResourceConfigurationInput) SetStreamName added in v1.44.163 

func (s *DescribeMappedResourceConfigurationInput) SetStreamName(v string) *DescribeMappedResourceConfigurationInput

SetStreamName sets the StreamName field's value.

func (DescribeMappedResourceConfigurationInput) String added in v1.44.163 

func (s DescribeMappedResourceConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMappedResourceConfigurationInput) Validate added in v1.44.163 

func (s *DescribeMappedResourceConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMappedResourceConfigurationOutput added in v1.44.163 

type DescribeMappedResourceConfigurationOutput struct {

	// A structure that encapsulates, or contains, the media storage configuration
	// properties.
	MappedResourceConfigurationList []*MappedResourceConfigurationListItem `type:"list"`

	// The token that was used in the NextTokenrequest to fetch the next set of
	// results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMappedResourceConfigurationOutput) GoString added in v1.44.163 

func (s DescribeMappedResourceConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMappedResourceConfigurationOutput) SetMappedResourceConfigurationList added in v1.44.163 

func (s *DescribeMappedResourceConfigurationOutput) SetMappedResourceConfigurationList(v []*MappedResourceConfigurationListItem) *DescribeMappedResourceConfigurationOutput

SetMappedResourceConfigurationList sets the MappedResourceConfigurationList field's value.

func (*DescribeMappedResourceConfigurationOutput) SetNextToken added in v1.44.163 

func (s *DescribeMappedResourceConfigurationOutput) SetNextToken(v string) *DescribeMappedResourceConfigurationOutput

SetNextToken sets the NextToken field's value.

func (DescribeMappedResourceConfigurationOutput) String added in v1.44.163 

func (s DescribeMappedResourceConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeMediaStorageConfigurationInput added in v1.44.163 

type DescribeMediaStorageConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the channel.
	ChannelARN *string `min:"1" type:"string"`

	// The name of the channel.
	ChannelName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeMediaStorageConfigurationInput) GoString added in v1.44.163 

func (s DescribeMediaStorageConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMediaStorageConfigurationInput) SetChannelARN added in v1.44.163 

func (s *DescribeMediaStorageConfigurationInput) SetChannelARN(v string) *DescribeMediaStorageConfigurationInput

SetChannelARN sets the ChannelARN field's value.

func (*DescribeMediaStorageConfigurationInput) SetChannelName added in v1.44.163 

func (s *DescribeMediaStorageConfigurationInput) SetChannelName(v string) *DescribeMediaStorageConfigurationInput

SetChannelName sets the ChannelName field's value.

func (DescribeMediaStorageConfigurationInput) String added in v1.44.163 

func (s DescribeMediaStorageConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMediaStorageConfigurationInput) Validate added in v1.44.163 

func (s *DescribeMediaStorageConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeMediaStorageConfigurationOutput added in v1.44.163 

type DescribeMediaStorageConfigurationOutput struct {

	// A structure that encapsulates, or contains, the media storage configuration
	// properties.
	MediaStorageConfiguration *MediaStorageConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeMediaStorageConfigurationOutput) GoString added in v1.44.163 

func (s DescribeMediaStorageConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeMediaStorageConfigurationOutput) SetMediaStorageConfiguration added in v1.44.163 

func (s *DescribeMediaStorageConfigurationOutput) SetMediaStorageConfiguration(v *MediaStorageConfiguration) *DescribeMediaStorageConfigurationOutput

SetMediaStorageConfiguration sets the MediaStorageConfiguration field's value.

func (DescribeMediaStorageConfigurationOutput) String added in v1.44.163 

func (s DescribeMediaStorageConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeNotificationConfigurationInput added in v1.44.6 

type DescribeNotificationConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the Kinesis video stream from where you
	// want to retrieve the notification configuration. You must specify either
	// the StreamName or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which to retrieve the notification configuration.
	// You must specify either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeNotificationConfigurationInput) GoString added in v1.44.6 

func (s DescribeNotificationConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationConfigurationInput) SetStreamARN added in v1.44.6 

func (s *DescribeNotificationConfigurationInput) SetStreamARN(v string) *DescribeNotificationConfigurationInput

SetStreamARN sets the StreamARN field's value.

func (*DescribeNotificationConfigurationInput) SetStreamName added in v1.44.6 

func (s *DescribeNotificationConfigurationInput) SetStreamName(v string) *DescribeNotificationConfigurationInput

SetStreamName sets the StreamName field's value.

func (DescribeNotificationConfigurationInput) String added in v1.44.6 

func (s DescribeNotificationConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationConfigurationInput) Validate added in v1.44.6 

func (s *DescribeNotificationConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeNotificationConfigurationOutput added in v1.44.6 

type DescribeNotificationConfigurationOutput struct {

	// The structure that contains the information required for notifications. If
	// the structure is null, the configuration will be deleted from the stream.
	NotificationConfiguration *NotificationConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeNotificationConfigurationOutput) GoString added in v1.44.6 

func (s DescribeNotificationConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationConfigurationOutput) SetNotificationConfiguration added in v1.44.6 

func (s *DescribeNotificationConfigurationOutput) SetNotificationConfiguration(v *NotificationConfiguration) *DescribeNotificationConfigurationOutput

SetNotificationConfiguration sets the NotificationConfiguration field's value.

func (DescribeNotificationConfigurationOutput) String added in v1.44.6 

func (s DescribeNotificationConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSignalingChannelInput added in v1.25.48 

type DescribeSignalingChannelInput struct {

	// The ARN of the signaling channel that you want to describe.
	ChannelARN *string `min:"1" type:"string"`

	// The name of the signaling channel that you want to describe.
	ChannelName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSignalingChannelInput) GoString added in v1.25.48 

func (s DescribeSignalingChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSignalingChannelInput) SetChannelARN added in v1.25.48 

func (s *DescribeSignalingChannelInput) SetChannelARN(v string) *DescribeSignalingChannelInput

SetChannelARN sets the ChannelARN field's value.

func (*DescribeSignalingChannelInput) SetChannelName added in v1.25.48 

func (s *DescribeSignalingChannelInput) SetChannelName(v string) *DescribeSignalingChannelInput

SetChannelName sets the ChannelName field's value.

func (DescribeSignalingChannelInput) String added in v1.25.48 

func (s DescribeSignalingChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSignalingChannelInput) Validate added in v1.25.48 

func (s *DescribeSignalingChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSignalingChannelOutput added in v1.25.48 

type DescribeSignalingChannelOutput struct {

	// A structure that encapsulates the specified signaling channel's metadata
	// and properties.
	ChannelInfo *ChannelInfo `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSignalingChannelOutput) GoString added in v1.25.48 

func (s DescribeSignalingChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSignalingChannelOutput) SetChannelInfo added in v1.25.48 

func (s *DescribeSignalingChannelOutput) SetChannelInfo(v *ChannelInfo) *DescribeSignalingChannelOutput

SetChannelInfo sets the ChannelInfo field's value.

func (DescribeSignalingChannelOutput) String added in v1.25.48 

func (s DescribeSignalingChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStreamInput 

type DescribeStreamInput struct {

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeStreamInput) GoString 

func (s DescribeStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamInput) SetStreamARN 

func (s *DescribeStreamInput) SetStreamARN(v string) *DescribeStreamInput

SetStreamARN sets the StreamARN field's value.

func (*DescribeStreamInput) SetStreamName 

func (s *DescribeStreamInput) SetStreamName(v string) *DescribeStreamInput

SetStreamName sets the StreamName field's value.

func (DescribeStreamInput) String 

func (s DescribeStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamInput) Validate 

func (s *DescribeStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStreamOutput 

type DescribeStreamOutput struct {

	// An object that describes the stream.
	StreamInfo *StreamInfo `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeStreamOutput) GoString 

func (s DescribeStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamOutput) SetStreamInfo 

func (s *DescribeStreamOutput) SetStreamInfo(v *StreamInfo) *DescribeStreamOutput

SetStreamInfo sets the StreamInfo field's value.

func (DescribeStreamOutput) String 

func (s DescribeStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeviceStreamLimitExceededException added in v1.28.0 

type DeviceStreamLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Not implemented.

func (*DeviceStreamLimitExceededException) Code added in v1.28.0 

func (s *DeviceStreamLimitExceededException) Code() string

Code returns the exception type name.

func (*DeviceStreamLimitExceededException) Error added in v1.28.0 

func (s *DeviceStreamLimitExceededException) Error() string

func (DeviceStreamLimitExceededException) GoString added in v1.28.0 

func (s DeviceStreamLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceStreamLimitExceededException) Message added in v1.28.0 

func (s *DeviceStreamLimitExceededException) Message() string

Message returns the exception's message.

func (*DeviceStreamLimitExceededException) OrigErr added in v1.28.0 

func (s *DeviceStreamLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DeviceStreamLimitExceededException) RequestID added in v1.28.0 

func (s *DeviceStreamLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DeviceStreamLimitExceededException) StatusCode added in v1.28.0 

func (s *DeviceStreamLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DeviceStreamLimitExceededException) String added in v1.28.0 

func (s DeviceStreamLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EdgeAgentStatus added in v1.44.291 

type EdgeAgentStatus struct {

	// The latest status of a stream’s edge recording job.
	LastRecorderStatus *LastRecorderStatus `type:"structure"`

	// The latest status of a stream’s edge to cloud uploader job.
	LastUploaderStatus *LastUploaderStatus `type:"structure"`
	// 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.

func (EdgeAgentStatus) GoString added in v1.44.291 

func (s EdgeAgentStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EdgeAgentStatus) SetLastRecorderStatus added in v1.44.291 

func (s *EdgeAgentStatus) SetLastRecorderStatus(v *LastRecorderStatus) *EdgeAgentStatus

SetLastRecorderStatus sets the LastRecorderStatus field's value.

func (*EdgeAgentStatus) SetLastUploaderStatus added in v1.44.291 

func (s *EdgeAgentStatus) SetLastUploaderStatus(v *LastUploaderStatus) *EdgeAgentStatus

SetLastUploaderStatus sets the LastUploaderStatus field's value.

func (EdgeAgentStatus) String added in v1.44.291 

func (s EdgeAgentStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EdgeConfig added in v1.44.158 

type EdgeConfig struct {

	// 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 `type:"structure"`

	// The "Internet of Things (IoT) Thing" Arn of the stream.
	//
	// HubDeviceArn is a required field
	HubDeviceArn *string `min:"1" type:"string" required:"true"`

	// The recorder configuration consists of the local MediaSourceConfig details,
	// that are used as credentials to access the local media files streamed on
	// the camera.
	//
	// RecorderConfig is a required field
	RecorderConfig *RecorderConfig `type:"structure" required:"true"`

	// 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 `type:"structure"`
	// 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.

func (EdgeConfig) GoString added in v1.44.158 

func (s EdgeConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EdgeConfig) SetDeletionConfig added in v1.44.158 

func (s *EdgeConfig) SetDeletionConfig(v *DeletionConfig) *EdgeConfig

SetDeletionConfig sets the DeletionConfig field's value.

func (*EdgeConfig) SetHubDeviceArn added in v1.44.158 

func (s *EdgeConfig) SetHubDeviceArn(v string) *EdgeConfig

SetHubDeviceArn sets the HubDeviceArn field's value.

func (*EdgeConfig) SetRecorderConfig added in v1.44.158 

func (s *EdgeConfig) SetRecorderConfig(v *RecorderConfig) *EdgeConfig

SetRecorderConfig sets the RecorderConfig field's value.

func (*EdgeConfig) SetUploaderConfig added in v1.44.158 

func (s *EdgeConfig) SetUploaderConfig(v *UploaderConfig) *EdgeConfig

SetUploaderConfig sets the UploaderConfig field's value.

func (EdgeConfig) String added in v1.44.158 

func (s EdgeConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EdgeConfig) Validate added in v1.44.158 

func (s *EdgeConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDataEndpointInput 

type GetDataEndpointInput struct {

	// The name of the API action for which to get an endpoint.
	//
	// APIName is a required field
	APIName *string `type:"string" required:"true" enum:"APIName"`

	// The Amazon Resource Name (ARN) of the stream that you want to get the endpoint
	// for. You must specify either this parameter or a StreamName in the request.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream that you want to get the endpoint for. You must specify
	// either this parameter or a StreamARN in the request.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetDataEndpointInput) GoString 

func (s GetDataEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataEndpointInput) SetAPIName 

func (s *GetDataEndpointInput) SetAPIName(v string) *GetDataEndpointInput

SetAPIName sets the APIName field's value.

func (*GetDataEndpointInput) SetStreamARN 

func (s *GetDataEndpointInput) SetStreamARN(v string) *GetDataEndpointInput

SetStreamARN sets the StreamARN field's value.

func (*GetDataEndpointInput) SetStreamName 

func (s *GetDataEndpointInput) SetStreamName(v string) *GetDataEndpointInput

SetStreamName sets the StreamName field's value.

func (GetDataEndpointInput) String 

func (s GetDataEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataEndpointInput) Validate 

func (s *GetDataEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDataEndpointOutput 

type GetDataEndpointOutput struct {

	// The endpoint value. To read data from the stream or to write data to it,
	// specify this endpoint in your application.
	DataEndpoint *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetDataEndpointOutput) GoString 

func (s GetDataEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataEndpointOutput) SetDataEndpoint 

func (s *GetDataEndpointOutput) SetDataEndpoint(v string) *GetDataEndpointOutput

SetDataEndpoint sets the DataEndpoint field's value.

func (GetDataEndpointOutput) String 

func (s GetDataEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSignalingChannelEndpointInput added in v1.25.48 

type GetSignalingChannelEndpointInput struct {

	// The Amazon Resource Name (ARN) of the signalling channel for which you want
	// to get an endpoint.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// A structure containing the endpoint configuration for the SINGLE_MASTER channel
	// type.
	SingleMasterChannelEndpointConfiguration *SingleMasterChannelEndpointConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetSignalingChannelEndpointInput) GoString added in v1.25.48 

func (s GetSignalingChannelEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSignalingChannelEndpointInput) SetChannelARN added in v1.25.48 

func (s *GetSignalingChannelEndpointInput) SetChannelARN(v string) *GetSignalingChannelEndpointInput

SetChannelARN sets the ChannelARN field's value.

func (*GetSignalingChannelEndpointInput) SetSingleMasterChannelEndpointConfiguration added in v1.25.48 

func (s *GetSignalingChannelEndpointInput) SetSingleMasterChannelEndpointConfiguration(v *SingleMasterChannelEndpointConfiguration) *GetSignalingChannelEndpointInput

SetSingleMasterChannelEndpointConfiguration sets the SingleMasterChannelEndpointConfiguration field's value.

func (GetSignalingChannelEndpointInput) String added in v1.25.48 

func (s GetSignalingChannelEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSignalingChannelEndpointInput) Validate added in v1.25.48 

func (s *GetSignalingChannelEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSignalingChannelEndpointOutput added in v1.25.48 

type GetSignalingChannelEndpointOutput struct {

	// A list of endpoints for the specified signaling channel.
	ResourceEndpointList []*ResourceEndpointListItem `type:"list"`
	// contains filtered or unexported fields
}

func (GetSignalingChannelEndpointOutput) GoString added in v1.25.48 

func (s GetSignalingChannelEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSignalingChannelEndpointOutput) SetResourceEndpointList added in v1.25.48 

func (s *GetSignalingChannelEndpointOutput) SetResourceEndpointList(v []*ResourceEndpointListItem) *GetSignalingChannelEndpointOutput

SetResourceEndpointList sets the ResourceEndpointList field's value.

func (GetSignalingChannelEndpointOutput) String added in v1.25.48 

func (s GetSignalingChannelEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImageGenerationConfiguration added in v1.44.6 

type ImageGenerationConfiguration struct {

	// The structure that contains the information required to deliver images to
	// a customer.
	//
	// DestinationConfig is a required field
	DestinationConfig *ImageGenerationDestinationConfig `type:"structure" required:"true"`

	// The accepted image format.
	//
	// Format is a required field
	Format *string `type:"string" required:"true" enum:"Format"`

	// 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 `min:"1" type:"map"`

	// 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 *int64 `min:"1" type:"integer"`

	// The origin of the Server or Producer timestamps to use to generate the images.
	//
	// ImageSelectorType is a required field
	ImageSelectorType *string `type:"string" required:"true" enum:"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.
	//
	// SamplingInterval is a required field
	SamplingInterval *int64 `type:"integer" required:"true"`

	// Indicates whether the ContinuousImageGenerationConfigurations API is enabled
	// or disabled.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"ConfigurationStatus"`

	// 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 *int64 `min:"1" type:"integer"`
	// 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.

func (ImageGenerationConfiguration) GoString added in v1.44.6 

func (s ImageGenerationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageGenerationConfiguration) SetDestinationConfig added in v1.44.6 

func (s *ImageGenerationConfiguration) SetDestinationConfig(v *ImageGenerationDestinationConfig) *ImageGenerationConfiguration

SetDestinationConfig sets the DestinationConfig field's value.

func (*ImageGenerationConfiguration) SetFormat added in v1.44.6 

func (s *ImageGenerationConfiguration) SetFormat(v string) *ImageGenerationConfiguration

SetFormat sets the Format field's value.

func (*ImageGenerationConfiguration) SetFormatConfig added in v1.44.6 

func (s *ImageGenerationConfiguration) SetFormatConfig(v map[string]*string) *ImageGenerationConfiguration

SetFormatConfig sets the FormatConfig field's value.

func (*ImageGenerationConfiguration) SetHeightPixels added in v1.44.6 

func (s *ImageGenerationConfiguration) SetHeightPixels(v int64) *ImageGenerationConfiguration

SetHeightPixels sets the HeightPixels field's value.

func (*ImageGenerationConfiguration) SetImageSelectorType added in v1.44.6 

func (s *ImageGenerationConfiguration) SetImageSelectorType(v string) *ImageGenerationConfiguration

SetImageSelectorType sets the ImageSelectorType field's value.

func (*ImageGenerationConfiguration) SetSamplingInterval added in v1.44.6 

func (s *ImageGenerationConfiguration) SetSamplingInterval(v int64) *ImageGenerationConfiguration

SetSamplingInterval sets the SamplingInterval field's value.

func (*ImageGenerationConfiguration) SetStatus added in v1.44.6 

func (s *ImageGenerationConfiguration) SetStatus(v string) *ImageGenerationConfiguration

SetStatus sets the Status field's value.

func (*ImageGenerationConfiguration) SetWidthPixels added in v1.44.6 

func (s *ImageGenerationConfiguration) SetWidthPixels(v int64) *ImageGenerationConfiguration

SetWidthPixels sets the WidthPixels field's value.

func (ImageGenerationConfiguration) String added in v1.44.6 

func (s ImageGenerationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageGenerationConfiguration) Validate added in v1.44.6 

func (s *ImageGenerationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImageGenerationDestinationConfig added in v1.44.6 

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.
	//
	// DestinationRegion is a required field
	DestinationRegion *string `min:"9" type:"string" required:"true"`

	// The Uniform Resource Identifier (URI) that identifies where the images will
	// be delivered.
	//
	// Uri is a required field
	Uri *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (ImageGenerationDestinationConfig) GoString added in v1.44.6 

func (s ImageGenerationDestinationConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageGenerationDestinationConfig) SetDestinationRegion added in v1.44.6 

func (s *ImageGenerationDestinationConfig) SetDestinationRegion(v string) *ImageGenerationDestinationConfig

SetDestinationRegion sets the DestinationRegion field's value.

func (*ImageGenerationDestinationConfig) SetUri added in v1.44.6 

func (s *ImageGenerationDestinationConfig) SetUri(v string) *ImageGenerationDestinationConfig

SetUri sets the Uri field's value.

func (ImageGenerationDestinationConfig) String added in v1.44.6 

func (s ImageGenerationDestinationConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageGenerationDestinationConfig) Validate added in v1.44.6 

func (s *ImageGenerationDestinationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InvalidArgumentException added in v1.28.0 

type InvalidArgumentException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The value for this input parameter is invalid.

func (*InvalidArgumentException) Code added in v1.28.0 

func (s *InvalidArgumentException) Code() string

Code returns the exception type name.

func (*InvalidArgumentException) Error added in v1.28.0 

func (s *InvalidArgumentException) Error() string

func (InvalidArgumentException) GoString added in v1.28.0 

func (s InvalidArgumentException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidArgumentException) Message added in v1.28.0 

func (s *InvalidArgumentException) Message() string

Message returns the exception's message.

func (*InvalidArgumentException) OrigErr added in v1.28.0 

func (s *InvalidArgumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArgumentException) RequestID added in v1.28.0 

func (s *InvalidArgumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArgumentException) StatusCode added in v1.28.0 

func (s *InvalidArgumentException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidArgumentException) String added in v1.28.0 

func (s InvalidArgumentException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidDeviceException added in v1.28.0 

type InvalidDeviceException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Not implemented.

func (*InvalidDeviceException) Code added in v1.28.0 

func (s *InvalidDeviceException) Code() string

Code returns the exception type name.

func (*InvalidDeviceException) Error added in v1.28.0 

func (s *InvalidDeviceException) Error() string

func (InvalidDeviceException) GoString added in v1.28.0 

func (s InvalidDeviceException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidDeviceException) Message added in v1.28.0 

func (s *InvalidDeviceException) Message() string

Message returns the exception's message.

func (*InvalidDeviceException) OrigErr added in v1.28.0 

func (s *InvalidDeviceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidDeviceException) RequestID added in v1.28.0 

func (s *InvalidDeviceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidDeviceException) StatusCode added in v1.28.0 

func (s *InvalidDeviceException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidDeviceException) String added in v1.28.0 

func (s InvalidDeviceException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidResourceFormatException added in v1.28.0 

type InvalidResourceFormatException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The format of the StreamARN is invalid.

func (*InvalidResourceFormatException) Code added in v1.28.0 

func (s *InvalidResourceFormatException) Code() string

Code returns the exception type name.

func (*InvalidResourceFormatException) Error added in v1.28.0 

func (s *InvalidResourceFormatException) Error() string

func (InvalidResourceFormatException) GoString added in v1.28.0 

func (s InvalidResourceFormatException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidResourceFormatException) Message added in v1.28.0 

func (s *InvalidResourceFormatException) Message() string

Message returns the exception's message.

func (*InvalidResourceFormatException) OrigErr added in v1.28.0 

func (s *InvalidResourceFormatException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidResourceFormatException) RequestID added in v1.28.0 

func (s *InvalidResourceFormatException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidResourceFormatException) StatusCode added in v1.28.0 

func (s *InvalidResourceFormatException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidResourceFormatException) String added in v1.28.0 

func (s InvalidResourceFormatException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KinesisVideo 

type KinesisVideo struct {
	*client.Client
}

KinesisVideo provides the API operation methods for making requests to Amazon Kinesis Video Streams. See this package's package overview docs for details on the service.

KinesisVideo methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *KinesisVideo

New creates a new instance of the KinesisVideo client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a KinesisVideo client from just a session.
svc := kinesisvideo.New(mySession)

// Create a KinesisVideo client with additional configuration
svc := kinesisvideo.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*KinesisVideo) CreateSignalingChannel added in v1.25.48 

func (c *KinesisVideo) CreateSignalingChannel(input *CreateSignalingChannelInput) (*CreateSignalingChannelOutput, error)

CreateSignalingChannel API operation for Amazon Kinesis Video Streams.

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation CreateSignalingChannel for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • ResourceInUseException 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.

  • AccessDeniedException You do not have required permissions to perform this operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateSignalingChannel

func (*KinesisVideo) CreateSignalingChannelRequest added in v1.25.48 

func (c *KinesisVideo) CreateSignalingChannelRequest(input *CreateSignalingChannelInput) (req *request.Request, output *CreateSignalingChannelOutput)

CreateSignalingChannelRequest generates a "aws/request.Request" representing the client's request for the CreateSignalingChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSignalingChannel for more information on using the CreateSignalingChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateSignalingChannelRequest method.
req, resp := client.CreateSignalingChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateSignalingChannel

func (*KinesisVideo) CreateSignalingChannelWithContext added in v1.25.48 

func (c *KinesisVideo) CreateSignalingChannelWithContext(ctx aws.Context, input *CreateSignalingChannelInput, opts ...request.Option) (*CreateSignalingChannelOutput, error)

CreateSignalingChannelWithContext is the same as CreateSignalingChannel with the addition of the ability to pass a context and additional request options.

See CreateSignalingChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) CreateStream 

func (c *KinesisVideo) CreateStream(input *CreateStreamInput) (*CreateStreamOutput, error)

CreateStream API operation for Amazon Kinesis Video Streams.

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html).

You must have permissions for the KinesisVideo:CreateStream action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation CreateStream for usage and error information.

Returned Error Types:

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

  • DeviceStreamLimitExceededException Not implemented.

  • ResourceInUseException 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.

  • InvalidDeviceException Not implemented.

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateStream

func (*KinesisVideo) CreateStreamRequest 

func (c *KinesisVideo) CreateStreamRequest(input *CreateStreamInput) (req *request.Request, output *CreateStreamOutput)

CreateStreamRequest generates a "aws/request.Request" representing the client's request for the CreateStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStream for more information on using the CreateStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateStreamRequest method.
req, resp := client.CreateStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateStream

func (*KinesisVideo) CreateStreamWithContext 

func (c *KinesisVideo) CreateStreamWithContext(ctx aws.Context, input *CreateStreamInput, opts ...request.Option) (*CreateStreamOutput, error)

CreateStreamWithContext is the same as CreateStream with the addition of the ability to pass a context and additional request options.

See CreateStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DeleteEdgeConfiguration added in v1.44.291 

func (c *KinesisVideo) DeleteEdgeConfiguration(input *DeleteEdgeConfigurationInput) (*DeleteEdgeConfigurationOutput, error)

DeleteEdgeConfiguration API operation for Amazon Kinesis Video Streams.

An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.

When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion.

When the deletion process has completed successfully, the edge configuration is no longer accessible.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DeleteEdgeConfiguration for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have required permissions to perform this operation.

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

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteEdgeConfiguration

func (*KinesisVideo) DeleteEdgeConfigurationRequest added in v1.44.291 

func (c *KinesisVideo) DeleteEdgeConfigurationRequest(input *DeleteEdgeConfigurationInput) (req *request.Request, output *DeleteEdgeConfigurationOutput)

DeleteEdgeConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteEdgeConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEdgeConfiguration for more information on using the DeleteEdgeConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteEdgeConfigurationRequest method.
req, resp := client.DeleteEdgeConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteEdgeConfiguration

func (*KinesisVideo) DeleteEdgeConfigurationWithContext added in v1.44.291 

func (c *KinesisVideo) DeleteEdgeConfigurationWithContext(ctx aws.Context, input *DeleteEdgeConfigurationInput, opts ...request.Option) (*DeleteEdgeConfigurationOutput, error)

DeleteEdgeConfigurationWithContext is the same as DeleteEdgeConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteEdgeConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DeleteSignalingChannel added in v1.25.48 

func (c *KinesisVideo) DeleteSignalingChannel(input *DeleteSignalingChannelInput) (*DeleteSignalingChannelOutput, error)

DeleteSignalingChannel API operation for Amazon Kinesis Video Streams.

Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DeleteSignalingChannel for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

  • VersionMismatchException 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.

  • ResourceInUseException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteSignalingChannel

func (*KinesisVideo) DeleteSignalingChannelRequest added in v1.25.48 

func (c *KinesisVideo) DeleteSignalingChannelRequest(input *DeleteSignalingChannelInput) (req *request.Request, output *DeleteSignalingChannelOutput)

DeleteSignalingChannelRequest generates a "aws/request.Request" representing the client's request for the DeleteSignalingChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSignalingChannel for more information on using the DeleteSignalingChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSignalingChannelRequest method.
req, resp := client.DeleteSignalingChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteSignalingChannel

func (*KinesisVideo) DeleteSignalingChannelWithContext added in v1.25.48 

func (c *KinesisVideo) DeleteSignalingChannelWithContext(ctx aws.Context, input *DeleteSignalingChannelInput, opts ...request.Option) (*DeleteSignalingChannelOutput, error)

DeleteSignalingChannelWithContext is the same as DeleteSignalingChannel with the addition of the ability to pass a context and additional request options.

See DeleteSignalingChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DeleteStream 

func (c *KinesisVideo) DeleteStream(input *DeleteStreamInput) (*DeleteStreamOutput, error)

DeleteStream API operation for Amazon Kinesis Video Streams.

Deletes a Kinesis video stream and the data contained in the stream.

This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

This operation requires permission for the KinesisVideo:DeleteStream action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DeleteStream for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

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

  • NotAuthorizedException The caller is not authorized to perform this operation.

  • VersionMismatchException 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.

  • ResourceInUseException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteStream

func (*KinesisVideo) DeleteStreamRequest 

func (c *KinesisVideo) DeleteStreamRequest(input *DeleteStreamInput) (req *request.Request, output *DeleteStreamOutput)

DeleteStreamRequest generates a "aws/request.Request" representing the client's request for the DeleteStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStream for more information on using the DeleteStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteStreamRequest method.
req, resp := client.DeleteStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteStream

func (*KinesisVideo) DeleteStreamWithContext 

func (c *KinesisVideo) DeleteStreamWithContext(ctx aws.Context, input *DeleteStreamInput, opts ...request.Option) (*DeleteStreamOutput, error)

DeleteStreamWithContext is the same as DeleteStream with the addition of the ability to pass a context and additional request options.

See DeleteStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeEdgeConfiguration added in v1.44.158 

func (c *KinesisVideo) DescribeEdgeConfiguration(input *DescribeEdgeConfigurationInput) (*DescribeEdgeConfigurationOutput, error)

DescribeEdgeConfiguration API operation for Amazon Kinesis Video Streams.

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DescribeEdgeConfiguration for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have required permissions to perform this operation.

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

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeEdgeConfiguration

func (*KinesisVideo) DescribeEdgeConfigurationRequest added in v1.44.158 

func (c *KinesisVideo) DescribeEdgeConfigurationRequest(input *DescribeEdgeConfigurationInput) (req *request.Request, output *DescribeEdgeConfigurationOutput)

DescribeEdgeConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeEdgeConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEdgeConfiguration for more information on using the DescribeEdgeConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEdgeConfigurationRequest method.
req, resp := client.DescribeEdgeConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeEdgeConfiguration

func (*KinesisVideo) DescribeEdgeConfigurationWithContext added in v1.44.158 

func (c *KinesisVideo) DescribeEdgeConfigurationWithContext(ctx aws.Context, input *DescribeEdgeConfigurationInput, opts ...request.Option) (*DescribeEdgeConfigurationOutput, error)

DescribeEdgeConfigurationWithContext is the same as DescribeEdgeConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeEdgeConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeImageGenerationConfiguration added in v1.44.6 

func (c *KinesisVideo) DescribeImageGenerationConfiguration(input *DescribeImageGenerationConfigurationInput) (*DescribeImageGenerationConfigurationOutput, error)

DescribeImageGenerationConfiguration API operation for Amazon Kinesis Video Streams.

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DescribeImageGenerationConfiguration for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration

func (*KinesisVideo) DescribeImageGenerationConfigurationRequest added in v1.44.6 

func (c *KinesisVideo) DescribeImageGenerationConfigurationRequest(input *DescribeImageGenerationConfigurationInput) (req *request.Request, output *DescribeImageGenerationConfigurationOutput)

DescribeImageGenerationConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeImageGenerationConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeImageGenerationConfiguration for more information on using the DescribeImageGenerationConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeImageGenerationConfigurationRequest method.
req, resp := client.DescribeImageGenerationConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeImageGenerationConfiguration

func (*KinesisVideo) DescribeImageGenerationConfigurationWithContext added in v1.44.6 

func (c *KinesisVideo) DescribeImageGenerationConfigurationWithContext(ctx aws.Context, input *DescribeImageGenerationConfigurationInput, opts ...request.Option) (*DescribeImageGenerationConfigurationOutput, error)

DescribeImageGenerationConfigurationWithContext is the same as DescribeImageGenerationConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeImageGenerationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeMappedResourceConfiguration added in v1.44.163 

func (c *KinesisVideo) DescribeMappedResourceConfiguration(input *DescribeMappedResourceConfigurationInput) (*DescribeMappedResourceConfigurationOutput, error)

DescribeMappedResourceConfiguration API operation for Amazon Kinesis Video Streams.

Returns the most current information about the stream. The streamName or streamARN should be provided in the input.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DescribeMappedResourceConfiguration for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

  • AccessDeniedException You do not have required permissions to perform this operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration

func (*KinesisVideo) DescribeMappedResourceConfigurationPages added in v1.44.163 

func (c *KinesisVideo) DescribeMappedResourceConfigurationPages(input *DescribeMappedResourceConfigurationInput, fn func(*DescribeMappedResourceConfigurationOutput, bool) bool) error

DescribeMappedResourceConfigurationPages iterates over the pages of a DescribeMappedResourceConfiguration operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeMappedResourceConfiguration method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeMappedResourceConfiguration operation.
pageNum := 0
err := client.DescribeMappedResourceConfigurationPages(params,
    func(page *kinesisvideo.DescribeMappedResourceConfigurationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KinesisVideo) DescribeMappedResourceConfigurationPagesWithContext added in v1.44.163 

func (c *KinesisVideo) DescribeMappedResourceConfigurationPagesWithContext(ctx aws.Context, input *DescribeMappedResourceConfigurationInput, fn func(*DescribeMappedResourceConfigurationOutput, bool) bool, opts ...request.Option) error

DescribeMappedResourceConfigurationPagesWithContext same as DescribeMappedResourceConfigurationPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeMappedResourceConfigurationRequest added in v1.44.163 

func (c *KinesisVideo) DescribeMappedResourceConfigurationRequest(input *DescribeMappedResourceConfigurationInput) (req *request.Request, output *DescribeMappedResourceConfigurationOutput)

DescribeMappedResourceConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeMappedResourceConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMappedResourceConfiguration for more information on using the DescribeMappedResourceConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeMappedResourceConfigurationRequest method.
req, resp := client.DescribeMappedResourceConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeMappedResourceConfiguration

func (*KinesisVideo) DescribeMappedResourceConfigurationWithContext added in v1.44.163 

func (c *KinesisVideo) DescribeMappedResourceConfigurationWithContext(ctx aws.Context, input *DescribeMappedResourceConfigurationInput, opts ...request.Option) (*DescribeMappedResourceConfigurationOutput, error)

DescribeMappedResourceConfigurationWithContext is the same as DescribeMappedResourceConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeMappedResourceConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeMediaStorageConfiguration added in v1.44.163 

func (c *KinesisVideo) DescribeMediaStorageConfiguration(input *DescribeMediaStorageConfigurationInput) (*DescribeMediaStorageConfigurationOutput, error)

DescribeMediaStorageConfiguration API operation for Amazon Kinesis Video Streams.

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DescribeMediaStorageConfiguration for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

  • AccessDeniedException You do not have required permissions to perform this operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration

func (*KinesisVideo) DescribeMediaStorageConfigurationRequest added in v1.44.163 

func (c *KinesisVideo) DescribeMediaStorageConfigurationRequest(input *DescribeMediaStorageConfigurationInput) (req *request.Request, output *DescribeMediaStorageConfigurationOutput)

DescribeMediaStorageConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeMediaStorageConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeMediaStorageConfiguration for more information on using the DescribeMediaStorageConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeMediaStorageConfigurationRequest method.
req, resp := client.DescribeMediaStorageConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeMediaStorageConfiguration

func (*KinesisVideo) DescribeMediaStorageConfigurationWithContext added in v1.44.163 

func (c *KinesisVideo) DescribeMediaStorageConfigurationWithContext(ctx aws.Context, input *DescribeMediaStorageConfigurationInput, opts ...request.Option) (*DescribeMediaStorageConfigurationOutput, error)

DescribeMediaStorageConfigurationWithContext is the same as DescribeMediaStorageConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeMediaStorageConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeNotificationConfiguration added in v1.44.6 

func (c *KinesisVideo) DescribeNotificationConfiguration(input *DescribeNotificationConfigurationInput) (*DescribeNotificationConfigurationOutput, error)

DescribeNotificationConfiguration API operation for Amazon Kinesis Video Streams.

Gets the NotificationConfiguration for a given Kinesis video stream.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DescribeNotificationConfiguration for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeNotificationConfiguration

func (*KinesisVideo) DescribeNotificationConfigurationRequest added in v1.44.6 

func (c *KinesisVideo) DescribeNotificationConfigurationRequest(input *DescribeNotificationConfigurationInput) (req *request.Request, output *DescribeNotificationConfigurationOutput)

DescribeNotificationConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeNotificationConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeNotificationConfiguration for more information on using the DescribeNotificationConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeNotificationConfigurationRequest method.
req, resp := client.DescribeNotificationConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeNotificationConfiguration

func (*KinesisVideo) DescribeNotificationConfigurationWithContext added in v1.44.6 

func (c *KinesisVideo) DescribeNotificationConfigurationWithContext(ctx aws.Context, input *DescribeNotificationConfigurationInput, opts ...request.Option) (*DescribeNotificationConfigurationOutput, error)

DescribeNotificationConfigurationWithContext is the same as DescribeNotificationConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeNotificationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeSignalingChannel added in v1.25.48 

func (c *KinesisVideo) DescribeSignalingChannel(input *DescribeSignalingChannelInput) (*DescribeSignalingChannelOutput, error)

DescribeSignalingChannel API operation for Amazon Kinesis Video Streams.

Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DescribeSignalingChannel for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeSignalingChannel

func (*KinesisVideo) DescribeSignalingChannelRequest added in v1.25.48 

func (c *KinesisVideo) DescribeSignalingChannelRequest(input *DescribeSignalingChannelInput) (req *request.Request, output *DescribeSignalingChannelOutput)

DescribeSignalingChannelRequest generates a "aws/request.Request" representing the client's request for the DescribeSignalingChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSignalingChannel for more information on using the DescribeSignalingChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeSignalingChannelRequest method.
req, resp := client.DescribeSignalingChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeSignalingChannel

func (*KinesisVideo) DescribeSignalingChannelWithContext added in v1.25.48 

func (c *KinesisVideo) DescribeSignalingChannelWithContext(ctx aws.Context, input *DescribeSignalingChannelInput, opts ...request.Option) (*DescribeSignalingChannelOutput, error)

DescribeSignalingChannelWithContext is the same as DescribeSignalingChannel with the addition of the ability to pass a context and additional request options.

See DescribeSignalingChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeStream 

func (c *KinesisVideo) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error)

DescribeStream API operation for Amazon Kinesis Video Streams.

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DescribeStream for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • NotAuthorizedException The caller is not authorized to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeStream

func (*KinesisVideo) DescribeStreamRequest 

func (c *KinesisVideo) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput)

DescribeStreamRequest generates a "aws/request.Request" representing the client's request for the DescribeStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStream for more information on using the DescribeStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStreamRequest method.
req, resp := client.DescribeStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeStream

func (*KinesisVideo) DescribeStreamWithContext 

func (c *KinesisVideo) DescribeStreamWithContext(ctx aws.Context, input *DescribeStreamInput, opts ...request.Option) (*DescribeStreamOutput, error)

DescribeStreamWithContext is the same as DescribeStream with the addition of the ability to pass a context and additional request options.

See DescribeStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) GetDataEndpoint 

func (c *KinesisVideo) GetDataEndpoint(input *GetDataEndpointInput) (*GetDataEndpointOutput, error)

GetDataEndpoint API operation for Amazon Kinesis Video Streams.

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

In the request, specify the stream either by StreamName or StreamARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation GetDataEndpoint for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • NotAuthorizedException The caller is not authorized to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetDataEndpoint

func (*KinesisVideo) GetDataEndpointRequest 

func (c *KinesisVideo) GetDataEndpointRequest(input *GetDataEndpointInput) (req *request.Request, output *GetDataEndpointOutput)

GetDataEndpointRequest generates a "aws/request.Request" representing the client's request for the GetDataEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDataEndpoint for more information on using the GetDataEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDataEndpointRequest method.
req, resp := client.GetDataEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetDataEndpoint

func (*KinesisVideo) GetDataEndpointWithContext 

func (c *KinesisVideo) GetDataEndpointWithContext(ctx aws.Context, input *GetDataEndpointInput, opts ...request.Option) (*GetDataEndpointOutput, error)

GetDataEndpointWithContext is the same as GetDataEndpoint with the addition of the ability to pass a context and additional request options.

See GetDataEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) GetSignalingChannelEndpoint added in v1.25.48 

func (c *KinesisVideo) GetSignalingChannelEndpoint(input *GetSignalingChannelEndpointInput) (*GetSignalingChannelEndpointOutput, error)

GetSignalingChannelEndpoint API operation for Amazon Kinesis Video Streams.

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation GetSignalingChannelEndpoint for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • ResourceInUseException 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.

  • AccessDeniedException You do not have required permissions to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint

func (*KinesisVideo) GetSignalingChannelEndpointRequest added in v1.25.48 

func (c *KinesisVideo) GetSignalingChannelEndpointRequest(input *GetSignalingChannelEndpointInput) (req *request.Request, output *GetSignalingChannelEndpointOutput)

GetSignalingChannelEndpointRequest generates a "aws/request.Request" representing the client's request for the GetSignalingChannelEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSignalingChannelEndpoint for more information on using the GetSignalingChannelEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetSignalingChannelEndpointRequest method.
req, resp := client.GetSignalingChannelEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetSignalingChannelEndpoint

func (*KinesisVideo) GetSignalingChannelEndpointWithContext added in v1.25.48 

func (c *KinesisVideo) GetSignalingChannelEndpointWithContext(ctx aws.Context, input *GetSignalingChannelEndpointInput, opts ...request.Option) (*GetSignalingChannelEndpointOutput, error)

GetSignalingChannelEndpointWithContext is the same as GetSignalingChannelEndpoint with the addition of the ability to pass a context and additional request options.

See GetSignalingChannelEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListEdgeAgentConfigurations added in v1.44.291 

func (c *KinesisVideo) ListEdgeAgentConfigurations(input *ListEdgeAgentConfigurationsInput) (*ListEdgeAgentConfigurationsOutput, error)

ListEdgeAgentConfigurations API operation for Amazon Kinesis Video Streams.

Returns an array of edge configurations associated with the specified Edge Agent.

In the request, you must specify the Edge Agent HubDeviceArn.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation ListEdgeAgentConfigurations for usage and error information.

Returned Error Types:

  • NotAuthorizedException The caller is not authorized to perform this operation.

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

  • InvalidArgumentException The value for this input parameter is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations

func (*KinesisVideo) ListEdgeAgentConfigurationsPages added in v1.44.291 

func (c *KinesisVideo) ListEdgeAgentConfigurationsPages(input *ListEdgeAgentConfigurationsInput, fn func(*ListEdgeAgentConfigurationsOutput, bool) bool) error

ListEdgeAgentConfigurationsPages iterates over the pages of a ListEdgeAgentConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEdgeAgentConfigurations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListEdgeAgentConfigurations operation.
pageNum := 0
err := client.ListEdgeAgentConfigurationsPages(params,
    func(page *kinesisvideo.ListEdgeAgentConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KinesisVideo) ListEdgeAgentConfigurationsPagesWithContext added in v1.44.291 

func (c *KinesisVideo) ListEdgeAgentConfigurationsPagesWithContext(ctx aws.Context, input *ListEdgeAgentConfigurationsInput, fn func(*ListEdgeAgentConfigurationsOutput, bool) bool, opts ...request.Option) error

ListEdgeAgentConfigurationsPagesWithContext same as ListEdgeAgentConfigurationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListEdgeAgentConfigurationsRequest added in v1.44.291 

func (c *KinesisVideo) ListEdgeAgentConfigurationsRequest(input *ListEdgeAgentConfigurationsInput) (req *request.Request, output *ListEdgeAgentConfigurationsOutput)

ListEdgeAgentConfigurationsRequest generates a "aws/request.Request" representing the client's request for the ListEdgeAgentConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEdgeAgentConfigurations for more information on using the ListEdgeAgentConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEdgeAgentConfigurationsRequest method.
req, resp := client.ListEdgeAgentConfigurationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListEdgeAgentConfigurations

func (*KinesisVideo) ListEdgeAgentConfigurationsWithContext added in v1.44.291 

func (c *KinesisVideo) ListEdgeAgentConfigurationsWithContext(ctx aws.Context, input *ListEdgeAgentConfigurationsInput, opts ...request.Option) (*ListEdgeAgentConfigurationsOutput, error)

ListEdgeAgentConfigurationsWithContext is the same as ListEdgeAgentConfigurations with the addition of the ability to pass a context and additional request options.

See ListEdgeAgentConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListSignalingChannels added in v1.25.48 

func (c *KinesisVideo) ListSignalingChannels(input *ListSignalingChannelsInput) (*ListSignalingChannelsOutput, error)

ListSignalingChannels API operation for Amazon Kinesis Video Streams.

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation ListSignalingChannels for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

  • AccessDeniedException You do not have required permissions to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListSignalingChannels

func (*KinesisVideo) ListSignalingChannelsPages added in v1.25.48 

func (c *KinesisVideo) ListSignalingChannelsPages(input *ListSignalingChannelsInput, fn func(*ListSignalingChannelsOutput, bool) bool) error

ListSignalingChannelsPages iterates over the pages of a ListSignalingChannels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSignalingChannels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListSignalingChannels operation.
pageNum := 0
err := client.ListSignalingChannelsPages(params,
    func(page *kinesisvideo.ListSignalingChannelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KinesisVideo) ListSignalingChannelsPagesWithContext added in v1.25.48 

func (c *KinesisVideo) ListSignalingChannelsPagesWithContext(ctx aws.Context, input *ListSignalingChannelsInput, fn func(*ListSignalingChannelsOutput, bool) bool, opts ...request.Option) error

ListSignalingChannelsPagesWithContext same as ListSignalingChannelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListSignalingChannelsRequest added in v1.25.48 

func (c *KinesisVideo) ListSignalingChannelsRequest(input *ListSignalingChannelsInput) (req *request.Request, output *ListSignalingChannelsOutput)

ListSignalingChannelsRequest generates a "aws/request.Request" representing the client's request for the ListSignalingChannels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSignalingChannels for more information on using the ListSignalingChannels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListSignalingChannelsRequest method.
req, resp := client.ListSignalingChannelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListSignalingChannels

func (*KinesisVideo) ListSignalingChannelsWithContext added in v1.25.48 

func (c *KinesisVideo) ListSignalingChannelsWithContext(ctx aws.Context, input *ListSignalingChannelsInput, opts ...request.Option) (*ListSignalingChannelsOutput, error)

ListSignalingChannelsWithContext is the same as ListSignalingChannels with the addition of the ability to pass a context and additional request options.

See ListSignalingChannels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListStreams 

func (c *KinesisVideo) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error)

ListStreams API operation for Amazon Kinesis Video Streams.

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation ListStreams for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListStreams

func (*KinesisVideo) ListStreamsPages added in v1.20.17 

func (c *KinesisVideo) ListStreamsPages(input *ListStreamsInput, fn func(*ListStreamsOutput, bool) bool) error

ListStreamsPages iterates over the pages of a ListStreams operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStreams method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStreams operation.
pageNum := 0
err := client.ListStreamsPages(params,
    func(page *kinesisvideo.ListStreamsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KinesisVideo) ListStreamsPagesWithContext added in v1.20.17 

func (c *KinesisVideo) ListStreamsPagesWithContext(ctx aws.Context, input *ListStreamsInput, fn func(*ListStreamsOutput, bool) bool, opts ...request.Option) error

ListStreamsPagesWithContext same as ListStreamsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListStreamsRequest 

func (c *KinesisVideo) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput)

ListStreamsRequest generates a "aws/request.Request" representing the client's request for the ListStreams operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStreams for more information on using the ListStreams API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStreamsRequest method.
req, resp := client.ListStreamsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListStreams

func (*KinesisVideo) ListStreamsWithContext 

func (c *KinesisVideo) ListStreamsWithContext(ctx aws.Context, input *ListStreamsInput, opts ...request.Option) (*ListStreamsOutput, error)

ListStreamsWithContext is the same as ListStreams with the addition of the ability to pass a context and additional request options.

See ListStreams for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListTagsForResource added in v1.25.48 

func (c *KinesisVideo) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Kinesis Video Streams.

Returns a list of tags associated with the specified signaling channel.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForResource

func (*KinesisVideo) ListTagsForResourceRequest added in v1.25.48 

func (c *KinesisVideo) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForResource

func (*KinesisVideo) ListTagsForResourceWithContext added in v1.25.48 

func (c *KinesisVideo) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListTagsForStream 

func (c *KinesisVideo) ListTagsForStream(input *ListTagsForStreamInput) (*ListTagsForStreamOutput, error)

ListTagsForStream API operation for Amazon Kinesis Video Streams.

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation ListTagsForStream for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

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

  • NotAuthorizedException The caller is not authorized to perform this operation.

  • InvalidResourceFormatException The format of the StreamARN is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForStream

func (*KinesisVideo) ListTagsForStreamRequest 

func (c *KinesisVideo) ListTagsForStreamRequest(input *ListTagsForStreamInput) (req *request.Request, output *ListTagsForStreamOutput)

ListTagsForStreamRequest generates a "aws/request.Request" representing the client's request for the ListTagsForStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForStream for more information on using the ListTagsForStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForStreamRequest method.
req, resp := client.ListTagsForStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForStream

func (*KinesisVideo) ListTagsForStreamWithContext 

func (c *KinesisVideo) ListTagsForStreamWithContext(ctx aws.Context, input *ListTagsForStreamInput, opts ...request.Option) (*ListTagsForStreamOutput, error)

ListTagsForStreamWithContext is the same as ListTagsForStream with the addition of the ability to pass a context and additional request options.

See ListTagsForStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) StartEdgeConfigurationUpdate added in v1.44.158 

func (c *KinesisVideo) StartEdgeConfigurationUpdate(input *StartEdgeConfigurationUpdateInput) (*StartEdgeConfigurationUpdateOutput, error)

StartEdgeConfigurationUpdate API operation for Amazon Kinesis Video Streams.

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation StartEdgeConfigurationUpdate for usage and error information.

Returned Error Types:

  • AccessDeniedException You do not have required permissions to perform this operation.

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

  • InvalidArgumentException The value for this input parameter is invalid.

  • NoDataRetentionException The Stream data retention in hours is equal to zero.

  • ResourceInUseException 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate

func (*KinesisVideo) StartEdgeConfigurationUpdateRequest added in v1.44.158 

func (c *KinesisVideo) StartEdgeConfigurationUpdateRequest(input *StartEdgeConfigurationUpdateInput) (req *request.Request, output *StartEdgeConfigurationUpdateOutput)

StartEdgeConfigurationUpdateRequest generates a "aws/request.Request" representing the client's request for the StartEdgeConfigurationUpdate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartEdgeConfigurationUpdate for more information on using the StartEdgeConfigurationUpdate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartEdgeConfigurationUpdateRequest method.
req, resp := client.StartEdgeConfigurationUpdateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StartEdgeConfigurationUpdate

func (*KinesisVideo) StartEdgeConfigurationUpdateWithContext added in v1.44.158 

func (c *KinesisVideo) StartEdgeConfigurationUpdateWithContext(ctx aws.Context, input *StartEdgeConfigurationUpdateInput, opts ...request.Option) (*StartEdgeConfigurationUpdateOutput, error)

StartEdgeConfigurationUpdateWithContext is the same as StartEdgeConfigurationUpdate with the addition of the ability to pass a context and additional request options.

See StartEdgeConfigurationUpdate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) TagResource added in v1.25.48 

func (c *KinesisVideo) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Kinesis Video Streams.

Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the Billing and Cost Management and Cost Management User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation TagResource for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagResource

func (*KinesisVideo) TagResourceRequest added in v1.25.48 

func (c *KinesisVideo) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagResource

func (*KinesisVideo) TagResourceWithContext added in v1.25.48 

func (c *KinesisVideo) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) TagStream 

func (c *KinesisVideo) TagStream(input *TagStreamInput) (*TagStreamOutput, error)

TagStream API operation for Amazon Kinesis Video Streams.

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the Billing and Cost Management and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

A Kinesis video stream can support up to 50 tags.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation TagStream for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

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

  • NotAuthorizedException The caller is not authorized to perform this operation.

  • InvalidResourceFormatException The format of the StreamARN is invalid.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagStream

func (*KinesisVideo) TagStreamRequest 

func (c *KinesisVideo) TagStreamRequest(input *TagStreamInput) (req *request.Request, output *TagStreamOutput)

TagStreamRequest generates a "aws/request.Request" representing the client's request for the TagStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagStream for more information on using the TagStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagStreamRequest method.
req, resp := client.TagStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagStream

func (*KinesisVideo) TagStreamWithContext 

func (c *KinesisVideo) TagStreamWithContext(ctx aws.Context, input *TagStreamInput, opts ...request.Option) (*TagStreamOutput, error)

TagStreamWithContext is the same as TagStream with the addition of the ability to pass a context and additional request options.

See TagStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UntagResource added in v1.25.48 

func (c *KinesisVideo) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Kinesis Video Streams.

Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UntagResource for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagResource

func (*KinesisVideo) UntagResourceRequest added in v1.25.48 

func (c *KinesisVideo) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagResource

func (*KinesisVideo) UntagResourceWithContext added in v1.25.48 

func (c *KinesisVideo) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UntagStream 

func (c *KinesisVideo) UntagStream(input *UntagStreamInput) (*UntagStreamOutput, error)

UntagStream API operation for Amazon Kinesis Video Streams.

Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

In the request, you must provide the StreamName or StreamARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UntagStream for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

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

  • NotAuthorizedException The caller is not authorized to perform this operation.

  • InvalidResourceFormatException The format of the StreamARN is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagStream

func (*KinesisVideo) UntagStreamRequest 

func (c *KinesisVideo) UntagStreamRequest(input *UntagStreamInput) (req *request.Request, output *UntagStreamOutput)

UntagStreamRequest generates a "aws/request.Request" representing the client's request for the UntagStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagStream for more information on using the UntagStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagStreamRequest method.
req, resp := client.UntagStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagStream

func (*KinesisVideo) UntagStreamWithContext 

func (c *KinesisVideo) UntagStreamWithContext(ctx aws.Context, input *UntagStreamInput, opts ...request.Option) (*UntagStreamOutput, error)

UntagStreamWithContext is the same as UntagStream with the addition of the ability to pass a context and additional request options.

See UntagStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UpdateDataRetention 

func (c *KinesisVideo) UpdateDataRetention(input *UpdateDataRetentionInput) (*UpdateDataRetentionOutput, error)

UpdateDataRetention API operation for Amazon Kinesis Video Streams.

Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

  • If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.

  • If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UpdateDataRetention for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

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

  • ResourceInUseException 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.

  • NotAuthorizedException The caller is not authorized to perform this operation.

  • VersionMismatchException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateDataRetention

func (*KinesisVideo) UpdateDataRetentionRequest 

func (c *KinesisVideo) UpdateDataRetentionRequest(input *UpdateDataRetentionInput) (req *request.Request, output *UpdateDataRetentionOutput)

UpdateDataRetentionRequest generates a "aws/request.Request" representing the client's request for the UpdateDataRetention operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDataRetention for more information on using the UpdateDataRetention API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateDataRetentionRequest method.
req, resp := client.UpdateDataRetentionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateDataRetention

func (*KinesisVideo) UpdateDataRetentionWithContext 

func (c *KinesisVideo) UpdateDataRetentionWithContext(ctx aws.Context, input *UpdateDataRetentionInput, opts ...request.Option) (*UpdateDataRetentionOutput, error)

UpdateDataRetentionWithContext is the same as UpdateDataRetention with the addition of the ability to pass a context and additional request options.

See UpdateDataRetention for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UpdateImageGenerationConfiguration added in v1.44.6 

func (c *KinesisVideo) UpdateImageGenerationConfiguration(input *UpdateImageGenerationConfigurationInput) (*UpdateImageGenerationConfigurationOutput, error)

UpdateImageGenerationConfiguration API operation for Amazon Kinesis Video Streams.

Updates the StreamInfo and ImageProcessingConfiguration fields.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UpdateImageGenerationConfiguration for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

  • ResourceInUseException 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.

  • NoDataRetentionException The Stream data retention in hours is equal to zero.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration

func (*KinesisVideo) UpdateImageGenerationConfigurationRequest added in v1.44.6 

func (c *KinesisVideo) UpdateImageGenerationConfigurationRequest(input *UpdateImageGenerationConfigurationInput) (req *request.Request, output *UpdateImageGenerationConfigurationOutput)

UpdateImageGenerationConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateImageGenerationConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateImageGenerationConfiguration for more information on using the UpdateImageGenerationConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateImageGenerationConfigurationRequest method.
req, resp := client.UpdateImageGenerationConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateImageGenerationConfiguration

func (*KinesisVideo) UpdateImageGenerationConfigurationWithContext added in v1.44.6 

func (c *KinesisVideo) UpdateImageGenerationConfigurationWithContext(ctx aws.Context, input *UpdateImageGenerationConfigurationInput, opts ...request.Option) (*UpdateImageGenerationConfigurationOutput, error)

UpdateImageGenerationConfigurationWithContext is the same as UpdateImageGenerationConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateImageGenerationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UpdateMediaStorageConfiguration added in v1.44.163 

func (c *KinesisVideo) UpdateMediaStorageConfiguration(input *UpdateMediaStorageConfigurationInput) (*UpdateMediaStorageConfigurationOutput, error)

UpdateMediaStorageConfiguration API operation for Amazon Kinesis Video Streams.

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you can specify :

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

If StorageStatus is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession API to trigger an SDP offer send and establish a connection between a peer and the storage session.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UpdateMediaStorageConfiguration for usage and error information.

Returned Error Types:

  • ResourceInUseException 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.

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

  • NoDataRetentionException The Stream data retention in hours is equal to zero.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration

func (*KinesisVideo) UpdateMediaStorageConfigurationRequest added in v1.44.163 

func (c *KinesisVideo) UpdateMediaStorageConfigurationRequest(input *UpdateMediaStorageConfigurationInput) (req *request.Request, output *UpdateMediaStorageConfigurationOutput)

UpdateMediaStorageConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateMediaStorageConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateMediaStorageConfiguration for more information on using the UpdateMediaStorageConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateMediaStorageConfigurationRequest method.
req, resp := client.UpdateMediaStorageConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateMediaStorageConfiguration

func (*KinesisVideo) UpdateMediaStorageConfigurationWithContext added in v1.44.163 

func (c *KinesisVideo) UpdateMediaStorageConfigurationWithContext(ctx aws.Context, input *UpdateMediaStorageConfigurationInput, opts ...request.Option) (*UpdateMediaStorageConfigurationOutput, error)

UpdateMediaStorageConfigurationWithContext is the same as UpdateMediaStorageConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateMediaStorageConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UpdateNotificationConfiguration added in v1.44.6 

func (c *KinesisVideo) UpdateNotificationConfiguration(input *UpdateNotificationConfigurationInput) (*UpdateNotificationConfigurationOutput, error)

UpdateNotificationConfiguration API operation for Amazon Kinesis Video Streams.

Updates the notification information for a stream.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UpdateNotificationConfiguration for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • AccessDeniedException You do not have required permissions to perform this operation.

  • ResourceInUseException 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.

  • NoDataRetentionException The Stream data retention in hours is equal to zero.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateNotificationConfiguration

func (*KinesisVideo) UpdateNotificationConfigurationRequest added in v1.44.6 

func (c *KinesisVideo) UpdateNotificationConfigurationRequest(input *UpdateNotificationConfigurationInput) (req *request.Request, output *UpdateNotificationConfigurationOutput)

UpdateNotificationConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateNotificationConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNotificationConfiguration for more information on using the UpdateNotificationConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateNotificationConfigurationRequest method.
req, resp := client.UpdateNotificationConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateNotificationConfiguration

func (*KinesisVideo) UpdateNotificationConfigurationWithContext added in v1.44.6 

func (c *KinesisVideo) UpdateNotificationConfigurationWithContext(ctx aws.Context, input *UpdateNotificationConfigurationInput, opts ...request.Option) (*UpdateNotificationConfigurationOutput, error)

UpdateNotificationConfigurationWithContext is the same as UpdateNotificationConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateNotificationConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UpdateSignalingChannel added in v1.25.48 

func (c *KinesisVideo) UpdateSignalingChannel(input *UpdateSignalingChannelInput) (*UpdateSignalingChannelOutput, error)

UpdateSignalingChannel API operation for Amazon Kinesis Video Streams.

Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UpdateSignalingChannel for usage and error information.

Returned Error Types:

  • InvalidArgumentException The value for this input parameter is invalid.

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

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

  • ResourceInUseException 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.

  • AccessDeniedException You do not have required permissions to perform this operation.

  • VersionMismatchException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateSignalingChannel

func (*KinesisVideo) UpdateSignalingChannelRequest added in v1.25.48 

func (c *KinesisVideo) UpdateSignalingChannelRequest(input *UpdateSignalingChannelInput) (req *request.Request, output *UpdateSignalingChannelOutput)

UpdateSignalingChannelRequest generates a "aws/request.Request" representing the client's request for the UpdateSignalingChannel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSignalingChannel for more information on using the UpdateSignalingChannel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateSignalingChannelRequest method.
req, resp := client.UpdateSignalingChannelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateSignalingChannel

func (*KinesisVideo) UpdateSignalingChannelWithContext added in v1.25.48 

func (c *KinesisVideo) UpdateSignalingChannelWithContext(ctx aws.Context, input *UpdateSignalingChannelInput, opts ...request.Option) (*UpdateSignalingChannelOutput, error)

UpdateSignalingChannelWithContext is the same as UpdateSignalingChannel with the addition of the ability to pass a context and additional request options.

See UpdateSignalingChannel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UpdateStream 

func (c *KinesisVideo) UpdateStream(input *UpdateStreamInput) (*UpdateStreamOutput, error)

UpdateStream API operation for Amazon Kinesis Video Streams.

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

UpdateStream is an asynchronous operation, and takes time to complete.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UpdateStream for usage and error information.

Returned Error Types:

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

  • InvalidArgumentException The value for this input parameter is invalid.

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

  • ResourceInUseException 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.

  • NotAuthorizedException The caller is not authorized to perform this operation.

  • VersionMismatchException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateStream

func (*KinesisVideo) UpdateStreamRequest 

func (c *KinesisVideo) UpdateStreamRequest(input *UpdateStreamInput) (req *request.Request, output *UpdateStreamOutput)

UpdateStreamRequest generates a "aws/request.Request" representing the client's request for the UpdateStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStream for more information on using the UpdateStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateStreamRequest method.
req, resp := client.UpdateStreamRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateStream

func (*KinesisVideo) UpdateStreamWithContext 

func (c *KinesisVideo) UpdateStreamWithContext(ctx aws.Context, input *UpdateStreamInput, opts ...request.Option) (*UpdateStreamOutput, error)

UpdateStreamWithContext is the same as UpdateStream with the addition of the ability to pass a context and additional request options.

See UpdateStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type LastRecorderStatus added in v1.44.291 

type LastRecorderStatus struct {

	// A description of a recorder job’s latest status.
	JobStatusDetails *string `type:"string"`

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

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

	// The status of the latest recorder job.
	RecorderStatus *string `type:"string" enum:"RecorderStatus"`
	// contains filtered or unexported fields
}

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

func (LastRecorderStatus) GoString added in v1.44.291 

func (s LastRecorderStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LastRecorderStatus) SetJobStatusDetails added in v1.44.291 

func (s *LastRecorderStatus) SetJobStatusDetails(v string) *LastRecorderStatus

SetJobStatusDetails sets the JobStatusDetails field's value.

func (*LastRecorderStatus) SetLastCollectedTime added in v1.44.291 

func (s *LastRecorderStatus) SetLastCollectedTime(v time.Time) *LastRecorderStatus

SetLastCollectedTime sets the LastCollectedTime field's value.

func (*LastRecorderStatus) SetLastUpdatedTime added in v1.44.291 

func (s *LastRecorderStatus) SetLastUpdatedTime(v time.Time) *LastRecorderStatus

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*LastRecorderStatus) SetRecorderStatus added in v1.44.291 

func (s *LastRecorderStatus) SetRecorderStatus(v string) *LastRecorderStatus

SetRecorderStatus sets the RecorderStatus field's value.

func (LastRecorderStatus) String added in v1.44.291 

func (s LastRecorderStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LastUploaderStatus added in v1.44.291 

type LastUploaderStatus struct {

	// A description of an uploader job’s latest status.
	JobStatusDetails *string `type:"string"`

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

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

	// The status of the latest uploader job.
	UploaderStatus *string `type:"string" enum:"UploaderStatus"`
	// contains filtered or unexported fields
}

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

func (LastUploaderStatus) GoString added in v1.44.291 

func (s LastUploaderStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LastUploaderStatus) SetJobStatusDetails added in v1.44.291 

func (s *LastUploaderStatus) SetJobStatusDetails(v string) *LastUploaderStatus

SetJobStatusDetails sets the JobStatusDetails field's value.

func (*LastUploaderStatus) SetLastCollectedTime added in v1.44.291 

func (s *LastUploaderStatus) SetLastCollectedTime(v time.Time) *LastUploaderStatus

SetLastCollectedTime sets the LastCollectedTime field's value.

func (*LastUploaderStatus) SetLastUpdatedTime added in v1.44.291 

func (s *LastUploaderStatus) SetLastUpdatedTime(v time.Time) *LastUploaderStatus

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*LastUploaderStatus) SetUploaderStatus added in v1.44.291 

func (s *LastUploaderStatus) SetUploaderStatus(v string) *LastUploaderStatus

SetUploaderStatus sets the UploaderStatus field's value.

func (LastUploaderStatus) String added in v1.44.291 

func (s LastUploaderStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEdgeAgentConfigurationsEdgeConfig added in v1.44.291 

type ListEdgeAgentConfigurationsEdgeConfig struct {

	// The timestamp when the stream first created the edge config.
	CreationTime *time.Time `type:"timestamp"`

	// 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 `type:"structure"`

	// A description of the generated failure status.
	FailedStatusDetails *string `type:"string"`

	// The timestamp when the stream last updated the edge config.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream.
	StreamName *string `min:"1" type:"string"`

	// The current sync status of the stream's edge configuration.
	SyncStatus *string `type:"string" enum:"SyncStatus"`
	// contains filtered or unexported fields
}

A description of a single stream's edge configuration.

func (ListEdgeAgentConfigurationsEdgeConfig) GoString added in v1.44.291 

func (s ListEdgeAgentConfigurationsEdgeConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEdgeAgentConfigurationsEdgeConfig) SetCreationTime added in v1.44.291 

func (s *ListEdgeAgentConfigurationsEdgeConfig) SetCreationTime(v time.Time) *ListEdgeAgentConfigurationsEdgeConfig

SetCreationTime sets the CreationTime field's value.

func (*ListEdgeAgentConfigurationsEdgeConfig) SetEdgeConfig added in v1.44.291 

func (s *ListEdgeAgentConfigurationsEdgeConfig) SetEdgeConfig(v *EdgeConfig) *ListEdgeAgentConfigurationsEdgeConfig

SetEdgeConfig sets the EdgeConfig field's value.

func (*ListEdgeAgentConfigurationsEdgeConfig) SetFailedStatusDetails added in v1.44.291 

func (s *ListEdgeAgentConfigurationsEdgeConfig) SetFailedStatusDetails(v string) *ListEdgeAgentConfigurationsEdgeConfig

SetFailedStatusDetails sets the FailedStatusDetails field's value.

func (*ListEdgeAgentConfigurationsEdgeConfig) SetLastUpdatedTime added in v1.44.291 

func (s *ListEdgeAgentConfigurationsEdgeConfig) SetLastUpdatedTime(v time.Time) *ListEdgeAgentConfigurationsEdgeConfig

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*ListEdgeAgentConfigurationsEdgeConfig) SetStreamARN added in v1.44.291 

func (s *ListEdgeAgentConfigurationsEdgeConfig) SetStreamARN(v string) *ListEdgeAgentConfigurationsEdgeConfig

SetStreamARN sets the StreamARN field's value.

func (*ListEdgeAgentConfigurationsEdgeConfig) SetStreamName added in v1.44.291 

func (s *ListEdgeAgentConfigurationsEdgeConfig) SetStreamName(v string) *ListEdgeAgentConfigurationsEdgeConfig

SetStreamName sets the StreamName field's value.

func (*ListEdgeAgentConfigurationsEdgeConfig) SetSyncStatus added in v1.44.291 

func (s *ListEdgeAgentConfigurationsEdgeConfig) SetSyncStatus(v string) *ListEdgeAgentConfigurationsEdgeConfig

SetSyncStatus sets the SyncStatus field's value.

func (ListEdgeAgentConfigurationsEdgeConfig) String added in v1.44.291 

func (s ListEdgeAgentConfigurationsEdgeConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEdgeAgentConfigurationsInput added in v1.44.291 

type ListEdgeAgentConfigurationsInput struct {

	// The "Internet of Things (IoT) Thing" Arn of the edge agent.
	//
	// HubDeviceArn is a required field
	HubDeviceArn *string `min:"1" type:"string" required:"true"`

	// The maximum number of edge configurations to return in the response. The
	// default is 5.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you specify this parameter, when the result of a ListEdgeAgentConfigurations
	// operation is truncated, the call returns the NextToken in the response. To
	// get another batch of edge configurations, provide this token in your next
	// request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListEdgeAgentConfigurationsInput) GoString added in v1.44.291 

func (s ListEdgeAgentConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEdgeAgentConfigurationsInput) SetHubDeviceArn added in v1.44.291 

func (s *ListEdgeAgentConfigurationsInput) SetHubDeviceArn(v string) *ListEdgeAgentConfigurationsInput

SetHubDeviceArn sets the HubDeviceArn field's value.

func (*ListEdgeAgentConfigurationsInput) SetMaxResults added in v1.44.291 

func (s *ListEdgeAgentConfigurationsInput) SetMaxResults(v int64) *ListEdgeAgentConfigurationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEdgeAgentConfigurationsInput) SetNextToken added in v1.44.291 

func (s *ListEdgeAgentConfigurationsInput) SetNextToken(v string) *ListEdgeAgentConfigurationsInput

SetNextToken sets the NextToken field's value.

func (ListEdgeAgentConfigurationsInput) String added in v1.44.291 

func (s ListEdgeAgentConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEdgeAgentConfigurationsInput) Validate added in v1.44.291 

func (s *ListEdgeAgentConfigurationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEdgeAgentConfigurationsOutput added in v1.44.291 

type ListEdgeAgentConfigurationsOutput struct {

	// A description of a single stream's edge configuration.
	EdgeConfigs []*ListEdgeAgentConfigurationsEdgeConfig `type:"list"`

	// If the response is truncated, the call returns this element with a given
	// token. To get the next batch of edge configurations, use this token in your
	// next request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListEdgeAgentConfigurationsOutput) GoString added in v1.44.291 

func (s ListEdgeAgentConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEdgeAgentConfigurationsOutput) SetEdgeConfigs added in v1.44.291 

func (s *ListEdgeAgentConfigurationsOutput) SetEdgeConfigs(v []*ListEdgeAgentConfigurationsEdgeConfig) *ListEdgeAgentConfigurationsOutput

SetEdgeConfigs sets the EdgeConfigs field's value.

func (*ListEdgeAgentConfigurationsOutput) SetNextToken added in v1.44.291 

func (s *ListEdgeAgentConfigurationsOutput) SetNextToken(v string) *ListEdgeAgentConfigurationsOutput

SetNextToken sets the NextToken field's value.

func (ListEdgeAgentConfigurationsOutput) String added in v1.44.291 

func (s ListEdgeAgentConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSignalingChannelsInput added in v1.25.48 

type ListSignalingChannelsInput struct {

	// Optional: Returns only the channels that satisfy a specific condition.
	ChannelNameCondition *ChannelNameCondition `type:"structure"`

	// The maximum number of channels to return in the response. The default is
	// 500.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you specify this parameter, when the result of a ListSignalingChannels
	// operation is truncated, the call returns the NextToken in the response. To
	// get another batch of channels, provide this token in your next request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSignalingChannelsInput) GoString added in v1.25.48 

func (s ListSignalingChannelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSignalingChannelsInput) SetChannelNameCondition added in v1.25.48 

func (s *ListSignalingChannelsInput) SetChannelNameCondition(v *ChannelNameCondition) *ListSignalingChannelsInput

SetChannelNameCondition sets the ChannelNameCondition field's value.

func (*ListSignalingChannelsInput) SetMaxResults added in v1.25.48 

func (s *ListSignalingChannelsInput) SetMaxResults(v int64) *ListSignalingChannelsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSignalingChannelsInput) SetNextToken added in v1.25.48 

func (s *ListSignalingChannelsInput) SetNextToken(v string) *ListSignalingChannelsInput

SetNextToken sets the NextToken field's value.

func (ListSignalingChannelsInput) String added in v1.25.48 

func (s ListSignalingChannelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSignalingChannelsInput) Validate added in v1.25.48 

func (s *ListSignalingChannelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSignalingChannelsOutput added in v1.25.48 

type ListSignalingChannelsOutput struct {

	// An array of ChannelInfo objects.
	ChannelInfoList []*ChannelInfo `type:"list"`

	// If the response is truncated, the call returns this element with a token.
	// To get the next batch of streams, use this token in your next request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSignalingChannelsOutput) GoString added in v1.25.48 

func (s ListSignalingChannelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSignalingChannelsOutput) SetChannelInfoList added in v1.25.48 

func (s *ListSignalingChannelsOutput) SetChannelInfoList(v []*ChannelInfo) *ListSignalingChannelsOutput

SetChannelInfoList sets the ChannelInfoList field's value.

func (*ListSignalingChannelsOutput) SetNextToken added in v1.25.48 

func (s *ListSignalingChannelsOutput) SetNextToken(v string) *ListSignalingChannelsOutput

SetNextToken sets the NextToken field's value.

func (ListSignalingChannelsOutput) String added in v1.25.48 

func (s ListSignalingChannelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStreamsInput 

type ListStreamsInput struct {

	// The maximum number of streams to return in the response. The default is 10,000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you specify this parameter, when the result of a ListStreams operation
	// is truncated, the call returns the NextToken in the response. To get another
	// batch of streams, provide this token in your next request.
	NextToken *string `type:"string"`

	// Optional: Returns only streams that satisfy a specific condition. Currently,
	// you can specify only the prefix of a stream name as a condition.
	StreamNameCondition *StreamNameCondition `type:"structure"`
	// contains filtered or unexported fields
}

func (ListStreamsInput) GoString 

func (s ListStreamsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamsInput) SetMaxResults 

func (s *ListStreamsInput) SetMaxResults(v int64) *ListStreamsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStreamsInput) SetNextToken 

func (s *ListStreamsInput) SetNextToken(v string) *ListStreamsInput

SetNextToken sets the NextToken field's value.

func (*ListStreamsInput) SetStreamNameCondition 

func (s *ListStreamsInput) SetStreamNameCondition(v *StreamNameCondition) *ListStreamsInput

SetStreamNameCondition sets the StreamNameCondition field's value.

func (ListStreamsInput) String 

func (s ListStreamsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamsInput) Validate 

func (s *ListStreamsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStreamsOutput 

type ListStreamsOutput struct {

	// If the response is truncated, the call returns this element with a token.
	// To get the next batch of streams, use this token in your next request.
	NextToken *string `type:"string"`

	// An array of StreamInfo objects.
	StreamInfoList []*StreamInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListStreamsOutput) GoString 

func (s ListStreamsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamsOutput) SetNextToken 

func (s *ListStreamsOutput) SetNextToken(v string) *ListStreamsOutput

SetNextToken sets the NextToken field's value.

func (*ListStreamsOutput) SetStreamInfoList 

func (s *ListStreamsOutput) SetStreamInfoList(v []*StreamInfo) *ListStreamsOutput

SetStreamInfoList sets the StreamInfoList field's value.

func (ListStreamsOutput) String 

func (s ListStreamsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.25.48 

type ListTagsForResourceInput struct {

	// If you specify this parameter and the result of a ListTagsForResource call
	// is truncated, the response includes a token that you can use in the next
	// request to fetch the next batch of tags.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) of the signaling channel for which you want
	// to list tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.25.48 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetNextToken added in v1.25.48 

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceARN added in v1.25.48 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.25.48 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.25.48 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.25.48 

type ListTagsForResourceOutput struct {

	// If you specify this parameter and the result of a ListTagsForResource call
	// is truncated, the response includes a token that you can use in the next
	// request to fetch the next set of tags.
	NextToken *string `type:"string"`

	// A map of tag keys and values associated with the specified signaling channel.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.25.48 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken added in v1.25.48 

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.25.48 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.25.48 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForStreamInput 

type ListTagsForStreamInput struct {

	// If you specify this parameter and the result of a ListTagsForStream call
	// is truncated, the response includes a token that you can use in the next
	// request to fetch the next batch of tags.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) of the stream that you want to list tags for.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream that you want to list tags for.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTagsForStreamInput) GoString 

func (s ListTagsForStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForStreamInput) SetNextToken 

func (s *ListTagsForStreamInput) SetNextToken(v string) *ListTagsForStreamInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForStreamInput) SetStreamARN 

func (s *ListTagsForStreamInput) SetStreamARN(v string) *ListTagsForStreamInput

SetStreamARN sets the StreamARN field's value.

func (*ListTagsForStreamInput) SetStreamName 

func (s *ListTagsForStreamInput) SetStreamName(v string) *ListTagsForStreamInput

SetStreamName sets the StreamName field's value.

func (ListTagsForStreamInput) String 

func (s ListTagsForStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForStreamInput) Validate 

func (s *ListTagsForStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForStreamOutput 

type ListTagsForStreamOutput struct {

	// If you specify this parameter and the result of a ListTags call is truncated,
	// the response includes a token that you can use in the next request to fetch
	// the next set of tags.
	NextToken *string `type:"string"`

	// A map of tag keys and values associated with the specified stream.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForStreamOutput) GoString 

func (s ListTagsForStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForStreamOutput) SetNextToken 

func (s *ListTagsForStreamOutput) SetNextToken(v string) *ListTagsForStreamOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForStreamOutput) SetTags 

func (s *ListTagsForStreamOutput) SetTags(v map[string]*string) *ListTagsForStreamOutput

SetTags sets the Tags field's value.

func (ListTagsForStreamOutput) String 

func (s ListTagsForStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LocalSizeConfig added in v1.44.158 

type LocalSizeConfig struct {

	// The overall maximum size of the media that you want to store for a stream
	// on the Edge Agent.
	MaxLocalMediaSizeInMB *int64 `min:"64" type:"integer"`

	// The strategy to perform when a stream’s MaxLocalMediaSizeInMB limit is
	// reached.
	StrategyOnFullSize *string `type:"string" enum:"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.

func (LocalSizeConfig) GoString added in v1.44.158 

func (s LocalSizeConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocalSizeConfig) SetMaxLocalMediaSizeInMB added in v1.44.158 

func (s *LocalSizeConfig) SetMaxLocalMediaSizeInMB(v int64) *LocalSizeConfig

SetMaxLocalMediaSizeInMB sets the MaxLocalMediaSizeInMB field's value.

func (*LocalSizeConfig) SetStrategyOnFullSize added in v1.44.158 

func (s *LocalSizeConfig) SetStrategyOnFullSize(v string) *LocalSizeConfig

SetStrategyOnFullSize sets the StrategyOnFullSize field's value.

func (LocalSizeConfig) String added in v1.44.158 

func (s LocalSizeConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocalSizeConfig) Validate added in v1.44.158 

func (s *LocalSizeConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MappedResourceConfigurationListItem added in v1.44.163 

type MappedResourceConfigurationListItem struct {

	// The Amazon Resource Name (ARN) of the Kinesis Video Stream resource, associated
	// with the stream.
	ARN *string `min:"1" type:"string"`

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

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

func (MappedResourceConfigurationListItem) GoString added in v1.44.163 

func (s MappedResourceConfigurationListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MappedResourceConfigurationListItem) SetARN added in v1.44.163 

func (s *MappedResourceConfigurationListItem) SetARN(v string) *MappedResourceConfigurationListItem

SetARN sets the ARN field's value.

func (*MappedResourceConfigurationListItem) SetType added in v1.44.163 

func (s *MappedResourceConfigurationListItem) SetType(v string) *MappedResourceConfigurationListItem

SetType sets the Type field's value.

func (MappedResourceConfigurationListItem) String added in v1.44.163 

func (s MappedResourceConfigurationListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MediaSourceConfig added in v1.44.158 

type MediaSourceConfig struct {

	// The Amazon Web Services Secrets Manager ARN for the username and password
	// of the camera, or a local media file location.
	//
	// MediaUriSecretArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by MediaSourceConfig's
	// String and GoString methods.
	//
	// MediaUriSecretArn is a required field
	MediaUriSecretArn *string `min:"20" type:"string" required:"true" sensitive:"true"`

	// 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 .
	//
	// MediaUriType is a required field
	MediaUriType *string `type:"string" required:"true" enum:"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.

func (MediaSourceConfig) GoString added in v1.44.158 

func (s MediaSourceConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MediaSourceConfig) SetMediaUriSecretArn added in v1.44.158 

func (s *MediaSourceConfig) SetMediaUriSecretArn(v string) *MediaSourceConfig

SetMediaUriSecretArn sets the MediaUriSecretArn field's value.

func (*MediaSourceConfig) SetMediaUriType added in v1.44.158 

func (s *MediaSourceConfig) SetMediaUriType(v string) *MediaSourceConfig

SetMediaUriType sets the MediaUriType field's value.

func (MediaSourceConfig) String added in v1.44.158 

func (s MediaSourceConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MediaSourceConfig) Validate added in v1.44.158 

func (s *MediaSourceConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MediaStorageConfiguration added in v1.44.163 

type MediaStorageConfiguration struct {

	// The status of the media storage configuration.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"MediaStorageConfigurationStatus"`

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string `min:"1" type:"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.

func (MediaStorageConfiguration) GoString added in v1.44.163 

func (s MediaStorageConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MediaStorageConfiguration) SetStatus added in v1.44.163 

func (s *MediaStorageConfiguration) SetStatus(v string) *MediaStorageConfiguration

SetStatus sets the Status field's value.

func (*MediaStorageConfiguration) SetStreamARN added in v1.44.163 

func (s *MediaStorageConfiguration) SetStreamARN(v string) *MediaStorageConfiguration

SetStreamARN sets the StreamARN field's value.

func (MediaStorageConfiguration) String added in v1.44.163 

func (s MediaStorageConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MediaStorageConfiguration) Validate added in v1.44.163 

func (s *MediaStorageConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NoDataRetentionException added in v1.44.6 

type NoDataRetentionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The Stream data retention in hours is equal to zero.

func (*NoDataRetentionException) Code added in v1.44.6 

func (s *NoDataRetentionException) Code() string

Code returns the exception type name.

func (*NoDataRetentionException) Error added in v1.44.6 

func (s *NoDataRetentionException) Error() string

func (NoDataRetentionException) GoString added in v1.44.6 

func (s NoDataRetentionException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NoDataRetentionException) Message added in v1.44.6 

func (s *NoDataRetentionException) Message() string

Message returns the exception's message.

func (*NoDataRetentionException) OrigErr added in v1.44.6 

func (s *NoDataRetentionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NoDataRetentionException) RequestID added in v1.44.6 

func (s *NoDataRetentionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NoDataRetentionException) StatusCode added in v1.44.6 

func (s *NoDataRetentionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NoDataRetentionException) String added in v1.44.6 

func (s NoDataRetentionException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotAuthorizedException added in v1.28.0 

type NotAuthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The caller is not authorized to perform this operation.

func (*NotAuthorizedException) Code added in v1.28.0 

func (s *NotAuthorizedException) Code() string

Code returns the exception type name.

func (*NotAuthorizedException) Error added in v1.28.0 

func (s *NotAuthorizedException) Error() string

func (NotAuthorizedException) GoString added in v1.28.0 

func (s NotAuthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotAuthorizedException) Message added in v1.28.0 

func (s *NotAuthorizedException) Message() string

Message returns the exception's message.

func (*NotAuthorizedException) OrigErr added in v1.28.0 

func (s *NotAuthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotAuthorizedException) RequestID added in v1.28.0 

func (s *NotAuthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotAuthorizedException) StatusCode added in v1.28.0 

func (s *NotAuthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotAuthorizedException) String added in v1.28.0 

func (s NotAuthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotificationConfiguration added in v1.44.6 

type NotificationConfiguration struct {

	// The destination information required to deliver a notification to a customer.
	//
	// DestinationConfig is a required field
	DestinationConfig *NotificationDestinationConfig `type:"structure" required:"true"`

	// Indicates if a notification configuration is enabled or disabled.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"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.

func (NotificationConfiguration) GoString added in v1.44.6 

func (s NotificationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationConfiguration) SetDestinationConfig added in v1.44.6 

func (s *NotificationConfiguration) SetDestinationConfig(v *NotificationDestinationConfig) *NotificationConfiguration

SetDestinationConfig sets the DestinationConfig field's value.

func (*NotificationConfiguration) SetStatus added in v1.44.6 

func (s *NotificationConfiguration) SetStatus(v string) *NotificationConfiguration

SetStatus sets the Status field's value.

func (NotificationConfiguration) String added in v1.44.6 

func (s NotificationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationConfiguration) Validate added in v1.44.6 

func (s *NotificationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NotificationDestinationConfig added in v1.44.6 

type NotificationDestinationConfig struct {

	// The Uniform Resource Identifier (URI) that identifies where the images will
	// be delivered.
	//
	// Uri is a required field
	Uri *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (NotificationDestinationConfig) GoString added in v1.44.6 

func (s NotificationDestinationConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationDestinationConfig) SetUri added in v1.44.6 

func (s *NotificationDestinationConfig) SetUri(v string) *NotificationDestinationConfig

SetUri sets the Uri field's value.

func (NotificationDestinationConfig) String added in v1.44.6 

func (s NotificationDestinationConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationDestinationConfig) Validate added in v1.44.6 

func (s *NotificationDestinationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RecorderConfig added in v1.44.158 

type RecorderConfig struct {

	// The configuration details that consist of the credentials required (MediaUriSecretArn
	// and MediaUriType) to access the media files streamed to the camera.
	//
	// MediaSourceConfig is a required field
	MediaSourceConfig *MediaSourceConfig `type:"structure" required:"true"`

	// 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 `type:"structure"`
	// 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.

func (RecorderConfig) GoString added in v1.44.158 

func (s RecorderConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecorderConfig) SetMediaSourceConfig added in v1.44.158 

func (s *RecorderConfig) SetMediaSourceConfig(v *MediaSourceConfig) *RecorderConfig

SetMediaSourceConfig sets the MediaSourceConfig field's value.

func (*RecorderConfig) SetScheduleConfig added in v1.44.158 

func (s *RecorderConfig) SetScheduleConfig(v *ScheduleConfig) *RecorderConfig

SetScheduleConfig sets the ScheduleConfig field's value.

func (RecorderConfig) String added in v1.44.158 

func (s RecorderConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecorderConfig) Validate added in v1.44.158 

func (s *RecorderConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceEndpointListItem added in v1.25.48 

type ResourceEndpointListItem struct {

	// The protocol of the signaling channel returned by the GetSignalingChannelEndpoint
	// API.
	Protocol *string `type:"string" enum:"ChannelProtocol"`

	// The endpoint of the signaling channel returned by the GetSignalingChannelEndpoint
	// API.
	ResourceEndpoint *string `type:"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.

func (ResourceEndpointListItem) GoString added in v1.25.48 

func (s ResourceEndpointListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceEndpointListItem) SetProtocol added in v1.25.48 

func (s *ResourceEndpointListItem) SetProtocol(v string) *ResourceEndpointListItem

SetProtocol sets the Protocol field's value.

func (*ResourceEndpointListItem) SetResourceEndpoint added in v1.25.48 

func (s *ResourceEndpointListItem) SetResourceEndpoint(v string) *ResourceEndpointListItem

SetResourceEndpoint sets the ResourceEndpoint field's value.

func (ResourceEndpointListItem) String added in v1.25.48 

func (s ResourceEndpointListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException added in v1.28.0 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"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) Code added in v1.28.0 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message added in v1.28.0 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.28.0 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScheduleConfig added in v1.44.158 

type ScheduleConfig struct {

	// The total duration to record the media. If the ScheduleExpression attribute
	// is provided, then the DurationInSeconds attribute should also be specified.
	//
	// DurationInSeconds is a required field
	DurationInSeconds *int64 `min:"60" type:"integer" required:"true"`

	// 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.
	//
	// ScheduleExpression is a required field
	ScheduleExpression *string `min:"11" type:"string" required:"true"`
	// 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).

func (ScheduleConfig) GoString added in v1.44.158 

func (s ScheduleConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduleConfig) SetDurationInSeconds added in v1.44.158 

func (s *ScheduleConfig) SetDurationInSeconds(v int64) *ScheduleConfig

SetDurationInSeconds sets the DurationInSeconds field's value.

func (*ScheduleConfig) SetScheduleExpression added in v1.44.158 

func (s *ScheduleConfig) SetScheduleExpression(v string) *ScheduleConfig

SetScheduleExpression sets the ScheduleExpression field's value.

func (ScheduleConfig) String added in v1.44.158 

func (s ScheduleConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScheduleConfig) Validate added in v1.44.158 

func (s *ScheduleConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SingleMasterChannelEndpointConfiguration added in v1.25.48 

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 []*string `min:"1" type:"list" enum:"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 *string `type:"string" enum:"ChannelRole"`
	// contains filtered or unexported fields
}

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

func (SingleMasterChannelEndpointConfiguration) GoString added in v1.25.48 

func (s SingleMasterChannelEndpointConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SingleMasterChannelEndpointConfiguration) SetProtocols added in v1.25.48 

func (s *SingleMasterChannelEndpointConfiguration) SetProtocols(v []*string) *SingleMasterChannelEndpointConfiguration

SetProtocols sets the Protocols field's value.

func (*SingleMasterChannelEndpointConfiguration) SetRole added in v1.25.48 

func (s *SingleMasterChannelEndpointConfiguration) SetRole(v string) *SingleMasterChannelEndpointConfiguration

SetRole sets the Role field's value.

func (SingleMasterChannelEndpointConfiguration) String added in v1.25.48 

func (s SingleMasterChannelEndpointConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SingleMasterChannelEndpointConfiguration) Validate added in v1.25.48 

func (s *SingleMasterChannelEndpointConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SingleMasterConfiguration added in v1.25.48 

type SingleMasterConfiguration struct {

	// The period of time a signaling channel retains undelivered messages before
	// they are discarded.
	MessageTtlSeconds *int64 `min:"5" type:"integer"`
	// contains filtered or unexported fields
}

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

func (SingleMasterConfiguration) GoString added in v1.25.48 

func (s SingleMasterConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SingleMasterConfiguration) SetMessageTtlSeconds added in v1.25.48 

func (s *SingleMasterConfiguration) SetMessageTtlSeconds(v int64) *SingleMasterConfiguration

SetMessageTtlSeconds sets the MessageTtlSeconds field's value.

func (SingleMasterConfiguration) String added in v1.25.48 

func (s SingleMasterConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SingleMasterConfiguration) Validate added in v1.25.48 

func (s *SingleMasterConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartEdgeConfigurationUpdateInput added in v1.44.158 

type StartEdgeConfigurationUpdateInput struct {

	// The edge configuration details required to invoke the update process.
	//
	// EdgeConfig is a required field
	EdgeConfig *EdgeConfig `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of the stream. Specify either the StreamName
	// or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream whose edge configuration you want to update. Specify
	// either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartEdgeConfigurationUpdateInput) GoString added in v1.44.158 

func (s StartEdgeConfigurationUpdateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEdgeConfigurationUpdateInput) SetEdgeConfig added in v1.44.158 

func (s *StartEdgeConfigurationUpdateInput) SetEdgeConfig(v *EdgeConfig) *StartEdgeConfigurationUpdateInput

SetEdgeConfig sets the EdgeConfig field's value.

func (*StartEdgeConfigurationUpdateInput) SetStreamARN added in v1.44.158 

func (s *StartEdgeConfigurationUpdateInput) SetStreamARN(v string) *StartEdgeConfigurationUpdateInput

SetStreamARN sets the StreamARN field's value.

func (*StartEdgeConfigurationUpdateInput) SetStreamName added in v1.44.158 

func (s *StartEdgeConfigurationUpdateInput) SetStreamName(v string) *StartEdgeConfigurationUpdateInput

SetStreamName sets the StreamName field's value.

func (StartEdgeConfigurationUpdateInput) String added in v1.44.158 

func (s StartEdgeConfigurationUpdateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEdgeConfigurationUpdateInput) Validate added in v1.44.158 

func (s *StartEdgeConfigurationUpdateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartEdgeConfigurationUpdateOutput added in v1.44.158 

type StartEdgeConfigurationUpdateOutput struct {

	// The timestamp at which a stream’s edge configuration was first created.
	CreationTime *time.Time `type:"timestamp"`

	// 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 `type:"structure"`

	// A description of the generated failure status.
	FailedStatusDetails *string `type:"string"`

	// The timestamp at which a stream’s edge configuration was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which the edge configuration was updated.
	StreamName *string `min:"1" type:"string"`

	// The current sync status of the stream's edge configuration. When you invoke
	// this API, the sync status will be set to the SYNCING state. Use the DescribeEdgeConfiguration
	// API to get the latest status of the edge configuration.
	SyncStatus *string `type:"string" enum:"SyncStatus"`
	// contains filtered or unexported fields
}

func (StartEdgeConfigurationUpdateOutput) GoString added in v1.44.158 

func (s StartEdgeConfigurationUpdateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEdgeConfigurationUpdateOutput) SetCreationTime added in v1.44.158 

func (s *StartEdgeConfigurationUpdateOutput) SetCreationTime(v time.Time) *StartEdgeConfigurationUpdateOutput

SetCreationTime sets the CreationTime field's value.

func (*StartEdgeConfigurationUpdateOutput) SetEdgeConfig added in v1.44.158 

func (s *StartEdgeConfigurationUpdateOutput) SetEdgeConfig(v *EdgeConfig) *StartEdgeConfigurationUpdateOutput

SetEdgeConfig sets the EdgeConfig field's value.

func (*StartEdgeConfigurationUpdateOutput) SetFailedStatusDetails added in v1.44.158 

func (s *StartEdgeConfigurationUpdateOutput) SetFailedStatusDetails(v string) *StartEdgeConfigurationUpdateOutput

SetFailedStatusDetails sets the FailedStatusDetails field's value.

func (*StartEdgeConfigurationUpdateOutput) SetLastUpdatedTime added in v1.44.158 

func (s *StartEdgeConfigurationUpdateOutput) SetLastUpdatedTime(v time.Time) *StartEdgeConfigurationUpdateOutput

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*StartEdgeConfigurationUpdateOutput) SetStreamARN added in v1.44.158 

func (s *StartEdgeConfigurationUpdateOutput) SetStreamARN(v string) *StartEdgeConfigurationUpdateOutput

SetStreamARN sets the StreamARN field's value.

func (*StartEdgeConfigurationUpdateOutput) SetStreamName added in v1.44.158 

func (s *StartEdgeConfigurationUpdateOutput) SetStreamName(v string) *StartEdgeConfigurationUpdateOutput

SetStreamName sets the StreamName field's value.

func (*StartEdgeConfigurationUpdateOutput) SetSyncStatus added in v1.44.158 

func (s *StartEdgeConfigurationUpdateOutput) SetSyncStatus(v string) *StartEdgeConfigurationUpdateOutput

SetSyncStatus sets the SyncStatus field's value.

func (StartEdgeConfigurationUpdateOutput) String added in v1.44.158 

func (s StartEdgeConfigurationUpdateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StreamEdgeConfigurationNotFoundException added in v1.44.158 

type StreamEdgeConfigurationNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"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) Code added in v1.44.158 

func (s *StreamEdgeConfigurationNotFoundException) Code() string

Code returns the exception type name.

func (*StreamEdgeConfigurationNotFoundException) Error added in v1.44.158 

func (s *StreamEdgeConfigurationNotFoundException) Error() string

func (StreamEdgeConfigurationNotFoundException) GoString added in v1.44.158 

func (s StreamEdgeConfigurationNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StreamEdgeConfigurationNotFoundException) Message added in v1.44.158 

func (s *StreamEdgeConfigurationNotFoundException) Message() string

Message returns the exception's message.

func (*StreamEdgeConfigurationNotFoundException) OrigErr added in v1.44.158 

func (s *StreamEdgeConfigurationNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StreamEdgeConfigurationNotFoundException) RequestID added in v1.44.158 

func (s *StreamEdgeConfigurationNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StreamEdgeConfigurationNotFoundException) StatusCode added in v1.44.158 

func (s *StreamEdgeConfigurationNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StreamEdgeConfigurationNotFoundException) String added in v1.44.158 

func (s StreamEdgeConfigurationNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StreamInfo 

type StreamInfo struct {

	// A time stamp that indicates when the stream was created.
	CreationTime *time.Time `type:"timestamp"`

	// How long the stream retains data, in hours.
	DataRetentionInHours *int64 `type:"integer"`

	// The name of the device that is associated with the stream.
	DeviceName *string `min:"1" type:"string"`

	// The ID of the Key Management Service (KMS) key that Kinesis Video Streams
	// uses to encrypt data on the stream.
	KmsKeyId *string `min:"1" type:"string"`

	// The MediaType of the stream.
	MediaType *string `min:"1" type:"string"`

	// The status of the stream.
	Status *string `type:"string" enum:"Status"`

	// The Amazon Resource Name (ARN) of the stream.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream.
	StreamName *string `min:"1" type:"string"`

	// The version of the stream.
	Version *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object describing a Kinesis video stream.

func (StreamInfo) GoString 

func (s StreamInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StreamInfo) SetCreationTime 

func (s *StreamInfo) SetCreationTime(v time.Time) *StreamInfo

SetCreationTime sets the CreationTime field's value.

func (*StreamInfo) SetDataRetentionInHours 

func (s *StreamInfo) SetDataRetentionInHours(v int64) *StreamInfo

SetDataRetentionInHours sets the DataRetentionInHours field's value.

func (*StreamInfo) SetDeviceName 

func (s *StreamInfo) SetDeviceName(v string) *StreamInfo

SetDeviceName sets the DeviceName field's value.

func (*StreamInfo) SetKmsKeyId 

func (s *StreamInfo) SetKmsKeyId(v string) *StreamInfo

SetKmsKeyId sets the KmsKeyId field's value.

func (*StreamInfo) SetMediaType 

func (s *StreamInfo) SetMediaType(v string) *StreamInfo

SetMediaType sets the MediaType field's value.

func (*StreamInfo) SetStatus 

func (s *StreamInfo) SetStatus(v string) *StreamInfo

SetStatus sets the Status field's value.

func (*StreamInfo) SetStreamARN 

func (s *StreamInfo) SetStreamARN(v string) *StreamInfo

SetStreamARN sets the StreamARN field's value.

func (*StreamInfo) SetStreamName 

func (s *StreamInfo) SetStreamName(v string) *StreamInfo

SetStreamName sets the StreamName field's value.

func (*StreamInfo) SetVersion 

func (s *StreamInfo) SetVersion(v string) *StreamInfo

SetVersion sets the Version field's value.

func (StreamInfo) String 

func (s StreamInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" enum:"ComparisonOperator"`

	// A value to compare.
	ComparisonValue *string `min:"1" type:"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.

func (StreamNameCondition) GoString 

func (s StreamNameCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StreamNameCondition) SetComparisonOperator 

func (s *StreamNameCondition) SetComparisonOperator(v string) *StreamNameCondition

SetComparisonOperator sets the ComparisonOperator field's value.

func (*StreamNameCondition) SetComparisonValue 

func (s *StreamNameCondition) SetComparisonValue(v string) *StreamNameCondition

SetComparisonValue sets the ComparisonValue field's value.

func (StreamNameCondition) String 

func (s StreamNameCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StreamNameCondition) Validate 

func (s *StreamNameCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tag added in v1.25.48 

type Tag struct {

	// The key of the tag that is associated with the specified signaling channel.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag that is associated with the specified signaling channel.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (Tag) GoString added in v1.25.48 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.25.48 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.25.48 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.25.48 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.25.48 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.25.48 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel to which you want
	// to add tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of tags to associate with the specified signaling channel. Each tag
	// is a key-value pair.
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.25.48 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN added in v1.25.48 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.25.48 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.25.48 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.25.48 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.25.48 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.25.48 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.25.48 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagStreamInput 

type TagStreamInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to add the tag
	// or tags to.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream that you want to add the tag or tags to.
	StreamName *string `min:"1" type:"string"`

	// A list of tags to associate with the specified stream. Each tag is a key-value
	// pair (the value is optional).
	//
	// Tags is a required field
	Tags map[string]*string `min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagStreamInput) GoString 

func (s TagStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagStreamInput) SetStreamARN 

func (s *TagStreamInput) SetStreamARN(v string) *TagStreamInput

SetStreamARN sets the StreamARN field's value.

func (*TagStreamInput) SetStreamName 

func (s *TagStreamInput) SetStreamName(v string) *TagStreamInput

SetStreamName sets the StreamName field's value.

func (*TagStreamInput) SetTags 

func (s *TagStreamInput) SetTags(v map[string]*string) *TagStreamInput

SetTags sets the Tags field's value.

func (TagStreamInput) String 

func (s TagStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagStreamInput) Validate 

func (s *TagStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagStreamOutput 

type TagStreamOutput struct {
	// contains filtered or unexported fields
}

func (TagStreamOutput) GoString 

func (s TagStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagStreamOutput) String 

func (s TagStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagsPerResourceExceededLimitException added in v1.28.0 

type TagsPerResourceExceededLimitException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"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) Code added in v1.28.0 

func (s *TagsPerResourceExceededLimitException) Code() string

Code returns the exception type name.

func (*TagsPerResourceExceededLimitException) Error added in v1.28.0 

func (s *TagsPerResourceExceededLimitException) Error() string

func (TagsPerResourceExceededLimitException) GoString added in v1.28.0 

func (s TagsPerResourceExceededLimitException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagsPerResourceExceededLimitException) Message added in v1.28.0 

func (s *TagsPerResourceExceededLimitException) Message() string

Message returns the exception's message.

func (*TagsPerResourceExceededLimitException) OrigErr added in v1.28.0 

func (s *TagsPerResourceExceededLimitException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TagsPerResourceExceededLimitException) RequestID added in v1.28.0 

func (s *TagsPerResourceExceededLimitException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TagsPerResourceExceededLimitException) StatusCode added in v1.28.0 

func (s *TagsPerResourceExceededLimitException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TagsPerResourceExceededLimitException) String added in v1.28.0 

func (s TagsPerResourceExceededLimitException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.25.48 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel from which you want
	// to remove tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of the keys of the tags that you want to remove.
	//
	// TagKeyList is a required field
	TagKeyList []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.25.48 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN added in v1.25.48 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeyList added in v1.25.48 

func (s *UntagResourceInput) SetTagKeyList(v []*string) *UntagResourceInput

SetTagKeyList sets the TagKeyList field's value.

func (UntagResourceInput) String added in v1.25.48 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.25.48 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.25.48 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.25.48 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.25.48 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagStreamInput 

type UntagStreamInput struct {

	// The Amazon Resource Name (ARN) of the stream that you want to remove tags
	// from.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream that you want to remove tags from.
	StreamName *string `min:"1" type:"string"`

	// A list of the keys of the tags that you want to remove.
	//
	// TagKeyList is a required field
	TagKeyList []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagStreamInput) GoString 

func (s UntagStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagStreamInput) SetStreamARN 

func (s *UntagStreamInput) SetStreamARN(v string) *UntagStreamInput

SetStreamARN sets the StreamARN field's value.

func (*UntagStreamInput) SetStreamName 

func (s *UntagStreamInput) SetStreamName(v string) *UntagStreamInput

SetStreamName sets the StreamName field's value.

func (*UntagStreamInput) SetTagKeyList 

func (s *UntagStreamInput) SetTagKeyList(v []*string) *UntagStreamInput

SetTagKeyList sets the TagKeyList field's value.

func (UntagStreamInput) String 

func (s UntagStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagStreamInput) Validate 

func (s *UntagStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagStreamOutput 

type UntagStreamOutput struct {
	// contains filtered or unexported fields
}

func (UntagStreamOutput) GoString 

func (s UntagStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagStreamOutput) String 

func (s UntagStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDataRetentionInput 

type UpdateDataRetentionInput struct {

	// The version of the stream whose retention period you want to change. To get
	// the version, call either the DescribeStream or the ListStreams API.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `min:"1" type:"string" required:"true"`

	// The number of hours to adjust the current retention by. The value you specify
	// is added to or subtracted from the current value, depending on the operation.
	//
	// The minimum value for data retention is 0 and the maximum value is 87600
	// (ten years).
	//
	// DataRetentionChangeInHours is a required field
	DataRetentionChangeInHours *int64 `min:"1" type:"integer" required:"true"`

	// Indicates whether you want to increase or decrease the retention period.
	//
	// Operation is a required field
	Operation *string `type:"string" required:"true" enum:"UpdateDataRetentionOperation"`

	// The Amazon Resource Name (ARN) of the stream whose retention period you want
	// to change.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream whose retention period you want to change.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateDataRetentionInput) GoString 

func (s UpdateDataRetentionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataRetentionInput) SetCurrentVersion 

func (s *UpdateDataRetentionInput) SetCurrentVersion(v string) *UpdateDataRetentionInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateDataRetentionInput) SetDataRetentionChangeInHours 

func (s *UpdateDataRetentionInput) SetDataRetentionChangeInHours(v int64) *UpdateDataRetentionInput

SetDataRetentionChangeInHours sets the DataRetentionChangeInHours field's value.

func (*UpdateDataRetentionInput) SetOperation 

func (s *UpdateDataRetentionInput) SetOperation(v string) *UpdateDataRetentionInput

SetOperation sets the Operation field's value.

func (*UpdateDataRetentionInput) SetStreamARN 

func (s *UpdateDataRetentionInput) SetStreamARN(v string) *UpdateDataRetentionInput

SetStreamARN sets the StreamARN field's value.

func (*UpdateDataRetentionInput) SetStreamName 

func (s *UpdateDataRetentionInput) SetStreamName(v string) *UpdateDataRetentionInput

SetStreamName sets the StreamName field's value.

func (UpdateDataRetentionInput) String 

func (s UpdateDataRetentionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataRetentionInput) Validate 

func (s *UpdateDataRetentionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDataRetentionOutput 

type UpdateDataRetentionOutput struct {
	// contains filtered or unexported fields
}

func (UpdateDataRetentionOutput) GoString 

func (s UpdateDataRetentionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateDataRetentionOutput) String 

func (s UpdateDataRetentionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateImageGenerationConfigurationInput added in v1.44.6 

type UpdateImageGenerationConfigurationInput struct {

	// The structure that contains the information required for the KVS images delivery.
	// If the structure is null, the configuration will be deleted from the stream.
	ImageGenerationConfiguration *ImageGenerationConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of the Kinesis video stream from where you
	// want to update the image generation configuration. You must specify either
	// the StreamName or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which to update the image generation configuration.
	// You must specify either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateImageGenerationConfigurationInput) GoString added in v1.44.6 

func (s UpdateImageGenerationConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateImageGenerationConfigurationInput) SetImageGenerationConfiguration added in v1.44.6 

func (s *UpdateImageGenerationConfigurationInput) SetImageGenerationConfiguration(v *ImageGenerationConfiguration) *UpdateImageGenerationConfigurationInput

SetImageGenerationConfiguration sets the ImageGenerationConfiguration field's value.

func (*UpdateImageGenerationConfigurationInput) SetStreamARN added in v1.44.6 

func (s *UpdateImageGenerationConfigurationInput) SetStreamARN(v string) *UpdateImageGenerationConfigurationInput

SetStreamARN sets the StreamARN field's value.

func (*UpdateImageGenerationConfigurationInput) SetStreamName added in v1.44.6 

func (s *UpdateImageGenerationConfigurationInput) SetStreamName(v string) *UpdateImageGenerationConfigurationInput

SetStreamName sets the StreamName field's value.

func (UpdateImageGenerationConfigurationInput) String added in v1.44.6 

func (s UpdateImageGenerationConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateImageGenerationConfigurationInput) Validate added in v1.44.6 

func (s *UpdateImageGenerationConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateImageGenerationConfigurationOutput added in v1.44.6 

type UpdateImageGenerationConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateImageGenerationConfigurationOutput) GoString added in v1.44.6 

func (s UpdateImageGenerationConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateImageGenerationConfigurationOutput) String added in v1.44.6 

func (s UpdateImageGenerationConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateMediaStorageConfigurationInput added in v1.44.163 

type UpdateMediaStorageConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the channel.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// A structure that encapsulates, or contains, the media storage configuration
	// properties.
	//
	// MediaStorageConfiguration is a required field
	MediaStorageConfiguration *MediaStorageConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMediaStorageConfigurationInput) GoString added in v1.44.163 

func (s UpdateMediaStorageConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMediaStorageConfigurationInput) SetChannelARN added in v1.44.163 

func (s *UpdateMediaStorageConfigurationInput) SetChannelARN(v string) *UpdateMediaStorageConfigurationInput

SetChannelARN sets the ChannelARN field's value.

func (*UpdateMediaStorageConfigurationInput) SetMediaStorageConfiguration added in v1.44.163 

func (s *UpdateMediaStorageConfigurationInput) SetMediaStorageConfiguration(v *MediaStorageConfiguration) *UpdateMediaStorageConfigurationInput

SetMediaStorageConfiguration sets the MediaStorageConfiguration field's value.

func (UpdateMediaStorageConfigurationInput) String added in v1.44.163 

func (s UpdateMediaStorageConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateMediaStorageConfigurationInput) Validate added in v1.44.163 

func (s *UpdateMediaStorageConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMediaStorageConfigurationOutput added in v1.44.163 

type UpdateMediaStorageConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateMediaStorageConfigurationOutput) GoString added in v1.44.163 

func (s UpdateMediaStorageConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateMediaStorageConfigurationOutput) String added in v1.44.163 

func (s UpdateMediaStorageConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateNotificationConfigurationInput added in v1.44.6 

type UpdateNotificationConfigurationInput struct {

	// The structure containing the information required for notifications. If the
	// structure is null, the configuration will be deleted from the stream.
	NotificationConfiguration *NotificationConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of the Kinesis video stream from where you
	// want to update the notification configuration. You must specify either the
	// StreamName or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which to update the notification configuration.
	// You must specify either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateNotificationConfigurationInput) GoString added in v1.44.6 

func (s UpdateNotificationConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNotificationConfigurationInput) SetNotificationConfiguration added in v1.44.6 

func (s *UpdateNotificationConfigurationInput) SetNotificationConfiguration(v *NotificationConfiguration) *UpdateNotificationConfigurationInput

SetNotificationConfiguration sets the NotificationConfiguration field's value.

func (*UpdateNotificationConfigurationInput) SetStreamARN added in v1.44.6 

func (s *UpdateNotificationConfigurationInput) SetStreamARN(v string) *UpdateNotificationConfigurationInput

SetStreamARN sets the StreamARN field's value.

func (*UpdateNotificationConfigurationInput) SetStreamName added in v1.44.6 

func (s *UpdateNotificationConfigurationInput) SetStreamName(v string) *UpdateNotificationConfigurationInput

SetStreamName sets the StreamName field's value.

func (UpdateNotificationConfigurationInput) String added in v1.44.6 

func (s UpdateNotificationConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNotificationConfigurationInput) Validate added in v1.44.6 

func (s *UpdateNotificationConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateNotificationConfigurationOutput added in v1.44.6 

type UpdateNotificationConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateNotificationConfigurationOutput) GoString added in v1.44.6 

func (s UpdateNotificationConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateNotificationConfigurationOutput) String added in v1.44.6 

func (s UpdateNotificationConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSignalingChannelInput added in v1.25.48 

type UpdateSignalingChannelInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel that you want to
	// update.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// The current version of the signaling channel that you want to update.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `min:"1" type:"string" required:"true"`

	// The structure containing the configuration for the SINGLE_MASTER type of
	// the signaling channel that you want to update.
	SingleMasterConfiguration *SingleMasterConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateSignalingChannelInput) GoString added in v1.25.48 

func (s UpdateSignalingChannelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSignalingChannelInput) SetChannelARN added in v1.25.48 

func (s *UpdateSignalingChannelInput) SetChannelARN(v string) *UpdateSignalingChannelInput

SetChannelARN sets the ChannelARN field's value.

func (*UpdateSignalingChannelInput) SetCurrentVersion added in v1.25.48 

func (s *UpdateSignalingChannelInput) SetCurrentVersion(v string) *UpdateSignalingChannelInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateSignalingChannelInput) SetSingleMasterConfiguration added in v1.25.48 

func (s *UpdateSignalingChannelInput) SetSingleMasterConfiguration(v *SingleMasterConfiguration) *UpdateSignalingChannelInput

SetSingleMasterConfiguration sets the SingleMasterConfiguration field's value.

func (UpdateSignalingChannelInput) String added in v1.25.48 

func (s UpdateSignalingChannelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSignalingChannelInput) Validate added in v1.25.48 

func (s *UpdateSignalingChannelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSignalingChannelOutput added in v1.25.48 

type UpdateSignalingChannelOutput struct {
	// contains filtered or unexported fields
}

func (UpdateSignalingChannelOutput) GoString added in v1.25.48 

func (s UpdateSignalingChannelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateSignalingChannelOutput) String added in v1.25.48 

func (s UpdateSignalingChannelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStreamInput 

type UpdateStreamInput struct {

	// The version of the stream whose metadata you want to update.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `min:"1" type:"string" required:"true"`

	// The name of the device that is writing to the stream.
	//
	// In the current implementation, Kinesis Video Streams does not use this name.
	DeviceName *string `min:"1" type:"string"`

	// The stream's media type. Use MediaType to specify the type of content that
	// the stream contains to the consumers of the stream. For more information
	// about media types, see Media Types (http://www.iana.org/assignments/media-types/media-types.xhtml).
	// If you choose to specify the MediaType, see Naming Requirements (https://tools.ietf.org/html/rfc6838#section-4.2).
	//
	// To play video on the console, you must specify the correct video type. For
	// example, if the video in the stream is H.264, specify video/h264 as the MediaType.
	MediaType *string `min:"1" type:"string"`

	// The ARN of the stream whose metadata you want to update.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream whose metadata you want to update.
	//
	// The stream name is an identifier for the stream, and must be unique for each
	// account and region.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateStreamInput) GoString 

func (s UpdateStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStreamInput) SetCurrentVersion 

func (s *UpdateStreamInput) SetCurrentVersion(v string) *UpdateStreamInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateStreamInput) SetDeviceName 

func (s *UpdateStreamInput) SetDeviceName(v string) *UpdateStreamInput

SetDeviceName sets the DeviceName field's value.

func (*UpdateStreamInput) SetMediaType 

func (s *UpdateStreamInput) SetMediaType(v string) *UpdateStreamInput

SetMediaType sets the MediaType field's value.

func (*UpdateStreamInput) SetStreamARN 

func (s *UpdateStreamInput) SetStreamARN(v string) *UpdateStreamInput

SetStreamARN sets the StreamARN field's value.

func (*UpdateStreamInput) SetStreamName 

func (s *UpdateStreamInput) SetStreamName(v string) *UpdateStreamInput

SetStreamName sets the StreamName field's value.

func (UpdateStreamInput) String 

func (s UpdateStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStreamInput) Validate 

func (s *UpdateStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateStreamOutput 

type UpdateStreamOutput struct {
	// contains filtered or unexported fields
}

func (UpdateStreamOutput) GoString 

func (s UpdateStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateStreamOutput) String 

func (s UpdateStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UploaderConfig added in v1.44.158 

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).
	//
	// ScheduleConfig is a required field
	ScheduleConfig *ScheduleConfig `type:"structure" required:"true"`
	// 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).

func (UploaderConfig) GoString added in v1.44.158 

func (s UploaderConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UploaderConfig) SetScheduleConfig added in v1.44.158 

func (s *UploaderConfig) SetScheduleConfig(v *ScheduleConfig) *UploaderConfig

SetScheduleConfig sets the ScheduleConfig field's value.

func (UploaderConfig) String added in v1.44.158 

func (s UploaderConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UploaderConfig) Validate added in v1.44.158 

func (s *UploaderConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VersionMismatchException added in v1.28.0 

type VersionMismatchException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"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) Code added in v1.28.0 

func (s *VersionMismatchException) Code() string

Code returns the exception type name.

func (*VersionMismatchException) Error added in v1.28.0 

func (s *VersionMismatchException) Error() string

func (VersionMismatchException) GoString added in v1.28.0 

func (s VersionMismatchException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VersionMismatchException) Message added in v1.28.0 

func (s *VersionMismatchException) Message() string

Message returns the exception's message.

func (*VersionMismatchException) OrigErr added in v1.28.0 

func (s *VersionMismatchException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*VersionMismatchException) RequestID added in v1.28.0 

func (s *VersionMismatchException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*VersionMismatchException) StatusCode added in v1.28.0 

func (s *VersionMismatchException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (VersionMismatchException) String added in v1.28.0 

func (s VersionMismatchException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package kinesisvideoiface provides an interface to enable mocking the Amazon Kinesis Video Streams service client for testing your code.
 Package kinesisvideoiface provides an interface to enable mocking the Amazon Kinesis Video Streams service client for testing your code.

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.