kinesisvideo

package
v1.14.29 Latest Latest
Warning

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

 Go to latest Published: Jul 18, 2018 License: Apache-2.0 Imports: 7 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 contact Amazon Kinesis Video Streams with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

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

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

Index

Constants

View Source 
const (
	// APINamePutMedia is a APIName enum value
	APINamePutMedia = "PUT_MEDIA"

	// APINameGetMedia is a APIName enum value
	APINameGetMedia = "GET_MEDIA"

	// APINameListFragments is a APIName enum value
	APINameListFragments = "LIST_FRAGMENTS"

	// APINameGetMediaForFragmentList is a APIName enum value
	APINameGetMediaForFragmentList = "GET_MEDIA_FOR_FRAGMENT_LIST"

	// APINameGetHlsStreamingSessionUrl is a APIName enum value
	APINameGetHlsStreamingSessionUrl = "GET_HLS_STREAMING_SESSION_URL"
)
View Source 
const (
	// StatusCreating is a Status enum value
	StatusCreating = "CREATING"

	// StatusActive is a Status enum value
	StatusActive = "ACTIVE"

	// StatusUpdating is a Status enum value
	StatusUpdating = "UPDATING"

	// StatusDeleting is a Status enum value
	StatusDeleting = "DELETING"
)
View Source 
const (
	// UpdateDataRetentionOperationIncreaseDataRetention is a UpdateDataRetentionOperation enum value
	UpdateDataRetentionOperationIncreaseDataRetention = "INCREASE_DATA_RETENTION"

	// UpdateDataRetentionOperationDecreaseDataRetention is a UpdateDataRetentionOperation enum value
	UpdateDataRetentionOperationDecreaseDataRetention = "DECREASE_DATA_RETENTION"
)
View Source 
const (

	// 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/kinesisvideostreams/latest/dg/API_DescribeStream.html)
	// API.
	ErrCodeVersionMismatchException = "VersionMismatchException"
)
View Source 
const (
	ServiceName = "kinesisvideo"  // Name of service.
	EndpointsID = ServiceName     // ID to lookup a service endpoint with.
	ServiceID   = "Kinesis Video" // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// ComparisonOperatorBeginsWith is a ComparisonOperator enum value
	ComparisonOperatorBeginsWith = "BEGINS_WITH"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateStreamInput 

type CreateStreamInput struct {

	// The number of hours that you want to retain the data in the stream. Kinesis
	// Video Streams retains the data in a data store that is associated with the
	// stream.
	//
	// The default value is 0, indicating that the stream does not persist data.
	//
	// When the DataRetentionInHours value is 0, consumers can still consume the
	// fragments that remain in the service host buffer, which has a retention time
	// limit of 5 minutes and a retention memory limit of 200 MB. Fragments are
	// removed from the buffer when either limit is reached.
	DataRetentionInHours *int64 `type:"integer"`

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

	// The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis
	// Video Streams to use to encrypt stream data.
	//
	// If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo)
	// is used.
	//
	// For more information, see DescribeKey (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
}

func (CreateStreamInput) GoString 

func (s CreateStreamInput) GoString() string

GoString returns the string representation

func (*CreateStreamInput) SetDataRetentionInHours 

func (s *CreateStreamInput) SetDataRetentionInHours(v int64) *CreateStreamInput

SetDataRetentionInHours sets the DataRetentionInHours field's value.

func (*CreateStreamInput) SetDeviceName 

func (s *CreateStreamInput) SetDeviceName(v string) *CreateStreamInput

SetDeviceName sets the DeviceName field's value.

func (*CreateStreamInput) SetKmsKeyId 

func (s *CreateStreamInput) SetKmsKeyId(v string) *CreateStreamInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateStreamInput) SetMediaType 

func (s *CreateStreamInput) SetMediaType(v string) *CreateStreamInput

SetMediaType sets the MediaType field's value.

func (*CreateStreamInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (CreateStreamInput) String 

func (s CreateStreamInput) String() string

String returns the string representation

func (*CreateStreamInput) Validate 

func (s *CreateStreamInput) Validate() error

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

type CreateStreamOutput 

type CreateStreamOutput struct {

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

func (CreateStreamOutput) GoString 

func (s CreateStreamOutput) GoString() string

GoString returns the string representation

func (*CreateStreamOutput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (CreateStreamOutput) String 

func (s CreateStreamOutput) String() string

String returns the string representation

type DeleteStreamInput 

type DeleteStreamInput struct {

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

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

func (DeleteStreamInput) GoString 

func (s DeleteStreamInput) GoString() string

GoString returns the string representation

func (*DeleteStreamInput) SetCurrentVersion 

func (s *DeleteStreamInput) SetCurrentVersion(v string) *DeleteStreamInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*DeleteStreamInput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (DeleteStreamInput) String 

func (s DeleteStreamInput) String() string

String returns the string representation

func (*DeleteStreamInput) Validate 

func (s *DeleteStreamInput) Validate() error

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

type DeleteStreamOutput 

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

func (DeleteStreamOutput) GoString 

func (s DeleteStreamOutput) GoString() string

GoString returns the string representation

func (DeleteStreamOutput) String 

func (s DeleteStreamOutput) String() string

String returns the string representation

type DescribeStreamInput 

type DescribeStreamInput struct {

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

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

func (DescribeStreamInput) GoString 

func (s DescribeStreamInput) GoString() string

GoString returns the string representation

func (*DescribeStreamInput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (*DescribeStreamInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (DescribeStreamInput) String 

func (s DescribeStreamInput) String() string

String returns the string representation

func (*DescribeStreamInput) Validate 

func (s *DescribeStreamInput) Validate() error

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

type DescribeStreamOutput 

type DescribeStreamOutput struct {

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

func (DescribeStreamOutput) GoString 

func (s DescribeStreamOutput) GoString() string

GoString returns the string representation

func (*DescribeStreamOutput) SetStreamInfo 

func (s *DescribeStreamOutput) SetStreamInfo(v *StreamInfo) *DescribeStreamOutput

SetStreamInfo sets the StreamInfo field's value.

func (DescribeStreamOutput) String 

func (s DescribeStreamOutput) String() string

String returns the string representation

type GetDataEndpointInput 

type GetDataEndpointInput struct {

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

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

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

func (GetDataEndpointInput) GoString 

func (s GetDataEndpointInput) GoString() string

GoString returns the string representation

func (*GetDataEndpointInput) SetAPIName 

func (s *GetDataEndpointInput) SetAPIName(v string) *GetDataEndpointInput

SetAPIName sets the APIName field's value.

func (*GetDataEndpointInput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (*GetDataEndpointInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (GetDataEndpointInput) String 

func (s GetDataEndpointInput) String() string

String returns the string representation

func (*GetDataEndpointInput) Validate 

func (s *GetDataEndpointInput) Validate() error

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

type GetDataEndpointOutput 

type GetDataEndpointOutput struct {

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

func (GetDataEndpointOutput) GoString 

func (s GetDataEndpointOutput) GoString() string

GoString returns the string representation

func (*GetDataEndpointOutput) SetDataEndpoint 

func (s *GetDataEndpointOutput) SetDataEndpoint(v string) *GetDataEndpointOutput

SetDataEndpoint sets the DataEndpoint field's value.

func (GetDataEndpointOutput) String 

func (s GetDataEndpointOutput) String() string

String returns the string representation

type KinesisVideo 

type KinesisVideo struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *KinesisVideo

New creates a new instance of the KinesisVideo client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a KinesisVideo client from just a session.
svc := kinesisvideo.New(mySession)

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

func (*KinesisVideo) CreateStream 

func (c *KinesisVideo) CreateStream(input *CreateStreamInput) (*CreateStreamOutput, error)

CreateStream API operation for Amazon Kinesis Video Streams.

Creates a new Kinesis video stream.

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

CreateStream is an asynchronous operation.

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

You must have permissions for the KinesisVideo:CreateStream action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation CreateStream for usage and error information.

Returned Error Codes:

  • ErrCodeAccountStreamLimitExceededException "AccountStreamLimitExceededException" The number of streams created for the account is too high.

  • ErrCodeDeviceStreamLimitExceededException "DeviceStreamLimitExceededException" Not implemented.

  • ErrCodeResourceInUseException "ResourceInUseException" The stream is currently not available for this operation.

  • ErrCodeInvalidDeviceException "InvalidDeviceException" Not implemented.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

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

func (*KinesisVideo) CreateStreamRequest 

func (c *KinesisVideo) CreateStreamRequest(input *CreateStreamInput) (req *request.Request, output *CreateStreamOutput)

CreateStreamRequest generates a "aws/request.Request" representing the client's request for the CreateStream operation. The "output" return value will be populated with the request's response once the request completes 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 CreateStream for more information on using the CreateStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateStreamRequest method.
req, resp := client.CreateStreamRequest(params)

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

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

func (*KinesisVideo) CreateStreamWithContext 

func (c *KinesisVideo) CreateStreamWithContext(ctx aws.Context, input *CreateStreamInput, opts ...request.Option) (*CreateStreamOutput, error)

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

See CreateStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DeleteStream 

func (c *KinesisVideo) DeleteStream(input *DeleteStreamInput) (*DeleteStreamOutput, error)

DeleteStream API operation for Amazon Kinesis Video Streams.

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

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

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

This operation requires permission for the KinesisVideo:DeleteStream action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DeleteStream for usage and error information.

Returned Error Codes:

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

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

  • ErrCodeNotAuthorizedException "NotAuthorizedException" The caller is not authorized to perform this operation.

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

func (*KinesisVideo) DeleteStreamRequest 

func (c *KinesisVideo) DeleteStreamRequest(input *DeleteStreamInput) (req *request.Request, output *DeleteStreamOutput)

DeleteStreamRequest generates a "aws/request.Request" representing the client's request for the DeleteStream operation. The "output" return value will be populated with the request's response once the request completes 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 DeleteStream for more information on using the DeleteStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteStreamRequest method.
req, resp := client.DeleteStreamRequest(params)

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

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

func (*KinesisVideo) DeleteStreamWithContext 

func (c *KinesisVideo) DeleteStreamWithContext(ctx aws.Context, input *DeleteStreamInput, opts ...request.Option) (*DeleteStreamOutput, error)

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

See DeleteStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) DescribeStream 

func (c *KinesisVideo) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error)

DescribeStream API operation for Amazon Kinesis Video Streams.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation DescribeStream for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

  • 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" The caller is not authorized to perform this operation.

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

func (*KinesisVideo) DescribeStreamRequest 

func (c *KinesisVideo) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput)

DescribeStreamRequest generates a "aws/request.Request" representing the client's request for the DescribeStream operation. The "output" return value will be populated with the request's response once the request completes 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 DescribeStream for more information on using the DescribeStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStreamRequest method.
req, resp := client.DescribeStreamRequest(params)

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

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

func (*KinesisVideo) DescribeStreamWithContext 

func (c *KinesisVideo) DescribeStreamWithContext(ctx aws.Context, input *DescribeStreamInput, opts ...request.Option) (*DescribeStreamOutput, error)

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

See DescribeStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) GetDataEndpoint 

func (c *KinesisVideo) GetDataEndpoint(input *GetDataEndpointInput) (*GetDataEndpointOutput, error)

GetDataEndpoint API operation for Amazon Kinesis Video Streams.

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation GetDataEndpoint for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

  • 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" The caller is not authorized to perform this operation.

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

func (*KinesisVideo) GetDataEndpointRequest 

func (c *KinesisVideo) GetDataEndpointRequest(input *GetDataEndpointInput) (req *request.Request, output *GetDataEndpointOutput)

GetDataEndpointRequest generates a "aws/request.Request" representing the client's request for the GetDataEndpoint operation. The "output" return value will be populated with the request's response once the request completes 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 GetDataEndpoint for more information on using the GetDataEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDataEndpointRequest method.
req, resp := client.GetDataEndpointRequest(params)

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

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

func (*KinesisVideo) GetDataEndpointWithContext 

func (c *KinesisVideo) GetDataEndpointWithContext(ctx aws.Context, input *GetDataEndpointInput, opts ...request.Option) (*GetDataEndpointOutput, error)

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

See GetDataEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListStreams 

func (c *KinesisVideo) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error)

ListStreams API operation for Amazon Kinesis Video Streams.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation ListStreams for usage and error information.

Returned Error Codes:

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

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

func (*KinesisVideo) ListStreamsRequest 

func (c *KinesisVideo) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput)

ListStreamsRequest generates a "aws/request.Request" representing the client's request for the ListStreams operation. The "output" return value will be populated with the request's response once the request completes 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 ListStreams for more information on using the ListStreams API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStreamsRequest method.
req, resp := client.ListStreamsRequest(params)

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

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

func (*KinesisVideo) ListStreamsWithContext 

func (c *KinesisVideo) ListStreamsWithContext(ctx aws.Context, input *ListStreamsInput, opts ...request.Option) (*ListStreamsOutput, error)

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

See ListStreams for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) ListTagsForStream 

func (c *KinesisVideo) ListTagsForStream(input *ListTagsForStreamInput) (*ListTagsForStreamOutput, error)

ListTagsForStream API operation for Amazon Kinesis Video Streams.

Returns a list of tags associated with the specified stream.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation ListTagsForStream for usage and error information.

Returned Error Codes:

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

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

  • ErrCodeNotAuthorizedException "NotAuthorizedException" The caller is not authorized to perform this operation.

  • ErrCodeInvalidResourceFormatException "InvalidResourceFormatException" The format of the StreamARN is invalid.

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

func (*KinesisVideo) ListTagsForStreamRequest 

func (c *KinesisVideo) ListTagsForStreamRequest(input *ListTagsForStreamInput) (req *request.Request, output *ListTagsForStreamOutput)

ListTagsForStreamRequest generates a "aws/request.Request" representing the client's request for the ListTagsForStream operation. The "output" return value will be populated with the request's response once the request completes 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 ListTagsForStream for more information on using the ListTagsForStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForStreamRequest method.
req, resp := client.ListTagsForStreamRequest(params)

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

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

func (*KinesisVideo) ListTagsForStreamWithContext 

func (c *KinesisVideo) ListTagsForStreamWithContext(ctx aws.Context, input *ListTagsForStreamInput, opts ...request.Option) (*ListTagsForStreamOutput, error)

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

See ListTagsForStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) TagStream 

func (c *KinesisVideo) TagStream(input *TagStreamInput) (*TagStreamOutput, error)

TagStream API operation for Amazon Kinesis Video Streams.

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags (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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation TagStream for usage and error information.

Returned Error Codes:

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

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

  • ErrCodeNotAuthorizedException "NotAuthorizedException" The caller is not authorized to perform this operation.

  • ErrCodeInvalidResourceFormatException "InvalidResourceFormatException" The format of the StreamARN is invalid.

  • ErrCodeTagsPerResourceExceededLimitException "TagsPerResourceExceededLimitException" You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams support up to 50 tags.

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

func (*KinesisVideo) TagStreamRequest 

func (c *KinesisVideo) TagStreamRequest(input *TagStreamInput) (req *request.Request, output *TagStreamOutput)

TagStreamRequest generates a "aws/request.Request" representing the client's request for the TagStream operation. The "output" return value will be populated with the request's response once the request completes 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 TagStream for more information on using the TagStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagStreamRequest method.
req, resp := client.TagStreamRequest(params)

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

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

func (*KinesisVideo) TagStreamWithContext 

func (c *KinesisVideo) TagStreamWithContext(ctx aws.Context, input *TagStreamInput, opts ...request.Option) (*TagStreamOutput, error)

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

See TagStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UntagStream 

func (c *KinesisVideo) UntagStream(input *UntagStreamInput) (*UntagStreamOutput, error)

UntagStream API operation for Amazon Kinesis Video Streams.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UntagStream for usage and error information.

Returned Error Codes:

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

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

  • ErrCodeNotAuthorizedException "NotAuthorizedException" The caller is not authorized to perform this operation.

  • ErrCodeInvalidResourceFormatException "InvalidResourceFormatException" The format of the StreamARN is invalid.

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

func (*KinesisVideo) UntagStreamRequest 

func (c *KinesisVideo) UntagStreamRequest(input *UntagStreamInput) (req *request.Request, output *UntagStreamOutput)

UntagStreamRequest generates a "aws/request.Request" representing the client's request for the UntagStream operation. The "output" return value will be populated with the request's response once the request completes 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 UntagStream for more information on using the UntagStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagStreamRequest method.
req, resp := client.UntagStreamRequest(params)

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

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

func (*KinesisVideo) UntagStreamWithContext 

func (c *KinesisVideo) UntagStreamWithContext(ctx aws.Context, input *UntagStreamInput, opts ...request.Option) (*UntagStreamOutput, error)

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

See UntagStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UpdateDataRetention 

func (c *KinesisVideo) UpdateDataRetention(input *UpdateDataRetentionInput) (*UpdateDataRetentionOutput, error)

UpdateDataRetention API operation for Amazon Kinesis Video Streams.

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

The retention period that you specify replaces the current value.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UpdateDataRetention for usage and error information.

Returned Error Codes:

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

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

  • ErrCodeResourceInUseException "ResourceInUseException" The stream is currently not available for this operation.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" The caller is not authorized to perform this operation.

  • ErrCodeVersionMismatchException "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/kinesisvideostreams/latest/dg/API_DescribeStream.html) API.

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

func (*KinesisVideo) UpdateDataRetentionRequest 

func (c *KinesisVideo) UpdateDataRetentionRequest(input *UpdateDataRetentionInput) (req *request.Request, output *UpdateDataRetentionOutput)

UpdateDataRetentionRequest generates a "aws/request.Request" representing the client's request for the UpdateDataRetention operation. The "output" return value will be populated with the request's response once the request completes 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 UpdateDataRetention for more information on using the UpdateDataRetention API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateDataRetentionRequest method.
req, resp := client.UpdateDataRetentionRequest(params)

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

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

func (*KinesisVideo) UpdateDataRetentionWithContext 

func (c *KinesisVideo) UpdateDataRetentionWithContext(ctx aws.Context, input *UpdateDataRetentionInput, opts ...request.Option) (*UpdateDataRetentionOutput, error)

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

See UpdateDataRetention for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KinesisVideo) UpdateStream 

func (c *KinesisVideo) UpdateStream(input *UpdateStreamInput) (*UpdateStreamOutput, error)

UpdateStream API operation for Amazon Kinesis Video Streams.

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

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

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Video Streams's API operation UpdateStream for usage and error information.

Returned Error Codes:

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

  • ErrCodeInvalidArgumentException "InvalidArgumentException" The value for this input parameter is invalid.

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

  • ErrCodeResourceInUseException "ResourceInUseException" The stream is currently not available for this operation.

  • ErrCodeNotAuthorizedException "NotAuthorizedException" The caller is not authorized to perform this operation.

  • ErrCodeVersionMismatchException "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/kinesisvideostreams/latest/dg/API_DescribeStream.html) API.

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

func (*KinesisVideo) UpdateStreamRequest 

func (c *KinesisVideo) UpdateStreamRequest(input *UpdateStreamInput) (req *request.Request, output *UpdateStreamOutput)

UpdateStreamRequest generates a "aws/request.Request" representing the client's request for the UpdateStream operation. The "output" return value will be populated with the request's response once the request completes 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 UpdateStream for more information on using the UpdateStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateStreamRequest method.
req, resp := client.UpdateStreamRequest(params)

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

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

func (*KinesisVideo) UpdateStreamWithContext 

func (c *KinesisVideo) UpdateStreamWithContext(ctx aws.Context, input *UpdateStreamInput, opts ...request.Option) (*UpdateStreamOutput, error)

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

See UpdateStream for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListStreamsInput 

type ListStreamsInput struct {

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

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

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

func (ListStreamsInput) GoString 

func (s ListStreamsInput) GoString() string

GoString returns the string representation

func (*ListStreamsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListStreamsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListStreamsInput) SetStreamNameCondition 

func (s *ListStreamsInput) SetStreamNameCondition(v *StreamNameCondition) *ListStreamsInput

SetStreamNameCondition sets the StreamNameCondition field's value.

func (ListStreamsInput) String 

func (s ListStreamsInput) String() string

String returns the string representation

func (*ListStreamsInput) Validate 

func (s *ListStreamsInput) Validate() error

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

type ListStreamsOutput 

type ListStreamsOutput struct {

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

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

func (ListStreamsOutput) GoString 

func (s ListStreamsOutput) GoString() string

GoString returns the string representation

func (*ListStreamsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListStreamsOutput) SetStreamInfoList 

func (s *ListStreamsOutput) SetStreamInfoList(v []*StreamInfo) *ListStreamsOutput

SetStreamInfoList sets the StreamInfoList field's value.

func (ListStreamsOutput) String 

func (s ListStreamsOutput) String() string

String returns the string representation

type ListTagsForStreamInput 

type ListTagsForStreamInput struct {

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

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

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

func (ListTagsForStreamInput) GoString 

func (s ListTagsForStreamInput) GoString() string

GoString returns the string representation

func (*ListTagsForStreamInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsForStreamInput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (*ListTagsForStreamInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (ListTagsForStreamInput) String 

func (s ListTagsForStreamInput) String() string

String returns the string representation

func (*ListTagsForStreamInput) Validate 

func (s *ListTagsForStreamInput) Validate() error

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

type ListTagsForStreamOutput 

type ListTagsForStreamOutput struct {

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

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

func (ListTagsForStreamOutput) GoString 

func (s ListTagsForStreamOutput) GoString() string

GoString returns the string representation

func (*ListTagsForStreamOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsForStreamOutput) SetTags 

func (s *ListTagsForStreamOutput) SetTags(v map[string]*string) *ListTagsForStreamOutput

SetTags sets the Tags field's value.

func (ListTagsForStreamOutput) String 

func (s ListTagsForStreamOutput) String() string

String returns the string representation

type 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 *string `type:"string" enum:"Status"`

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

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

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

An object describing a Kinesis video stream.

func (StreamInfo) GoString 

func (s StreamInfo) GoString() string

GoString returns the string representation

func (*StreamInfo) SetCreationTime 

func (s *StreamInfo) SetCreationTime(v time.Time) *StreamInfo

SetCreationTime sets the CreationTime field's value.

func (*StreamInfo) SetDataRetentionInHours 

func (s *StreamInfo) SetDataRetentionInHours(v int64) *StreamInfo

SetDataRetentionInHours sets the DataRetentionInHours field's value.

func (*StreamInfo) SetDeviceName 

func (s *StreamInfo) SetDeviceName(v string) *StreamInfo

SetDeviceName sets the DeviceName field's value.

func (*StreamInfo) SetKmsKeyId 

func (s *StreamInfo) SetKmsKeyId(v string) *StreamInfo

SetKmsKeyId sets the KmsKeyId field's value.

func (*StreamInfo) SetMediaType 

func (s *StreamInfo) SetMediaType(v string) *StreamInfo

SetMediaType sets the MediaType field's value.

func (*StreamInfo) SetStatus 

func (s *StreamInfo) SetStatus(v string) *StreamInfo

SetStatus sets the Status field's value.

func (*StreamInfo) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (*StreamInfo) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (*StreamInfo) SetVersion 

func (s *StreamInfo) SetVersion(v string) *StreamInfo

SetVersion sets the Version field's value.

func (StreamInfo) String 

func (s StreamInfo) String() string

String returns the string representation

type StreamNameCondition 

type StreamNameCondition struct {

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

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

Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

func (StreamNameCondition) GoString 

func (s StreamNameCondition) GoString() string

GoString returns the string representation

func (*StreamNameCondition) SetComparisonOperator 

func (s *StreamNameCondition) SetComparisonOperator(v string) *StreamNameCondition

SetComparisonOperator sets the ComparisonOperator field's value.

func (*StreamNameCondition) SetComparisonValue 

func (s *StreamNameCondition) SetComparisonValue(v string) *StreamNameCondition

SetComparisonValue sets the ComparisonValue field's value.

func (StreamNameCondition) String 

func (s StreamNameCondition) String() string

String returns the string representation

func (*StreamNameCondition) Validate 

func (s *StreamNameCondition) Validate() error

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

type TagStreamInput 

type TagStreamInput struct {

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

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

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

func (TagStreamInput) GoString 

func (s TagStreamInput) GoString() string

GoString returns the string representation

func (*TagStreamInput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (*TagStreamInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (*TagStreamInput) SetTags 

func (s *TagStreamInput) SetTags(v map[string]*string) *TagStreamInput

SetTags sets the Tags field's value.

func (TagStreamInput) String 

func (s TagStreamInput) String() string

String returns the string representation

func (*TagStreamInput) Validate 

func (s *TagStreamInput) Validate() error

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

type TagStreamOutput 

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

func (TagStreamOutput) GoString 

func (s TagStreamOutput) GoString() string

GoString returns the string representation

func (TagStreamOutput) String 

func (s TagStreamOutput) String() string

String returns the string representation

type UntagStreamInput 

type UntagStreamInput struct {

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

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

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

func (UntagStreamInput) GoString 

func (s UntagStreamInput) GoString() string

GoString returns the string representation

func (*UntagStreamInput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (*UntagStreamInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (*UntagStreamInput) SetTagKeyList 

func (s *UntagStreamInput) SetTagKeyList(v []*string) *UntagStreamInput

SetTagKeyList sets the TagKeyList field's value.

func (UntagStreamInput) String 

func (s UntagStreamInput) String() string

String returns the string representation

func (*UntagStreamInput) Validate 

func (s *UntagStreamInput) Validate() error

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

type UntagStreamOutput 

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

func (UntagStreamOutput) GoString 

func (s UntagStreamOutput) GoString() string

GoString returns the string representation

func (UntagStreamOutput) String 

func (s UntagStreamOutput) String() string

String returns the string representation

type UpdateDataRetentionInput 

type UpdateDataRetentionInput struct {

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

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

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

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

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

func (UpdateDataRetentionInput) GoString 

func (s UpdateDataRetentionInput) GoString() string

GoString returns the string representation

func (*UpdateDataRetentionInput) SetCurrentVersion 

func (s *UpdateDataRetentionInput) SetCurrentVersion(v string) *UpdateDataRetentionInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateDataRetentionInput) SetDataRetentionChangeInHours 

func (s *UpdateDataRetentionInput) SetDataRetentionChangeInHours(v int64) *UpdateDataRetentionInput

SetDataRetentionChangeInHours sets the DataRetentionChangeInHours field's value.

func (*UpdateDataRetentionInput) SetOperation 

func (s *UpdateDataRetentionInput) SetOperation(v string) *UpdateDataRetentionInput

SetOperation sets the Operation field's value.

func (*UpdateDataRetentionInput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (*UpdateDataRetentionInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (UpdateDataRetentionInput) String 

func (s UpdateDataRetentionInput) String() string

String returns the string representation

func (*UpdateDataRetentionInput) Validate 

func (s *UpdateDataRetentionInput) Validate() error

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

type UpdateDataRetentionOutput 

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

func (UpdateDataRetentionOutput) GoString 

func (s UpdateDataRetentionOutput) GoString() string

GoString returns the string representation

func (UpdateDataRetentionOutput) String 

func (s UpdateDataRetentionOutput) String() string

String returns the string representation

type UpdateStreamInput 

type UpdateStreamInput struct {

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

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

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

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

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

func (UpdateStreamInput) GoString 

func (s UpdateStreamInput) GoString() string

GoString returns the string representation

func (*UpdateStreamInput) SetCurrentVersion 

func (s *UpdateStreamInput) SetCurrentVersion(v string) *UpdateStreamInput

SetCurrentVersion sets the CurrentVersion field's value.

func (*UpdateStreamInput) SetDeviceName 

func (s *UpdateStreamInput) SetDeviceName(v string) *UpdateStreamInput

SetDeviceName sets the DeviceName field's value.

func (*UpdateStreamInput) SetMediaType 

func (s *UpdateStreamInput) SetMediaType(v string) *UpdateStreamInput

SetMediaType sets the MediaType field's value.

func (*UpdateStreamInput) SetStreamARN 

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

SetStreamARN sets the StreamARN field's value.

func (*UpdateStreamInput) SetStreamName 

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

SetStreamName sets the StreamName field's value.

func (UpdateStreamInput) String 

func (s UpdateStreamInput) String() string

String returns the string representation

func (*UpdateStreamInput) Validate 

func (s *UpdateStreamInput) Validate() error

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

type UpdateStreamOutput 

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

func (UpdateStreamOutput) GoString 

func (s UpdateStreamOutput) GoString() string

GoString returns the string representation

func (UpdateStreamOutput) String 

func (s UpdateStreamOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.