Aws::Keyspaces::KeyspacesClient Class Reference

#include <KeyspacesClient.h>

Inheritance diagram for Aws::Keyspaces::KeyspacesClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS

 

typedef KeyspacesClientConfiguration ClientConfigurationType

 

typedef KeyspacesEndpointProvider EndpointProviderType

 

Public Types inherited from Aws::Client::AWSJsonClient

typedef AWSClient BASECLASS

 

Public Member Functions

 KeyspacesClient (const Aws::Keyspaces::KeyspacesClientConfiguration &clientConfiguration=Aws::Keyspaces::KeyspacesClientConfiguration(), std::shared_ptr< KeyspacesEndpointProviderBase > endpointProvider=nullptr)

 

 KeyspacesClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< KeyspacesEndpointProviderBase > endpointProvider=nullptr, const Aws::Keyspaces::KeyspacesClientConfiguration &clientConfiguration=Aws::Keyspaces::KeyspacesClientConfiguration())

 

 KeyspacesClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< KeyspacesEndpointProviderBase > endpointProvider=nullptr, const Aws::Keyspaces::KeyspacesClientConfiguration &clientConfiguration=Aws::Keyspaces::KeyspacesClientConfiguration())

 

 KeyspacesClient (const Aws::Client::ClientConfiguration &clientConfiguration)

 

 KeyspacesClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration)

 

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

 

virtual ~KeyspacesClient ()

 

virtual Model::CreateKeyspaceOutcome CreateKeyspace (const Model::CreateKeyspaceRequest &request) const

 

template<typename CreateKeyspaceRequestT = Model::CreateKeyspaceRequest>

Model::CreateKeyspaceOutcomeCallable CreateKeyspaceCallable (const CreateKeyspaceRequestT &request) const

 

template<typename CreateKeyspaceRequestT = Model::CreateKeyspaceRequest>

