kinesisvideoarchivedmedia

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 11 Imported by: 22

Documentation

Overview

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

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

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

Using the Client

To contact Amazon Kinesis Video Streams Archived Media 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 Archived Media client KinesisVideoArchivedMedia for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesisvideoarchivedmedia/#New

Index

Constants

View Source 
const (
	// ClipFragmentSelectorTypeProducerTimestamp is a ClipFragmentSelectorType enum value
	ClipFragmentSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"

	// ClipFragmentSelectorTypeServerTimestamp is a ClipFragmentSelectorType enum value
	ClipFragmentSelectorTypeServerTimestamp = "SERVER_TIMESTAMP"
)
View Source 
const (
	// ContainerFormatFragmentedMp4 is a ContainerFormat enum value
	ContainerFormatFragmentedMp4 = "FRAGMENTED_MP4"

	// ContainerFormatMpegTs is a ContainerFormat enum value
	ContainerFormatMpegTs = "MPEG_TS"
)
View Source 
const (
	// DASHDisplayFragmentNumberAlways is a DASHDisplayFragmentNumber enum value
	DASHDisplayFragmentNumberAlways = "ALWAYS"

	// DASHDisplayFragmentNumberNever is a DASHDisplayFragmentNumber enum value
	DASHDisplayFragmentNumberNever = "NEVER"
)
View Source 
const (
	// DASHDisplayFragmentTimestampAlways is a DASHDisplayFragmentTimestamp enum value
	DASHDisplayFragmentTimestampAlways = "ALWAYS"

	// DASHDisplayFragmentTimestampNever is a DASHDisplayFragmentTimestamp enum value
	DASHDisplayFragmentTimestampNever = "NEVER"
)
View Source 
const (
	// DASHFragmentSelectorTypeProducerTimestamp is a DASHFragmentSelectorType enum value
	DASHFragmentSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"

	// DASHFragmentSelectorTypeServerTimestamp is a DASHFragmentSelectorType enum value
	DASHFragmentSelectorTypeServerTimestamp = "SERVER_TIMESTAMP"
)
View Source 
const (
	// DASHPlaybackModeLive is a DASHPlaybackMode enum value
	DASHPlaybackModeLive = "LIVE"

	// DASHPlaybackModeLiveReplay is a DASHPlaybackMode enum value
	DASHPlaybackModeLiveReplay = "LIVE_REPLAY"

	// DASHPlaybackModeOnDemand is a DASHPlaybackMode enum value
	DASHPlaybackModeOnDemand = "ON_DEMAND"
)
View Source 
const (
	// FormatJpeg is a Format enum value
	FormatJpeg = "JPEG"

	// FormatPng is a Format enum value
	FormatPng = "PNG"
)
View Source 
const (
	// FragmentSelectorTypeProducerTimestamp is a FragmentSelectorType enum value
	FragmentSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"

	// FragmentSelectorTypeServerTimestamp is a FragmentSelectorType enum value
	FragmentSelectorTypeServerTimestamp = "SERVER_TIMESTAMP"
)
View Source 
const (
	// HLSDiscontinuityModeAlways is a HLSDiscontinuityMode enum value
	HLSDiscontinuityModeAlways = "ALWAYS"

	// HLSDiscontinuityModeNever is a HLSDiscontinuityMode enum value
	HLSDiscontinuityModeNever = "NEVER"

	// HLSDiscontinuityModeOnDiscontinuity is a HLSDiscontinuityMode enum value
	HLSDiscontinuityModeOnDiscontinuity = "ON_DISCONTINUITY"
)
View Source 
const (
	// HLSDisplayFragmentTimestampAlways is a HLSDisplayFragmentTimestamp enum value
	HLSDisplayFragmentTimestampAlways = "ALWAYS"

	// HLSDisplayFragmentTimestampNever is a HLSDisplayFragmentTimestamp enum value
	HLSDisplayFragmentTimestampNever = "NEVER"
)
View Source 
const (
	// HLSFragmentSelectorTypeProducerTimestamp is a HLSFragmentSelectorType enum value
	HLSFragmentSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"

	// HLSFragmentSelectorTypeServerTimestamp is a HLSFragmentSelectorType enum value
	HLSFragmentSelectorTypeServerTimestamp = "SERVER_TIMESTAMP"
)
View Source 
const (
	// HLSPlaybackModeLive is a HLSPlaybackMode enum value
	HLSPlaybackModeLive = "LIVE"

	// HLSPlaybackModeLiveReplay is a HLSPlaybackMode enum value
	HLSPlaybackModeLiveReplay = "LIVE_REPLAY"

	// HLSPlaybackModeOnDemand is a HLSPlaybackMode enum value
	HLSPlaybackModeOnDemand = "ON_DEMAND"
)
View Source 
const (
	// ImageErrorNoMedia is a ImageError enum value
	ImageErrorNoMedia = "NO_MEDIA"

	// ImageErrorMediaError is a ImageError enum value
	ImageErrorMediaError = "MEDIA_ERROR"
)
View Source 
const (
	// ImageSelectorTypeProducerTimestamp is a ImageSelectorType enum value
	ImageSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"

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

	// ErrCodeClientLimitExceededException for service response error code
	// "ClientLimitExceededException".
	//
	// Kinesis Video Streams has throttled the request because you have exceeded
	// a limit. Try making the call later. For information about limits, see Kinesis
	// Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).
	ErrCodeClientLimitExceededException = "ClientLimitExceededException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// A specified parameter exceeds its restrictions, is not supported, or can't
	// be used.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeInvalidCodecPrivateDataException for service response error code
	// "InvalidCodecPrivateDataException".
	//
	// The codec private data in at least one of the tracks of the video stream
	// is not valid for this operation.
	ErrCodeInvalidCodecPrivateDataException = "InvalidCodecPrivateDataException"

	// ErrCodeInvalidMediaFrameException for service response error code
	// "InvalidMediaFrameException".
	//
	// One or more frames in the requested clip could not be parsed based on the
	// specified codec.
	ErrCodeInvalidMediaFrameException = "InvalidMediaFrameException"

	// ErrCodeMissingCodecPrivateDataException for service response error code
	// "MissingCodecPrivateDataException".
	//
	// No codec private data was found in at least one of tracks of the video stream.
	ErrCodeMissingCodecPrivateDataException = "MissingCodecPrivateDataException"

	// ErrCodeNoDataRetentionException for service response error code
	// "NoDataRetentionException".
	//
	// GetImages was requested for a stream that does not retain data (that is,
	// has a DataRetentionInHours of 0).
	ErrCodeNoDataRetentionException = "NoDataRetentionException"

	// ErrCodeNotAuthorizedException for service response error code
	// "NotAuthorizedException".
	//
	// Status Code: 403, The caller is not authorized to perform an operation on
	// the given stream, or the token has expired.
	ErrCodeNotAuthorizedException = "NotAuthorizedException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// GetImages will throw this error when Kinesis Video Streams can't find the
	// stream that you specified.
	//
	// GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error
	// if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested
	// for a stream that has no fragments within the requested time range, or if
	// a session with a PlaybackMode of LIVE is requested for a stream that has
	// no fragments within the last 30 seconds.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeUnsupportedStreamMediaTypeException for service response error code
	// "UnsupportedStreamMediaTypeException".
	//
	// The type of the media (for example, h.264 or h.265 video or ACC or G.711
	// audio) could not be determined from the codec IDs of the tracks in the first
	// fragment for a playback session. The codec ID for track 1 should be V_MPEG/ISO/AVC
	// and, optionally, the codec ID for track 2 should be A_AAC.
	ErrCodeUnsupportedStreamMediaTypeException = "UnsupportedStreamMediaTypeException"
)
View Source 
const (
	ServiceName = "kinesisvideo"                 // Name of service.
	EndpointsID = ServiceName                    // ID to lookup a service endpoint with.
	ServiceID   = "Kinesis Video Archived Media" // ServiceID is a unique identifier of a specific service.
)

Service information constants

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

Variables

This section is empty.

Functions

func ClipFragmentSelectorType_Values added in v1.34.3 

func ClipFragmentSelectorType_Values() []string

ClipFragmentSelectorType_Values returns all elements of the ClipFragmentSelectorType enum

func ContainerFormat_Values added in v1.34.3 

func ContainerFormat_Values() []string

ContainerFormat_Values returns all elements of the ContainerFormat enum

func DASHDisplayFragmentNumber_Values added in v1.34.3 

func DASHDisplayFragmentNumber_Values() []string

DASHDisplayFragmentNumber_Values returns all elements of the DASHDisplayFragmentNumber enum

func DASHDisplayFragmentTimestamp_Values added in v1.34.3 

func DASHDisplayFragmentTimestamp_Values() []string

DASHDisplayFragmentTimestamp_Values returns all elements of the DASHDisplayFragmentTimestamp enum

func DASHFragmentSelectorType_Values added in v1.34.3 

func DASHFragmentSelectorType_Values() []string

DASHFragmentSelectorType_Values returns all elements of the DASHFragmentSelectorType enum

func DASHPlaybackMode_Values added in v1.34.3 

func DASHPlaybackMode_Values() []string

DASHPlaybackMode_Values returns all elements of the DASHPlaybackMode enum

func FormatConfigKey_Values added in v1.44.6 

func FormatConfigKey_Values() []string

FormatConfigKey_Values returns all elements of the FormatConfigKey enum

func Format_Values added in v1.44.6 

func Format_Values() []string

Format_Values returns all elements of the Format enum

func FragmentSelectorType_Values added in v1.34.3 

func FragmentSelectorType_Values() []string

FragmentSelectorType_Values returns all elements of the FragmentSelectorType enum

func HLSDiscontinuityMode_Values added in v1.34.3 

func HLSDiscontinuityMode_Values() []string

HLSDiscontinuityMode_Values returns all elements of the HLSDiscontinuityMode enum

func HLSDisplayFragmentTimestamp_Values added in v1.34.3 

func HLSDisplayFragmentTimestamp_Values() []string

HLSDisplayFragmentTimestamp_Values returns all elements of the HLSDisplayFragmentTimestamp enum

func HLSFragmentSelectorType_Values added in v1.34.3 

func HLSFragmentSelectorType_Values() []string

HLSFragmentSelectorType_Values returns all elements of the HLSFragmentSelectorType enum

func HLSPlaybackMode_Values added in v1.34.3 

func HLSPlaybackMode_Values() []string

HLSPlaybackMode_Values returns all elements of the HLSPlaybackMode enum

func ImageError_Values added in v1.44.6 

func ImageError_Values() []string

ImageError_Values returns all elements of the ImageError enum

func ImageSelectorType_Values added in v1.44.6 

