Documentation

Overview

    Package kinesisvideo provides the API client, operations, and parameter types for Amazon Kinesis Video Streams.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-09-30"
    View Source
    const ServiceID = "Kinesis Video"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

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

            Client provides the API client to make operations call for Amazon Kinesis Video Streams.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CreateSignalingChannel

                func (c *Client) CreateSignalingChannel(ctx context.Context, params *CreateSignalingChannelInput, optFns ...func(*Options)) (*CreateSignalingChannelOutput, error)

                  Creates a signaling channel. CreateSignalingChannel is an asynchronous operation.

                  func (*Client) CreateStream

                  func (c *Client) CreateStream(ctx context.Context, params *CreateStreamInput, optFns ...func(*Options)) (*CreateStreamOutput, error)

                    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.

                    func (*Client) DeleteSignalingChannel

                    func (c *Client) DeleteSignalingChannel(ctx context.Context, params *DeleteSignalingChannelInput, optFns ...func(*Options)) (*DeleteSignalingChannelOutput, error)

                      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.

                      func (*Client) DeleteStream

                      func (c *Client) DeleteStream(ctx context.Context, params *DeleteStreamInput, optFns ...func(*Options)) (*DeleteStreamOutput, error)

                        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.

                        func (*Client) DescribeSignalingChannel

                        func (c *Client) DescribeSignalingChannel(ctx context.Context, params *DescribeSignalingChannelInput, optFns ...func(*Options)) (*DescribeSignalingChannelOutput, error)

                          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.

                          func (*Client) DescribeStream

                          func (c *Client) DescribeStream(ctx context.Context, params *DescribeStreamInput, optFns ...func(*Options)) (*DescribeStreamOutput, error)

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

                            func (*Client) GetDataEndpoint

                            func (c *Client) GetDataEndpoint(ctx context.Context, params *GetDataEndpointInput, optFns ...func(*Options)) (*GetDataEndpointOutput, error)

                              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.

                              func (*Client) GetSignalingChannelEndpoint

                              func (c *Client) GetSignalingChannelEndpoint(ctx context.Context, params *GetSignalingChannelEndpointInput, optFns ...func(*Options)) (*GetSignalingChannelEndpointOutput, error)

                                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.

                                func (*Client) ListSignalingChannels

                                func (c *Client) ListSignalingChannels(ctx context.Context, params *ListSignalingChannelsInput, optFns ...func(*Options)) (*ListSignalingChannelsOutput, error)

                                  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.

                                  func (*Client) ListStreams

                                  func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error)

                                    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.

                                    func (*Client) ListTagsForResource

                                    func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

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

                                      func (*Client) ListTagsForStream

                                      func (c *Client) ListTagsForStream(ctx context.Context, params *ListTagsForStreamInput, optFns ...func(*Options)) (*ListTagsForStreamOutput, error)

                                        Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN.

                                        func (*Client) TagResource

                                        func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

                                          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.

                                          func (*Client) TagStream

                                          func (c *Client) TagStream(ctx context.Context, params *TagStreamInput, optFns ...func(*Options)) (*TagStreamOutput, error)

                                            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.

                                            func (*Client) UntagResource

                                            func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

                                              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.

                                              func (*Client) UntagStream

                                              func (c *Client) UntagStream(ctx context.Context, params *UntagStreamInput, optFns ...func(*Options)) (*UntagStreamOutput, error)

                                                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.

                                                func (*Client) UpdateDataRetention

                                                func (c *Client) UpdateDataRetention(ctx context.Context, params *UpdateDataRetentionInput, optFns ...func(*Options)) (*UpdateDataRetentionOutput, error)

                                                  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.

                                                  func (*Client) UpdateSignalingChannel

                                                  func (c *Client) UpdateSignalingChannel(ctx context.Context, params *UpdateSignalingChannelInput, optFns ...func(*Options)) (*UpdateSignalingChannelOutput, error)

                                                    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.

                                                    func (*Client) UpdateStream

                                                    func (c *Client) UpdateStream(ctx context.Context, params *UpdateStreamInput, optFns ...func(*Options)) (*UpdateStreamOutput, error)

                                                      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.

                                                      type CreateSignalingChannelInput

                                                      type CreateSignalingChannelInput struct {
                                                      
                                                      	// A name for the signaling channel that you are creating. It must be unique for
                                                      	// each AWS account and AWS Region.
                                                      	//
                                                      	// This member is required.
                                                      	ChannelName *string
                                                      
                                                      	// A type of the signaling channel that you are creating. Currently, SINGLE_MASTER
                                                      	// is the only supported channel type.
                                                      	ChannelType types.ChannelType
                                                      
                                                      	// A structure containing the configuration for the SINGLE_MASTER channel type.
                                                      	SingleMasterConfiguration *types.SingleMasterConfiguration
                                                      
                                                      	// A set of tags (key-value pairs) that you want to associate with this channel.
                                                      	Tags []types.Tag
                                                      }

                                                      type CreateSignalingChannelOutput

                                                      type CreateSignalingChannelOutput struct {
                                                      
                                                      	// The Amazon Resource Name (ARN) of the created channel.
                                                      	ChannelARN *string
                                                      
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                      type CreateStreamInput

                                                      type CreateStreamInput struct {
                                                      
                                                      	// 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.
                                                      	//
                                                      	// This member is required.
                                                      	StreamName *string
                                                      
                                                      	// 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 *int32
                                                      
                                                      	// 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
                                                      
                                                      	// 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
                                                      
                                                      	// 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
                                                      
                                                      	// 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
                                                      }

                                                      type CreateStreamOutput

                                                      type CreateStreamOutput struct {
                                                      
                                                      	// The Amazon Resource Name (ARN) of the stream.
                                                      	StreamARN *string
                                                      
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                      type DeleteSignalingChannelInput

                                                      type DeleteSignalingChannelInput struct {
                                                      
                                                      	// The Amazon Resource Name (ARN) of the signaling channel that you want to delete.
                                                      	//
                                                      	// This member is required.
                                                      	ChannelARN *string
                                                      
                                                      	// 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
                                                      }

                                                      type DeleteSignalingChannelOutput

                                                      type DeleteSignalingChannelOutput struct {
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                      type DeleteStreamInput

                                                      type DeleteStreamInput struct {
                                                      
                                                      	// The Amazon Resource Name (ARN) of the stream that you want to delete.
                                                      	//
                                                      	// This member is required.
                                                      	StreamARN *string
                                                      
                                                      	// 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
                                                      }

                                                      type DeleteStreamOutput

                                                      type DeleteStreamOutput struct {
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                      type DescribeSignalingChannelInput

                                                      type DescribeSignalingChannelInput struct {
                                                      
                                                      	// The ARN of the signaling channel that you want to describe.
                                                      	ChannelARN *string
                                                      
                                                      	// The name of the signaling channel that you want to describe.
                                                      	ChannelName *string
                                                      }

                                                      type DescribeSignalingChannelOutput

                                                      type DescribeSignalingChannelOutput struct {
                                                      
                                                      	// A structure that encapsulates the specified signaling channel's metadata and
                                                      	// properties.
                                                      	ChannelInfo *types.ChannelInfo
                                                      
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                      type DescribeStreamInput

                                                      type DescribeStreamInput struct {
                                                      
                                                      	// The Amazon Resource Name (ARN) of the stream.
                                                      	StreamARN *string
                                                      
                                                      	// The name of the stream.
                                                      	StreamName *string
                                                      }

                                                      type DescribeStreamOutput

                                                      type DescribeStreamOutput struct {
                                                      
                                                      	// An object that describes the stream.
                                                      	StreamInfo *types.StreamInfo
                                                      
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                      type EndpointResolver

                                                      type EndpointResolver interface {
                                                      	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                                      }

                                                        EndpointResolver interface for resolving service endpoints.

                                                        func EndpointResolverFromURL

                                                        func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                                          EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                                          type EndpointResolverFunc

                                                          type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                                            EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                                            func (EndpointResolverFunc) ResolveEndpoint

                                                            func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                                            type EndpointResolverOptions

                                                            type EndpointResolverOptions = internalendpoints.Options

                                                              EndpointResolverOptions is the service endpoint resolver options

                                                              type GetDataEndpointInput

                                                              type GetDataEndpointInput struct {
                                                              
                                                              	// The name of the API action for which to get an endpoint.
                                                              	//
                                                              	// This member is required.
                                                              	APIName types.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
                                                              
                                                              	// 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
                                                              }

                                                              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
                                                              
                                                              	// Metadata pertaining to the operation's result.
                                                              	ResultMetadata middleware.Metadata
                                                              }

                                                              type GetSignalingChannelEndpointInput

                                                              type GetSignalingChannelEndpointInput struct {
                                                              
                                                              	// The Amazon Resource Name (ARN) of the signalling channel for which you want to
                                                              	// get an endpoint.
                                                              	//
                                                              	// This member is required.
                                                              	ChannelARN *string
                                                              
                                                              	// A structure containing the endpoint configuration for the SINGLE_MASTER channel
                                                              	// type.
                                                              	SingleMasterChannelEndpointConfiguration *types.SingleMasterChannelEndpointConfiguration
                                                              }

                                                              type GetSignalingChannelEndpointOutput

                                                              type GetSignalingChannelEndpointOutput struct {
                                                              
                                                              	// A list of endpoints for the specified signaling channel.
                                                              	ResourceEndpointList []types.ResourceEndpointListItem
                                                              
                                                              	// Metadata pertaining to the operation's result.
                                                              	ResultMetadata middleware.Metadata
                                                              }

                                                              type HTTPClient

                                                              type HTTPClient interface {
                                                              	Do(*http.Request) (*http.Response, error)
                                                              }

                                                              type HTTPSignerV4

                                                              type HTTPSignerV4 interface {
                                                              	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                              }

                                                              type ListSignalingChannelsAPIClient

                                                              type ListSignalingChannelsAPIClient interface {
                                                              	ListSignalingChannels(context.Context, *ListSignalingChannelsInput, ...func(*Options)) (*ListSignalingChannelsOutput, error)
                                                              }

                                                                ListSignalingChannelsAPIClient is a client that implements the ListSignalingChannels operation.

                                                                type ListSignalingChannelsInput

                                                                type ListSignalingChannelsInput struct {
                                                                
                                                                	// Optional: Returns only the channels that satisfy a specific condition.
                                                                	ChannelNameCondition *types.ChannelNameCondition
                                                                
                                                                	// The maximum number of channels to return in the response. The default is 500.
                                                                	MaxResults *int32
                                                                
                                                                	// 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 ListSignalingChannelsOutput

                                                                type ListSignalingChannelsOutput struct {
                                                                
                                                                	// An array of ChannelInfo objects.
                                                                	ChannelInfoList []types.ChannelInfo
                                                                
                                                                	// 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
                                                                
                                                                	// Metadata pertaining to the operation's result.
                                                                	ResultMetadata middleware.Metadata
                                                                }

                                                                type ListSignalingChannelsPaginator

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

                                                                  ListSignalingChannelsPaginator is a paginator for ListSignalingChannels

                                                                  func NewListSignalingChannelsPaginator

                                                                    NewListSignalingChannelsPaginator returns a new ListSignalingChannelsPaginator

                                                                    func (*ListSignalingChannelsPaginator) HasMorePages

                                                                    func (p *ListSignalingChannelsPaginator) HasMorePages() bool

                                                                      HasMorePages returns a boolean indicating whether more pages are available

                                                                      func (*ListSignalingChannelsPaginator) NextPage

                                                                        NextPage retrieves the next ListSignalingChannels page.

                                                                        type ListSignalingChannelsPaginatorOptions

                                                                        type ListSignalingChannelsPaginatorOptions struct {
                                                                        	// The maximum number of channels to return in the response. The default is 500.
                                                                        	Limit int32
                                                                        
                                                                        	// Set to true if pagination should stop if the service returns a pagination token
                                                                        	// that matches the most recent token provided to the service.
                                                                        	StopOnDuplicateToken bool
                                                                        }

                                                                          ListSignalingChannelsPaginatorOptions is the paginator options for ListSignalingChannels

                                                                          type ListStreamsAPIClient

                                                                          type ListStreamsAPIClient interface {
                                                                          	ListStreams(context.Context, *ListStreamsInput, ...func(*Options)) (*ListStreamsOutput, error)
                                                                          }

                                                                            ListStreamsAPIClient is a client that implements the ListStreams operation.

                                                                            type ListStreamsInput

                                                                            type ListStreamsInput struct {
                                                                            
                                                                            	// The maximum number of streams to return in the response. The default is 10,000.
                                                                            	MaxResults *int32
                                                                            
                                                                            	// 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
                                                                            
                                                                            	// Optional: Returns only streams that satisfy a specific condition. Currently, you
                                                                            	// can specify only the prefix of a stream name as a condition.
                                                                            	StreamNameCondition *types.StreamNameCondition
                                                                            }

                                                                            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
                                                                            
                                                                            	// An array of StreamInfo objects.
                                                                            	StreamInfoList []types.StreamInfo
                                                                            
                                                                            	// Metadata pertaining to the operation's result.
                                                                            	ResultMetadata middleware.Metadata
                                                                            }

                                                                            type ListStreamsPaginator

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

                                                                              ListStreamsPaginator is a paginator for ListStreams

                                                                              func NewListStreamsPaginator

                                                                              func NewListStreamsPaginator(client ListStreamsAPIClient, params *ListStreamsInput, optFns ...func(*ListStreamsPaginatorOptions)) *ListStreamsPaginator

                                                                                NewListStreamsPaginator returns a new ListStreamsPaginator

                                                                                func (*ListStreamsPaginator) HasMorePages

                                                                                func (p *ListStreamsPaginator) HasMorePages() bool

                                                                                  HasMorePages returns a boolean indicating whether more pages are available

                                                                                  func (*ListStreamsPaginator) NextPage

                                                                                  func (p *ListStreamsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamsOutput, error)

                                                                                    NextPage retrieves the next ListStreams page.

                                                                                    type ListStreamsPaginatorOptions

                                                                                    type ListStreamsPaginatorOptions struct {
                                                                                    	// The maximum number of streams to return in the response. The default is 10,000.
                                                                                    	Limit int32
                                                                                    
                                                                                    	// Set to true if pagination should stop if the service returns a pagination token
                                                                                    	// that matches the most recent token provided to the service.
                                                                                    	StopOnDuplicateToken bool
                                                                                    }

                                                                                      ListStreamsPaginatorOptions is the paginator options for ListStreams

                                                                                      type ListTagsForResourceInput

                                                                                      type ListTagsForResourceInput struct {
                                                                                      
                                                                                      	// The Amazon Resource Name (ARN) of the signaling channel for which you want to
                                                                                      	// list tags.
                                                                                      	//
                                                                                      	// This member is required.
                                                                                      	ResourceARN *string
                                                                                      
                                                                                      	// 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 ListTagsForResourceOutput

                                                                                      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
                                                                                      
                                                                                      	// A map of tag keys and values associated with the specified signaling channel.
                                                                                      	Tags map[string]string
                                                                                      
                                                                                      	// Metadata pertaining to the operation's result.
                                                                                      	ResultMetadata middleware.Metadata
                                                                                      }

                                                                                      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
                                                                                      
                                                                                      	// The Amazon Resource Name (ARN) of the stream that you want to list tags for.
                                                                                      	StreamARN *string
                                                                                      
                                                                                      	// The name of the stream that you want to list tags for.
                                                                                      	StreamName *string
                                                                                      }

                                                                                      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
                                                                                      
                                                                                      	// A map of tag keys and values associated with the specified stream.
                                                                                      	Tags map[string]string
                                                                                      
                                                                                      	// Metadata pertaining to the operation's result.
                                                                                      	ResultMetadata middleware.Metadata
                                                                                      }

                                                                                      type Options

                                                                                      type Options struct {
                                                                                      	// Set of options to modify how an operation is invoked. These apply to all
                                                                                      	// operations invoked for this client. Use functional options on operation call to
                                                                                      	// modify this list for per operation behavior.
                                                                                      	APIOptions []func(*middleware.Stack) error
                                                                                      
                                                                                      	// Configures the events that will be sent to the configured logger.
                                                                                      	ClientLogMode aws.ClientLogMode
                                                                                      
                                                                                      	// The credentials object to use when signing requests.
                                                                                      	Credentials aws.CredentialsProvider
                                                                                      
                                                                                      	// The endpoint options to be used when attempting to resolve an endpoint.
                                                                                      	EndpointOptions EndpointResolverOptions
                                                                                      
                                                                                      	// The service endpoint resolver.
                                                                                      	EndpointResolver EndpointResolver
                                                                                      
                                                                                      	// Signature Version 4 (SigV4) Signer
                                                                                      	HTTPSignerV4 HTTPSignerV4
                                                                                      
                                                                                      	// The logger writer interface to write logging messages to.
                                                                                      	Logger logging.Logger
                                                                                      
                                                                                      	// The region to send requests to. (Required)
                                                                                      	Region string
                                                                                      
                                                                                      	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                      	// failures. When nil the API client will use a default retryer.
                                                                                      	Retryer aws.Retryer
                                                                                      
                                                                                      	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                      	// implementation if nil.
                                                                                      	HTTPClient HTTPClient
                                                                                      }

                                                                                      func (Options) Copy

                                                                                      func (o Options) Copy() Options

                                                                                        Copy creates a clone where the APIOptions list is deep copied.

                                                                                        type ResolveEndpoint

                                                                                        type ResolveEndpoint struct {
                                                                                        	Resolver EndpointResolver
                                                                                        	Options  EndpointResolverOptions
                                                                                        }

                                                                                        func (*ResolveEndpoint) HandleSerialize

                                                                                        func (*ResolveEndpoint) ID

                                                                                        func (*ResolveEndpoint) ID() string

                                                                                        type TagResourceInput

                                                                                        type TagResourceInput struct {
                                                                                        
                                                                                        	// The Amazon Resource Name (ARN) of the signaling channel to which you want to add
                                                                                        	// tags.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	ResourceARN *string
                                                                                        
                                                                                        	// A list of tags to associate with the specified signaling channel. Each tag is a
                                                                                        	// key-value pair.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	Tags []types.Tag
                                                                                        }

                                                                                        type TagResourceOutput

                                                                                        type TagResourceOutput struct {
                                                                                        	// Metadata pertaining to the operation's result.
                                                                                        	ResultMetadata middleware.Metadata
                                                                                        }

                                                                                        type TagStreamInput

                                                                                        type TagStreamInput struct {
                                                                                        
                                                                                        	// A list of tags to associate with the specified stream. Each tag is a key-value
                                                                                        	// pair (the value is optional).
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	Tags map[string]string
                                                                                        
                                                                                        	// The Amazon Resource Name (ARN) of the resource that you want to add the tag or
                                                                                        	// tags to.
                                                                                        	StreamARN *string
                                                                                        
                                                                                        	// The name of the stream that you want to add the tag or tags to.
                                                                                        	StreamName *string
                                                                                        }

                                                                                        type TagStreamOutput

                                                                                        type TagStreamOutput struct {
                                                                                        	// Metadata pertaining to the operation's result.
                                                                                        	ResultMetadata middleware.Metadata
                                                                                        }

                                                                                        type UntagResourceInput

                                                                                        type UntagResourceInput struct {
                                                                                        
                                                                                        	// The Amazon Resource Name (ARN) of the signaling channel from which you want to
                                                                                        	// remove tags.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	ResourceARN *string
                                                                                        
                                                                                        	// A list of the keys of the tags that you want to remove.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	TagKeyList []string
                                                                                        }

                                                                                        type UntagResourceOutput

                                                                                        type UntagResourceOutput struct {
                                                                                        	// Metadata pertaining to the operation's result.
                                                                                        	ResultMetadata middleware.Metadata
                                                                                        }

                                                                                        type UntagStreamInput

                                                                                        type UntagStreamInput struct {
                                                                                        
                                                                                        	// A list of the keys of the tags that you want to remove.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	TagKeyList []string
                                                                                        
                                                                                        	// The Amazon Resource Name (ARN) of the stream that you want to remove tags from.
                                                                                        	StreamARN *string
                                                                                        
                                                                                        	// The name of the stream that you want to remove tags from.
                                                                                        	StreamName *string
                                                                                        }

                                                                                        type UntagStreamOutput

                                                                                        type UntagStreamOutput struct {
                                                                                        	// Metadata pertaining to the operation's result.
                                                                                        	ResultMetadata middleware.Metadata
                                                                                        }

                                                                                        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.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	CurrentVersion *string
                                                                                        
                                                                                        	// The retention period, in hours. The value you specify replaces the current
                                                                                        	// value. The maximum value for this parameter is 87600 (ten years).
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	DataRetentionChangeInHours *int32
                                                                                        
                                                                                        	// Indicates whether you want to increase or decrease the retention period.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	Operation types.UpdateDataRetentionOperation
                                                                                        
                                                                                        	// The Amazon Resource Name (ARN) of the stream whose retention period you want to
                                                                                        	// change.
                                                                                        	StreamARN *string
                                                                                        
                                                                                        	// The name of the stream whose retention period you want to change.
                                                                                        	StreamName *string
                                                                                        }

                                                                                        type UpdateDataRetentionOutput

                                                                                        type UpdateDataRetentionOutput struct {
                                                                                        	// Metadata pertaining to the operation's result.
                                                                                        	ResultMetadata middleware.Metadata
                                                                                        }

                                                                                        type UpdateSignalingChannelInput

                                                                                        type UpdateSignalingChannelInput struct {
                                                                                        
                                                                                        	// The Amazon Resource Name (ARN) of the signaling channel that you want to update.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	ChannelARN *string
                                                                                        
                                                                                        	// The current version of the signaling channel that you want to update.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	CurrentVersion *string
                                                                                        
                                                                                        	// The structure containing the configuration for the SINGLE_MASTER type of the
                                                                                        	// signaling channel that you want to update.
                                                                                        	SingleMasterConfiguration *types.SingleMasterConfiguration
                                                                                        }

                                                                                        type UpdateSignalingChannelOutput

                                                                                        type UpdateSignalingChannelOutput struct {
                                                                                        	// Metadata pertaining to the operation's result.
                                                                                        	ResultMetadata middleware.Metadata
                                                                                        }

                                                                                        type UpdateStreamInput

                                                                                        type UpdateStreamInput struct {
                                                                                        
                                                                                        	// The version of the stream whose metadata you want to update.
                                                                                        	//
                                                                                        	// This member is required.
                                                                                        	CurrentVersion *string
                                                                                        
                                                                                        	// 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
                                                                                        
                                                                                        	// 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
                                                                                        
                                                                                        	// The ARN of the stream whose metadata you want to update.
                                                                                        	StreamARN *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
                                                                                        }

                                                                                        type UpdateStreamOutput

                                                                                        type UpdateStreamOutput struct {
                                                                                        	// Metadata pertaining to the operation's result.
                                                                                        	ResultMetadata middleware.Metadata
                                                                                        }

                                                                                        Directories

                                                                                        Path Synopsis
                                                                                        internal