void CreateKeyspaceAsync (const CreateKeyspaceRequestT &request, const CreateKeyspaceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateTableOutcome CreateTable (const Model::CreateTableRequest &request) const

 

template<typename CreateTableRequestT = Model::CreateTableRequest>

Model::CreateTableOutcomeCallable CreateTableCallable (const CreateTableRequestT &request) const

 

template<typename CreateTableRequestT = Model::CreateTableRequest>

void CreateTableAsync (const CreateTableRequestT &request, const CreateTableResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateTypeOutcome CreateType (const Model::CreateTypeRequest &request) const

 

template<typename CreateTypeRequestT = Model::CreateTypeRequest>

Model::CreateTypeOutcomeCallable CreateTypeCallable (const CreateTypeRequestT &request) const

 

template<typename CreateTypeRequestT = Model::CreateTypeRequest>

void CreateTypeAsync (const CreateTypeRequestT &request, const CreateTypeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteKeyspaceOutcome DeleteKeyspace (const Model::DeleteKeyspaceRequest &request) const

 

template<typename DeleteKeyspaceRequestT = Model::DeleteKeyspaceRequest>

Model::DeleteKeyspaceOutcomeCallable DeleteKeyspaceCallable (const DeleteKeyspaceRequestT &request) const

 

template<typename DeleteKeyspaceRequestT = Model::DeleteKeyspaceRequest>

void DeleteKeyspaceAsync (const DeleteKeyspaceRequestT &request, const DeleteKeyspaceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteTableOutcome DeleteTable (const Model::DeleteTableRequest &request) const

 

template<typename DeleteTableRequestT = Model::DeleteTableRequest>

Model::DeleteTableOutcomeCallable DeleteTableCallable (const DeleteTableRequestT &request) const

 

template<typename DeleteTableRequestT = Model::DeleteTableRequest>

void DeleteTableAsync (const DeleteTableRequestT &request, const DeleteTableResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteTypeOutcome DeleteType (const Model::DeleteTypeRequest &request) const

 

template<typename DeleteTypeRequestT = Model::DeleteTypeRequest>

Model::DeleteTypeOutcomeCallable DeleteTypeCallable (const DeleteTypeRequestT &request) const

 

template<typename DeleteTypeRequestT = Model::DeleteTypeRequest>

void DeleteTypeAsync (const DeleteTypeRequestT &request, const DeleteTypeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetKeyspaceOutcome GetKeyspace (const Model::GetKeyspaceRequest &request) const

 

template<typename GetKeyspaceRequestT = Model::GetKeyspaceRequest>

Model::GetKeyspaceOutcomeCallable GetKeyspaceCallable (const GetKeyspaceRequestT &request) const

 

template<typename GetKeyspaceRequestT = Model::GetKeyspaceRequest>

void GetKeyspaceAsync (const GetKeyspaceRequestT &request, const GetKeyspaceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetTableOutcome GetTable (const Model::GetTableRequest &request) const

 

template<typename GetTableRequestT = Model::GetTableRequest>

Model::GetTableOutcomeCallable GetTableCallable (const GetTableRequestT &request) const

 

template<typename GetTableRequestT = Model::GetTableRequest>

void GetTableAsync (const GetTableRequestT &request, const GetTableResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetTableAutoScalingSettingsOutcome GetTableAutoScalingSettings (const Model::GetTableAutoScalingSettingsRequest &request) const

 

template<typename GetTableAutoScalingSettingsRequestT = Model::GetTableAutoScalingSettingsRequest>

Model::GetTableAutoScalingSettingsOutcomeCallable GetTableAutoScalingSettingsCallable (const GetTableAutoScalingSettingsRequestT &request) const

 

template<typename GetTableAutoScalingSettingsRequestT = Model::GetTableAutoScalingSettingsRequest>

void GetTableAutoScalingSettingsAsync (const GetTableAutoScalingSettingsRequestT &request, const GetTableAutoScalingSettingsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetTypeOutcome GetType (const Model::GetTypeRequest &request) const

 

template<typename GetTypeRequestT = Model::GetTypeRequest>

Model::GetTypeOutcomeCallable GetTypeCallable (const GetTypeRequestT &request) const

 

template<typename GetTypeRequestT = Model::GetTypeRequest>

void GetTypeAsync (const GetTypeRequestT &request, const GetTypeResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListKeyspacesOutcome ListKeyspaces (const Model::ListKeyspacesRequest &request={}) const

 

template<typename ListKeyspacesRequestT = Model::ListKeyspacesRequest>

Model::ListKeyspacesOutcomeCallable ListKeyspacesCallable (const ListKeyspacesRequestT &request={}) const

 

template<typename ListKeyspacesRequestT = Model::ListKeyspacesRequest>

void ListKeyspacesAsync (const ListKeyspacesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListKeyspacesRequestT &request={}) const

 

virtual Model::ListTablesOutcome ListTables (const Model::ListTablesRequest &request) const

 

template<typename ListTablesRequestT = Model::ListTablesRequest>

Model::ListTablesOutcomeCallable ListTablesCallable (const ListTablesRequestT &request) const

 

template<typename ListTablesRequestT = Model::ListTablesRequest>

void ListTablesAsync (const ListTablesRequestT &request, const ListTablesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const ListTagsForResourceRequestT &request) const

 

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void ListTagsForResourceAsync (const ListTagsForResourceRequestT &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListTypesOutcome ListTypes (const Model::ListTypesRequest &request) const

 

template<typename ListTypesRequestT = Model::ListTypesRequest>

Model::ListTypesOutcomeCallable ListTypesCallable (const ListTypesRequestT &request) const

 

template<typename ListTypesRequestT = Model::ListTypesRequest>

void ListTypesAsync (const ListTypesRequestT &request, const ListTypesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::RestoreTableOutcome RestoreTable (const Model::RestoreTableRequest &request) const

 

template<typename RestoreTableRequestT = Model::RestoreTableRequest>

Model::RestoreTableOutcomeCallable RestoreTableCallable (const RestoreTableRequestT &request) const

 

template<typename RestoreTableRequestT = Model::RestoreTableRequest>

void RestoreTableAsync (const RestoreTableRequestT &request, const RestoreTableResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable TagResourceCallable (const TagResourceRequestT &request) const

 

template<typename TagResourceRequestT = Model::TagResourceRequest>

void TagResourceAsync (const TagResourceRequestT &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable UntagResourceCallable (const UntagResourceRequestT &request) const

 

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void UntagResourceAsync (const UntagResourceRequestT &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateKeyspaceOutcome UpdateKeyspace (const Model::UpdateKeyspaceRequest &request) const

 

template<typename UpdateKeyspaceRequestT = Model::UpdateKeyspaceRequest>

Model::UpdateKeyspaceOutcomeCallable UpdateKeyspaceCallable (const UpdateKeyspaceRequestT &request) const

 

template<typename UpdateKeyspaceRequestT = Model::UpdateKeyspaceRequest>

void UpdateKeyspaceAsync (const UpdateKeyspaceRequestT &request, const UpdateKeyspaceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::UpdateTableOutcome UpdateTable (const Model::UpdateTableRequest &request) const

 

template<typename UpdateTableRequestT = Model::UpdateTableRequest>

Model::UpdateTableOutcomeCallable UpdateTableCallable (const UpdateTableRequestT &request) const

 

template<typename UpdateTableRequestT = Model::UpdateTableRequest>

void UpdateTableAsync (const UpdateTableRequestT &request, const UpdateTableResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void OverrideEndpoint (const Aws::String &endpoint)

 

std::shared_ptr< KeyspacesEndpointProviderBase > & accessEndpointProvider ()

 

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 (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const 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, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::Endpoint::AWSEndpoint &endpoint, Aws::Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const Aws::Http::HeaderValueCollection &customizedHeaders={}, uint64_t expirationInSeconds=0, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={})

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const 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 std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const 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 std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0, const std::shared_ptr< Aws::Http::ServiceSpecificParameters > serviceSpecificParameter={}) const

 

const std::shared_ptr< Aws::Http::HttpClient > & GetHttpClient () const

 

void DisableRequestProcessing ()

 

void EnableRequestProcessing ()

 

virtual const char * GetServiceClientName () const

 

virtual void SetServiceClientName (const Aws::String &name)

 

void AppendToUserAgent (const Aws::String &valueToAppend)

 

Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< KeyspacesClient >

 ClientWithAsyncTemplateMethods ()

 

 ClientWithAsyncTemplateMethods (const ClientWithAsyncTemplateMethods &other)

 

ClientWithAsyncTemplateMethods & operator= (const ClientWithAsyncTemplateMethods &other)

 

virtual ~ClientWithAsyncTemplateMethods ()

 

void SubmitAsync (OperationFuncT operationFunc, const RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, RequestT &request, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void SubmitAsync (OperationFuncT operationFunc, const HandlerT &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

auto SubmitCallable (OperationFuncT operationFunc, const RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc, RequestT &request) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)(request))>

 

auto SubmitCallable (OperationFuncT operationFunc) const -> std::future< decltype((static_cast< const AwsServiceClientT * >(nullptr) -> *operationFunc)())>

 

Static Public Member Functions

static const char * GetServiceName ()

 

static const char * GetAllocationTag ()

 

Static Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< KeyspacesClient >

static void ShutdownSdkClient (void *pThis, int64_t timeoutMs=-1)

 

Friends

class Aws::Client::ClientWithAsyncTemplateMethods< KeyspacesClient >

 

Additional Inherited Members

Protected Member Functions inherited from Aws::Client::AWSJsonClient

virtual AWSError< CoreErrors > BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override

 

JsonOutcome MakeRequest (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, 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::Endpoint::AWSEndpoint &endpoint, 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, 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

 

StreamOutcome MakeRequestWithUnparsedResponse (const Aws::AmazonWebServiceRequest &request, const Aws::Endpoint::AWSEndpoint &endpoint, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, 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

 

virtual void AddContentLengthToRequest (const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest, const std::shared_ptr< Aws::IOStream > &body, bool isChunked) const

 

const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const

 

Aws::Client::AWSAuthSigner * GetSignerByName (const char *name) const

 

std::shared_ptr< Auth::AWSCredentialsProvider > GetCredentialsProvider () const

 

std::shared_ptr< Aws::Http::HttpRequest > BuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const

 

std::shared_ptr< Aws::Http::HttpResponse > MakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const

 

Static Protected Member Functions inherited from Aws::Client::AWSClient

static void AppendRecursionDetectionHeader (std::shared_ptr< Aws::Http::HttpRequest > ioRequest)

 

static CoreErrors GuessBodylessErrorType (Aws::Http::HttpResponseCode responseCode)

 

static bool DoesResponseGenerateError (const std::shared_ptr< Aws::Http::HttpResponse > &response)

 

Protected Attributes inherited from Aws::Client::AWSClient

Aws::String m_region

 

std::shared_ptr< smithy::components::tracing::TelemetryProvider > m_telemetryProvider

 

std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > m_signerProvider

 

Protected Attributes inherited from Aws::Client::ClientWithAsyncTemplateMethods< KeyspacesClient >

std::atomic< bool > m_isInitialized

 

std::atomic< size_t > m_operationsProcessed

 

std::condition_variable m_shutdownSignal

 

std::mutex m_shutdownMutex

 

Detailed Description

Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.

In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail.

For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer Guide.

For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.

Definition at line 43 of file KeyspacesClient.h.

Member Typedef Documentation

BASECLASS

typedef Aws::Client::AWSJsonClient Aws::Keyspaces::KeyspacesClient::BASECLASS

Definition at line 46 of file KeyspacesClient.h.

ClientConfigurationType

typedef KeyspacesClientConfiguration Aws::Keyspaces::KeyspacesClient::ClientConfigurationType

Definition at line 50 of file KeyspacesClient.h.

EndpointProviderType

typedef KeyspacesEndpointProvider Aws::Keyspaces::KeyspacesClient::EndpointProviderType

Definition at line 51 of file KeyspacesClient.h.

Constructor & Destructor Documentation

KeyspacesClient() [1/6]

Aws::Keyspaces::KeyspacesClient::KeyspacesClient ( const Aws::Keyspaces::KeyspacesClientConfiguration &  clientConfiguration = Aws::Keyspaces::KeyspacesClientConfiguration(),

std::shared_ptr< KeyspacesEndpointProviderBase >  endpointProvider = nullptr 

)

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.

KeyspacesClient() [2/6]

Aws::Keyspaces::KeyspacesClient::KeyspacesClient ( const Aws::Auth::AWSCredentials &  credentials,

std::shared_ptr< KeyspacesEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Keyspaces::KeyspacesClientConfiguration &  clientConfiguration = Aws::Keyspaces::KeyspacesClientConfiguration() 

)

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.

KeyspacesClient() [3/6]

Aws::Keyspaces::KeyspacesClient::KeyspacesClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

std::shared_ptr< KeyspacesEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Keyspaces::KeyspacesClientConfiguration &  clientConfiguration = Aws::Keyspaces::KeyspacesClientConfiguration() 

)

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

KeyspacesClient() [4/6]

Aws::Keyspaces::KeyspacesClient::KeyspacesClient ( const Aws::Client::ClientConfiguration &  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.

KeyspacesClient() [5/6]

Aws::Keyspaces::KeyspacesClient::KeyspacesClient ( const Aws::Auth::AWSCredentials &  credentials,

const Aws::Client::ClientConfiguration &  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.

KeyspacesClient() [6/6]

Aws::Keyspaces::KeyspacesClient::KeyspacesClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

const Aws::Client::ClientConfiguration &  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

~KeyspacesClient()

virtual Aws::Keyspaces::KeyspacesClient::~KeyspacesClient ( )

virtual

Member Function Documentation

accessEndpointProvider()

std::shared_ptr< KeyspacesEndpointProviderBase > & Aws::Keyspaces::KeyspacesClient::accessEndpointProvider ( )

CreateKeyspace()

virtual Model::CreateKeyspaceOutcome Aws::Keyspaces::KeyspacesClient::CreateKeyspace ( const Model::CreateKeyspaceRequest &  request) const

virtual

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.

CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation.

For more information, see Create a keyspace in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Reference

CreateKeyspaceAsync()

template<typename CreateKeyspaceRequestT = Model::CreateKeyspaceRequest>

void Aws::Keyspaces::KeyspacesClient::CreateKeyspaceAsync ( const CreateKeyspaceRequestT &  request,

const CreateKeyspaceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateKeyspace that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 128 of file KeyspacesClient.h.

CreateKeyspaceCallable()

template<typename CreateKeyspaceRequestT = Model::CreateKeyspaceRequest>

Model::CreateKeyspaceOutcomeCallable Aws::Keyspaces::KeyspacesClient::CreateKeyspaceCallable ( const CreateKeyspaceRequestT &  request) const

inline

A Callable wrapper for CreateKeyspace that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 119 of file KeyspacesClient.h.

CreateTable()

virtual Model::CreateTableOutcome Aws::Keyspaces::KeyspacesClient::CreateTable ( const Model::CreateTableRequest &  request) const

virtual

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.

CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. You can monitor the creation status of the new table by using the GetTable operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

For more information, see Create a table in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Reference

CreateTableAsync()

template<typename CreateTableRequestT = Model::CreateTableRequest>

void Aws::Keyspaces::KeyspacesClient::CreateTableAsync ( const CreateTableRequestT &  request,

const CreateTableResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateTable that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 163 of file KeyspacesClient.h.

CreateTableCallable()

template<typename CreateTableRequestT = Model::CreateTableRequest>

Model::CreateTableOutcomeCallable Aws::Keyspaces::KeyspacesClient::CreateTableCallable ( const CreateTableRequestT &  request) const

inline

A Callable wrapper for CreateTable that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 154 of file KeyspacesClient.h.

CreateType()

virtual Model::CreateTypeOutcome Aws::Keyspaces::KeyspacesClient::CreateType ( const Model::CreateTypeRequest &  request) const

virtual

The CreateType operation creates a new user-defined type in the specified keyspace.

To configure the required permissions, see Permissions to create a UDT in the Amazon Keyspaces Developer Guide.

For more information, see User-defined types (UDTs) in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Reference

CreateTypeAsync()

template<typename CreateTypeRequestT = Model::CreateTypeRequest>

void Aws::Keyspaces::KeyspacesClient::CreateTypeAsync ( const CreateTypeRequestT &  request,

const CreateTypeResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for CreateType that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 195 of file KeyspacesClient.h.

CreateTypeCallable()

template<typename CreateTypeRequestT = Model::CreateTypeRequest>

Model::CreateTypeOutcomeCallable Aws::Keyspaces::KeyspacesClient::CreateTypeCallable ( const CreateTypeRequestT &  request) const

inline

A Callable wrapper for CreateType that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 186 of file KeyspacesClient.h.

DeleteKeyspace()

virtual Model::DeleteKeyspaceOutcome Aws::Keyspaces::KeyspacesClient::DeleteKeyspace ( const Model::DeleteKeyspaceRequest &  request) const

virtual

The DeleteKeyspace operation deletes a keyspace and all of its tables.

See Also:

AWS API Reference

DeleteKeyspaceAsync()

template<typename DeleteKeyspaceRequestT = Model::DeleteKeyspaceRequest>

void Aws::Keyspaces::KeyspacesClient::DeleteKeyspaceAsync ( const DeleteKeyspaceRequestT &  request,

const DeleteKeyspaceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteKeyspace that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 221 of file KeyspacesClient.h.

DeleteKeyspaceCallable()

template<typename DeleteKeyspaceRequestT = Model::DeleteKeyspaceRequest>

Model::DeleteKeyspaceOutcomeCallable Aws::Keyspaces::KeyspacesClient::DeleteKeyspaceCallable ( const DeleteKeyspaceRequestT &  request) const

inline

A Callable wrapper for DeleteKeyspace that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 212 of file KeyspacesClient.h.

DeleteTable()

virtual Model::DeleteTableOutcome Aws::Keyspaces::KeyspacesClient::DeleteTable ( const Model::DeleteTableRequest &  request) const

virtual

The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned.

See Also:

AWS API Reference

DeleteTableAsync()

template<typename DeleteTableRequestT = Model::DeleteTableRequest>

void Aws::Keyspaces::KeyspacesClient::DeleteTableAsync ( const DeleteTableRequestT &  request,

const DeleteTableResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteTable that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 254 of file KeyspacesClient.h.

DeleteTableCallable()

template<typename DeleteTableRequestT = Model::DeleteTableRequest>

Model::DeleteTableOutcomeCallable Aws::Keyspaces::KeyspacesClient::DeleteTableCallable ( const DeleteTableRequestT &  request) const

inline

A Callable wrapper for DeleteTable that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 245 of file KeyspacesClient.h.

DeleteType()

virtual Model::DeleteTypeOutcome Aws::Keyspaces::KeyspacesClient::DeleteType ( const Model::DeleteTypeRequest &  request) const

virtual

The DeleteType operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table or another UDT.

To configure the required permissions, see Permissions to delete a UDT in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Reference

DeleteTypeAsync()

template<typename DeleteTypeRequestT = Model::DeleteTypeRequest>

void Aws::Keyspaces::KeyspacesClient::DeleteTypeAsync ( const DeleteTypeRequestT &  request,

const DeleteTypeResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for DeleteType that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 284 of file KeyspacesClient.h.

DeleteTypeCallable()

template<typename DeleteTypeRequestT = Model::DeleteTypeRequest>

Model::DeleteTypeOutcomeCallable Aws::Keyspaces::KeyspacesClient::DeleteTypeCallable ( const DeleteTypeRequestT &  request) const

inline

A Callable wrapper for DeleteType that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 275 of file KeyspacesClient.h.

GetAllocationTag()

static const char * Aws::Keyspaces::KeyspacesClient::GetAllocationTag ( )

static

GetKeyspace()

virtual Model::GetKeyspaceOutcome Aws::Keyspaces::KeyspacesClient::GetKeyspace ( const Model::GetKeyspaceRequest &  request) const

virtual

Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an UpdateKeyspace operation.

See Also:

AWS API Reference

GetKeyspaceAsync()

template<typename GetKeyspaceRequestT = Model::GetKeyspaceRequest>

void Aws::Keyspaces::KeyspacesClient::GetKeyspaceAsync ( const GetKeyspaceRequestT &  request,

const GetKeyspaceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetKeyspace that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 312 of file KeyspacesClient.h.

GetKeyspaceCallable()

template<typename GetKeyspaceRequestT = Model::GetKeyspaceRequest>

Model::GetKeyspaceOutcomeCallable Aws::Keyspaces::KeyspacesClient::GetKeyspaceCallable ( const GetKeyspaceRequestT &  request) const

inline

A Callable wrapper for GetKeyspace that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 303 of file KeyspacesClient.h.

GetServiceName()

static const char * Aws::Keyspaces::KeyspacesClient::GetServiceName ( )

static

GetTable()

virtual Model::GetTableOutcome Aws::Keyspaces::KeyspacesClient::GetTable ( const Model::GetTableRequest &  request) const

virtual

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

To read table metadata using GetTable, the IAM principal needs Select action permissions for the table and the system keyspace.

See Also:

AWS API Reference

GetTableAsync()

template<typename GetTableRequestT = Model::GetTableRequest>

void Aws::Keyspaces::KeyspacesClient::GetTableAsync ( const GetTableRequestT &  request,

const GetTableResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetTable that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 341 of file KeyspacesClient.h.

GetTableAutoScalingSettings()

virtual Model::GetTableAutoScalingSettingsOutcome Aws::Keyspaces::KeyspacesClient::GetTableAutoScalingSettings ( const Model::GetTableAutoScalingSettingsRequest &  request) const

virtual

Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.

Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

GetTableAutoScalingSettings can't be used as an action in an IAM policy.

To define permissions for GetTableAutoScalingSettings, you must allow the following two actions in the IAM policy statement's Action element:

• application-autoscaling:DescribeScalableTargets

• application-autoscaling:DescribeScalingPolicies

See Also:

AWS API Reference

GetTableAutoScalingSettingsAsync()

template<typename GetTableAutoScalingSettingsRequestT = Model::GetTableAutoScalingSettingsRequest>

void Aws::Keyspaces::KeyspacesClient::GetTableAutoScalingSettingsAsync ( const GetTableAutoScalingSettingsRequestT &  request,

const GetTableAutoScalingSettingsResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetTableAutoScalingSettings that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 381 of file KeyspacesClient.h.

GetTableAutoScalingSettingsCallable()

template<typename GetTableAutoScalingSettingsRequestT = Model::GetTableAutoScalingSettingsRequest>

Model::GetTableAutoScalingSettingsOutcomeCallable Aws::Keyspaces::KeyspacesClient::GetTableAutoScalingSettingsCallable ( const GetTableAutoScalingSettingsRequestT &  request) const

inline

A Callable wrapper for GetTableAutoScalingSettings that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 372 of file KeyspacesClient.h.

GetTableCallable()

template<typename GetTableRequestT = Model::GetTableRequest>

Model::GetTableOutcomeCallable Aws::Keyspaces::KeyspacesClient::GetTableCallable ( const GetTableRequestT &  request) const

inline

A Callable wrapper for GetTable that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 332 of file KeyspacesClient.h.

GetType()

virtual Model::GetTypeOutcome Aws::Keyspaces::KeyspacesClient::GetType ( const Model::GetTypeRequest &  request) const

virtual

The GetType operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables.

To read keyspace metadata using GetType, the IAM principal needs Select action permissions for the system keyspace. To configure the required permissions, see Permissions to view a UDT in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Reference

GetTypeAsync()

template<typename GetTypeRequestT = Model::GetTypeRequest>

void Aws::Keyspaces::KeyspacesClient::GetTypeAsync ( const GetTypeRequestT &  request,

const GetTypeResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for GetType that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 414 of file KeyspacesClient.h.

GetTypeCallable()

template<typename GetTypeRequestT = Model::GetTypeRequest>

Model::GetTypeOutcomeCallable Aws::Keyspaces::KeyspacesClient::GetTypeCallable ( const GetTypeRequestT &  request) const

inline

A Callable wrapper for GetType that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 405 of file KeyspacesClient.h.

ListKeyspaces()

virtual Model::ListKeyspacesOutcome Aws::Keyspaces::KeyspacesClient::ListKeyspaces ( const Model::ListKeyspacesRequest &  request = {}) const

virtual

The ListKeyspaces operation returns a list of keyspaces.

See Also:

AWS API Reference

ListKeyspacesAsync()

template<typename ListKeyspacesRequestT = Model::ListKeyspacesRequest>

void Aws::Keyspaces::KeyspacesClient::ListKeyspacesAsync ( const ListKeyspacesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr,

const ListKeyspacesRequestT &  request = {} 

) const

inline

An Async wrapper for ListKeyspaces that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 440 of file KeyspacesClient.h.

ListKeyspacesCallable()

template<typename ListKeyspacesRequestT = Model::ListKeyspacesRequest>

Model::ListKeyspacesOutcomeCallable Aws::Keyspaces::KeyspacesClient::ListKeyspacesCallable ( const ListKeyspacesRequestT &  request = {}) const

inline

A Callable wrapper for ListKeyspaces that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 431 of file KeyspacesClient.h.

ListTables()

virtual Model::ListTablesOutcome Aws::Keyspaces::KeyspacesClient::ListTables ( const Model::ListTablesRequest &  request) const

virtual

The ListTables operation returns a list of tables for a specified keyspace.

To read keyspace metadata using ListTables, the IAM principal needs Select action permissions for the system keyspace.

See Also:

AWS API Reference

ListTablesAsync()

template<typename ListTablesRequestT = Model::ListTablesRequest>

void Aws::Keyspaces::KeyspacesClient::ListTablesAsync ( const ListTablesRequestT &  request,

const ListTablesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListTables that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 468 of file KeyspacesClient.h.

ListTablesCallable()

template<typename ListTablesRequestT = Model::ListTablesRequest>

Model::ListTablesOutcomeCallable Aws::Keyspaces::KeyspacesClient::ListTablesCallable ( const ListTablesRequestT &  request) const

inline

A Callable wrapper for ListTables that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 459 of file KeyspacesClient.h.

ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::Keyspaces::KeyspacesClient::ListTagsForResource ( const Model::ListTagsForResourceRequest &  request) const

virtual

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

To read keyspace metadata using ListTagsForResource, the IAM principal needs Select action permissions for the specified resource and the system keyspace.

See Also:

AWS API Reference

ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void Aws::Keyspaces::KeyspacesClient::ListTagsForResourceAsync ( const ListTagsForResourceRequestT &  request,

const ListTagsForResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 497 of file KeyspacesClient.h.

ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable Aws::Keyspaces::KeyspacesClient::ListTagsForResourceCallable ( const ListTagsForResourceRequestT &  request) const

inline

A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 488 of file KeyspacesClient.h.

ListTypes()

virtual Model::ListTypesOutcome Aws::Keyspaces::KeyspacesClient::ListTypes ( const Model::ListTypesRequest &  request) const

virtual

The ListTypes operation returns a list of types for a specified keyspace.

To read keyspace metadata using ListTypes, the IAM principal needs Select action permissions for the system keyspace. To configure the required permissions, see Permissions to view a UDT in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Reference

ListTypesAsync()

template<typename ListTypesRequestT = Model::ListTypesRequest>

void Aws::Keyspaces::KeyspacesClient::ListTypesAsync ( const ListTypesRequestT &  request,

const ListTypesResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for ListTypes that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 528 of file KeyspacesClient.h.

ListTypesCallable()

template<typename ListTypesRequestT = Model::ListTypesRequest>

Model::ListTypesOutcomeCallable Aws::Keyspaces::KeyspacesClient::ListTypesCallable ( const ListTypesRequestT &  request) const

inline

A Callable wrapper for ListTypes that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 519 of file KeyspacesClient.h.

OverrideEndpoint()

void Aws::Keyspaces::KeyspacesClient::OverrideEndpoint ( const Aws::String &  endpoint)

RestoreTable()

virtual Model::RestoreTableOutcome Aws::Keyspaces::KeyspacesClient::RestoreTable ( const Model::RestoreTableRequest &  request) const

virtual

Restores the table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.

Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.

In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.

You can also overwrite these settings during restore:

• Read/write capacity mode

• Provisioned throughput capacity units

• Auto scaling settings

• Point-in-time (PITR) settings

• Tags

For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.

Note that the following settings are not restored, and you must configure them manually for the new table:

• Identity and Access Management (IAM) policies

• Amazon CloudWatch metrics and alarms

See Also:

AWS API Reference

RestoreTableAsync()

template<typename RestoreTableRequestT = Model::RestoreTableRequest>

void Aws::Keyspaces::KeyspacesClient::RestoreTableAsync ( const RestoreTableRequestT &  request,

const RestoreTableResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for RestoreTable that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 579 of file KeyspacesClient.h.

RestoreTableCallable()

template<typename RestoreTableRequestT = Model::RestoreTableRequest>

Model::RestoreTableOutcomeCallable Aws::Keyspaces::KeyspacesClient::RestoreTableCallable ( const RestoreTableRequestT &  request) const

inline

A Callable wrapper for RestoreTable that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 570 of file KeyspacesClient.h.

TagResource()

virtual Model::TagResourceOutcome Aws::Keyspaces::KeyspacesClient::TagResource ( const Model::TagResourceRequest &  request) const

virtual

Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Reference

TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>

void Aws::Keyspaces::KeyspacesClient::TagResourceAsync ( const TagResourceRequestT &  request,

const TagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 613 of file KeyspacesClient.h.

TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable Aws::Keyspaces::KeyspacesClient::TagResourceCallable ( const TagResourceRequestT &  request) const

inline

A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 604 of file KeyspacesClient.h.

UntagResource()

virtual Model::UntagResourceOutcome Aws::Keyspaces::KeyspacesClient::UntagResource ( const Model::UntagResourceRequest &  request) const

virtual

Removes the association of tags from a Amazon Keyspaces resource.

See Also:

AWS API Reference

UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void Aws::Keyspaces::KeyspacesClient::UntagResourceAsync ( const UntagResourceRequestT &  request,

const UntagResourceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 639 of file KeyspacesClient.h.

UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable Aws::Keyspaces::KeyspacesClient::UntagResourceCallable ( const UntagResourceRequestT &  request) const

inline

A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 630 of file KeyspacesClient.h.

UpdateKeyspace()

virtual Model::UpdateKeyspaceOutcome Aws::Keyspaces::KeyspacesClient::UpdateKeyspace ( const Model::UpdateKeyspaceRequest &  request) const

virtual

Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled when invoking the API. For more information about client-side timestamps, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

To add a Region to a keyspace using the UpdateKeyspace API, the IAM principal needs permissions for the following IAM actions:

• cassandra:Alter

• cassandra:AlterMultiRegionResource

• cassandra:Create

• cassandra:CreateMultiRegionResource

• cassandra:Select

• cassandra:SelectMultiRegionResource

• cassandra:Modify

• cassandra:ModifyMultiRegionResource

If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, the following additional IAM actions need to be allowed.

• application-autoscaling:RegisterScalableTarget

• application-autoscaling:DeregisterScalableTarget

• application-autoscaling:DescribeScalableTargets

• application-autoscaling:PutScalingPolicy

• application-autoscaling:DescribeScalingPolicies

To use the UpdateKeyspace API, the IAM principal also needs permissions to create a service-linked role with the following elements:

• iam:CreateServiceLinkedRole - The action the principal can perform.

• arn:aws:iam::*:role/aws-service-role/replication.cassandra.amazonaws.com/AWSServiceRoleForKeyspacesReplication

  • The resource that the action can be performed on.

• iam:AWSServiceName: replication.cassandra.amazonaws.com - The only Amazon Web Services service that this role can be attached to is Amazon Keyspaces.

For more information, see Configure the IAM permissions required to add an Amazon Web Services Region to a keyspace in the Amazon Keyspaces Developer Guide.

See Also:

AWS API Reference

UpdateKeyspaceAsync()

template<typename UpdateKeyspaceRequestT = Model::UpdateKeyspaceRequest>

void Aws::Keyspaces::KeyspacesClient::UpdateKeyspaceAsync ( const UpdateKeyspaceRequestT &  request,

const UpdateKeyspaceResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateKeyspace that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 702 of file KeyspacesClient.h.

UpdateKeyspaceCallable()

template<typename UpdateKeyspaceRequestT = Model::UpdateKeyspaceRequest>

Model::UpdateKeyspaceOutcomeCallable Aws::Keyspaces::KeyspacesClient::UpdateKeyspaceCallable ( const UpdateKeyspaceRequestT &  request) const

inline

A Callable wrapper for UpdateKeyspace that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 693 of file KeyspacesClient.h.

UpdateTable()

virtual Model::UpdateTableOutcome Aws::Keyspaces::KeyspacesClient::UpdateTable ( const Model::UpdateTableRequest &  request) const

virtual

Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.

See Also:

AWS API Reference

UpdateTableAsync()

template<typename UpdateTableRequestT = Model::UpdateTableRequest>

void Aws::Keyspaces::KeyspacesClient::UpdateTableAsync ( const UpdateTableRequestT &  request,

const UpdateTableResponseReceivedHandler &  handler,

const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 

) const

inline

An Async wrapper for UpdateTable that queues the request into a thread executor and triggers associated callback when operation has finished.

Definition at line 730 of file KeyspacesClient.h.

UpdateTableCallable()

template<typename UpdateTableRequestT = Model::UpdateTableRequest>

Model::UpdateTableOutcomeCallable Aws::Keyspaces::KeyspacesClient::UpdateTableCallable ( const UpdateTableRequestT &  request) const

inline

A Callable wrapper for UpdateTable that returns a future to the operation so that it can be executed in parallel to other requests.

Definition at line 721 of file KeyspacesClient.h.

Friends And Related Symbol Documentation

Aws::Client::ClientWithAsyncTemplateMethods< KeyspacesClient >

friend class Aws::Client::ClientWithAsyncTemplateMethods< KeyspacesClient >

friend

Definition at line 737 of file KeyspacesClient.h.

---

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

• generated/src/aws-cpp-sdk-keyspaces/include/aws/keyspaces/KeyspacesClient.h