kinesisvideo

package
v0.23.3 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

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 use Kinesis Video 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 Kinesis Video client 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 (
	ServiceName = "Kinesis Video" // Service's name
	ServiceID   = "KinesisVideo"  // Service's identifier
	EndpointsID = "kinesisvideo"  // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have required permissions to perform this operation.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeAccountChannelLimitExceededException for service response error code
	// "AccountChannelLimitExceededException".
	//
	// You have reached the maximum limit of active signaling channels for this
	// AWS account in this region.
	ErrCodeAccountChannelLimitExceededException = "AccountChannelLimitExceededException"

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

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

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

	// 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 signaling channel 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 (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)
	// API.
	ErrCodeVersionMismatchException = "VersionMismatchException"
)

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"
	APINameGetHlsStreamingSessionUrl  APIName = "GET_HLS_STREAMING_SESSION_URL"
	APINameGetDashStreamingSessionUrl APIName = "GET_DASH_STREAMING_SESSION_URL"
	APINameGetClip                    APIName = "GET_CLIP"
)

Enum values for APIName

func (APIName) MarshalValue added in v0.3.0 

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

func (APIName) MarshalValueBuf added in v0.3.0 

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

type ChannelInfo added in v0.23.2 

type ChannelInfo struct {

	// The Amazon Resource Name (ARN) of the signaling channel.
	ChannelARN *string `min:"1" type:"string"`

	// The name of the signaling channel.
	ChannelName *string `min:"1" type:"string"`

	// Current status of the signaling channel.
	ChannelStatus Status `type:"string" enum:"true"`

	// The type of the signaling channel.
	ChannelType ChannelType `type:"string" enum:"true"`

	// The time at which the signaling channel was created.
	CreationTime *time.Time `type:"timestamp"`

	// A structure that contains the configuration for the SINGLE_MASTER channel
	// type.
	SingleMasterConfiguration *SingleMasterConfiguration `type:"structure"`

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

A structure that encapsulates a signaling channel's metadata and properties.

func (ChannelInfo) MarshalFields added in v0.23.2 

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

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

func (ChannelInfo) String added in v0.23.2 

func (s ChannelInfo) String() string

String returns the string representation

type ChannelNameCondition added in v0.23.2 

type ChannelNameCondition struct {

	// A comparison operator. Currently, you can only specify the BEGINS_WITH operator,
	// which finds signaling channels whose names begin 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
}

An optional input parameter for the ListSignalingChannels API. When this parameter is specified while invoking ListSignalingChannels, the API returns only the channels that satisfy a condition specified in ChannelNameCondition.

func (ChannelNameCondition) MarshalFields added in v0.23.2 

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

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

func (ChannelNameCondition) String added in v0.23.2 

func (s ChannelNameCondition) String() string

String returns the string representation

func (*ChannelNameCondition) Validate added in v0.23.2 

func (s *ChannelNameCondition) Validate() error

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

type ChannelProtocol added in v0.23.2 

type ChannelProtocol string
const (
	ChannelProtocolWss   ChannelProtocol = "WSS"
	ChannelProtocolHttps ChannelProtocol = "HTTPS"
)

Enum values for ChannelProtocol

func (ChannelProtocol) MarshalValue added in v0.23.2 

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

func (ChannelProtocol) MarshalValueBuf added in v0.23.2 

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

type ChannelRole added in v0.23.2 

type ChannelRole string
const (
	ChannelRoleMaster ChannelRole = "MASTER"
	ChannelRoleViewer ChannelRole = "VIEWER"
)

Enum values for ChannelRole

func (ChannelRole) MarshalValue added in v0.23.2 

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

func (ChannelRole) MarshalValueBuf added in v0.23.2 

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

type ChannelType added in v0.23.2 

type ChannelType string
const (
	ChannelTypeSingleMaster ChannelType = "SINGLE_MASTER"
)

Enum values for ChannelType

func (ChannelType) MarshalValue added in v0.23.2 

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

func (ChannelType) MarshalValueBuf added in v0.23.2 

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

type Client added in v0.23.2 

type Client struct {
	*aws.Client
}

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

The client's 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) *Client

New creates a new instance of the client from the provided Config.

Example: 

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

func (*Client) CreateSignalingChannelRequest added in v0.23.2 

func (c *Client) CreateSignalingChannelRequest(input *CreateSignalingChannelInput) CreateSignalingChannelRequest

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

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation. 

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

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

func (*Client) CreateStreamRequest added in v0.23.2 

func (c *Client) 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 (https://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 CreateStreamRequest.
req := client.CreateStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteSignalingChannelRequest added in v0.23.2 

func (c *Client) DeleteSignalingChannelRequest(input *DeleteSignalingChannelInput) DeleteSignalingChannelRequest

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

Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted. 

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

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

func (*Client) DeleteStreamRequest added in v0.23.2 

func (c *Client) 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 DeleteStreamRequest.
req := client.DeleteStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeSignalingChannelRequest added in v0.23.2 

func (c *Client) DescribeSignalingChannelRequest(input *DescribeSignalingChannelInput) DescribeSignalingChannelRequest

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

Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe. 

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

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

func (*Client) DescribeStreamRequest added in v0.23.2 

func (c *Client) 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 DescribeStreamRequest.
req := client.DescribeStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetDataEndpointRequest added in v0.23.2 

func (c *Client) 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 GetDataEndpointRequest.
req := client.GetDataEndpointRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetSignalingChannelEndpointRequest added in v0.23.2 

func (c *Client) GetSignalingChannelEndpointRequest(input *GetSignalingChannelEndpointInput) GetSignalingChannelEndpointRequest

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

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER. 

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

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

func (*Client) ListSignalingChannelsRequest added in v0.23.2 

func (c *Client) ListSignalingChannelsRequest(input *ListSignalingChannelsInput) ListSignalingChannelsRequest

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

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition. 

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

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

func (*Client) ListStreamsRequest added in v0.23.2 

func (c *Client) 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 ListStreamsRequest.
req := client.ListStreamsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTagsForResourceRequest added in v0.23.2 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

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

Returns a list of tags associated with the specified signaling channel. 

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

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

func (*Client) ListTagsForStreamRequest added in v0.23.2 

func (c *Client) 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 ListTagsForStreamRequest.
req := client.ListTagsForStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) TagResourceRequest added in v0.23.2 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

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

Adds one or more tags to a signaling channel. 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 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide. 

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

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

func (*Client) TagStreamRequest added in v0.23.2 

func (c *Client) 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 (https://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 TagStreamRequest.
req := client.TagStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UntagResourceRequest added in v0.23.2 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

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

Removes one or more tags from a signaling channel. 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. 

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

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

func (*Client) UntagStreamRequest added in v0.23.2 

func (c *Client) 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 UntagStreamRequest.
req := client.UntagStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateDataRetentionRequest added in v0.23.2 

func (c *Client) 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 UpdateDataRetentionRequest. req := client.UpdateDataRetentionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) UpdateSignalingChannelRequest added in v0.23.2 

func (c *Client) UpdateSignalingChannelRequest(input *UpdateSignalingChannelInput) UpdateSignalingChannelRequest

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

Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value. 

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

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

func (*Client) UpdateStreamRequest added in v0.23.2 

func (c *Client) 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 UpdateStreamRequest.
req := client.UpdateStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type ComparisonOperator 

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

Enum values for ComparisonOperator

func (ComparisonOperator) MarshalValue added in v0.3.0 

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

func (ComparisonOperator) MarshalValueBuf added in v0.3.0 

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

type CreateSignalingChannelInput added in v0.23.2 

type CreateSignalingChannelInput struct {

	// A name for the signaling channel that you are creating. It must be unique
	// for each AWS account and AWS Region.
	//
	// ChannelName is a required field
	ChannelName *string `min:"1" type:"string" required:"true"`

	// A type of the signaling channel that you are creating. Currently, SINGLE_MASTER
	// is the only supported channel type.
	ChannelType ChannelType `type:"string" enum:"true"`

	// A structure containing the configuration for the SINGLE_MASTER channel type.
	SingleMasterConfiguration *SingleMasterConfiguration `type:"structure"`

	// A set of tags (key-value pairs) that you want to associate with this channel.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateSignalingChannelInput) MarshalFields added in v0.23.2 

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

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

func (CreateSignalingChannelInput) String added in v0.23.2 

func (s CreateSignalingChannelInput) String() string

String returns the string representation

func (*CreateSignalingChannelInput) Validate added in v0.23.2 

func (s *CreateSignalingChannelInput) Validate() error

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

type CreateSignalingChannelOutput added in v0.23.2 

type CreateSignalingChannelOutput struct {

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

func (CreateSignalingChannelOutput) MarshalFields added in v0.23.2 

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

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

func (CreateSignalingChannelOutput) String added in v0.23.2 

func (s CreateSignalingChannelOutput) String() string

String returns the string representation

type CreateSignalingChannelRequest added in v0.23.2 

type CreateSignalingChannelRequest struct {
	*aws.Request
	Input *CreateSignalingChannelInput
	Copy  func(*CreateSignalingChannelInput) CreateSignalingChannelRequest
}

CreateSignalingChannelRequest is the request type for the CreateSignalingChannel API operation.

func (CreateSignalingChannelRequest) Send added in v0.23.2 

func (r CreateSignalingChannelRequest) Send(ctx context.Context) (*CreateSignalingChannelResponse, error)

Send marshals and sends the CreateSignalingChannel API request.

type CreateSignalingChannelResponse added in v0.23.2 

type CreateSignalingChannelResponse struct {
	*CreateSignalingChannelOutput
	// contains filtered or unexported fields
}

CreateSignalingChannelResponse is the response type for the CreateSignalingChannel API operation.

func (*CreateSignalingChannelResponse) SDKResponseMetdata added in v0.23.2 

func (r *CreateSignalingChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSignalingChannel request.

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 (https://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.
	//
	// Example valid values include "video/h264" and "video/h264,audio/aac".
	//
	// 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"`

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

func (CreateStreamInput) MarshalFields added in v0.3.0 

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
}

func (CreateStreamOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the CreateStream API operation.

func (CreateStreamRequest) Send 

func (r CreateStreamRequest) Send(ctx context.Context) (*CreateStreamResponse, error)

Send marshals and sends the CreateStream API request.

type CreateStreamResponse added in v0.23.2 

type CreateStreamResponse struct {
	*CreateStreamOutput
	// contains filtered or unexported fields
}

CreateStreamResponse is the response type for the CreateStream API operation.

func (*CreateStreamResponse) SDKResponseMetdata added in v0.23.2 

func (r *CreateStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateStream request.

type DeleteSignalingChannelInput added in v0.23.2 

type DeleteSignalingChannelInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel that you want to
	// delete.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// The current version of the signaling channel that you want to delete. You
	// can obtain the current version by invoking the DescribeSignalingChannel or
	// ListSignalingChannels API operations.
	CurrentVersion *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSignalingChannelInput) MarshalFields added in v0.23.2 

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

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

func (DeleteSignalingChannelInput) String added in v0.23.2 

func (s DeleteSignalingChannelInput) String() string

String returns the string representation

func (*DeleteSignalingChannelInput) Validate added in v0.23.2 

func (s *DeleteSignalingChannelInput) Validate() error

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

type DeleteSignalingChannelOutput added in v0.23.2 

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

func (DeleteSignalingChannelOutput) MarshalFields added in v0.23.2 

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

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

func (DeleteSignalingChannelOutput) String added in v0.23.2 

func (s DeleteSignalingChannelOutput) String() string

String returns the string representation

type DeleteSignalingChannelRequest added in v0.23.2 

type DeleteSignalingChannelRequest struct {
	*aws.Request
	Input *DeleteSignalingChannelInput
	Copy  func(*DeleteSignalingChannelInput) DeleteSignalingChannelRequest
}

DeleteSignalingChannelRequest is the request type for the DeleteSignalingChannel API operation.

func (DeleteSignalingChannelRequest) Send added in v0.23.2 

func (r DeleteSignalingChannelRequest) Send(ctx context.Context) (*DeleteSignalingChannelResponse, error)

Send marshals and sends the DeleteSignalingChannel API request.

type DeleteSignalingChannelResponse added in v0.23.2 

type DeleteSignalingChannelResponse struct {
	*DeleteSignalingChannelOutput
	// contains filtered or unexported fields
}

DeleteSignalingChannelResponse is the response type for the DeleteSignalingChannel API operation.

func (*DeleteSignalingChannelResponse) SDKResponseMetdata added in v0.23.2 

func (r *DeleteSignalingChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSignalingChannel 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
}

func (DeleteStreamInput) MarshalFields added in v0.3.0 

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
}

func (DeleteStreamOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the DeleteStream API operation.

func (DeleteStreamRequest) Send 

func (r DeleteStreamRequest) Send(ctx context.Context) (*DeleteStreamResponse, error)

Send marshals and sends the DeleteStream API request.

type DeleteStreamResponse added in v0.23.2 

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

DeleteStreamResponse is the response type for the DeleteStream API operation.

func (*DeleteStreamResponse) SDKResponseMetdata added in v0.23.2 

func (r *DeleteStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteStream request.

type DescribeSignalingChannelInput added in v0.23.2 

type DescribeSignalingChannelInput struct {

	// The ARN of the signaling channel that you want to describe.
	ChannelARN *string `min:"1" type:"string"`

	// The name of the signaling channel that you want to describe.
	ChannelName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSignalingChannelInput) MarshalFields added in v0.23.2 

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

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

func (DescribeSignalingChannelInput) String added in v0.23.2 

func (s DescribeSignalingChannelInput) String() string

String returns the string representation

func (*DescribeSignalingChannelInput) Validate added in v0.23.2 

func (s *DescribeSignalingChannelInput) Validate() error

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

type DescribeSignalingChannelOutput added in v0.23.2 

type DescribeSignalingChannelOutput struct {

	// A structure that encapsulates the specified signaling channel's metadata
	// and properties.
	ChannelInfo *ChannelInfo `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSignalingChannelOutput) MarshalFields added in v0.23.2 

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

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

func (DescribeSignalingChannelOutput) String added in v0.23.2 

func (s DescribeSignalingChannelOutput) String() string

String returns the string representation

type DescribeSignalingChannelRequest added in v0.23.2 

type DescribeSignalingChannelRequest struct {
	*aws.Request
	Input *DescribeSignalingChannelInput
	Copy  func(*DescribeSignalingChannelInput) DescribeSignalingChannelRequest
}

DescribeSignalingChannelRequest is the request type for the DescribeSignalingChannel API operation.

func (DescribeSignalingChannelRequest) Send added in v0.23.2 

func (r DescribeSignalingChannelRequest) Send(ctx context.Context) (*DescribeSignalingChannelResponse, error)

Send marshals and sends the DescribeSignalingChannel API request.

type DescribeSignalingChannelResponse added in v0.23.2 

type DescribeSignalingChannelResponse struct {
	*DescribeSignalingChannelOutput
	// contains filtered or unexported fields
}

DescribeSignalingChannelResponse is the response type for the DescribeSignalingChannel API operation.

func (*DescribeSignalingChannelResponse) SDKResponseMetdata added in v0.23.2 

func (r *DescribeSignalingChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSignalingChannel 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
}

func (DescribeStreamInput) MarshalFields added in v0.3.0 

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
}

func (DescribeStreamOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the DescribeStream API operation.

func (DescribeStreamRequest) Send 

func (r DescribeStreamRequest) Send(ctx context.Context) (*DescribeStreamResponse, error)

Send marshals and sends the DescribeStream API request.

type DescribeStreamResponse added in v0.23.2 

type DescribeStreamResponse struct {
	*DescribeStreamOutput
	// contains filtered or unexported fields
}

DescribeStreamResponse is the response type for the DescribeStream API operation.

func (*DescribeStreamResponse) SDKResponseMetdata added in v0.23.2 

func (r *DescribeStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeStream 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
}

func (GetDataEndpointInput) MarshalFields added in v0.3.0 

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
}

func (GetDataEndpointOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the GetDataEndpoint API operation.

func (GetDataEndpointRequest) Send 

func (r GetDataEndpointRequest) Send(ctx context.Context) (*GetDataEndpointResponse, error)

Send marshals and sends the GetDataEndpoint API request.

type GetDataEndpointResponse added in v0.23.2 

type GetDataEndpointResponse struct {
	*GetDataEndpointOutput
	// contains filtered or unexported fields
}

GetDataEndpointResponse is the response type for the GetDataEndpoint API operation.

func (*GetDataEndpointResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetDataEndpointResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDataEndpoint request.

type GetSignalingChannelEndpointInput added in v0.23.2 

type GetSignalingChannelEndpointInput struct {

	// The Amazon Resource Name (ARN) of the signalling channel for which you want
	// to get an endpoint.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// A structure containing the endpoint configuration for the SINGLE_MASTER channel
	// type.
	SingleMasterChannelEndpointConfiguration *SingleMasterChannelEndpointConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (GetSignalingChannelEndpointInput) MarshalFields added in v0.23.2 

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

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

func (GetSignalingChannelEndpointInput) String added in v0.23.2 

func (s GetSignalingChannelEndpointInput) String() string

String returns the string representation

func (*GetSignalingChannelEndpointInput) Validate added in v0.23.2 

func (s *GetSignalingChannelEndpointInput) Validate() error

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

type GetSignalingChannelEndpointOutput added in v0.23.2 

type GetSignalingChannelEndpointOutput struct {

	// A list of endpoints for the specified signaling channel.
	ResourceEndpointList []ResourceEndpointListItem `type:"list"`
	// contains filtered or unexported fields
}

func (GetSignalingChannelEndpointOutput) MarshalFields added in v0.23.2 

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

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

func (GetSignalingChannelEndpointOutput) String added in v0.23.2 

func (s GetSignalingChannelEndpointOutput) String() string

String returns the string representation

type GetSignalingChannelEndpointRequest added in v0.23.2 

type GetSignalingChannelEndpointRequest struct {
	*aws.Request
	Input *GetSignalingChannelEndpointInput
	Copy  func(*GetSignalingChannelEndpointInput) GetSignalingChannelEndpointRequest
}

GetSignalingChannelEndpointRequest is the request type for the GetSignalingChannelEndpoint API operation.

func (GetSignalingChannelEndpointRequest) Send added in v0.23.2 

func (r GetSignalingChannelEndpointRequest) Send(ctx context.Context) (*GetSignalingChannelEndpointResponse, error)

Send marshals and sends the GetSignalingChannelEndpoint API request.

type GetSignalingChannelEndpointResponse added in v0.23.2 

type GetSignalingChannelEndpointResponse struct {
	*GetSignalingChannelEndpointOutput
	// contains filtered or unexported fields
}

GetSignalingChannelEndpointResponse is the response type for the GetSignalingChannelEndpoint API operation.

func (*GetSignalingChannelEndpointResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetSignalingChannelEndpointResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSignalingChannelEndpoint request.

type ListSignalingChannelsInput added in v0.23.2 

type ListSignalingChannelsInput struct {

	// Optional: Returns only the channels that satisfy a specific condition.
	ChannelNameCondition *ChannelNameCondition `type:"structure"`

	// The maximum number of channels to return in the response. The default is
	// 500.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you specify this parameter, when the result of a ListSignalingChannels
	// operation is truncated, the call returns the NextToken in the response. To
	// get another batch of channels, provide this token in your next request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSignalingChannelsInput) MarshalFields added in v0.23.2 

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

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

func (ListSignalingChannelsInput) String added in v0.23.2 

func (s ListSignalingChannelsInput) String() string

String returns the string representation

func (*ListSignalingChannelsInput) Validate added in v0.23.2 

func (s *ListSignalingChannelsInput) Validate() error

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

type ListSignalingChannelsOutput added in v0.23.2 

type ListSignalingChannelsOutput struct {

	// An array of ChannelInfo objects.
	ChannelInfoList []ChannelInfo `type:"list"`

	// 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"`
	// contains filtered or unexported fields
}

func (ListSignalingChannelsOutput) MarshalFields added in v0.23.2 

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

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

func (ListSignalingChannelsOutput) String added in v0.23.2 

func (s ListSignalingChannelsOutput) String() string

String returns the string representation

type ListSignalingChannelsPaginator added in v0.23.2 

type ListSignalingChannelsPaginator struct {
	aws.Pager
}

ListSignalingChannelsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListSignalingChannelsPaginator added in v0.23.2 

func NewListSignalingChannelsPaginator(req ListSignalingChannelsRequest) ListSignalingChannelsPaginator

NewListSignalingChannelsRequestPaginator returns a paginator for ListSignalingChannels. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListSignalingChannelsRequest(input)
p := kinesisvideo.NewListSignalingChannelsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListSignalingChannelsPaginator) CurrentPage added in v0.23.2 

func (p *ListSignalingChannelsPaginator) CurrentPage() *ListSignalingChannelsOutput

type ListSignalingChannelsRequest added in v0.23.2 

type ListSignalingChannelsRequest struct {
	*aws.Request
	Input *ListSignalingChannelsInput
	Copy  func(*ListSignalingChannelsInput) ListSignalingChannelsRequest
}

ListSignalingChannelsRequest is the request type for the ListSignalingChannels API operation.

func (ListSignalingChannelsRequest) Send added in v0.23.2 

func (r ListSignalingChannelsRequest) Send(ctx context.Context) (*ListSignalingChannelsResponse, error)

Send marshals and sends the ListSignalingChannels API request.

type ListSignalingChannelsResponse added in v0.23.2 

type ListSignalingChannelsResponse struct {
	*ListSignalingChannelsOutput
	// contains filtered or unexported fields
}

ListSignalingChannelsResponse is the response type for the ListSignalingChannels API operation.

func (*ListSignalingChannelsResponse) SDKResponseMetdata added in v0.23.2 

func (r *ListSignalingChannelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSignalingChannels request.

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) MarshalFields added in v0.3.0 

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
}

func (ListStreamsOutput) MarshalFields added in v0.3.0 

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

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

func (ListStreamsOutput) String 

func (s ListStreamsOutput) String() string

String returns the string representation

type ListStreamsPaginator added in v0.23.2 

type ListStreamsPaginator struct {
	aws.Pager
}

ListStreamsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListStreamsPaginator added in v0.23.2 

func NewListStreamsPaginator(req ListStreamsRequest) ListStreamsPaginator

NewListStreamsRequestPaginator returns a paginator for ListStreams. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListStreamsRequest(input)
p := kinesisvideo.NewListStreamsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListStreamsPaginator) CurrentPage added in v0.23.2 

func (p *ListStreamsPaginator) CurrentPage() *ListStreamsOutput

type ListStreamsRequest 

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

ListStreamsRequest is the request type for the ListStreams API operation.

func (ListStreamsRequest) Send 

func (r ListStreamsRequest) Send(ctx context.Context) (*ListStreamsResponse, error)

Send marshals and sends the ListStreams API request.

type ListStreamsResponse added in v0.23.2 

type ListStreamsResponse struct {
	*ListStreamsOutput
	// contains filtered or unexported fields
}

ListStreamsResponse is the response type for the ListStreams API operation.

func (*ListStreamsResponse) SDKResponseMetdata added in v0.23.2 

func (r *ListStreamsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListStreams request.

type ListTagsForResourceInput added in v0.23.2 

type ListTagsForResourceInput struct {

	// If you specify this parameter and the result of a ListTagsForResource 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 signaling channel for which you want
	// to list tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields added in v0.23.2 

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

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

func (ListTagsForResourceInput) String added in v0.23.2 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.23.2 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.23.2 

type ListTagsForResourceOutput struct {

	// If you specify this parameter and the result of a ListTagsForResource 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 signaling channel.
	Tags map[string]string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields added in v0.23.2 

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

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

func (ListTagsForResourceOutput) String added in v0.23.2 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.23.2 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.23.2 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.23.2 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.23.2 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource 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
}

func (ListTagsForStreamInput) MarshalFields added in v0.3.0 

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

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
}

func (ListTagsForStreamOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the ListTagsForStream API operation.

func (ListTagsForStreamRequest) Send 

func (r ListTagsForStreamRequest) Send(ctx context.Context) (*ListTagsForStreamResponse, error)

Send marshals and sends the ListTagsForStream API request.

type ListTagsForStreamResponse added in v0.23.2 

type ListTagsForStreamResponse struct {
	*ListTagsForStreamOutput
	// contains filtered or unexported fields
}

ListTagsForStreamResponse is the response type for the ListTagsForStream API operation.

func (*ListTagsForStreamResponse) SDKResponseMetdata added in v0.23.2 

func (r *ListTagsForStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForStream request.

type ResourceEndpointListItem added in v0.23.2 

type ResourceEndpointListItem struct {

	// The protocol of the signaling channel returned by the GetSignalingChannelEndpoint
	// API.
	Protocol ChannelProtocol `type:"string" enum:"true"`

	// The endpoint of the signaling channel returned by the GetSignalingChannelEndpoint
	// API.
	ResourceEndpoint *string `type:"string"`
	// contains filtered or unexported fields
}

An object that describes the endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.

func (ResourceEndpointListItem) MarshalFields added in v0.23.2 

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

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

func (ResourceEndpointListItem) String added in v0.23.2 

func (s ResourceEndpointListItem) String() string

String returns the string representation

type SingleMasterChannelEndpointConfiguration added in v0.23.2 

type SingleMasterChannelEndpointConfiguration struct {

	// This property is used to determine the nature of communication over this
	// SINGLE_MASTER signaling channel. If WSS is specified, this API returns a
	// websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.
	Protocols []ChannelProtocol `min:"1" type:"list"`

	// This property is used to determine messaging permissions in this SINGLE_MASTER
	// signaling channel. If MASTER is specified, this API returns an endpoint that
	// a client can use to receive offers from and send answers to any of the viewers
	// on this signaling channel. If VIEWER is specified, this API returns an endpoint
	// that a client can use only to send offers to another MASTER client on this
	// signaling channel.
	Role ChannelRole `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

func (SingleMasterChannelEndpointConfiguration) MarshalFields added in v0.23.2 

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

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

func (SingleMasterChannelEndpointConfiguration) String added in v0.23.2 

func (s SingleMasterChannelEndpointConfiguration) String() string

String returns the string representation

func (*SingleMasterChannelEndpointConfiguration) Validate added in v0.23.2 

func (s *SingleMasterChannelEndpointConfiguration) Validate() error

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

type SingleMasterConfiguration added in v0.23.2 

type SingleMasterConfiguration struct {

	// The period of time a signaling channel retains underlivered messages before
	// they are discarded.
	MessageTtlSeconds *int64 `min:"5" type:"integer"`
	// contains filtered or unexported fields
}

A structure that contains the configuration for the SINGLE_MASTER channel type.

func (SingleMasterConfiguration) MarshalFields added in v0.23.2 

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

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

func (SingleMasterConfiguration) String added in v0.23.2 

func (s SingleMasterConfiguration) String() string

String returns the string representation

func (*SingleMasterConfiguration) Validate added in v0.23.2 

func (s *SingleMasterConfiguration) Validate() error

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

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 added in v0.3.0 

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

func (Status) MarshalValueBuf added in v0.3.0 

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"`

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

func (StreamInfo) MarshalFields added in v0.3.0 

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.

func (StreamNameCondition) MarshalFields added in v0.3.0 

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 Tag added in v0.23.2 

type Tag struct {

	// The key of the tag that is associated with the specified signaling channel.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag that is associated with the specified signaling channel.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A key and value pair that is associated with the specified signaling channel.

func (Tag) MarshalFields added in v0.23.2 

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

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

func (Tag) String added in v0.23.2 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v0.23.2 

func (s *Tag) Validate() error

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

type TagResourceInput added in v0.23.2 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel to which you want
	// to add tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

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

func (TagResourceInput) MarshalFields added in v0.23.2 

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

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

func (TagResourceInput) String added in v0.23.2 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.23.2 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v0.23.2 

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

func (TagResourceOutput) MarshalFields added in v0.23.2 

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

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

func (TagResourceOutput) String added in v0.23.2 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.23.2 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.23.2 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.23.2 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.23.2 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

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) MarshalFields added in v0.3.0 

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
}

func (TagStreamOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the TagStream API operation.

func (TagStreamRequest) Send 

func (r TagStreamRequest) Send(ctx context.Context) (*TagStreamResponse, error)

Send marshals and sends the TagStream API request.

type TagStreamResponse added in v0.23.2 

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

TagStreamResponse is the response type for the TagStream API operation.

func (*TagStreamResponse) SDKResponseMetdata added in v0.23.2 

func (r *TagStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagStream request.

type UntagResourceInput added in v0.23.2 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel from which you want
	// to remove tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// 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 (UntagResourceInput) MarshalFields added in v0.23.2 

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

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

func (UntagResourceInput) String added in v0.23.2 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.23.2 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v0.23.2 

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

func (UntagResourceOutput) MarshalFields added in v0.23.2 

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

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

func (UntagResourceOutput) String added in v0.23.2 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.23.2 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.23.2 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.23.2 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.23.2 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource 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
}

func (UntagStreamInput) MarshalFields added in v0.3.0 

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
}

func (UntagStreamOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the UntagStream API operation.

func (UntagStreamRequest) Send 

func (r UntagStreamRequest) Send(ctx context.Context) (*UntagStreamResponse, error)

Send marshals and sends the UntagStream API request.

type UntagStreamResponse added in v0.23.2 

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

UntagStreamResponse is the response type for the UntagStream API operation.

func (*UntagStreamResponse) SDKResponseMetdata added in v0.23.2 

func (r *UntagStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagStream 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. The maximum value for this parameter is 87600 (ten years).
	//
	// 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
}

func (UpdateDataRetentionInput) MarshalFields added in v0.3.0 

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

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 added in v0.3.0 

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

func (UpdateDataRetentionOperation) MarshalValueBuf added in v0.3.0 

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

type UpdateDataRetentionOutput 

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

func (UpdateDataRetentionOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the UpdateDataRetention API operation.

func (UpdateDataRetentionRequest) Send 

func (r UpdateDataRetentionRequest) Send(ctx context.Context) (*UpdateDataRetentionResponse, error)

Send marshals and sends the UpdateDataRetention API request.

type UpdateDataRetentionResponse added in v0.23.2 

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

UpdateDataRetentionResponse is the response type for the UpdateDataRetention API operation.

func (*UpdateDataRetentionResponse) SDKResponseMetdata added in v0.23.2 

func (r *UpdateDataRetentionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateDataRetention request.

type UpdateSignalingChannelInput added in v0.23.2 

type UpdateSignalingChannelInput struct {

	// The Amazon Resource Name (ARN) of the signaling channel that you want to
	// update.
	//
	// ChannelARN is a required field
	ChannelARN *string `min:"1" type:"string" required:"true"`

	// The current version of the signaling channel that you want to update.
	//
	// CurrentVersion is a required field
	CurrentVersion *string `min:"1" type:"string" required:"true"`

	// The structure containing the configuration for the SINGLE_MASTER type of
	// the signaling channel that you want to update.
	SingleMasterConfiguration *SingleMasterConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateSignalingChannelInput) MarshalFields added in v0.23.2 

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

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

func (UpdateSignalingChannelInput) String added in v0.23.2 

func (s UpdateSignalingChannelInput) String() string

String returns the string representation

func (*UpdateSignalingChannelInput) Validate added in v0.23.2 

func (s *UpdateSignalingChannelInput) Validate() error

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

type UpdateSignalingChannelOutput added in v0.23.2 

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

func (UpdateSignalingChannelOutput) MarshalFields added in v0.23.2 

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

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

func (UpdateSignalingChannelOutput) String added in v0.23.2 

func (s UpdateSignalingChannelOutput) String() string

String returns the string representation

type UpdateSignalingChannelRequest added in v0.23.2 

type UpdateSignalingChannelRequest struct {
	*aws.Request
	Input *UpdateSignalingChannelInput
	Copy  func(*UpdateSignalingChannelInput) UpdateSignalingChannelRequest
}

UpdateSignalingChannelRequest is the request type for the UpdateSignalingChannel API operation.

func (UpdateSignalingChannelRequest) Send added in v0.23.2 

func (r UpdateSignalingChannelRequest) Send(ctx context.Context) (*UpdateSignalingChannelResponse, error)

Send marshals and sends the UpdateSignalingChannel API request.

type UpdateSignalingChannelResponse added in v0.23.2 

type UpdateSignalingChannelResponse struct {
	*UpdateSignalingChannelOutput
	// contains filtered or unexported fields
}

UpdateSignalingChannelResponse is the response type for the UpdateSignalingChannel API operation.

func (*UpdateSignalingChannelResponse) SDKResponseMetdata added in v0.23.2 

func (r *UpdateSignalingChannelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateSignalingChannel 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.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) MarshalFields added in v0.3.0 

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
}

func (UpdateStreamOutput) MarshalFields added in v0.3.0 

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

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

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 the request type for the UpdateStream API operation.

func (UpdateStreamRequest) Send 

func (r UpdateStreamRequest) Send(ctx context.Context) (*UpdateStreamResponse, error)

Send marshals and sends the UpdateStream API request.

type UpdateStreamResponse added in v0.23.2 

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

UpdateStreamResponse is the response type for the UpdateStream API operation.

func (*UpdateStreamResponse) SDKResponseMetdata added in v0.23.2 

func (r *UpdateStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateStream request.

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.