kinesisvideo

package
Version: v2.0.0-preview.4+incom... 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: 6 Imported by: 0

Documentation

Overview

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

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

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

Using the Client

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

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

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

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

Index

Constants

View Source
const (

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

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

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

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

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

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

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

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The stream is currently not available for this operation.
	ErrCodeResourceInUseException = "ResourceInUseException"

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

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

	// ErrCodeVersionMismatchException for service response error code
	// "VersionMismatchException".
	//
	// The stream version that you specified is not the latest version. To get the
	// latest version, use the DescribeStream (http://docs.aws.amazon.com/kinesisvideo/latest/dg/API_DescribeStream.html)
	// API.
	ErrCodeVersionMismatchException = "VersionMismatchException"
)
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 APIName

type APIName string
const (
	APINamePutMedia                APIName = "PUT_MEDIA"
	APINameGetMedia                APIName = "GET_MEDIA"
	APINameListFragments           APIName = "LIST_FRAGMENTS"
	APINameGetMediaForFragmentList APIName = "GET_MEDIA_FOR_FRAGMENT_LIST"
)

Enum values for APIName

func (APIName) MarshalValue

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

func (APIName) MarshalValueBuf

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

type ComparisonOperator

type ComparisonOperator string
const (
	ComparisonOperatorBeginsWith ComparisonOperator = "BEGINS_WITH"
)

Enum values for ComparisonOperator

func (ComparisonOperator) MarshalValue

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

func (ComparisonOperator) MarshalValueBuf

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

type CreateStreamInput

