kinesisvideoarchivedmedia

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 7 Imported by: 18

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

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

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

	// 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".
	//
	// Kinesis Video Streams can't find the stream that you specified.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "kinesisvideo" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName    // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Fragment 

type Fragment struct {

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

	// The index value of the fragment.
	FragmentNumber *string `min:"1" type:"string"`

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

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

	// The time stamp from the AWS server corresponding to the fragment.
	ServerTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Represents a segment of video or other time-delimited data. Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/Fragment

func (Fragment) GoString 

func (s Fragment) GoString() string

GoString returns the string representation

func (Fragment) MarshalFields added in v0.3.0 

func (s Fragment) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Fragment) String 

func (s Fragment) String() string

String returns the string representation

type FragmentSelector 

type FragmentSelector struct {

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

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

Describes the time stamp range and time stamp origin of a range of fragments. Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/FragmentSelector

func (FragmentSelector) GoString 

func (s FragmentSelector) GoString() string

GoString returns the string representation

func (FragmentSelector) MarshalFields added in v0.3.0 

func (s FragmentSelector) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FragmentSelector) String 

func (s FragmentSelector) String() string

String returns the string representation

func (*FragmentSelector) Validate 

func (s *FragmentSelector) Validate() error

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

type FragmentSelectorType 

type FragmentSelectorType string
const (
	FragmentSelectorTypeProducerTimestamp FragmentSelectorType = "PRODUCER_TIMESTAMP"
	FragmentSelectorTypeServerTimestamp   FragmentSelectorType = "SERVER_TIMESTAMP"
)

Enum values for FragmentSelectorType

func (FragmentSelectorType) MarshalValue added in v0.3.0 

func (enum FragmentSelectorType) MarshalValue() (string, error)

func (FragmentSelectorType) MarshalValueBuf added in v0.3.0 

func (enum FragmentSelectorType) MarshalValueBuf(b []byte) ([]byte, error)

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 `type:"list" required:"true"`

	// The name of the stream from which to retrieve fragment media.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetMediaForFragmentListInput

func (GetMediaForFragmentListInput) GoString 

func (s GetMediaForFragmentListInput) GoString() string

GoString returns the string representation

func (GetMediaForFragmentListInput) MarshalFields added in v0.3.0 

func (s GetMediaForFragmentListInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetMediaForFragmentListInput) String 

func (s GetMediaForFragmentListInput) String() string

String returns the string representation

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 (docs.aws.amazon.com/acuity/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 time stamp of the
	//    fragment.
	//
	//    * AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side time stamp
	//    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 exception
	//
	//    * AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception
	Payload io.ReadCloser `type:"blob"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/GetMediaForFragmentListOutput

func (GetMediaForFragmentListOutput) GoString 

func (s GetMediaForFragmentListOutput) GoString() string

GoString returns the string representation

func (GetMediaForFragmentListOutput) MarshalFields added in v0.3.0 

func (s GetMediaForFragmentListOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetMediaForFragmentListOutput) SDKResponseMetadata 

func (s GetMediaForFragmentListOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetMediaForFragmentListOutput) String 

func (s GetMediaForFragmentListOutput) String() string

String returns the string representation

type GetMediaForFragmentListRequest 

type GetMediaForFragmentListRequest struct {
	*aws.Request
	Input *GetMediaForFragmentListInput
	Copy  func(*GetMediaForFragmentListInput) GetMediaForFragmentListRequest
}

GetMediaForFragmentListRequest is a API request type for the GetMediaForFragmentList API operation.

func (GetMediaForFragmentListRequest) Send 

func (r GetMediaForFragmentListRequest) Send() (*GetMediaForFragmentListOutput, error)

Send marshals and sends the GetMediaForFragmentList API request.

type KinesisVideoArchivedMedia 

type KinesisVideoArchivedMedia struct {
	*aws.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(config aws.Config) *KinesisVideoArchivedMedia

New creates a new instance of the KinesisVideoArchivedMedia client with a config.

Example: 

// Create a KinesisVideoArchivedMedia client from just a config.
svc := kinesisvideoarchivedmedia.New(myConfig)

func (*KinesisVideoArchivedMedia) GetMediaForFragmentListRequest 

func (c *KinesisVideoArchivedMedia) GetMediaForFragmentListRequest(input *GetMediaForFragmentListInput) GetMediaForFragmentListRequest

GetMediaForFragmentListRequest returns a request value for making 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 a Kinesis video stream.

This operation is only available for the AWS SDK for Java. It is not supported in AWS SDKs for other languages.

The following limits apply when using the GetMediaForFragmentList API:

  • A client can call GetMediaForFragmentList up to five times per second per stream.

  • Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMediaForFragmentList session.

    // Example sending a request using the GetMediaForFragmentListRequest method. req := client.GetMediaForFragmentListRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }

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

func (*KinesisVideoArchivedMedia) ListFragmentsRequest 

func (c *KinesisVideoArchivedMedia) ListFragmentsRequest(input *ListFragmentsInput) ListFragmentsRequest

ListFragmentsRequest returns a request value for making API operation for Amazon Kinesis Video Streams Archived Media.

Returns a list of Fragment objects from the specified stream and start location within the archived data. 

// Example sending a request using the ListFragmentsRequest method.
req := client.ListFragmentsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

type ListFragmentsInput 

type ListFragmentsInput struct {

	// Describes the time stamp range and time stamp origin for the range of fragments
	// to return.
	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 name of the stream from which to retrieve a fragment list.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/ListFragmentsInput

func (ListFragmentsInput) GoString 

func (s ListFragmentsInput) GoString() string

GoString returns the string representation

func (ListFragmentsInput) MarshalFields added in v0.3.0 

func (s ListFragmentsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListFragmentsInput) String 

func (s ListFragmentsInput) String() string

String returns the string representation

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 fragment numbers that correspond to the time stamp range provided.
	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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/ListFragmentsOutput

func (ListFragmentsOutput) GoString 

func (s ListFragmentsOutput) GoString() string

GoString returns the string representation

func (ListFragmentsOutput) MarshalFields added in v0.3.0 

func (s ListFragmentsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListFragmentsOutput) SDKResponseMetadata 

func (s ListFragmentsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListFragmentsOutput) String 

func (s ListFragmentsOutput) String() string

String returns the string representation

type ListFragmentsRequest 

type ListFragmentsRequest struct {
	*aws.Request
	Input *ListFragmentsInput
	Copy  func(*ListFragmentsInput) ListFragmentsRequest
}

ListFragmentsRequest is a API request type for the ListFragments API operation.

func (ListFragmentsRequest) Send 

func (r ListFragmentsRequest) Send() (*ListFragmentsOutput, error)

Send marshals and sends the ListFragments API request.

type TimestampRange 

type TimestampRange struct {

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

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

The range of time stamps for which to return fragments. Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-video-archived-media-2017-09-30/TimestampRange

func (TimestampRange) GoString 

func (s TimestampRange) GoString() string

GoString returns the string representation

func (TimestampRange) MarshalFields added in v0.3.0 

func (s TimestampRange) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TimestampRange) String 

func (s TimestampRange) String() string

String returns the string representation

func (*TimestampRange) Validate 

func (s *TimestampRange) Validate() error

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

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.