func ImageSelectorType_Values() []string

ImageSelectorType_Values returns all elements of the ImageSelectorType enum

Types

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 a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

func (*ClientLimitExceededException) Code added in v1.28.0 

func (s *ClientLimitExceededException) Code() string

Code returns the exception type name.

func (*ClientLimitExceededException) Error added in v1.28.0 

func (s *ClientLimitExceededException) Error() string

func (ClientLimitExceededException) GoString added in v1.28.0 

func (s ClientLimitExceededException) GoString() string

GoString returns the string representation.

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

func (*ClientLimitExceededException) Message added in v1.28.0 

func (s *ClientLimitExceededException) Message() string

Message returns the exception's message.

func (*ClientLimitExceededException) OrigErr added in v1.28.0 

func (s *ClientLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClientLimitExceededException) RequestID added in v1.28.0 

func (s *ClientLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClientLimitExceededException) StatusCode added in v1.28.0 

func (s *ClientLimitExceededException) StatusCode() int

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

func (ClientLimitExceededException) String added in v1.28.0 

func (s ClientLimitExceededException) String() string

String returns the string representation.

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

type ClipFragmentSelector added in v1.30.16 

type ClipFragmentSelector struct {

	// The origin of the timestamps to use (Server or Producer).
	//
	// FragmentSelectorType is a required field
	FragmentSelectorType *string `type:"string" required:"true" enum:"ClipFragmentSelectorType"`

	// The range of timestamps to return.
	//
	// TimestampRange is a required field
	TimestampRange *ClipTimestampRange `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Describes the timestamp range and timestamp origin of a range of fragments.

Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the clip will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.

func (ClipFragmentSelector) GoString added in v1.30.16 

func (s ClipFragmentSelector) GoString() string

GoString returns the string representation.

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

func (*ClipFragmentSelector) SetFragmentSelectorType added in v1.30.16 

func (s *ClipFragmentSelector) SetFragmentSelectorType(v string) *ClipFragmentSelector

SetFragmentSelectorType sets the FragmentSelectorType field's value.

func (*ClipFragmentSelector) SetTimestampRange added in v1.30.16 

func (s *ClipFragmentSelector) SetTimestampRange(v *ClipTimestampRange) *ClipFragmentSelector

SetTimestampRange sets the TimestampRange field's value.

func (ClipFragmentSelector) String added in v1.30.16 

func (s ClipFragmentSelector) String() string

String returns the string representation.

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

func (*ClipFragmentSelector) Validate added in v1.30.16 

func (s *ClipFragmentSelector) Validate() error

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

type ClipTimestampRange added in v1.30.16 

type ClipTimestampRange struct {

	// The end of the timestamp range for the requested media.
	//
	// This value must be within 24 hours of the specified StartTimestamp, and it
	// must be later than the StartTimestamp value. If FragmentSelectorType for
	// the request is SERVER_TIMESTAMP, this value must be in the past.
	//
	// This value is inclusive. The EndTimestamp is compared to the (starting) timestamp
	// of the fragment. Fragments that start before the EndTimestamp value and continue
	// past it are included in the session.
	//
	// EndTimestamp is a required field
	EndTimestamp *time.Time `type:"timestamp" required:"true"`

	// The starting timestamp in the range of timestamps for which to return fragments.
	//
	// Only fragments that start exactly at or after StartTimestamp are included
	// in the session. Fragments that start before StartTimestamp and continue past
	// it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP,
	// the StartTimestamp must be later than the stream head.
	//
	// StartTimestamp is a required field
	StartTimestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The range of timestamps for which to return fragments.

func (ClipTimestampRange) GoString added in v1.30.16 

func (s ClipTimestampRange) GoString() string

GoString returns the string representation.

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

func (*ClipTimestampRange) SetEndTimestamp added in v1.30.16 

func (s *ClipTimestampRange) SetEndTimestamp(v time.Time) *ClipTimestampRange

SetEndTimestamp sets the EndTimestamp field's value.

func (*ClipTimestampRange) SetStartTimestamp added in v1.30.16 

func (s *ClipTimestampRange) SetStartTimestamp(v time.Time) *ClipTimestampRange

SetStartTimestamp sets the StartTimestamp field's value.

func (ClipTimestampRange) String added in v1.30.16 

func (s ClipTimestampRange) String() string

String returns the string representation.

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

func (*ClipTimestampRange) Validate added in v1.30.16 

func (s *ClipTimestampRange) Validate() error

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

type DASHFragmentSelector added in v1.20.17 

type DASHFragmentSelector struct {

	// The source of the timestamps for the requested media.
	//
	// When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode
	// is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer
	// timestamp within the specified FragmentSelector$TimestampRange is included
	// in the media playlist. In addition, the fragments with producer timestamps
	// within the TimestampRange ingested immediately following the first fragment
	// (up to the GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value)
	// are included.
	//
	// Fragments that have duplicate producer timestamps are deduplicated. This
	// means that if producers are producing a stream of fragments with producer
	// timestamps that are approximately equal to the true clock time, the MPEG-DASH
	// manifest will contain all of the fragments within the requested timestamp
	// range. If some fragments are ingested within the same time range and very
	// different points in time, only the oldest ingested collection of fragments
	// are returned.
	//
	// When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode
	// is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication.
	// But the most recently ingested fragments based on server timestamps are included
	// in the MPEG-DASH manifest. This means that even if fragments ingested in
	// the past have producer timestamps with values now, they are not included
	// in the HLS media playlist.
	//
	// The default is SERVER_TIMESTAMP.
	FragmentSelectorType *string `type:"string" enum:"DASHFragmentSelectorType"`

	// The start and end of the timestamp range for the requested media.
	//
	// This value should not be present if PlaybackType is LIVE.
	TimestampRange *DASHTimestampRange `type:"structure"`
	// contains filtered or unexported fields
}

Contains the range of timestamps for the requested media, and the source of the timestamps.

func (DASHFragmentSelector) GoString added in v1.20.17 

func (s DASHFragmentSelector) GoString() string

GoString returns the string representation.

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

func (*DASHFragmentSelector) SetFragmentSelectorType added in v1.20.17 

func (s *DASHFragmentSelector) SetFragmentSelectorType(v string) *DASHFragmentSelector

SetFragmentSelectorType sets the FragmentSelectorType field's value.

func (*DASHFragmentSelector) SetTimestampRange added in v1.20.17 

func (s *DASHFragmentSelector) SetTimestampRange(v *DASHTimestampRange) *DASHFragmentSelector

SetTimestampRange sets the TimestampRange field's value.

func (DASHFragmentSelector) String added in v1.20.17 

func (s DASHFragmentSelector) String() string

String returns the string representation.

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

type DASHTimestampRange added in v1.20.17 

type DASHTimestampRange struct {

	// The end of the timestamp range for the requested media. This value must be
	// within 24 hours of the specified StartTimestamp, and it must be later than
	// the StartTimestamp value.
	//
	// If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must
	// be in the past.
	//
	// The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY
	// mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session
	// will continue to include newly ingested fragments until the session expires.
	//
	// This value is inclusive. The EndTimestamp is compared to the (starting) timestamp
	// of the fragment. Fragments that start before the EndTimestamp value and continue
	// past it are included in the session.
	EndTimestamp *time.Time `type:"timestamp"`

	// The start of the timestamp range for the requested media.
	//
	// If the DASHTimestampRange value is specified, the StartTimestamp value is
	// required.
	//
	// Only fragments that start exactly at or after StartTimestamp are included
	// in the session. Fragments that start before StartTimestamp and continue past
	// it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP,
	// the StartTimestamp must be later than the stream head.
	StartTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

The values in DASHimestampRange are inclusive. Fragments that start exactly at or after the start time are included in the session. Fragments that start before the start time and continue past it are not included in the session.

func (DASHTimestampRange) GoString added in v1.20.17 

func (s DASHTimestampRange) GoString() string

GoString returns the string representation.

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

func (*DASHTimestampRange) SetEndTimestamp added in v1.20.17 

func (s *DASHTimestampRange) SetEndTimestamp(v time.Time) *DASHTimestampRange

SetEndTimestamp sets the EndTimestamp field's value.

func (*DASHTimestampRange) SetStartTimestamp added in v1.20.17 

func (s *DASHTimestampRange) SetStartTimestamp(v time.Time) *DASHTimestampRange

SetStartTimestamp sets the StartTimestamp field's value.

func (DASHTimestampRange) String added in v1.20.17 

func (s DASHTimestampRange) String() string

String returns the string representation.

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

type Fragment 

type Fragment struct {

	// The playback duration or other time value associated with the fragment.
	FragmentLengthInMilliseconds *int64 `type:"long"`

	// The unique identifier of the fragment. This value monotonically increases
	// based on the ingestion order.
	FragmentNumber *string `min:"1" type:"string"`

	// The total fragment size, including information about the fragment and contained
	// media data.
	FragmentSizeInBytes *int64 `type:"long"`

	// The timestamp from the producer corresponding to the fragment.
	ProducerTimestamp *time.Time `type:"timestamp"`

	// The timestamp from the Amazon Web Services server corresponding to the fragment.
	ServerTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents a segment of video or other time-delimited data.

func (Fragment) GoString 

func (s Fragment) GoString() string

GoString returns the string representation.

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

func (*Fragment) SetFragmentLengthInMilliseconds 

func (s *Fragment) SetFragmentLengthInMilliseconds(v int64) *Fragment

SetFragmentLengthInMilliseconds sets the FragmentLengthInMilliseconds field's value.

func (*Fragment) SetFragmentNumber 

func (s *Fragment) SetFragmentNumber(v string) *Fragment

SetFragmentNumber sets the FragmentNumber field's value.

func (*Fragment) SetFragmentSizeInBytes 

func (s *Fragment) SetFragmentSizeInBytes(v int64) *Fragment

SetFragmentSizeInBytes sets the FragmentSizeInBytes field's value.

func (*Fragment) SetProducerTimestamp 

func (s *Fragment) SetProducerTimestamp(v time.Time) *Fragment

SetProducerTimestamp sets the ProducerTimestamp field's value.

func (*Fragment) SetServerTimestamp 

func (s *Fragment) SetServerTimestamp(v time.Time) *Fragment

SetServerTimestamp sets the ServerTimestamp field's value.

func (Fragment) String 

func (s Fragment) String() string

String returns the string representation.

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

type FragmentSelector 

type FragmentSelector struct {

	// The origin of the timestamps to use (Server or Producer).
	//
	// FragmentSelectorType is a required field
	FragmentSelectorType *string `type:"string" required:"true" enum:"FragmentSelectorType"`

	// The range of timestamps to return.
	//
	// TimestampRange is a required field
	TimestampRange *TimestampRange `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Describes the timestamp range and timestamp origin of a range of fragments.

Only fragments with a start timestamp greater than or equal to the given start time and less than or equal to the end time are returned. For example, if a stream contains fragments with the following start timestamps:

  • 00:00:00

  • 00:00:02

  • 00:00:04

  • 00:00:06

A fragment selector range with a start time of 00:00:01 and end time of 00:00:04 would return the fragments with start times of 00:00:02 and 00:00:04.

func (FragmentSelector) GoString 

func (s FragmentSelector) GoString() string

GoString returns the string representation.

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

func (*FragmentSelector) SetFragmentSelectorType 

func (s *FragmentSelector) SetFragmentSelectorType(v string) *FragmentSelector

SetFragmentSelectorType sets the FragmentSelectorType field's value.

func (*FragmentSelector) SetTimestampRange 

func (s *FragmentSelector) SetTimestampRange(v *TimestampRange) *FragmentSelector

SetTimestampRange sets the TimestampRange field's value.

func (FragmentSelector) String 

func (s FragmentSelector) String() string

String returns the string representation.

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

func (*FragmentSelector) Validate 

func (s *FragmentSelector) Validate() error

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

type GetClipInput added in v1.30.16 

type GetClipInput struct {

	// The time range of the requested clip and the source of the timestamps.
	//
	// ClipFragmentSelector is a required field
	ClipFragmentSelector *ClipFragmentSelector `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of the stream for which to retrieve the media
	// clip.
	//
	// You must specify either the StreamName or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

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

func (GetClipInput) GoString added in v1.30.16 

func (s GetClipInput) GoString() string

GoString returns the string representation.

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

func (*GetClipInput) SetClipFragmentSelector added in v1.30.16 

func (s *GetClipInput) SetClipFragmentSelector(v *ClipFragmentSelector) *GetClipInput

SetClipFragmentSelector sets the ClipFragmentSelector field's value.

func (*GetClipInput) SetStreamARN added in v1.30.16 

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

SetStreamARN sets the StreamARN field's value.

func (*GetClipInput) SetStreamName added in v1.30.16 

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

SetStreamName sets the StreamName field's value.

func (GetClipInput) String added in v1.30.16 

func (s GetClipInput) String() string

String returns the string representation.

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

func (*GetClipInput) Validate added in v1.30.16 

func (s *GetClipInput) Validate() error

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

type GetClipOutput added in v1.30.16 

type GetClipOutput struct {

	// The content type of the media in the requested clip.
	ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string"`

	// Traditional MP4 file that contains the media clip from the specified video
	// stream. The output will contain the first 100 MB or the first 200 fragments
	// from the specified start timestamp. For more information, see Kinesis Video
	// Streams Limits (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).
	Payload io.ReadCloser `type:"blob"`
	// contains filtered or unexported fields
}

func (GetClipOutput) GoString added in v1.30.16 

func (s GetClipOutput) GoString() string

GoString returns the string representation.

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

func (*GetClipOutput) SetContentType added in v1.30.16 

func (s *GetClipOutput) SetContentType(v string) *GetClipOutput

SetContentType sets the ContentType field's value.

func (*GetClipOutput) SetPayload added in v1.30.16 

func (s *GetClipOutput) SetPayload(v io.ReadCloser) *GetClipOutput

SetPayload sets the Payload field's value.

func (GetClipOutput) String added in v1.30.16 

func (s GetClipOutput) String() string

String returns the string representation.

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

type GetDASHStreamingSessionURLInput added in v1.20.17 

type GetDASHStreamingSessionURLInput struct {

	// The time range of the requested fragment and the source of the timestamps.
	//
	// This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This
	// parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the
	// FragmentSelectorType can be set, but the TimestampRange should not be set.
	// If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and
	// TimestampRange must be set.
	DASHFragmentSelector *DASHFragmentSelector `type:"structure"`

	// Fragments are identified in the manifest file based on their sequence number
	// in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video
	// Streams fragment number is added to each S element in the manifest file with
	// the attribute name “kvs:fn”. These fragment numbers can be used for logging
	// or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A
	// custom MPEG-DASH media player is necessary to leverage these this custom
	// attribute.
	//
	// The default value is NEVER.
	DisplayFragmentNumber *string `type:"string" enum:"DASHDisplayFragmentNumber"`

	// Per the MPEG-DASH specification, the wall-clock time of fragments in the
	// manifest file can be derived using attributes in the manifest itself. However,
	// typically, MPEG-DASH compatible media players do not properly handle gaps
	// in the media timeline. Kinesis Video Streams adjusts the media timeline in
	// the manifest file to enable playback of media with discontinuities. Therefore,
	// the wall-clock time derived from the manifest file may be inaccurate. If
	// DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp
	// is added to each S element in the manifest file with the attribute name “kvs:ts”.
	// A custom MPEG-DASH media player is necessary to leverage this custom attribute.
	//
	// The default value is NEVER. When DASHFragmentSelector is SERVER_TIMESTAMP,
	// the timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector
	// is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.
	DisplayFragmentTimestamp *string `type:"string" enum:"DASHDisplayFragmentTimestamp"`

	// The time in seconds until the requested session expires. This value can be
	// between 300 (5 minutes) and 43200 (12 hours).
	//
	// When a session expires, no new calls to GetDashManifest, GetMP4InitFragment,
	// or GetMP4MediaFragment can be made for that session.
	//
	// The default is 300 (5 minutes).
	Expires *int64 `min:"300" type:"integer"`

	// The maximum number of fragments that are returned in the MPEG-DASH manifest.
	//
	// When the PlaybackMode is LIVE, the most recent fragments are returned up
	// to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are
	// returned, up to this maximum number.
	//
	// When there are a higher number of fragments available in a live MPEG-DASH
	// manifest, video players often buffer content before starting playback. Increasing
	// the buffer size increases the playback latency, but it decreases the likelihood
	// that rebuffering will occur during playback. We recommend that a live MPEG-DASH
	// manifest have a minimum of 3 fragments and a maximum of 10 fragments.
	//
	// The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000
	// if PlaybackMode is ON_DEMAND.
	//
	// The maximum value of 1,000 fragments corresponds to more than 16 minutes
	// of video on streams with 1-second fragments, and more than 2 1/2 hours of
	// video on streams with 10-second fragments.
	MaxManifestFragmentResults *int64 `min:"1" type:"long"`

	// Whether to retrieve live, live replay, or archived, on-demand data.
	//
	// Features of the three types of sessions include the following:
	//
	//    * LIVE : For sessions of this type, the MPEG-DASH manifest is continually
	//    updated with the latest fragments as they become available. We recommend
	//    that the media player retrieve a new manifest on a one-second interval.
	//    When this type of session is played in a media player, the user interface
	//    typically displays a "live" notification, with no scrubber control for
	//    choosing the position in the playback window to display. In LIVE mode,
	//    the newest available fragments are included in an MPEG-DASH manifest,
	//    even if there is a gap between fragments (that is, if a fragment is missing).
	//    A gap like this might cause a media player to halt or cause a jump in
	//    playback. In this mode, fragments are not added to the MPEG-DASH manifest
	//    if they are older than the newest fragment in the playlist. If the missing
	//    fragment becomes available after a subsequent fragment is added to the
	//    manifest, the older fragment is not added, and the gap is not filled.
	//
	//    * LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated
	//    similarly to how it is updated for LIVE mode except that it starts by
	//    including fragments from a given start time. Instead of fragments being
	//    added as they are ingested, fragments are added as the duration of the
	//    next fragment elapses. For example, if the fragments in the session are
	//    two seconds long, then a new fragment is added to the manifest every two
	//    seconds. This mode is useful to be able to start playback from when an
	//    event is detected and continue live streaming media that has not yet been
	//    ingested as of the time of the session creation. This mode is also useful
	//    to stream previously archived media without being limited by the 1,000
	//    fragment limit in the ON_DEMAND mode.
	//
	//    * ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains
	//    all the fragments for the session, up to the number that is specified
	//    in MaxManifestFragmentResults. The manifest must be retrieved only once
	//    for each session. When this type of session is played in a media player,
	//    the user interface typically displays a scrubber control for choosing
	//    the position in the playback window to display.
	//
	// In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and
	// if there are multiple fragments with the same start timestamp, the fragment
	// that has the larger fragment number (that is, the newer fragment) is included
	// in the MPEG-DASH manifest. The other fragments are not included. Fragments
	// that have different timestamps but have overlapping durations are still included
	// in the MPEG-DASH manifest. This can lead to unexpected behavior in the media
	// player.
	//
	// The default is LIVE.
	PlaybackMode *string `type:"string" enum:"DASHPlaybackMode"`

	// The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH
	// manifest URL.
	//
	// You must specify either the StreamName or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream for which to retrieve the MPEG-DASH manifest URL.
	//
	// You must specify either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetDASHStreamingSessionURLInput) GoString added in v1.20.17 

func (s GetDASHStreamingSessionURLInput) GoString() string

GoString returns the string representation.

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

func (*GetDASHStreamingSessionURLInput) SetDASHFragmentSelector added in v1.20.17 

func (s *GetDASHStreamingSessionURLInput) SetDASHFragmentSelector(v *DASHFragmentSelector) *GetDASHStreamingSessionURLInput

SetDASHFragmentSelector sets the DASHFragmentSelector field's value.

func (*GetDASHStreamingSessionURLInput) SetDisplayFragmentNumber added in v1.20.17 

func (s *GetDASHStreamingSessionURLInput) SetDisplayFragmentNumber(v string) *GetDASHStreamingSessionURLInput

SetDisplayFragmentNumber sets the DisplayFragmentNumber field's value.

func (*GetDASHStreamingSessionURLInput) SetDisplayFragmentTimestamp added in v1.20.17 

func (s *GetDASHStreamingSessionURLInput) SetDisplayFragmentTimestamp(v string) *GetDASHStreamingSessionURLInput

SetDisplayFragmentTimestamp sets the DisplayFragmentTimestamp field's value.

func (*GetDASHStreamingSessionURLInput) SetExpires added in v1.20.17 

func (s *GetDASHStreamingSessionURLInput) SetExpires(v int64) *GetDASHStreamingSessionURLInput

SetExpires sets the Expires field's value.

func (*GetDASHStreamingSessionURLInput) SetMaxManifestFragmentResults added in v1.20.17 

func (s *GetDASHStreamingSessionURLInput) SetMaxManifestFragmentResults(v int64) *GetDASHStreamingSessionURLInput

SetMaxManifestFragmentResults sets the MaxManifestFragmentResults field's value.

func (*GetDASHStreamingSessionURLInput) SetPlaybackMode added in v1.20.17 

func (s *GetDASHStreamingSessionURLInput) SetPlaybackMode(v string) *GetDASHStreamingSessionURLInput

SetPlaybackMode sets the PlaybackMode field's value.

func (*GetDASHStreamingSessionURLInput) SetStreamARN added in v1.20.17 

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

SetStreamARN sets the StreamARN field's value.

func (*GetDASHStreamingSessionURLInput) SetStreamName added in v1.20.17 

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

SetStreamName sets the StreamName field's value.

func (GetDASHStreamingSessionURLInput) String added in v1.20.17 

func (s GetDASHStreamingSessionURLInput) String() string

String returns the string representation.

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

func (*GetDASHStreamingSessionURLInput) Validate added in v1.20.17 

func (s *GetDASHStreamingSessionURLInput) Validate() error

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

type GetDASHStreamingSessionURLOutput added in v1.20.17 

type GetDASHStreamingSessionURLOutput struct {

	// The URL (containing the session token) that a media player can use to retrieve
	// the MPEG-DASH manifest.
	DASHStreamingSessionURL *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetDASHStreamingSessionURLOutput) GoString added in v1.20.17 

func (s GetDASHStreamingSessionURLOutput) GoString() string

GoString returns the string representation.

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

func (*GetDASHStreamingSessionURLOutput) SetDASHStreamingSessionURL added in v1.20.17 

func (s *GetDASHStreamingSessionURLOutput) SetDASHStreamingSessionURL(v string) *GetDASHStreamingSessionURLOutput

SetDASHStreamingSessionURL sets the DASHStreamingSessionURL field's value.

func (GetDASHStreamingSessionURLOutput) String added in v1.20.17 

func (s GetDASHStreamingSessionURLOutput) String() string

String returns the string representation.

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

type GetHLSStreamingSessionURLInput added in v1.14.27 

type GetHLSStreamingSessionURLInput struct {

	// Specifies which format should be used for packaging the media. Specifying
	// the FRAGMENTED_MP4 container format packages the media into MP4 fragments
	// (fMP4 or CMAF). This is the recommended packaging because there is minimal
	// packaging overhead. The other container format option is MPEG_TS. HLS has
	// supported MPEG TS chunks since it was released and is sometimes the only
	// supported packaging on older HLS players. MPEG TS typically has a 5-25 percent
	// packaging overhead. This means MPEG TS typically requires 5-25 percent more
	// bandwidth and cost than fMP4.
	//
	// The default is FRAGMENTED_MP4.
	ContainerFormat *string `type:"string" enum:"ContainerFormat"`

	// Specifies when flags marking discontinuities between fragments are added
	// to the media playlists.
	//
	// Media players typically build a timeline of media content to play, based
	// on the timestamps of each fragment. This means that if there is any overlap
	// or gap between fragments (as is typical if HLSFragmentSelector is set to
	// SERVER_TIMESTAMP), the media player timeline will also have small gaps between
	// fragments in some places, and will overwrite frames in other places. Gaps
	// in the media player timeline can cause playback to stall and overlaps can
	// cause playback to be jittery. When there are discontinuity flags between
	// fragments, the media player is expected to reset the timeline, resulting
	// in the next fragment being played immediately after the previous fragment.
	//
	// The following modes are supported:
	//
	//    * ALWAYS: a discontinuity marker is placed between every fragment in the
	//    HLS media playlist. It is recommended to use a value of ALWAYS if the
	//    fragment timestamps are not accurate.
	//
	//    * NEVER: no discontinuity markers are placed anywhere. It is recommended
	//    to use a value of NEVER to ensure the media player timeline most accurately
	//    maps to the producer timestamps.
	//
	//    * ON_DISCONTINUITY: a discontinuity marker is placed between fragments
	//    that have a gap or overlap of more than 50 milliseconds. For most playback
	//    scenarios, it is recommended to use a value of ON_DISCONTINUITY so that
	//    the media player timeline is only reset when there is a significant issue
	//    with the media timeline (e.g. a missing fragment).
	//
	// The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP,
	// and NEVER when it is set to PRODUCER_TIMESTAMP.
	DiscontinuityMode *string `type:"string" enum:"HLSDiscontinuityMode"`

	// Specifies when the fragment start timestamps should be included in the HLS
	// media playlist. Typically, media players report the playhead position as
	// a time relative to the start of the first fragment in the playback session.
	// However, when the start timestamps are included in the HLS media playlist,
	// some media players might report the current playhead as an absolute time
	// based on the fragment timestamps. This can be useful for creating a playback
	// experience that shows viewers the wall-clock time of the media.
	//
	// The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps
	// will be the server start timestamps. Similarly, when HLSFragmentSelector
	// is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.
	DisplayFragmentTimestamp *string `type:"string" enum:"HLSDisplayFragmentTimestamp"`

	// The time in seconds until the requested session expires. This value can be
	// between 300 (5 minutes) and 43200 (12 hours).
	//
	// When a session expires, no new calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist,
	// GetMP4InitFragment, GetMP4MediaFragment, or GetTSFragment can be made for
	// that session.
	//
	// The default is 300 (5 minutes).
	Expires *int64 `min:"300" type:"integer"`

	// The time range of the requested fragment and the source of the timestamps.
	//
	// This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This
	// parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the
	// FragmentSelectorType can be set, but the TimestampRange should not be set.
	// If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and
	// TimestampRange must be set.
	HLSFragmentSelector *HLSFragmentSelector `type:"structure"`

	// The maximum number of fragments that are returned in the HLS media playlists.
	//
	// When the PlaybackMode is LIVE, the most recent fragments are returned up
	// to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are
	// returned, up to this maximum number.
	//
	// When there are a higher number of fragments available in a live HLS media
	// playlist, video players often buffer content before starting playback. Increasing
	// the buffer size increases the playback latency, but it decreases the likelihood
	// that rebuffering will occur during playback. We recommend that a live HLS
	// media playlist have a minimum of 3 fragments and a maximum of 10 fragments.
	//
	// The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000
	// if PlaybackMode is ON_DEMAND.
	//
	// The maximum value of 5,000 fragments corresponds to more than 80 minutes
	// of video on streams with 1-second fragments, and more than 13 hours of video
	// on streams with 10-second fragments.
	MaxMediaPlaylistFragmentResults *int64 `min:"1" type:"long"`

	// Whether to retrieve live, live replay, or archived, on-demand data.
	//
	// Features of the three types of sessions include the following:
	//
	//    * LIVE : For sessions of this type, the HLS media playlist is continually
	//    updated with the latest fragments as they become available. We recommend
	//    that the media player retrieve a new playlist on a one-second interval.
	//    When this type of session is played in a media player, the user interface
	//    typically displays a "live" notification, with no scrubber control for
	//    choosing the position in the playback window to display. In LIVE mode,
	//    the newest available fragments are included in an HLS media playlist,
	//    even if there is a gap between fragments (that is, if a fragment is missing).
	//    A gap like this might cause a media player to halt or cause a jump in
	//    playback. In this mode, fragments are not added to the HLS media playlist
	//    if they are older than the newest fragment in the playlist. If the missing
	//    fragment becomes available after a subsequent fragment is added to the
	//    playlist, the older fragment is not added, and the gap is not filled.
	//
	//    * LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated
	//    similarly to how it is updated for LIVE mode except that it starts by
	//    including fragments from a given start time. Instead of fragments being
	//    added as they are ingested, fragments are added as the duration of the
	//    next fragment elapses. For example, if the fragments in the session are
	//    two seconds long, then a new fragment is added to the media playlist every
	//    two seconds. This mode is useful to be able to start playback from when
	//    an event is detected and continue live streaming media that has not yet
	//    been ingested as of the time of the session creation. This mode is also
	//    useful to stream previously archived media without being limited by the
	//    1,000 fragment limit in the ON_DEMAND mode.
	//
	//    * ON_DEMAND : For sessions of this type, the HLS media playlist contains
	//    all the fragments for the session, up to the number that is specified
	//    in MaxMediaPlaylistFragmentResults. The playlist must be retrieved only
	//    once for each session. When this type of session is played in a media
	//    player, the user interface typically displays a scrubber control for choosing
	//    the position in the playback window to display.
	//
	// In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and
	// if there are multiple fragments with the same start timestamp, the fragment
	// that has the largest fragment number (that is, the newest fragment) is included
	// in the HLS media playlist. The other fragments are not included. Fragments
	// that have different timestamps but have overlapping durations are still included
	// in the HLS media playlist. This can lead to unexpected behavior in the media
	// player.
	//
	// The default is LIVE.
	PlaybackMode *string `type:"string" enum:"HLSPlaybackMode"`

	// The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS
	// master playlist URL.
	//
	// You must specify either the StreamName or the StreamARN.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream for which to retrieve the HLS master playlist URL.
	//
	// You must specify either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetHLSStreamingSessionURLInput) GoString added in v1.14.27 

func (s GetHLSStreamingSessionURLInput) GoString() string

GoString returns the string representation.

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

func (*GetHLSStreamingSessionURLInput) SetContainerFormat added in v1.17.3 

func (s *GetHLSStreamingSessionURLInput) SetContainerFormat(v string) *GetHLSStreamingSessionURLInput

SetContainerFormat sets the ContainerFormat field's value.

func (*GetHLSStreamingSessionURLInput) SetDiscontinuityMode added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetDiscontinuityMode(v string) *GetHLSStreamingSessionURLInput

SetDiscontinuityMode sets the DiscontinuityMode field's value.

func (*GetHLSStreamingSessionURLInput) SetDisplayFragmentTimestamp added in v1.17.3 

func (s *GetHLSStreamingSessionURLInput) SetDisplayFragmentTimestamp(v string) *GetHLSStreamingSessionURLInput

SetDisplayFragmentTimestamp sets the DisplayFragmentTimestamp field's value.

func (*GetHLSStreamingSessionURLInput) SetExpires added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetExpires(v int64) *GetHLSStreamingSessionURLInput

SetExpires sets the Expires field's value.

func (*GetHLSStreamingSessionURLInput) SetHLSFragmentSelector added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetHLSFragmentSelector(v *HLSFragmentSelector) *GetHLSStreamingSessionURLInput

SetHLSFragmentSelector sets the HLSFragmentSelector field's value.

func (*GetHLSStreamingSessionURLInput) SetMaxMediaPlaylistFragmentResults added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetMaxMediaPlaylistFragmentResults(v int64) *GetHLSStreamingSessionURLInput

SetMaxMediaPlaylistFragmentResults sets the MaxMediaPlaylistFragmentResults field's value.

func (*GetHLSStreamingSessionURLInput) SetPlaybackMode added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) SetPlaybackMode(v string) *GetHLSStreamingSessionURLInput

SetPlaybackMode sets the PlaybackMode field's value.

func (*GetHLSStreamingSessionURLInput) SetStreamARN added in v1.14.27 

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

SetStreamARN sets the StreamARN field's value.

func (*GetHLSStreamingSessionURLInput) SetStreamName added in v1.14.27 

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

SetStreamName sets the StreamName field's value.

func (GetHLSStreamingSessionURLInput) String added in v1.14.27 

func (s GetHLSStreamingSessionURLInput) String() string

String returns the string representation.

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

func (*GetHLSStreamingSessionURLInput) Validate added in v1.14.27 

func (s *GetHLSStreamingSessionURLInput) Validate() error

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

type GetHLSStreamingSessionURLOutput added in v1.14.27 

type GetHLSStreamingSessionURLOutput struct {

	// The URL (containing the session token) that a media player can use to retrieve
	// the HLS master playlist.
	HLSStreamingSessionURL *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetHLSStreamingSessionURLOutput) GoString added in v1.14.27 

func (s GetHLSStreamingSessionURLOutput) GoString() string

GoString returns the string representation.

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

func (*GetHLSStreamingSessionURLOutput) SetHLSStreamingSessionURL added in v1.14.27 

func (s *GetHLSStreamingSessionURLOutput) SetHLSStreamingSessionURL(v string) *GetHLSStreamingSessionURLOutput

SetHLSStreamingSessionURL sets the HLSStreamingSessionURL field's value.

func (GetHLSStreamingSessionURLOutput) String added in v1.14.27 

func (s GetHLSStreamingSessionURLOutput) String() string

String returns the string representation.

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

type GetImagesInput added in v1.44.6 

type GetImagesInput struct {

	// The end timestamp for the range of images to be generated. If the time range
	// between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp,
	// you will receive an IllegalArgumentException.
	//
	// EndTimestamp is a required field
	EndTimestamp *time.Time `type:"timestamp" required:"true"`

	// The format that will be used to encode the image.
	//
	// Format is a required field
	Format *string `type:"string" required:"true" enum:"Format"`

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

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

	// The origin of the Server or Producer timestamps to use to generate the images.
	//
	// ImageSelectorType is a required field
	ImageSelectorType *string `type:"string" required:"true" enum:"ImageSelectorType"`

	// The maximum number of images to be returned by the API.
	//
	// The default limit is 25 images per API response. Providing a MaxResults greater
	// than this value will result in a page size of 25. Any additional results
	// will be paginated.
	MaxResults *int64 `min:"1" type:"long"`

	// A token that specifies where to start paginating the next set of Images.
	// This is the GetImages:NextToken from a previously truncated response.
	NextToken *string `min:"1" type:"string"`

	// The time interval in milliseconds (ms) at which the images need to be generated
	// from the stream. The minimum value that can be provided is 200 ms (5 images
	// per second). If the timestamp range is less than the sampling interval, the
	// image from the startTimestamp will be returned if available.
	SamplingInterval *int64 `type:"integer"`

	// The starting point from which the images should be generated. This StartTimestamp
	// must be within an inclusive range of timestamps for an image to be returned.
	//
	// StartTimestamp is a required field
	StartTimestamp *time.Time `type:"timestamp" required:"true"`

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

	// The name of the stream from which to retrieve the images. You must specify
	// either the StreamName or the StreamARN.
	StreamName *string `min:"1" type:"string"`

	// The width of the output image that is used in conjunction with the HeightPixels
	// parameter. When both WidthPixels and HeightPixels parameters are provided,
	// the image will be stretched to fit the specified aspect ratio. If only the
	// WidthPixels parameter is provided or if only the HeightPixels is provided,
	// a ValidationException will be thrown. If neither parameter is provided, the
	// original image size from the stream will be returned.
	WidthPixels *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (GetImagesInput) GoString added in v1.44.6 

func (s GetImagesInput) GoString() string

GoString returns the string representation.

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

func (*GetImagesInput) SetEndTimestamp added in v1.44.6 

func (s *GetImagesInput) SetEndTimestamp(v time.Time) *GetImagesInput

SetEndTimestamp sets the EndTimestamp field's value.

func (*GetImagesInput) SetFormat added in v1.44.6 

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

SetFormat sets the Format field's value.

func (*GetImagesInput) SetFormatConfig added in v1.44.6 

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

SetFormatConfig sets the FormatConfig field's value.

func (*GetImagesInput) SetHeightPixels added in v1.44.6 

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

SetHeightPixels sets the HeightPixels field's value.

func (*GetImagesInput) SetImageSelectorType added in v1.44.6 

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

SetImageSelectorType sets the ImageSelectorType field's value.

func (*GetImagesInput) SetMaxResults added in v1.44.6 

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

SetMaxResults sets the MaxResults field's value.

func (*GetImagesInput) SetNextToken added in v1.44.6 

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

SetNextToken sets the NextToken field's value.

func (*GetImagesInput) SetSamplingInterval added in v1.44.6 

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

SetSamplingInterval sets the SamplingInterval field's value.

func (*GetImagesInput) SetStartTimestamp added in v1.44.6 

func (s *GetImagesInput) SetStartTimestamp(v time.Time) *GetImagesInput

SetStartTimestamp sets the StartTimestamp field's value.

func (*GetImagesInput) SetStreamARN added in v1.44.6 

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

SetStreamARN sets the StreamARN field's value.

func (*GetImagesInput) SetStreamName added in v1.44.6 

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

SetStreamName sets the StreamName field's value.

func (*GetImagesInput) SetWidthPixels added in v1.44.6 

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

SetWidthPixels sets the WidthPixels field's value.

func (GetImagesInput) String added in v1.44.6 

func (s GetImagesInput) String() string

String returns the string representation.

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

func (*GetImagesInput) Validate added in v1.44.6 

func (s *GetImagesInput) Validate() error

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

type GetImagesOutput added in v1.44.6 

type GetImagesOutput struct {

	// The list of images generated from the video stream. If there is no media
	// available for the given timestamp, the NO_MEDIA error will be listed in the
	// output. If an error occurs while the image is being generated, the MEDIA_ERROR
	// will be listed in the output as the cause of the missing image.
	Images []*Image `type:"list"`

	// The encrypted token that was used in the request to get more images.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetImagesOutput) GoString added in v1.44.6 

func (s GetImagesOutput) GoString() string

GoString returns the string representation.

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

func (*GetImagesOutput) SetImages added in v1.44.6 

func (s *GetImagesOutput) SetImages(v []*Image) *GetImagesOutput

SetImages sets the Images field's value.

func (*GetImagesOutput) SetNextToken added in v1.44.6 

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

SetNextToken sets the NextToken field's value.

func (GetImagesOutput) String added in v1.44.6 

func (s GetImagesOutput) String() string

String returns the string representation.

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

type GetMediaForFragmentListInput 

type GetMediaForFragmentListInput struct {

	// A list of the numbers of fragments for which to retrieve media. You retrieve
	// these values with ListFragments.
	//
	// Fragments is a required field
	Fragments []*string `min:"1" type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the stream from which to retrieve fragment
	// media. Specify either this parameter or the StreamName parameter.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which to retrieve fragment media. Specify either
	// this parameter or the StreamARN parameter.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetMediaForFragmentListInput) GoString 

func (s GetMediaForFragmentListInput) GoString() string

GoString returns the string representation.

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

func (*GetMediaForFragmentListInput) SetFragments 

func (s *GetMediaForFragmentListInput) SetFragments(v []*string) *GetMediaForFragmentListInput

SetFragments sets the Fragments field's value.

func (*GetMediaForFragmentListInput) SetStreamARN added in v1.37.11 

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

SetStreamARN sets the StreamARN field's value.

func (*GetMediaForFragmentListInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (GetMediaForFragmentListInput) String 

func (s GetMediaForFragmentListInput) String() string

String returns the string representation.

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

func (*GetMediaForFragmentListInput) Validate 

func (s *GetMediaForFragmentListInput) Validate() error

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

type GetMediaForFragmentListOutput 

type GetMediaForFragmentListOutput struct {

	// The content type of the requested media.
	ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string"`

	// The payload that Kinesis Video Streams returns is a sequence of chunks from
	// the specified stream. For information about the chunks, see PutMedia (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_PutMedia.html).
	// The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList
	// call also include the following additional Matroska (MKV) tags:
	//
	//    * AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
	//
	//    * AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the
	//    fragment.
	//
	//    * AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of
	//    the fragment.
	//
	// The following tags will be included if an exception occurs:
	//
	//    * AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw
	//    the exception
	//
	//    * AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the
	//
	//    * AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception
	Payload io.ReadCloser `type:"blob"`
	// contains filtered or unexported fields
}

func (GetMediaForFragmentListOutput) GoString 

func (s GetMediaForFragmentListOutput) GoString() string

GoString returns the string representation.

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

func (*GetMediaForFragmentListOutput) SetContentType 

func (s *GetMediaForFragmentListOutput) SetContentType(v string) *GetMediaForFragmentListOutput

SetContentType sets the ContentType field's value.

func (*GetMediaForFragmentListOutput) SetPayload 

func (s *GetMediaForFragmentListOutput) SetPayload(v io.ReadCloser) *GetMediaForFragmentListOutput

SetPayload sets the Payload field's value.

func (GetMediaForFragmentListOutput) String 

func (s GetMediaForFragmentListOutput) String() string

String returns the string representation.

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

type HLSFragmentSelector added in v1.14.27 

type HLSFragmentSelector struct {

	// The source of the timestamps for the requested media.
	//
	// When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode
	// is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer
	// timestamp within the specified FragmentSelector$TimestampRange is included
	// in the media playlist. In addition, the fragments with producer timestamps
	// within the TimestampRange ingested immediately following the first fragment
	// (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults
	// value) are included.
	//
	// Fragments that have duplicate producer timestamps are deduplicated. This
	// means that if producers are producing a stream of fragments with producer
	// timestamps that are approximately equal to the true clock time, the HLS media
	// playlists will contain all of the fragments within the requested timestamp
	// range. If some fragments are ingested within the same time range and very
	// different points in time, only the oldest ingested collection of fragments
	// are returned.
	//
	// When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode
	// is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication.
	// But the most recently ingested fragments based on server timestamps are included
	// in the HLS media playlist. This means that even if fragments ingested in
	// the past have producer timestamps with values now, they are not included
	// in the HLS media playlist.
	//
	// The default is SERVER_TIMESTAMP.
	FragmentSelectorType *string `type:"string" enum:"HLSFragmentSelectorType"`

	// The start and end of the timestamp range for the requested media.
	//
	// This value should not be present if PlaybackType is LIVE.
	TimestampRange *HLSTimestampRange `type:"structure"`
	// contains filtered or unexported fields
}

Contains the range of timestamps for the requested media, and the source of the timestamps.

func (HLSFragmentSelector) GoString added in v1.14.27 

func (s HLSFragmentSelector) GoString() string

GoString returns the string representation.

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

func (*HLSFragmentSelector) SetFragmentSelectorType added in v1.14.27 

func (s *HLSFragmentSelector) SetFragmentSelectorType(v string) *HLSFragmentSelector

SetFragmentSelectorType sets the FragmentSelectorType field's value.

func (*HLSFragmentSelector) SetTimestampRange added in v1.14.27 

func (s *HLSFragmentSelector) SetTimestampRange(v *HLSTimestampRange) *HLSFragmentSelector

SetTimestampRange sets the TimestampRange field's value.

func (HLSFragmentSelector) String added in v1.14.27 

func (s HLSFragmentSelector) String() string

String returns the string representation.

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

type HLSTimestampRange added in v1.14.27 

type HLSTimestampRange struct {

	// The end of the timestamp range for the requested media. This value must be
	// within 24 hours of the specified StartTimestamp, and it must be later than
	// the StartTimestamp value.
	//
	// If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must
	// be in the past.
	//
	// The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY
	// mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session
	// will continue to include newly ingested fragments until the session expires.
	//
	// This value is inclusive. The EndTimestamp is compared to the (starting) timestamp
	// of the fragment. Fragments that start before the EndTimestamp value and continue
	// past it are included in the session.
	EndTimestamp *time.Time `type:"timestamp"`

	// The start of the timestamp range for the requested media.
	//
	// If the HLSTimestampRange value is specified, the StartTimestamp value is
	// required.
	//
	// Only fragments that start exactly at or after StartTimestamp are included
	// in the session. Fragments that start before StartTimestamp and continue past
	// it aren't included in the session. If FragmentSelectorType is SERVER_TIMESTAMP,
	// the StartTimestamp must be later than the stream head.
	StartTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

func (HLSTimestampRange) GoString added in v1.14.27 

func (s HLSTimestampRange) GoString() string

GoString returns the string representation.

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

func (*HLSTimestampRange) SetEndTimestamp added in v1.14.27 

func (s *HLSTimestampRange) SetEndTimestamp(v time.Time) *HLSTimestampRange

SetEndTimestamp sets the EndTimestamp field's value.

func (*HLSTimestampRange) SetStartTimestamp added in v1.14.27 

func (s *HLSTimestampRange) SetStartTimestamp(v time.Time) *HLSTimestampRange

SetStartTimestamp sets the StartTimestamp field's value.

func (HLSTimestampRange) String added in v1.14.27 

func (s HLSTimestampRange) String() string

String returns the string representation.

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

type Image added in v1.44.6 

type Image struct {

	// The error message shown when the image for the provided timestamp was not
	// extracted due to a non-tryable error. An error will be returned if:
	//
	//    * There is no media that exists for the specified Timestamp.
	//
	//    * The media for the specified time does not allow an image to be extracted.
	//    In this case the media is audio only, or the incorrect media has been
	//    ingested.
	Error *string `type:"string" enum:"ImageError"`

	// An attribute of the Image object that is Base64 encoded.
	ImageContent *string `min:"1" type:"string"`

	// An attribute of the Image object that is used to extract an image from the
	// video stream. This field is used to manage gaps on images or to better understand
	// the pagination window.
	TimeStamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A structure that contains the Timestamp, Error, and ImageContent.

func (Image) GoString added in v1.44.6 

func (s Image) GoString() string

GoString returns the string representation.

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

func (*Image) SetError added in v1.44.6 

func (s *Image) SetError(v string) *Image

SetError sets the Error field's value.

func (*Image) SetImageContent added in v1.44.6 

func (s *Image) SetImageContent(v string) *Image

SetImageContent sets the ImageContent field's value.

func (*Image) SetTimeStamp added in v1.44.6 

func (s *Image) SetTimeStamp(v time.Time) *Image

SetTimeStamp sets the TimeStamp field's value.

func (Image) String added in v1.44.6 

func (s Image) String() string

String returns the string representation.

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

type 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
}

A specified parameter exceeds its restrictions, is not supported, or can't be used.

func (*InvalidArgumentException) Code added in v1.28.0 

func (s *InvalidArgumentException) Code() string

Code returns the exception type name.

func (*InvalidArgumentException) Error added in v1.28.0 

func (s *InvalidArgumentException) Error() string

func (InvalidArgumentException) GoString added in v1.28.0 

func (s InvalidArgumentException) GoString() string

GoString returns the string representation.

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

func (*InvalidArgumentException) Message added in v1.28.0 

func (s *InvalidArgumentException) Message() string

Message returns the exception's message.

func (*InvalidArgumentException) OrigErr added in v1.28.0 

func (s *InvalidArgumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArgumentException) RequestID added in v1.28.0 

func (s *InvalidArgumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArgumentException) StatusCode added in v1.28.0 

func (s *InvalidArgumentException) StatusCode() int

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

func (InvalidArgumentException) String added in v1.28.0 

func (s InvalidArgumentException) String() string

String returns the string representation.

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

type InvalidCodecPrivateDataException added in v1.28.0 

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

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

The codec private data in at least one of the tracks of the video stream is not valid for this operation.

func (*InvalidCodecPrivateDataException) Code added in v1.28.0 

func (s *InvalidCodecPrivateDataException) Code() string

Code returns the exception type name.

func (*InvalidCodecPrivateDataException) Error added in v1.28.0 

func (s *InvalidCodecPrivateDataException) Error() string

func (InvalidCodecPrivateDataException) GoString added in v1.28.0 

func (s InvalidCodecPrivateDataException) GoString() string

GoString returns the string representation.

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

func (*InvalidCodecPrivateDataException) Message added in v1.28.0 

func (s *InvalidCodecPrivateDataException) Message() string

Message returns the exception's message.

func (*InvalidCodecPrivateDataException) OrigErr added in v1.28.0 

func (s *InvalidCodecPrivateDataException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidCodecPrivateDataException) RequestID added in v1.28.0 

func (s *InvalidCodecPrivateDataException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidCodecPrivateDataException) StatusCode added in v1.28.0 

func (s *InvalidCodecPrivateDataException) StatusCode() int

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

func (InvalidCodecPrivateDataException) String added in v1.28.0 

func (s InvalidCodecPrivateDataException) String() string

String returns the string representation.

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

type InvalidMediaFrameException added in v1.30.16 

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

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

One or more frames in the requested clip could not be parsed based on the specified codec.

func (*InvalidMediaFrameException) Code added in v1.30.16 

func (s *InvalidMediaFrameException) Code() string

Code returns the exception type name.

func (*InvalidMediaFrameException) Error added in v1.30.16 

func (s *InvalidMediaFrameException) Error() string

func (InvalidMediaFrameException) GoString added in v1.30.16 

func (s InvalidMediaFrameException) GoString() string

GoString returns the string representation.

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

func (*InvalidMediaFrameException) Message added in v1.30.16 

func (s *InvalidMediaFrameException) Message() string

Message returns the exception's message.

func (*InvalidMediaFrameException) OrigErr added in v1.30.16 

func (s *InvalidMediaFrameException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidMediaFrameException) RequestID added in v1.30.16 

func (s *InvalidMediaFrameException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidMediaFrameException) StatusCode added in v1.30.16 

func (s *InvalidMediaFrameException) StatusCode() int

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

func (InvalidMediaFrameException) String added in v1.30.16 

func (s InvalidMediaFrameException) String() string

String returns the string representation.

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

type KinesisVideoArchivedMedia 

type KinesisVideoArchivedMedia struct {
	*client.Client
}

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

KinesisVideoArchivedMedia 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) *KinesisVideoArchivedMedia

New creates a new instance of the KinesisVideoArchivedMedia 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 KinesisVideoArchivedMedia client from just a session.
svc := kinesisvideoarchivedmedia.New(mySession)

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

func (*KinesisVideoArchivedMedia) GetClip added in v1.30.16 

func (c *KinesisVideoArchivedMedia) GetClip(input *GetClipInput) (*GetClipOutput, error)

GetClip API operation for Amazon Kinesis Video Streams Archived Media.

Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the specified time range.

Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

As a prerequisite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint, specifying GET_CLIP for the APIName parameter.

An Amazon Kinesis video stream has the following requirements for providing data through MP4:

You can monitor the amount of outgoing data by monitoring the GetClip.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For pricing information, see Amazon Kinesis Video Streams Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) and Amazon Web Services Pricing (https://aws.amazon.com/pricing/). Charges for outgoing Amazon Web Services data apply.

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 Archived Media's API operation GetClip for usage and error information.

Returned Error Types:

  • ResourceNotFoundException GetImages will throw this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

  • NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

  • UnsupportedStreamMediaTypeException The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1 should be V_MPEG/ISO/AVC and, optionally, the codec ID for track 2 should be A_AAC.

  • MissingCodecPrivateDataException No codec private data was found in at least one of tracks of the video stream.

  • InvalidCodecPrivateDataException The codec private data in at least one of the tracks of the video stream is not valid for this operation.

  • InvalidMediaFrameException One or more frames in the requested clip could not be parsed based on the specified codec.

  • NoDataRetentionException GetImages was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetClip

func (*KinesisVideoArchivedMedia) GetClipRequest added in v1.30.16 

func (c *KinesisVideoArchivedMedia) GetClipRequest(input *GetClipInput) (req *request.Request, output *GetClipOutput)

GetClipRequest generates a "aws/request.Request" representing the client's request for the GetClip 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 GetClip for more information on using the GetClip 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 GetClipRequest method.
req, resp := client.GetClipRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetClip

func (*KinesisVideoArchivedMedia) GetClipWithContext added in v1.30.16 

func (c *KinesisVideoArchivedMedia) GetClipWithContext(ctx aws.Context, input *GetClipInput, opts ...request.Option) (*GetClipOutput, error)

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

See GetClip 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 (*KinesisVideoArchivedMedia) GetDASHStreamingSessionURL added in v1.20.17 

func (c *KinesisVideoArchivedMedia) GetDASHStreamingSessionURL(input *GetDASHStreamingSessionURLInput) (*GetDASHStreamingSessionURLOutput, error)

GetDASHStreamingSessionURL API operation for Amazon Kinesis Video Streams Archived Media.

Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can then open the URL in a media player to view the stream contents.

Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

An Amazon Kinesis video stream has the following requirements for providing data through MPEG-DASH:

The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:

Get an endpoint using GetDataEndpoint (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html), specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter.

Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL. Kinesis Video Streams creates an MPEG-DASH streaming session to be used for accessing content in a stream using the MPEG-DASH protocol. GetDASHStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's MPEG-DASH manifest (the root resource needed for streaming with MPEG-DASH).

Don't share or store this token where an unauthorized entity can access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you use with your Amazon Web Services credentials.

The media that is made available through the manifest consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available.

Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization fragment and media fragments available through the manifest URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded video frames or encoded audio samples.

The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

  • GetDASHManifest: Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want to playback.

  • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames.

  • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video. Data retrieved with this action is billable. See Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) for details.

For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For pricing information, see Amazon Kinesis Video Streams Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) and Amazon Web Services Pricing (https://aws.amazon.com/pricing/). Charges for both HLS sessions and outgoing Amazon Web Services data apply.

For more information about HLS, see HTTP Live Streaming (https://developer.apple.com/streaming/) on the Apple Developer site (https://developer.apple.com).

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html).

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 Archived Media's API operation GetDASHStreamingSessionURL for usage and error information.

Returned Error Types:

  • ResourceNotFoundException GetImages will throw this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

  • NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

  • UnsupportedStreamMediaTypeException The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1 should be V_MPEG/ISO/AVC and, optionally, the codec ID for track 2 should be A_AAC.

  • NoDataRetentionException GetImages was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

  • MissingCodecPrivateDataException No codec private data was found in at least one of tracks of the video stream.

  • InvalidCodecPrivateDataException The codec private data in at least one of the tracks of the video stream is not valid for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetDASHStreamingSessionURL

func (*KinesisVideoArchivedMedia) GetDASHStreamingSessionURLRequest added in v1.20.17 

func (c *KinesisVideoArchivedMedia) GetDASHStreamingSessionURLRequest(input *GetDASHStreamingSessionURLInput) (req *request.Request, output *GetDASHStreamingSessionURLOutput)

GetDASHStreamingSessionURLRequest generates a "aws/request.Request" representing the client's request for the GetDASHStreamingSessionURL 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 GetDASHStreamingSessionURL for more information on using the GetDASHStreamingSessionURL 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 GetDASHStreamingSessionURLRequest method.
req, resp := client.GetDASHStreamingSessionURLRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetDASHStreamingSessionURL

func (*KinesisVideoArchivedMedia) GetDASHStreamingSessionURLWithContext added in v1.20.17 

func (c *KinesisVideoArchivedMedia) GetDASHStreamingSessionURLWithContext(ctx aws.Context, input *GetDASHStreamingSessionURLInput, opts ...request.Option) (*GetDASHStreamingSessionURLOutput, error)

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

See GetDASHStreamingSessionURL 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 (*KinesisVideoArchivedMedia) GetHLSStreamingSessionURL added in v1.14.27 

func (c *KinesisVideoArchivedMedia) GetHLSStreamingSessionURL(input *GetHLSStreamingSessionURLInput) (*GetHLSStreamingSessionURLOutput, error)

GetHLSStreamingSessionURL API operation for Amazon Kinesis Video Streams Archived Media.

Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents.

Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

An Amazon Kinesis video stream has the following requirements for providing data through HLS:

  • For streaming video, the media must contain H.264 or H.265 encoded video and, optionally, AAC encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for H.264) or V_MPEG/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC. For audio only streaming, the codec ID of track 1 should be A_AAC.

  • Data retention must be greater than 0.

  • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC 14496-15 (https://www.iso.org/standard/55980.html)). For information about adapting stream data to a given format, see NAL Adaptation Flags (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-nal.html).

  • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7 (https://www.iso.org/standard/43345.html)).

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification (https://tools.ietf.org/html/draft-pantos-http-live-streaming-23).

The following procedure shows how to use HLS with Kinesis Video Streams:

Get an endpoint using GetDataEndpoint (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_GetDataEndpoint.html), specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS).

Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your Amazon Web Services credentials.

The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available.

Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples.

The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

  • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action for each track, and additional metadata for the media player, including estimated bitrate and resolution.

  • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track.

  • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames.

  • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. For the HLS streaming session, in-track codec private data (CPD) changes are supported. After the first media fragment is made available in a streaming session, fragments can contain CPD changes for each track. Therefore, the fragments in a session can have a different resolution, bit rate, or other information in the CPD without interrupting playback. However, any change made in the track number or track codec format can return an error when those different media fragments are loaded. For example, streaming will fail if the fragments in the stream change from having only video to having both audio and video, or if an AAC audio track is changed to an ALAW audio track. For each streaming session, only 500 CPD changes are allowed. Data retrieved with this action is billable. For information, see Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/).

  • GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream. If the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve stream media. Data retrieved with this action is billable. For more information, see Kinesis Video Streams pricing (https://aws.amazon.com/kinesis/video-streams/pricing/).

A streaming session URL must not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/monitoring.html). For pricing information, see Amazon Kinesis Video Streams Pricing (https://aws.amazon.com/kinesis/video-streams/pricing/) and Amazon Web Services Pricing (https://aws.amazon.com/pricing/). Charges for both HLS sessions and outgoing Amazon Web Services data apply.

For more information about HLS, see HTTP Live Streaming (https://developer.apple.com/streaming/) on the Apple Developer site (https://developer.apple.com).

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html).

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 Archived Media's API operation GetHLSStreamingSessionURL for usage and error information.

Returned Error Types:

  • ResourceNotFoundException GetImages will throw this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

  • NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

  • UnsupportedStreamMediaTypeException The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1 should be V_MPEG/ISO/AVC and, optionally, the codec ID for track 2 should be A_AAC.

  • NoDataRetentionException GetImages was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

  • MissingCodecPrivateDataException No codec private data was found in at least one of tracks of the video stream.

  • InvalidCodecPrivateDataException The codec private data in at least one of the tracks of the video stream is not valid for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetHLSStreamingSessionURL

func (*KinesisVideoArchivedMedia) GetHLSStreamingSessionURLRequest added in v1.14.27 

func (c *KinesisVideoArchivedMedia) GetHLSStreamingSessionURLRequest(input *GetHLSStreamingSessionURLInput) (req *request.Request, output *GetHLSStreamingSessionURLOutput)

GetHLSStreamingSessionURLRequest generates a "aws/request.Request" representing the client's request for the GetHLSStreamingSessionURL 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 GetHLSStreamingSessionURL for more information on using the GetHLSStreamingSessionURL 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 GetHLSStreamingSessionURLRequest method.
req, resp := client.GetHLSStreamingSessionURLRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetHLSStreamingSessionURL

func (*KinesisVideoArchivedMedia) GetHLSStreamingSessionURLWithContext added in v1.14.27 

func (c *KinesisVideoArchivedMedia) GetHLSStreamingSessionURLWithContext(ctx aws.Context, input *GetHLSStreamingSessionURLInput, opts ...request.Option) (*GetHLSStreamingSessionURLOutput, error)

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

See GetHLSStreamingSessionURL 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 (*KinesisVideoArchivedMedia) GetImages added in v1.44.6 

func (c *KinesisVideoArchivedMedia) GetImages(input *GetImagesInput) (*GetImagesOutput, error)

GetImages API operation for Amazon Kinesis Video Streams Archived Media.

Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

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 Archived Media's API operation GetImages for usage and error information.

Returned Error Types:

  • ResourceNotFoundException GetImages will throw this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

  • NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

  • NoDataRetentionException GetImages was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImages

func (*KinesisVideoArchivedMedia) GetImagesPages added in v1.44.6 

func (c *KinesisVideoArchivedMedia) GetImagesPages(input *GetImagesInput, fn func(*GetImagesOutput, bool) bool) error

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

See GetImages 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 GetImages operation.
pageNum := 0
err := client.GetImagesPages(params,
    func(page *kinesisvideoarchivedmedia.GetImagesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KinesisVideoArchivedMedia) GetImagesPagesWithContext added in v1.44.6 

func (c *KinesisVideoArchivedMedia) GetImagesPagesWithContext(ctx aws.Context, input *GetImagesInput, fn func(*GetImagesOutput, bool) bool, opts ...request.Option) error

GetImagesPagesWithContext same as GetImagesPages 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 (*KinesisVideoArchivedMedia) GetImagesRequest added in v1.44.6 

func (c *KinesisVideoArchivedMedia) GetImagesRequest(input *GetImagesInput) (req *request.Request, output *GetImagesOutput)

GetImagesRequest generates a "aws/request.Request" representing the client's request for the GetImages 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 GetImages for more information on using the GetImages 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 GetImagesRequest method.
req, resp := client.GetImagesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetImages

func (*KinesisVideoArchivedMedia) GetImagesWithContext added in v1.44.6 

func (c *KinesisVideoArchivedMedia) GetImagesWithContext(ctx aws.Context, input *GetImagesInput, opts ...request.Option) (*GetImagesOutput, error)

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

See GetImages 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 (*KinesisVideoArchivedMedia) GetMediaForFragmentList 

func (c *KinesisVideoArchivedMedia) GetMediaForFragmentList(input *GetMediaForFragmentListInput) (*GetMediaForFragmentListOutput, error)

GetMediaForFragmentList API operation for Amazon Kinesis Video Streams Archived Media.

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter (https://docs.aws.amazon.com/cli/latest/reference/).

For limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html).

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 Archived Media's API operation GetMediaForFragmentList for usage and error information.

Returned Error Types:

  • ResourceNotFoundException GetImages will throw this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

  • NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetMediaForFragmentList

func (*KinesisVideoArchivedMedia) GetMediaForFragmentListRequest 

func (c *KinesisVideoArchivedMedia) GetMediaForFragmentListRequest(input *GetMediaForFragmentListInput) (req *request.Request, output *GetMediaForFragmentListOutput)

GetMediaForFragmentListRequest generates a "aws/request.Request" representing the client's request for the GetMediaForFragmentList 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 GetMediaForFragmentList for more information on using the GetMediaForFragmentList 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 GetMediaForFragmentListRequest method.
req, resp := client.GetMediaForFragmentListRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetMediaForFragmentList

func (*KinesisVideoArchivedMedia) GetMediaForFragmentListWithContext 

func (c *KinesisVideoArchivedMedia) GetMediaForFragmentListWithContext(ctx aws.Context, input *GetMediaForFragmentListInput, opts ...request.Option) (*GetMediaForFragmentListOutput, error)

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

See GetMediaForFragmentList 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 (*KinesisVideoArchivedMedia) ListFragments 

func (c *KinesisVideoArchivedMedia) ListFragments(input *ListFragmentsInput) (*ListFragmentsOutput, error)

ListFragments API operation for Amazon Kinesis Video Streams Archived Media.

Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.

Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second.

You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the --endpoint-url parameter (https://docs.aws.amazon.com/cli/latest/reference/).

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/CommonErrors.html).

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 Archived Media's API operation ListFragments for usage and error information.

Returned Error Types:

  • ResourceNotFoundException GetImages will throw this error when Kinesis Video Streams can't find the stream that you specified.

    GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used.

  • ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded a limit. Try making the call later. For information about limits, see Kinesis Video Streams Limits (http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html).

  • NotAuthorizedException Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/ListFragments

func (*KinesisVideoArchivedMedia) ListFragmentsPages added in v1.20.17 

func (c *KinesisVideoArchivedMedia) ListFragmentsPages(input *ListFragmentsInput, fn func(*ListFragmentsOutput, bool) bool) error

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

See ListFragments 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 ListFragments operation.
pageNum := 0
err := client.ListFragmentsPages(params,
    func(page *kinesisvideoarchivedmedia.ListFragmentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KinesisVideoArchivedMedia) ListFragmentsPagesWithContext added in v1.20.17 

func (c *KinesisVideoArchivedMedia) ListFragmentsPagesWithContext(ctx aws.Context, input *ListFragmentsInput, fn func(*ListFragmentsOutput, bool) bool, opts ...request.Option) error

ListFragmentsPagesWithContext same as ListFragmentsPages 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 (*KinesisVideoArchivedMedia) ListFragmentsRequest 

func (c *KinesisVideoArchivedMedia) ListFragmentsRequest(input *ListFragmentsInput) (req *request.Request, output *ListFragmentsOutput)

ListFragmentsRequest generates a "aws/request.Request" representing the client's request for the ListFragments 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 ListFragments for more information on using the ListFragments 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 ListFragmentsRequest method.
req, resp := client.ListFragmentsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/ListFragments

func (*KinesisVideoArchivedMedia) ListFragmentsWithContext 

func (c *KinesisVideoArchivedMedia) ListFragmentsWithContext(ctx aws.Context, input *ListFragmentsInput, opts ...request.Option) (*ListFragmentsOutput, error)

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

See ListFragments 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 ListFragmentsInput 

type ListFragmentsInput struct {

	// Describes the timestamp range and timestamp origin for the range of fragments
	// to return.
	//
	// This is only required when the NextToken isn't passed in the API.
	FragmentSelector *FragmentSelector `type:"structure"`

	// The total number of fragments to return. If the total number of fragments
	// available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken
	// is provided in the output that you can use to resume pagination.
	MaxResults *int64 `min:"1" type:"long"`

	// A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken
	// from a previously truncated response.
	NextToken *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment
	// list. Specify either this parameter or the StreamName parameter.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream from which to retrieve a fragment list. Specify either
	// this parameter or the StreamARN parameter.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFragmentsInput) GoString 

func (s ListFragmentsInput) GoString() string

GoString returns the string representation.

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

func (*ListFragmentsInput) SetFragmentSelector 

func (s *ListFragmentsInput) SetFragmentSelector(v *FragmentSelector) *ListFragmentsInput

SetFragmentSelector sets the FragmentSelector field's value.

func (*ListFragmentsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListFragmentsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListFragmentsInput) SetStreamARN added in v1.37.11 

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

SetStreamARN sets the StreamARN field's value.

func (*ListFragmentsInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (ListFragmentsInput) String 

func (s ListFragmentsInput) String() string

String returns the string representation.

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

func (*ListFragmentsInput) Validate 

func (s *ListFragmentsInput) Validate() error

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

type ListFragmentsOutput 

type ListFragmentsOutput struct {

	// A list of archived Fragment objects from the stream that meet the selector
	// criteria. Results are in no specific order, even across pages.
	Fragments []*Fragment `type:"list"`

	// If the returned list is truncated, the operation returns this token to use
	// to retrieve the next page of results. This value is null when there are no
	// more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFragmentsOutput) GoString 

func (s ListFragmentsOutput) GoString() string

GoString returns the string representation.

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

func (*ListFragmentsOutput) SetFragments 

func (s *ListFragmentsOutput) SetFragments(v []*Fragment) *ListFragmentsOutput

SetFragments sets the Fragments field's value.

func (*ListFragmentsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListFragmentsOutput) String 

func (s ListFragmentsOutput) String() string

String returns the string representation.

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

type MissingCodecPrivateDataException added in v1.28.0 

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

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

No codec private data was found in at least one of tracks of the video stream.

func (*MissingCodecPrivateDataException) Code added in v1.28.0 

func (s *MissingCodecPrivateDataException) Code() string

Code returns the exception type name.

func (*MissingCodecPrivateDataException) Error added in v1.28.0 

func (s *MissingCodecPrivateDataException) Error() string

func (MissingCodecPrivateDataException) GoString added in v1.28.0 

func (s MissingCodecPrivateDataException) GoString() string

GoString returns the string representation.

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

func (*MissingCodecPrivateDataException) Message added in v1.28.0 

func (s *MissingCodecPrivateDataException) Message() string

Message returns the exception's message.

func (*MissingCodecPrivateDataException) OrigErr added in v1.28.0 

func (s *MissingCodecPrivateDataException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingCodecPrivateDataException) RequestID added in v1.28.0 

func (s *MissingCodecPrivateDataException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingCodecPrivateDataException) StatusCode added in v1.28.0 

func (s *MissingCodecPrivateDataException) StatusCode() int

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

func (MissingCodecPrivateDataException) String added in v1.28.0 

func (s MissingCodecPrivateDataException) String() string

String returns the string representation.

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

type NoDataRetentionException added in v1.28.0 

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

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

GetImages was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

func (*NoDataRetentionException) Code added in v1.28.0 

func (s *NoDataRetentionException) Code() string

Code returns the exception type name.

func (*NoDataRetentionException) Error added in v1.28.0 

func (s *NoDataRetentionException) Error() string

func (NoDataRetentionException) GoString added in v1.28.0 

func (s NoDataRetentionException) GoString() string

GoString returns the string representation.

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

func (*NoDataRetentionException) Message added in v1.28.0 

func (s *NoDataRetentionException) Message() string

Message returns the exception's message.

func (*NoDataRetentionException) OrigErr added in v1.28.0 

func (s *NoDataRetentionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NoDataRetentionException) RequestID added in v1.28.0 

func (s *NoDataRetentionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NoDataRetentionException) StatusCode added in v1.28.0 

func (s *NoDataRetentionException) StatusCode() int

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

func (NoDataRetentionException) String added in v1.28.0 

func (s NoDataRetentionException) String() string

String returns the string representation.

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

type NotAuthorizedException added in v1.28.0 

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

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

Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

func (*NotAuthorizedException) Code added in v1.28.0 

func (s *NotAuthorizedException) Code() string

Code returns the exception type name.

func (*NotAuthorizedException) Error added in v1.28.0 

func (s *NotAuthorizedException) Error() string

func (NotAuthorizedException) GoString added in v1.28.0 

func (s NotAuthorizedException) GoString() string

GoString returns the string representation.

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

func (*NotAuthorizedException) Message added in v1.28.0 

func (s *NotAuthorizedException) Message() string

Message returns the exception's message.

func (*NotAuthorizedException) OrigErr added in v1.28.0 

func (s *NotAuthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotAuthorizedException) RequestID added in v1.28.0 

func (s *NotAuthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotAuthorizedException) StatusCode added in v1.28.0 

func (s *NotAuthorizedException) StatusCode() int

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

func (NotAuthorizedException) String added in v1.28.0 

func (s NotAuthorizedException) String() string

String returns the string representation.

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

type 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
}

GetImages will throw this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

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

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

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

type TimestampRange 

type TimestampRange struct {

	// The ending timestamp in the range of timestamps for which to return fragments.
	//
	// EndTimestamp is a required field
	EndTimestamp *time.Time `type:"timestamp" required:"true"`

	// The starting timestamp in the range of timestamps for which to return fragments.
	//
	// StartTimestamp is a required field
	StartTimestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The range of timestamps for which to return fragments.

func (TimestampRange) GoString 

func (s TimestampRange) GoString() string

GoString returns the string representation.

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

func (*TimestampRange) SetEndTimestamp 

func (s *TimestampRange) SetEndTimestamp(v time.Time) *TimestampRange

SetEndTimestamp sets the EndTimestamp field's value.

func (*TimestampRange) SetStartTimestamp 

func (s *TimestampRange) SetStartTimestamp(v time.Time) *TimestampRange

SetStartTimestamp sets the StartTimestamp field's value.

func (TimestampRange) String 

func (s TimestampRange) String() string

String returns the string representation.

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

func (*TimestampRange) Validate 

func (s *TimestampRange) Validate() error

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

type UnsupportedStreamMediaTypeException added in v1.28.0 

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

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

The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1 should be V_MPEG/ISO/AVC and, optionally, the codec ID for track 2 should be A_AAC.

func (*UnsupportedStreamMediaTypeException) Code added in v1.28.0 

func (s *UnsupportedStreamMediaTypeException) Code() string

Code returns the exception type name.

func (*UnsupportedStreamMediaTypeException) Error added in v1.28.0 

func (s *UnsupportedStreamMediaTypeException) Error() string

func (UnsupportedStreamMediaTypeException) GoString added in v1.28.0 

func (s UnsupportedStreamMediaTypeException) GoString() string

GoString returns the string representation.

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

func (*UnsupportedStreamMediaTypeException) Message added in v1.28.0 

func (s *UnsupportedStreamMediaTypeException) Message() string

Message returns the exception's message.

func (*UnsupportedStreamMediaTypeException) OrigErr added in v1.28.0 

func (s *UnsupportedStreamMediaTypeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedStreamMediaTypeException) RequestID added in v1.28.0 

func (s *UnsupportedStreamMediaTypeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedStreamMediaTypeException) StatusCode added in v1.28.0 

func (s *UnsupportedStreamMediaTypeException) StatusCode() int

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

func (UnsupportedStreamMediaTypeException) String added in v1.28.0 

func (s UnsupportedStreamMediaTypeException) String() string

String returns the string representation.

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

Source Files

View all Source files

Directories

Path Synopsis
Package kinesisvideoarchivedmediaiface provides an interface to enable mocking the Amazon Kinesis Video Streams Archived Media service client for testing your code.
 Package kinesisvideoarchivedmediaiface provides an interface to enable mocking the Amazon Kinesis Video Streams Archived Media 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.