...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/kinesisvideoarchivedmedia"
Overview
Constants

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

The stub package, kinesisvideoarchivedmediaiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type Fragment
func (s *Fragment) SetFragmentLengthInMilliseconds(v int64) *Fragment
func (s *Fragment) SetFragmentNumber(v string) *Fragment
func (s *Fragment) SetFragmentSizeInBytes(v int64) *Fragment
func (s *Fragment) SetProducerTimestamp(v time.Time) *Fragment
func (s *Fragment) SetServerTimestamp(v time.Time) *Fragment
type FragmentSelector
func (s *FragmentSelector) SetFragmentSelectorType(v string) *FragmentSelector
func (s *FragmentSelector) SetTimestampRange(v *TimestampRange) *FragmentSelector
type GetMediaForFragmentListInput
func (s *GetMediaForFragmentListInput) SetFragments(v []*string) *GetMediaForFragmentListInput
func (s *GetMediaForFragmentListInput) SetStreamName(v string) *GetMediaForFragmentListInput
type GetMediaForFragmentListOutput
func (s *GetMediaForFragmentListOutput) SetContentType(v string) *GetMediaForFragmentListOutput
func (s *GetMediaForFragmentListOutput) SetPayload(v io.ReadCloser) *GetMediaForFragmentListOutput
type KinesisVideoArchivedMedia
type ListFragmentsInput
func (s *ListFragmentsInput) SetFragmentSelector(v *FragmentSelector) *ListFragmentsInput
func (s *ListFragmentsInput) SetMaxResults(v int64) *ListFragmentsInput
func (s *ListFragmentsInput) SetNextToken(v string) *ListFragmentsInput
func (s *ListFragmentsInput) SetStreamName(v string) *ListFragmentsInput
type ListFragmentsOutput
func (s *ListFragmentsOutput) SetFragments(v []*Fragment) *ListFragmentsOutput
func (s *ListFragmentsOutput) SetNextToken(v string) *ListFragmentsOutput
type TimestampRange
func (s *TimestampRange) SetEndTimestamp(v time.Time) *TimestampRange
func (s *TimestampRange) SetStartTimestamp(v time.Time) *TimestampRange

Constants ▾

const (
    // FragmentSelectorTypeProducerTimestamp is a FragmentSelectorType enum value
    FragmentSelectorTypeProducerTimestamp = "PRODUCER_TIMESTAMP"

    // FragmentSelectorTypeServerTimestamp is a FragmentSelectorType enum value
    FragmentSelectorTypeServerTimestamp = "SERVER_TIMESTAMP"
)
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"
)
const (
    ServiceName = "kinesisvideo" // Service endpoint prefix API calls made to.
    EndpointsID = ServiceName    // Service ID for Regions and Endpoints metadata.
)

Service information constants

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.

func (Fragment) GoString

func (s Fragment) GoString() string

GoString returns the string representation

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

type FragmentSelector

type FragmentSelector struct {

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

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

func (FragmentSelector) GoString

func (s FragmentSelector) GoString() string

GoString returns the string representation

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

func (*FragmentSelector) Validate

func (s *FragmentSelector) Validate() error

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

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
}

func (GetMediaForFragmentListInput) GoString

func (s GetMediaForFragmentListInput) GoString() string

GoString returns the string representation

func (*GetMediaForFragmentListInput) SetFragments

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

SetFragments sets the Fragments 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

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
}

func (GetMediaForFragmentListOutput) GoString

func (s GetMediaForFragmentListOutput) GoString() string

GoString returns the string representation

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

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:

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

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
Kinesis Video Streams can't find the stream that you specified.

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

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

* ErrCodeNotAuthorizedException "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 successfuly.

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 start location within the archived data.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
Kinesis Video Streams can't find the stream that you specified.

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

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

* ErrCodeNotAuthorizedException "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) 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 successfuly.

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

func (ListFragmentsInput) GoString

func (s ListFragmentsInput) GoString() string

GoString returns the string representation

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

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
}

func (ListFragmentsOutput) GoString

func (s ListFragmentsOutput) GoString() string

GoString returns the string representation

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

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.

func (TimestampRange) GoString

func (s TimestampRange) GoString() string

GoString returns the string representation

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

func (*TimestampRange) Validate

func (s *TimestampRange) Validate() error

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