AWS SDK for C++  1.9.108
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::KinesisVideo::KinesisVideoClient Class Reference

#include <KinesisVideoClient.h>

+ Inheritance diagram for Aws::KinesisVideo::KinesisVideoClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 KinesisVideoClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 KinesisVideoClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 KinesisVideoClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~KinesisVideoClient ()
 
virtual Model::CreateSignalingChannelOutcome CreateSignalingChannel (const Model::CreateSignalingChannelRequest &request) const
 
virtual Model::CreateSignalingChannelOutcomeCallable CreateSignalingChannelCallable (const Model::CreateSignalingChannelRequest &request) const
 
virtual void CreateSignalingChannelAsync (const Model::CreateSignalingChannelRequest &request, const CreateSignalingChannelResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateStreamOutcome CreateStream (const Model::CreateStreamRequest &request) const
 
virtual Model::CreateStreamOutcomeCallable CreateStreamCallable (const Model::CreateStreamRequest &request) const
 
virtual void CreateStreamAsync (const Model::CreateStreamRequest &request, const CreateStreamResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteSignalingChannelOutcome DeleteSignalingChannel (const Model::DeleteSignalingChannelRequest &request) const
 
virtual Model::DeleteSignalingChannelOutcomeCallable DeleteSignalingChannelCallable (const Model::DeleteSignalingChannelRequest &request) const
 
virtual void DeleteSignalingChannelAsync (const Model::DeleteSignalingChannelRequest &request, const DeleteSignalingChannelResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteStreamOutcome DeleteStream (const Model::DeleteStreamRequest &request) const
 
virtual Model::DeleteStreamOutcomeCallable DeleteStreamCallable (const Model::DeleteStreamRequest &request) const
 
virtual void DeleteStreamAsync (const Model::DeleteStreamRequest &request, const DeleteStreamResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeSignalingChannelOutcome DescribeSignalingChannel (const Model::DescribeSignalingChannelRequest &request) const
 
virtual Model::DescribeSignalingChannelOutcomeCallable DescribeSignalingChannelCallable (const Model::DescribeSignalingChannelRequest &request) const
 
virtual void DescribeSignalingChannelAsync (const Model::DescribeSignalingChannelRequest &request, const DescribeSignalingChannelResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeStreamOutcome DescribeStream (const Model::DescribeStreamRequest &request) const
 
virtual Model::DescribeStreamOutcomeCallable DescribeStreamCallable (const Model::DescribeStreamRequest &request) const
 
virtual void DescribeStreamAsync (const Model::DescribeStreamRequest &request, const DescribeStreamResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetDataEndpointOutcome GetDataEndpoint (const Model::GetDataEndpointRequest &request) const
 
virtual Model::GetDataEndpointOutcomeCallable GetDataEndpointCallable (const Model::GetDataEndpointRequest &request) const
 
virtual void GetDataEndpointAsync (const Model::GetDataEndpointRequest &request, const GetDataEndpointResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetSignalingChannelEndpointOutcome GetSignalingChannelEndpoint (const Model::GetSignalingChannelEndpointRequest &request) const
 
virtual Model::GetSignalingChannelEndpointOutcomeCallable GetSignalingChannelEndpointCallable (const Model::GetSignalingChannelEndpointRequest &request) const
 
virtual void GetSignalingChannelEndpointAsync (const Model::GetSignalingChannelEndpointRequest &request, const GetSignalingChannelEndpointResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListSignalingChannelsOutcome ListSignalingChannels (const Model::ListSignalingChannelsRequest &request) const
 
virtual Model::ListSignalingChannelsOutcomeCallable ListSignalingChannelsCallable (const Model::ListSignalingChannelsRequest &request) const
 
virtual void ListSignalingChannelsAsync (const Model::ListSignalingChannelsRequest &request, const ListSignalingChannelsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListStreamsOutcome ListStreams (const Model::ListStreamsRequest &request) const
 
virtual Model::ListStreamsOutcomeCallable ListStreamsCallable (const Model::ListStreamsRequest &request) const
 
virtual void ListStreamsAsync (const Model::ListStreamsRequest &request, const ListStreamsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
 
virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
 
virtual void ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForStreamOutcome ListTagsForStream (const Model::ListTagsForStreamRequest &request) const
 
virtual Model::ListTagsForStreamOutcomeCallable ListTagsForStreamCallable (const Model::ListTagsForStreamRequest &request) const
 
virtual void ListTagsForStreamAsync (const Model::ListTagsForStreamRequest &request, const ListTagsForStreamResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const
 
virtual Model::TagResourceOutcomeCallable TagResourceCallable (const Model::TagResourceRequest &request) const
 
virtual void TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagStreamOutcome TagStream (const Model::TagStreamRequest &request) const
 
virtual Model::TagStreamOutcomeCallable TagStreamCallable (const Model::TagStreamRequest &request) const
 
virtual void TagStreamAsync (const Model::TagStreamRequest &request, const TagStreamResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const
 
virtual Model::UntagResourceOutcomeCallable UntagResourceCallable (const Model::UntagResourceRequest &request) const
 
virtual void UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagStreamOutcome UntagStream (const Model::UntagStreamRequest &request) const
 
virtual Model::UntagStreamOutcomeCallable UntagStreamCallable (const Model::UntagStreamRequest &request) const
 
virtual void UntagStreamAsync (const Model::UntagStreamRequest &request, const UntagStreamResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateDataRetentionOutcome UpdateDataRetention (const Model::UpdateDataRetentionRequest &request) const
 
virtual Model::UpdateDataRetentionOutcomeCallable UpdateDataRetentionCallable (const Model::UpdateDataRetentionRequest &request) const
 
virtual void UpdateDataRetentionAsync (const Model::UpdateDataRetentionRequest &request, const UpdateDataRetentionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateSignalingChannelOutcome UpdateSignalingChannel (const Model::UpdateSignalingChannelRequest &request) const
 
virtual Model::UpdateSignalingChannelOutcomeCallable UpdateSignalingChannelCallable (const Model::UpdateSignalingChannelRequest &request) const
 
virtual void UpdateSignalingChannelAsync (const Model::UpdateSignalingChannelRequest &request, const UpdateSignalingChannelResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateStreamOutcome UpdateStream (const Model::UpdateStreamRequest &request) const
 
virtual Model::UpdateStreamOutcomeCallable UpdateStreamCallable (const Model::UpdateStreamRequest &request) const
 
virtual void UpdateStreamAsync (const Model::UpdateStreamRequest &request, const UpdateStreamResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

Definition at line 158 of file KinesisVideoClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 161 of file KinesisVideoClient.h.

Constructor & Destructor Documentation

◆ KinesisVideoClient() [1/3]

Aws::KinesisVideo::KinesisVideoClient::KinesisVideoClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ KinesisVideoClient() [2/3]

Aws::KinesisVideo::KinesisVideoClient::KinesisVideoClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ KinesisVideoClient() [3/3]

Aws::KinesisVideo::KinesisVideoClient::KinesisVideoClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~KinesisVideoClient()

virtual Aws::KinesisVideo::KinesisVideoClient::~KinesisVideoClient ( )
virtual

Member Function Documentation

◆ CreateSignalingChannel()

virtual Model::CreateSignalingChannelOutcome Aws::KinesisVideo::KinesisVideoClient::CreateSignalingChannel ( const Model::CreateSignalingChannelRequest request) const
virtual

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

See Also:

AWS API Reference

◆ CreateSignalingChannelAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::CreateSignalingChannelAsync ( const Model::CreateSignalingChannelRequest request,
const CreateSignalingChannelResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateSignalingChannelCallable()

virtual Model::CreateSignalingChannelOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::CreateSignalingChannelCallable ( const Model::CreateSignalingChannelRequest request) const
virtual

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateStream()

virtual Model::CreateStreamOutcome Aws::KinesisVideo::KinesisVideoClient::CreateStream ( const Model::CreateStreamRequest request) const
virtual

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.

You must have permissions for the KinesisVideo:CreateStream action.

See Also:

AWS API Reference

◆ CreateStreamAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::CreateStreamAsync ( const Model::CreateStreamRequest request,
const CreateStreamResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

You must have permissions for the KinesisVideo:CreateStream action.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateStreamCallable()

virtual Model::CreateStreamOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::CreateStreamCallable ( const Model::CreateStreamRequest request) const
virtual

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.

You must have permissions for the KinesisVideo:CreateStream action.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteSignalingChannel()

virtual Model::DeleteSignalingChannelOutcome Aws::KinesisVideo::KinesisVideoClient::DeleteSignalingChannel ( const Model::DeleteSignalingChannelRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DeleteSignalingChannelAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::DeleteSignalingChannelAsync ( const Model::DeleteSignalingChannelRequest request,
const DeleteSignalingChannelResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteSignalingChannelCallable()

virtual Model::DeleteSignalingChannelOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::DeleteSignalingChannelCallable ( const Model::DeleteSignalingChannelRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteStream()

virtual Model::DeleteStreamOutcome Aws::KinesisVideo::KinesisVideoClient::DeleteStream ( const Model::DeleteStreamRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DeleteStreamAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::DeleteStreamAsync ( const Model::DeleteStreamRequest request,
const DeleteStreamResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteStreamCallable()

virtual Model::DeleteStreamOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::DeleteStreamCallable ( const Model::DeleteStreamRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeSignalingChannel()

virtual Model::DescribeSignalingChannelOutcome Aws::KinesisVideo::KinesisVideoClient::DescribeSignalingChannel ( const Model::DescribeSignalingChannelRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DescribeSignalingChannelAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::DescribeSignalingChannelAsync ( const Model::DescribeSignalingChannelRequest request,
const DescribeSignalingChannelResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeSignalingChannelCallable()

virtual Model::DescribeSignalingChannelOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::DescribeSignalingChannelCallable ( const Model::DescribeSignalingChannelRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeStream()

virtual Model::DescribeStreamOutcome Aws::KinesisVideo::KinesisVideoClient::DescribeStream ( const Model::DescribeStreamRequest request) const
virtual

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

See Also:

AWS API Reference

◆ DescribeStreamAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::DescribeStreamAsync ( const Model::DescribeStreamRequest request,
const DescribeStreamResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeStreamCallable()

virtual Model::DescribeStreamOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::DescribeStreamCallable ( const Model::DescribeStreamRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetDataEndpoint()

virtual Model::GetDataEndpointOutcome Aws::KinesisVideo::KinesisVideoClient::GetDataEndpoint ( const Model::GetDataEndpointRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetDataEndpointAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::GetDataEndpointAsync ( const Model::GetDataEndpointRequest request,
const GetDataEndpointResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetDataEndpointCallable()

virtual Model::GetDataEndpointOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::GetDataEndpointCallable ( const Model::GetDataEndpointRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetSignalingChannelEndpoint()

virtual Model::GetSignalingChannelEndpointOutcome Aws::KinesisVideo::KinesisVideoClient::GetSignalingChannelEndpoint ( const Model::GetSignalingChannelEndpointRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetSignalingChannelEndpointAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::GetSignalingChannelEndpointAsync ( const Model::GetSignalingChannelEndpointRequest request,
const GetSignalingChannelEndpointResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetSignalingChannelEndpointCallable()

virtual Model::GetSignalingChannelEndpointOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::GetSignalingChannelEndpointCallable ( const Model::GetSignalingChannelEndpointRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListSignalingChannels()

virtual Model::ListSignalingChannelsOutcome Aws::KinesisVideo::KinesisVideoClient::ListSignalingChannels ( const Model::ListSignalingChannelsRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ ListSignalingChannelsAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::ListSignalingChannelsAsync ( const Model::ListSignalingChannelsRequest request,
const ListSignalingChannelsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListSignalingChannelsCallable()

virtual Model::ListSignalingChannelsOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::ListSignalingChannelsCallable ( const Model::ListSignalingChannelsRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListStreams()

virtual Model::ListStreamsOutcome Aws::KinesisVideo::KinesisVideoClient::ListStreams ( const Model::ListStreamsRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ ListStreamsAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::ListStreamsAsync ( const Model::ListStreamsRequest request,
const ListStreamsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListStreamsCallable()

virtual Model::ListStreamsOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::ListStreamsCallable ( const Model::ListStreamsRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::KinesisVideo::KinesisVideoClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

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

See Also:

AWS API Reference

◆ ListTagsForResourceAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::ListTagsForResourceAsync ( const Model::ListTagsForResourceRequest request,
const ListTagsForResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForStream()

virtual Model::ListTagsForStreamOutcome Aws::KinesisVideo::KinesisVideoClient::ListTagsForStream ( const Model::ListTagsForStreamRequest request) const
virtual

Returns a list of tags associated with the specified stream.

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

See Also:

AWS API Reference

◆ ListTagsForStreamAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::ListTagsForStreamAsync ( const Model::ListTagsForStreamRequest request,
const ListTagsForStreamResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns a list of tags associated with the specified stream.

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForStreamCallable()

virtual Model::ListTagsForStreamOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::ListTagsForStreamCallable ( const Model::ListTagsForStreamRequest request) const
virtual

Returns a list of tags associated with the specified stream.

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::KinesisVideo::KinesisVideoClient::OverrideEndpoint ( const Aws::String endpoint)

◆ TagResource()

virtual Model::TagResourceOutcome Aws::KinesisVideo::KinesisVideoClient::TagResource ( const Model::TagResourceRequest request) const
virtual

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 in the AWS Billing and Cost Management User Guide.

See Also:

AWS API Reference

◆ TagResourceAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::TagResourceAsync ( const Model::TagResourceRequest request,
const TagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 in the AWS Billing and Cost Management User Guide.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::TagResourceCallable ( const Model::TagResourceRequest request) const
virtual

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 in the AWS Billing and Cost Management User Guide.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagStream()

virtual Model::TagStreamOutcome Aws::KinesisVideo::KinesisVideoClient::TagStream ( const Model::TagStreamRequest request) const
virtual

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

See Also:

AWS API Reference

◆ TagStreamAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::TagStreamAsync ( const Model::TagStreamRequest request,
const TagStreamResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagStreamCallable()

virtual Model::TagStreamOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::TagStreamCallable ( const Model::TagStreamRequest request) const
virtual

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::KinesisVideo::KinesisVideoClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ UntagResourceAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::UntagResourceAsync ( const Model::UntagResourceRequest request,
const UntagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::UntagResourceCallable ( const Model::UntagResourceRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagStream()

virtual Model::UntagStreamOutcome Aws::KinesisVideo::KinesisVideoClient::UntagStream ( const Model::UntagStreamRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ UntagStreamAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::UntagStreamAsync ( const Model::UntagStreamRequest request,
const UntagStreamResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagStreamCallable()

virtual Model::UntagStreamOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::UntagStreamCallable ( const Model::UntagStreamRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateDataRetention()

virtual Model::UpdateDataRetentionOutcome Aws::KinesisVideo::KinesisVideoClient::UpdateDataRetention ( const Model::UpdateDataRetentionRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ UpdateDataRetentionAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::UpdateDataRetentionAsync ( const Model::UpdateDataRetentionRequest request,
const UpdateDataRetentionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateDataRetentionCallable()

virtual Model::UpdateDataRetentionOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::UpdateDataRetentionCallable ( const Model::UpdateDataRetentionRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateSignalingChannel()

virtual Model::UpdateSignalingChannelOutcome Aws::KinesisVideo::KinesisVideoClient::UpdateSignalingChannel ( const Model::UpdateSignalingChannelRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ UpdateSignalingChannelAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::UpdateSignalingChannelAsync ( const Model::UpdateSignalingChannelRequest request,
const UpdateSignalingChannelResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateSignalingChannelCallable()

virtual Model::UpdateSignalingChannelOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::UpdateSignalingChannelCallable ( const Model::UpdateSignalingChannelRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateStream()

virtual Model::UpdateStreamOutcome Aws::KinesisVideo::KinesisVideoClient::UpdateStream ( const Model::UpdateStreamRequest request) const
virtual

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.

See Also:


AWS API Reference

◆ UpdateStreamAsync()

virtual void Aws::KinesisVideo::KinesisVideoClient::UpdateStreamAsync ( const Model::UpdateStreamRequest request,
const UpdateStreamResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateStreamCallable()

virtual Model::UpdateStreamOutcomeCallable Aws::KinesisVideo::KinesisVideoClient::UpdateStreamCallable ( const Model::UpdateStreamRequest request) const
virtual

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.

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


The documentation for this class was generated from the following file: