kinesisvideo

package
v1.37.5 Latest Latest
Warning

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

 Go to latest Published: Feb 4, 2021 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"
)
View Source 
const (
	// ChannelProtocolWss is a ChannelProtocol enum value
	ChannelProtocolWss = "WSS"

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

	// ChannelRoleViewer is a ChannelRole enum value
	ChannelRoleViewer = "VIEWER"
)
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 (
	// UpdateDataRetentionOperationIncreaseDataRetention is a UpdateDataRetentionOperation enum value
	UpdateDataRetentionOperationIncreaseDataRetention = "INCREASE_DATA_RETENTION"

	// UpdateDataRetentionOperationDecreaseDataRetention is a UpdateDataRetentionOperation enum value
	UpdateDataRetentionOperationDecreaseDataRetention = "DECREASE_DATA_RETENTION"
)
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
	// AWS 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"

	// 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".
	//
	// The signaling channel is currently not available for this operation.
	ErrCodeResourceInUseException = "ResourceInUseException"

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

	// ErrCodeTagsPerResourceExceededLimitException for service response error code
	// "TagsPerResourceExceededLimitException".
	//
	// You have exceeded the limit of tags that you can associate with the resource.
	// Kinesis video streams 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 (
	// ChannelTypeSingleMaster is a ChannelType enum value
	ChannelTypeSingleMaster = "SINGLE_MASTER"
)
View Source 
const (
	// ComparisonOperatorBeginsWith is a ComparisonOperator enum value
	ComparisonOperatorBeginsWith = "BEGINS_WITH"
)

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 Status_Values added in v1.34.3 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func UpdateDataRetentionOperation_Values added in v1.34.3 

func UpdateDataRetentionOperation_Values() []string

UpdateDataRetentionOperation_Values returns all elements of the UpdateDataRetentionOperation 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

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

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

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

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

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

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

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

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

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

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

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

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 AWS account and AWS 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

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

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

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

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 AWS Key Management Service (AWS 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 (aws/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

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

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

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

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

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

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

func (DeleteSignalingChannelOutput) String added in v1.25.48 

func (s DeleteSignalingChannelOutput) String() string

String returns the string representation

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

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

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

func (DeleteStreamOutput) String 

func (s DeleteStreamOutput) String() string

String returns the string representation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 AWS account in this region.

  • ResourceInUseException The signaling channel is currently not available for this operation.

  • 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. Kinesis video streams 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 The signaling channel is currently not available for this operation.

  • 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. Kinesis video streams 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) 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 The signaling channel is currently not available for this operation.

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 The signaling channel is currently not available for this operation.

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) 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 The signaling channel is currently not available for this operation.

  • 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) 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) 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 AWS 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 AWS Billing 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. Kinesis video streams 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 AWS 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 AWS Billing and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

Kinesis video streams 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. Kinesis video streams 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.

The retention period that you specify replaces the current value.

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 The signaling channel is currently not available for this operation.

  • 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) 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 The signaling channel is currently not available for this operation.

  • 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 The signaling channel is currently not available for this operation.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

func (ResourceEndpointListItem) GoString added in v1.25.48 

func (s ResourceEndpointListItem) GoString() string

GoString returns the string representation

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

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
}

The signaling channel is currently not available for this operation.

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

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

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

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

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

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

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

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

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

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 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 AWS Key Management Service (AWS 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

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

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

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

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

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

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

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

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

func (TagResourceOutput) String added in v1.25.48 

func (s TagResourceOutput) String() string

String returns the string representation

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

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

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

func (TagStreamOutput) String 

func (s TagStreamOutput) String() string

String returns the string representation

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. Kinesis video streams 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

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

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

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

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

func (UntagResourceOutput) String added in v1.25.48 

func (s UntagResourceOutput) String() string

String returns the string representation

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

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

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

func (UntagStreamOutput) String 

func (s UntagStreamOutput) String() string

String returns the string representation

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 retention period, in hours. The value you specify replaces the current
	// value. The maximum value for this parameter 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

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

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

func (UpdateDataRetentionOutput) String 

func (s UpdateDataRetentionOutput) String() string

String returns the string representation

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

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

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

func (UpdateSignalingChannelOutput) String added in v1.25.48 

func (s UpdateSignalingChannelOutput) String() string

String returns the string representation

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

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

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

func (UpdateStreamOutput) String 

func (s UpdateStreamOutput) String() string

String returns the string representation

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

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

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.