type CreateStreamInput struct {

	// The number of hours that you want to retain the data in the stream. Kinesis
	// Video Streams retains the data in a data store that is associated with the
	// stream.
	//
	// The default value is 0, indicating that the stream does not persist data.
	DataRetentionInHours *int64 `type:"integer"`

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

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateStreamInput

func (CreateStreamInput) GoString

func (s CreateStreamInput) GoString() string

GoString returns the string representation

func (CreateStreamInput) MarshalFields

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

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

func (CreateStreamInput) String

func (s CreateStreamInput) String() string

String returns the string representation

func (*CreateStreamInput) Validate

func (s *CreateStreamInput) Validate() error

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

type CreateStreamOutput

type CreateStreamOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/CreateStreamOutput

func (CreateStreamOutput) GoString

func (s CreateStreamOutput) GoString() string

GoString returns the string representation

func (CreateStreamOutput) MarshalFields

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

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

func (CreateStreamOutput) SDKResponseMetadata

func (s CreateStreamOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateStreamOutput) String

func (s CreateStreamOutput) String() string

String returns the string representation

type CreateStreamRequest

type CreateStreamRequest struct {
	*aws.Request
	Input *CreateStreamInput
	Copy  func(*CreateStreamInput) CreateStreamRequest
}

CreateStreamRequest is a API request type for the CreateStream API operation.

func (CreateStreamRequest) Send

Send marshals and sends the CreateStream API request.

type DeleteStreamInput

type DeleteStreamInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteStreamInput

func (DeleteStreamInput) GoString

func (s DeleteStreamInput) GoString() string

GoString returns the string representation

func (DeleteStreamInput) MarshalFields

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

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

func (DeleteStreamInput) String

func (s DeleteStreamInput) String() string

String returns the string representation

func (*DeleteStreamInput) Validate

func (s *DeleteStreamInput) Validate() error

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

type DeleteStreamOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DeleteStreamOutput

func (DeleteStreamOutput) GoString

func (s DeleteStreamOutput) GoString() string

GoString returns the string representation

func (DeleteStreamOutput) MarshalFields

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

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

func (DeleteStreamOutput) SDKResponseMetadata

func (s DeleteStreamOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteStreamOutput) String

func (s DeleteStreamOutput) String() string

String returns the string representation

type DeleteStreamRequest

type DeleteStreamRequest struct {
	*aws.Request
	Input *DeleteStreamInput
	Copy  func(*DeleteStreamInput) DeleteStreamRequest
}

DeleteStreamRequest is a API request type for the DeleteStream API operation.

func (DeleteStreamRequest) Send

Send marshals and sends the DeleteStream API request.

type DescribeStreamInput

type DescribeStreamInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeStreamInput

func (DescribeStreamInput) GoString

func (s DescribeStreamInput) GoString() string

GoString returns the string representation

func (DescribeStreamInput) MarshalFields

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

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

func (DescribeStreamInput) String

func (s DescribeStreamInput) String() string

String returns the string representation

func (*DescribeStreamInput) Validate

func (s *DescribeStreamInput) Validate() error

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

type DescribeStreamOutput

type DescribeStreamOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/DescribeStreamOutput

func (DescribeStreamOutput) GoString

func (s DescribeStreamOutput) GoString() string

GoString returns the string representation

func (DescribeStreamOutput) MarshalFields

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

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

func (DescribeStreamOutput) SDKResponseMetadata

func (s DescribeStreamOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeStreamOutput) String

func (s DescribeStreamOutput) String() string

String returns the string representation

type DescribeStreamRequest

type DescribeStreamRequest struct {
	*aws.Request
	Input *DescribeStreamInput
	Copy  func(*DescribeStreamInput) DescribeStreamRequest
}

DescribeStreamRequest is a API request type for the DescribeStream API operation.

func (DescribeStreamRequest) Send

Send marshals and sends the DescribeStream API request.

type GetDataEndpointInput

type GetDataEndpointInput struct {

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetDataEndpointInput

func (GetDataEndpointInput) GoString

func (s GetDataEndpointInput) GoString() string

GoString returns the string representation

func (GetDataEndpointInput) MarshalFields

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

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

func (GetDataEndpointInput) String

func (s GetDataEndpointInput) String() string

String returns the string representation

func (*GetDataEndpointInput) Validate

func (s *GetDataEndpointInput) Validate() error

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

type GetDataEndpointOutput

type GetDataEndpointOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/GetDataEndpointOutput

func (GetDataEndpointOutput) GoString

func (s GetDataEndpointOutput) GoString() string

GoString returns the string representation

func (GetDataEndpointOutput) MarshalFields

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

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

func (GetDataEndpointOutput) SDKResponseMetadata

func (s GetDataEndpointOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetDataEndpointOutput) String

func (s GetDataEndpointOutput) String() string

String returns the string representation

type GetDataEndpointRequest

type GetDataEndpointRequest struct {
	*aws.Request
	Input *GetDataEndpointInput
	Copy  func(*GetDataEndpointInput) GetDataEndpointRequest
}

GetDataEndpointRequest is a API request type for the GetDataEndpoint API operation.

func (GetDataEndpointRequest) Send

Send marshals and sends the GetDataEndpoint API request.

type KinesisVideo

type KinesisVideo struct {
	*aws.Client
}

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

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

func New

func New(config aws.Config) *KinesisVideo

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

Example:

// Create a KinesisVideo client from just a config.
svc := kinesisvideo.New(myConfig)

func (*KinesisVideo) CreateStreamRequest

func (c *KinesisVideo) CreateStreamRequest(input *CreateStreamInput) CreateStreamRequest

CreateStreamRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

Creates a new Kinesis video stream.

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

CreateStream is an asynchronous operation.

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

You must have permissions for the KinesisVideo:CreateStream action.

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

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

func (*KinesisVideo) DeleteStreamRequest

func (c *KinesisVideo) DeleteStreamRequest(input *DeleteStreamInput) DeleteStreamRequest

DeleteStreamRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

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

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

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

This operation requires permission for the KinesisVideo:DeleteStream action.

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

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

func (*KinesisVideo) DescribeStreamRequest

func (c *KinesisVideo) DescribeStreamRequest(input *DescribeStreamInput) DescribeStreamRequest

DescribeStreamRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

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

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

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

func (*KinesisVideo) GetDataEndpointRequest

func (c *KinesisVideo) GetDataEndpointRequest(input *GetDataEndpointInput) GetDataEndpointRequest

GetDataEndpointRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

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

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

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

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

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

func (*KinesisVideo) ListStreamsRequest

func (c *KinesisVideo) ListStreamsRequest(input *ListStreamsInput) ListStreamsRequest

ListStreamsRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

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

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

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

func (*KinesisVideo) ListTagsForStreamRequest

func (c *KinesisVideo) ListTagsForStreamRequest(input *ListTagsForStreamInput) ListTagsForStreamRequest

ListTagsForStreamRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

Returns a list of tags associated with the specified stream.

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

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

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

func (*KinesisVideo) TagStreamRequest

func (c *KinesisVideo) TagStreamRequest(input *TagStreamInput) TagStreamRequest

TagStreamRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags (http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

Kinesis video streams support up to 50 tags.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagStream

func (*KinesisVideo) UntagStreamRequest

func (c *KinesisVideo) UntagStreamRequest(input *UntagStreamInput) UntagStreamRequest

UntagStreamRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

In the request, you must provide the StreamName or StreamARN.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagStream

func (*KinesisVideo) UpdateDataRetentionRequest

func (c *KinesisVideo) UpdateDataRetentionRequest(input *UpdateDataRetentionInput) UpdateDataRetentionRequest

UpdateDataRetentionRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

The retention period that you specify replaces the current value.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

* If the data retention period is increased, existing data is retained
for the new retention period. For example, if the data retention period
is increased from one hour to seven hours, all existing data is retained
for seven hours.

* If the data retention period is decreased, existing data is retained
for the new retention period. For example, if the data retention period
is decreased from seven hours to one hour, all existing data is retained
for one hour, and any data older than one hour is deleted immediately.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateDataRetention

func (*KinesisVideo) UpdateStreamRequest

func (c *KinesisVideo) UpdateStreamRequest(input *UpdateStreamInput) UpdateStreamRequest

UpdateStreamRequest returns a request value for making API operation for Amazon Kinesis Video Streams.

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

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

UpdateStream is an asynchronous operation, and takes time to complete.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateStream

type ListStreamsInput

type ListStreamsInput struct {

	// The maximum number of streams to return in the response. The default is 10,000.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you specify this parameter, when the result of a ListStreams operation
	// is truncated, the call returns the NextToken in the response. To get another
	// batch of streams, provide this token in your next request.
	NextToken *string `type:"string"`

	// Optional: Returns only streams that satisfy a specific condition. Currently,
	// you can specify only the prefix of a stream name as a condition.
	StreamNameCondition *StreamNameCondition `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListStreamsInput

func (ListStreamsInput) GoString

func (s ListStreamsInput) GoString() string

GoString returns the string representation

func (ListStreamsInput) MarshalFields

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

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

func (ListStreamsInput) String

func (s ListStreamsInput) String() string

String returns the string representation

func (*ListStreamsInput) Validate

func (s *ListStreamsInput) Validate() error

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

type ListStreamsOutput

type ListStreamsOutput struct {

	// If the response is truncated, the call returns this element with a token.
	// To get the next batch of streams, use this token in your next request.
	NextToken *string `type:"string"`

	// An array of StreamInfo objects.
	StreamInfoList []StreamInfo `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListStreamsOutput

func (ListStreamsOutput) GoString

func (s ListStreamsOutput) GoString() string

GoString returns the string representation

func (ListStreamsOutput) MarshalFields

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

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

func (ListStreamsOutput) SDKResponseMetadata

func (s ListStreamsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListStreamsOutput) String

func (s ListStreamsOutput) String() string

String returns the string representation

type ListStreamsRequest

type ListStreamsRequest struct {
	*aws.Request
	Input *ListStreamsInput
	Copy  func(*ListStreamsInput) ListStreamsRequest
}

ListStreamsRequest is a API request type for the ListStreams API operation.

func (ListStreamsRequest) Send

Send marshals and sends the ListStreams API request.

type ListTagsForStreamInput

type ListTagsForStreamInput struct {

	// If you specify this parameter and the result of a ListTagsForStream call
	// is truncated, the response includes a token that you can use in the next
	// request to fetch the next batch of tags.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) of the stream that you want to list tags for.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream that you want to list tags for.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForStreamInput

func (ListTagsForStreamInput) GoString

func (s ListTagsForStreamInput) GoString() string

GoString returns the string representation

func (ListTagsForStreamInput) MarshalFields

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

func (ListTagsForStreamInput) String

func (s ListTagsForStreamInput) String() string

String returns the string representation

func (*ListTagsForStreamInput) Validate

func (s *ListTagsForStreamInput) Validate() error

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

type ListTagsForStreamOutput

type ListTagsForStreamOutput struct {

	// If you specify this parameter and the result of a ListTags call is truncated,
	// the response includes a token that you can use in the next request to fetch
	// the next set of tags.
	NextToken *string `type:"string"`

	// A map of tag keys and values associated with the specified stream.
	Tags map[string]string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/ListTagsForStreamOutput

func (ListTagsForStreamOutput) GoString

func (s ListTagsForStreamOutput) GoString() string

GoString returns the string representation

func (ListTagsForStreamOutput) MarshalFields

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

func (ListTagsForStreamOutput) SDKResponseMetadata

func (s ListTagsForStreamOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListTagsForStreamOutput) String

func (s ListTagsForStreamOutput) String() string

String returns the string representation

type ListTagsForStreamRequest

type ListTagsForStreamRequest struct {
	*aws.Request
	Input *ListTagsForStreamInput
	Copy  func(*ListTagsForStreamInput) ListTagsForStreamRequest
}

ListTagsForStreamRequest is a API request type for the ListTagsForStream API operation.

func (ListTagsForStreamRequest) Send

Send marshals and sends the ListTagsForStream API request.

type Status

type Status string
const (
	StatusCreating Status = "CREATING"
	StatusActive   Status = "ACTIVE"
	StatusUpdating Status = "UPDATING"
	StatusDeleting Status = "DELETING"
)

Enum values for Status

func (Status) MarshalValue

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

func (Status) MarshalValueBuf

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

type StreamInfo

type StreamInfo struct {

	// A time stamp that indicates when the stream was created.
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// How long the stream retains data, in hours.
	DataRetentionInHours *int64 `type:"integer"`

	// The name of the device that is associated with the stream.
	DeviceName *string `min:"1" type:"string"`

	// The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
	// Streams uses to encrypt data on the stream.
	KmsKeyId *string `min:"1" type:"string"`

	// The MediaType of the stream.
	MediaType *string `min:"1" type:"string"`

	// The status of the stream.
	Status Status `type:"string" enum:"true"`

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

	// The name of the stream.
	StreamName *string `min:"1" type:"string"`

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

An object describing a Kinesis video stream. Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StreamInfo

func (StreamInfo) GoString

func (s StreamInfo) GoString() string

GoString returns the string representation

func (StreamInfo) MarshalFields

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

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

func (StreamInfo) String

func (s StreamInfo) String() string

String returns the string representation

type StreamNameCondition

type StreamNameCondition struct {

	// A comparison operator. Currently, you can specify only the BEGINS_WITH operator,
	// which finds streams whose names start with a given prefix.
	ComparisonOperator ComparisonOperator `type:"string" enum:"true"`

	// A value to compare.
	ComparisonValue *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix. Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StreamNameCondition

func (StreamNameCondition) GoString

func (s StreamNameCondition) GoString() string

GoString returns the string representation

func (StreamNameCondition) MarshalFields

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

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

func (StreamNameCondition) String

func (s StreamNameCondition) String() string

String returns the string representation

func (*StreamNameCondition) Validate

func (s *StreamNameCondition) Validate() error

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

type TagStreamInput

type TagStreamInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to add the tag
	// or tags to.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream that you want to add the tag or tags to.
	StreamName *string `min:"1" type:"string"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagStreamInput

func (TagStreamInput) GoString

func (s TagStreamInput) GoString() string

GoString returns the string representation

func (TagStreamInput) MarshalFields

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

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

func (TagStreamInput) String

func (s TagStreamInput) String() string

String returns the string representation

func (*TagStreamInput) Validate

func (s *TagStreamInput) Validate() error

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

type TagStreamOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/TagStreamOutput

func (TagStreamOutput) GoString

func (s TagStreamOutput) GoString() string

GoString returns the string representation

func (TagStreamOutput) MarshalFields

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

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

func (TagStreamOutput) SDKResponseMetadata

func (s TagStreamOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (TagStreamOutput) String

func (s TagStreamOutput) String() string

String returns the string representation

type TagStreamRequest

type TagStreamRequest struct {
	*aws.Request
	Input *TagStreamInput
	Copy  func(*TagStreamInput) TagStreamRequest
}

TagStreamRequest is a API request type for the TagStream API operation.

func (TagStreamRequest) Send

func (r TagStreamRequest) Send() (*TagStreamOutput, error)

Send marshals and sends the TagStream API request.

type UntagStreamInput

type UntagStreamInput struct {

	// The Amazon Resource Name (ARN) of the stream that you want to remove tags
	// from.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream that you want to remove tags from.
	StreamName *string `min:"1" type:"string"`

	// A list of the keys of the tags that you want to remove.
	//
	// TagKeyList is a required field
	TagKeyList []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagStreamInput

func (UntagStreamInput) GoString

func (s UntagStreamInput) GoString() string

GoString returns the string representation

func (UntagStreamInput) MarshalFields

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

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

func (UntagStreamInput) String

func (s UntagStreamInput) String() string

String returns the string representation

func (*UntagStreamInput) Validate

func (s *UntagStreamInput) Validate() error

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

type UntagStreamOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UntagStreamOutput

func (UntagStreamOutput) GoString

func (s UntagStreamOutput) GoString() string

GoString returns the string representation

func (UntagStreamOutput) MarshalFields

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

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

func (UntagStreamOutput) SDKResponseMetadata

func (s UntagStreamOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UntagStreamOutput) String

func (s UntagStreamOutput) String() string

String returns the string representation

type UntagStreamRequest

type UntagStreamRequest struct {
	*aws.Request
	Input *UntagStreamInput
	Copy  func(*UntagStreamInput) UntagStreamRequest
}

UntagStreamRequest is a API request type for the UntagStream API operation.

func (UntagStreamRequest) Send

Send marshals and sends the UntagStream API request.

type UpdateDataRetentionInput

type UpdateDataRetentionInput struct {

	// The version of the stream whose retention period you want to change. To get
	// the version, call either the DescribeStream or the ListStreams API.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `min:"1" type:"string" required:"true"`

	// The retention period, in hours. The value you specify replaces the current
	// value.
	//
	// DataRetentionChangeInHours is a required field
	DataRetentionChangeInHours *int64 `min:"1" type:"integer" required:"true"`

	// Indicates whether you want to increase or decrease the retention period.
	//
	// Operation is a required field
	Operation UpdateDataRetentionOperation `type:"string" required:"true" enum:"true"`

	// The Amazon Resource Name (ARN) of the stream whose retention period you want
	// to change.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream whose retention period you want to change.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateDataRetentionInput

func (UpdateDataRetentionInput) GoString

func (s UpdateDataRetentionInput) GoString() string

GoString returns the string representation

func (UpdateDataRetentionInput) MarshalFields

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

func (UpdateDataRetentionInput) String

func (s UpdateDataRetentionInput) String() string

String returns the string representation

func (*UpdateDataRetentionInput) Validate

func (s *UpdateDataRetentionInput) Validate() error

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

type UpdateDataRetentionOperation

type UpdateDataRetentionOperation string
const (
	UpdateDataRetentionOperationIncreaseDataRetention UpdateDataRetentionOperation = "INCREASE_DATA_RETENTION"
	UpdateDataRetentionOperationDecreaseDataRetention UpdateDataRetentionOperation = "DECREASE_DATA_RETENTION"
)

Enum values for UpdateDataRetentionOperation

func (UpdateDataRetentionOperation) MarshalValue

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

func (UpdateDataRetentionOperation) MarshalValueBuf

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

type UpdateDataRetentionOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateDataRetentionOutput

func (UpdateDataRetentionOutput) GoString

func (s UpdateDataRetentionOutput) GoString() string

GoString returns the string representation

func (UpdateDataRetentionOutput) MarshalFields

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

func (UpdateDataRetentionOutput) SDKResponseMetadata

func (s UpdateDataRetentionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateDataRetentionOutput) String

func (s UpdateDataRetentionOutput) String() string

String returns the string representation

type UpdateDataRetentionRequest

type UpdateDataRetentionRequest struct {
	*aws.Request
	Input *UpdateDataRetentionInput
	Copy  func(*UpdateDataRetentionInput) UpdateDataRetentionRequest
}

UpdateDataRetentionRequest is a API request type for the UpdateDataRetention API operation.

func (UpdateDataRetentionRequest) Send

Send marshals and sends the UpdateDataRetention API request.

type UpdateStreamInput

type UpdateStreamInput struct {

	// The version of the stream whose metadata you want to update.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `min:"1" type:"string" required:"true"`

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

	// The stream's media type. Use MediaType to specify the type of content that
	// the stream contains to the consumers of the stream. For more information
	// about media types, see Media Types (http://www.iana.org/assignments/media-types/media-types.xhtml).
	// If you choose to specify the MediaType, see Naming Requirements (https://tools.sietf.org/html/rfc6838#section-4.2).
	//
	// To play video on the console, you must specify the correct video type. For
	// example, if the video in the stream is H.264, specify video/h264 as the MediaType.
	MediaType *string `min:"1" type:"string"`

	// The ARN of the stream whose metadata you want to update.
	StreamARN *string `min:"1" type:"string"`

	// The name of the stream whose metadata you want to update.
	//
	// The stream name is an identifier for the stream, and must be unique for each
	// account and region.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateStreamInput

func (UpdateStreamInput) GoString

func (s UpdateStreamInput) GoString() string

GoString returns the string representation

func (UpdateStreamInput) MarshalFields

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

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

func (UpdateStreamInput) String

func (s UpdateStreamInput) String() string

String returns the string representation

func (*UpdateStreamInput) Validate

func (s *UpdateStreamInput) Validate() error

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

type UpdateStreamOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/UpdateStreamOutput

func (UpdateStreamOutput) GoString

func (s UpdateStreamOutput) GoString() string

GoString returns the string representation

func (UpdateStreamOutput) MarshalFields

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

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

func (UpdateStreamOutput) SDKResponseMetadata

func (s UpdateStreamOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateStreamOutput) String

func (s UpdateStreamOutput) String() string

String returns the string representation

type UpdateStreamRequest

type UpdateStreamRequest struct {
	*aws.Request
	Input *UpdateStreamInput
	Copy  func(*UpdateStreamInput) UpdateStreamRequest
}

UpdateStreamRequest is a API request type for the UpdateStream API operation.

func (UpdateStreamRequest) Send

Send marshals and sends the UpdateStream API request.

Directories

Path Synopsis
Package kinesisvideoiface provides an interface to enable mocking the Amazon Kinesis Video Streams service client for testing your code.
Package kinesisvideoiface provides an interface to enable mocking the Amazon Kinesis Video Streams service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL