Aws::Braket::BraketClient Class Reference

#include <BraketClient.h>

Inheritance diagram for Aws::Braket::BraketClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS

 

typedef BraketClientConfiguration ClientConfigurationType

 

typedef BraketEndpointProvider EndpointProviderType

 

Public Types inherited from Aws::Client::AWSJsonClient

typedef AWSClient BASECLASS

 

Public Member Functions

 BraketClient (const Aws::Braket::BraketClientConfiguration &clientConfiguration=Aws::Braket::BraketClientConfiguration(), std::shared_ptr< BraketEndpointProviderBase > endpointProvider=nullptr)

 

 BraketClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< BraketEndpointProviderBase > endpointProvider=nullptr, const Aws::Braket::BraketClientConfiguration &clientConfiguration=Aws::Braket::BraketClientConfiguration())

 

 BraketClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< BraketEndpointProviderBase > endpointProvider=nullptr, const Aws::Braket::BraketClientConfiguration &clientConfiguration=Aws::Braket::BraketClientConfiguration())

 

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

 

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

 

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

 

virtual ~BraketClient ()

 

virtual Model::CancelJobOutcome CancelJob (const Model::CancelJobRequest &request) const

 

template<typename CancelJobRequestT = Model::CancelJobRequest>

Model::CancelJobOutcomeCallable CancelJobCallable (const CancelJobRequestT &request) const

 

template<typename CancelJobRequestT = Model::CancelJobRequest>

void CancelJobAsync (const CancelJobRequestT &request, const CancelJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CancelQuantumTaskOutcome CancelQuantumTask (const Model::CancelQuantumTaskRequest &request) const

 

template<typename CancelQuantumTaskRequestT = Model::CancelQuantumTaskRequest>

Model::CancelQuantumTaskOutcomeCallable CancelQuantumTaskCallable (const CancelQuantumTaskRequestT &request) const

 

template<typename CancelQuantumTaskRequestT = Model::CancelQuantumTaskRequest>

void CancelQuantumTaskAsync (const CancelQuantumTaskRequestT &request, const CancelQuantumTaskResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateJobOutcome CreateJob (const Model::CreateJobRequest &request) const

 

template<typename CreateJobRequestT = Model::CreateJobRequest>

Model::CreateJobOutcomeCallable CreateJobCallable (const CreateJobRequestT &request) const

 

template<typename CreateJobRequestT = Model::CreateJobRequest>

void CreateJobAsync (const CreateJobRequestT &request, const CreateJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateQuantumTaskOutcome CreateQuantumTask (const Model::CreateQuantumTaskRequest &request) const

 

template<typename CreateQuantumTaskRequestT = Model::CreateQuantumTaskRequest>

Model::CreateQuantumTaskOutcomeCallable CreateQuantumTaskCallable (const CreateQuantumTaskRequestT &request) const

 

template<typename CreateQuantumTaskRequestT = Model::CreateQuantumTaskRequest>

void CreateQuantumTaskAsync (const CreateQuantumTaskRequestT &request, const CreateQuantumTaskResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetDeviceOutcome GetDevice (const Model::GetDeviceRequest &request) const

 

template<typename GetDeviceRequestT = Model::GetDeviceRequest>

Model::GetDeviceOutcomeCallable GetDeviceCallable (const GetDeviceRequestT &request) const

 

template<typename GetDeviceRequestT = Model::GetDeviceRequest>

void GetDeviceAsync (const GetDeviceRequestT &request, const GetDeviceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetJobOutcome GetJob (const Model::GetJobRequest &request) const

 

template<typename GetJobRequestT = Model::GetJobRequest>

Model::GetJobOutcomeCallable GetJobCallable (const GetJobRequestT &request) const

 

template<typename GetJobRequestT = Model::GetJobRequest>

void GetJobAsync (const GetJobRequestT &request, const GetJobResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetQuantumTaskOutcome GetQuantumTask (const Model::GetQuantumTaskRequest &request) const

 

template<typename GetQuantumTaskRequestT = Model::GetQuantumTaskRequest>

Model::GetQuantumTaskOutcomeCallable GetQuantumTaskCallable (const GetQuantumTaskRequestT &request) const

 

template<typename GetQuantumTaskRequestT = Model::GetQuantumTaskRequest>

void GetQuantumTaskAsync (const GetQuantumTaskRequestT &request, const GetQuantumTaskResponseReceivedHandler &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::SearchDevicesOutcome SearchDevices (const Model::SearchDevicesRequest &request) const

 

template<typename SearchDevicesRequestT = Model::SearchDevicesRequest>

Model::SearchDevicesOutcomeCallable SearchDevicesCallable (const SearchDevicesRequestT &request) const

 

template<typename SearchDevicesRequestT = Model::SearchDevicesRequest>

void SearchDevicesAsync (const SearchDevicesRequestT &request, const SearchDevicesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::SearchJobsOutcome SearchJobs (const Model::SearchJobsRequest &request) const

 

template<typename SearchJobsRequestT = Model::SearchJobsRequest>

Model::SearchJobsOutcomeCallable SearchJobsCallable (const SearchJobsRequestT &request) const

 

template<typename SearchJobsRequestT = Model::SearchJobsRequest>

void SearchJobsAsync (const SearchJobsRequestT &request, const SearchJobsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::SearchQuantumTasksOutcome SearchQuantumTasks (const Model::SearchQuantumTasksRequest &request) const

 

template<typename SearchQuantumTasksRequestT = Model::SearchQuantumTasksRequest>

Model::SearchQuantumTasksOutcomeCallable SearchQuantumTasksCallable (const SearchQuantumTasksRequestT &request) const

 

template<typename SearchQuantumTasksRequestT = Model::SearchQuantumTasksRequest>

void SearchQuantumTasksAsync (const SearchQuantumTasksRequestT &request, const SearchQuantumTasksResponseReceivedHandler &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

 

void OverrideEndpoint (const Aws::String &endpoint)

 

std::shared_ptr< BraketEndpointProviderBase > & 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< BraketClient >

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

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

 

Friends

class Aws::Client::ClientWithAsyncTemplateMethods< BraketClient >

 

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

 

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

std::atomic< bool > m_isInitialized

 

std::atomic< size_t > m_operationsProcessed

 

std::condition_variable m_shutdownSignal

 

std::mutex m_shutdownMutex

 

Detailed Description

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Additional Resources:

• Amazon Braket Developer Guide

Definition at line 25 of file BraketClient.h.

Member Typedef Documentation

BASECLASS

typedef Aws::Client::AWSJsonClient Aws::Braket::BraketClient::BASECLASS

Definition at line 28 of file BraketClient.h.

ClientConfigurationType

typedef BraketClientConfiguration Aws::Braket::BraketClient::ClientConfigurationType

Definition at line 32 of file BraketClient.h.

EndpointProviderType

typedef BraketEndpointProvider Aws::Braket::BraketClient::EndpointProviderType

Definition at line 33 of file BraketClient.h.

Constructor & Destructor Documentation

BraketClient() [1/6]

Aws::Braket::BraketClient::BraketClient ( const Aws::Braket::BraketClientConfiguration &  clientConfiguration = Aws::Braket::BraketClientConfiguration(),

std::shared_ptr< BraketEndpointProviderBase >  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.

BraketClient() [2/6]

Aws::Braket::BraketClient::BraketClient ( const Aws::Auth::AWSCredentials &  credentials,

std::shared_ptr< BraketEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Braket::BraketClientConfiguration &  clientConfiguration = Aws::Braket::BraketClientConfiguration() 

)

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.

BraketClient() [3/6]

Aws::Braket::BraketClient::BraketClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

std::shared_ptr< BraketEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Braket::BraketClientConfiguration &  clientConfiguration = Aws::Braket::BraketClientConfiguration() 

)

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

BraketClient() [4/6]

Aws::Braket::BraketClient::BraketClient ( 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.

BraketClient() [5/6]

Aws::Braket::BraketClient::BraketClient ( 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.

BraketClient() [6/6]

Aws::Braket::BraketClient::BraketClient ( 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

~BraketClient()

virtual Aws::Braket::BraketClient::~BraketClient ( )

virtual

Member Function Documentation

accessEndpointProvider()

std::shared_ptr< BraketEndpointProviderBase > & Aws::Braket::BraketClient::accessEndpointProvider ( )

CancelJob()

virtual Model::CancelJobOutcome Aws::Braket::BraketClient::CancelJob ( const Model::CancelJobRequest &  request) const

virtual

Cancels an Amazon Braket job.

See Also:

AWS API Reference

CancelJobAsync()

template<typename CancelJobRequestT = Model::CancelJobRequest>

void Aws::Braket::BraketClient::CancelJobAsync ( const CancelJobRequestT &  request,

const CancelJobResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 103 of file BraketClient.h.

CancelJobCallable()

template<typename CancelJobRequestT = Model::CancelJobRequest>

Model::CancelJobOutcomeCallable Aws::Braket::BraketClient::CancelJobCallable ( const CancelJobRequestT &  request) const

inline

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

Definition at line 94 of file BraketClient.h.

CancelQuantumTask()

virtual Model::CancelQuantumTaskOutcome Aws::Braket::BraketClient::CancelQuantumTask ( const Model::CancelQuantumTaskRequest &  request) const

virtual

Cancels the specified task.

See Also:

AWS API Reference

CancelQuantumTaskAsync()

template<typename CancelQuantumTaskRequestT = Model::CancelQuantumTaskRequest>

void Aws::Braket::BraketClient::CancelQuantumTaskAsync ( const CancelQuantumTaskRequestT &  request,

const CancelQuantumTaskResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 128 of file BraketClient.h.

CancelQuantumTaskCallable()

template<typename CancelQuantumTaskRequestT = Model::CancelQuantumTaskRequest>

Model::CancelQuantumTaskOutcomeCallable Aws::Braket::BraketClient::CancelQuantumTaskCallable ( const CancelQuantumTaskRequestT &  request) const

inline

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

Definition at line 119 of file BraketClient.h.

CreateJob()

virtual Model::CreateJobOutcome Aws::Braket::BraketClient::CreateJob ( const Model::CreateJobRequest &  request) const

virtual

Creates an Amazon Braket job.

See Also:

AWS API Reference

CreateJobAsync()

template<typename CreateJobRequestT = Model::CreateJobRequest>

void Aws::Braket::BraketClient::CreateJobAsync ( const CreateJobRequestT &  request,

const CreateJobResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 153 of file BraketClient.h.

CreateJobCallable()

template<typename CreateJobRequestT = Model::CreateJobRequest>

Model::CreateJobOutcomeCallable Aws::Braket::BraketClient::CreateJobCallable ( const CreateJobRequestT &  request) const

inline

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

Definition at line 144 of file BraketClient.h.

CreateQuantumTask()

virtual Model::CreateQuantumTaskOutcome Aws::Braket::BraketClient::CreateQuantumTask ( const Model::CreateQuantumTaskRequest &  request) const

virtual

Creates a quantum task.

See Also:

AWS API Reference

CreateQuantumTaskAsync()

template<typename CreateQuantumTaskRequestT = Model::CreateQuantumTaskRequest>

void Aws::Braket::BraketClient::CreateQuantumTaskAsync ( const CreateQuantumTaskRequestT &  request,

const CreateQuantumTaskResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 178 of file BraketClient.h.

CreateQuantumTaskCallable()

template<typename CreateQuantumTaskRequestT = Model::CreateQuantumTaskRequest>

Model::CreateQuantumTaskOutcomeCallable Aws::Braket::BraketClient::CreateQuantumTaskCallable ( const CreateQuantumTaskRequestT &  request) const

inline

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

Definition at line 169 of file BraketClient.h.

GetAllocationTag()

static const char * Aws::Braket::BraketClient::GetAllocationTag ( )

static

GetDevice()

virtual Model::GetDeviceOutcome Aws::Braket::BraketClient::GetDevice ( const Model::GetDeviceRequest &  request) const

virtual

Retrieves the devices available in Amazon Braket.

For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

See Also:

AWS API Reference

GetDeviceAsync()

template<typename GetDeviceRequestT = Model::GetDeviceRequest>

void Aws::Braket::BraketClient::GetDeviceAsync ( const GetDeviceRequestT &  request,

const GetDeviceResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 211 of file BraketClient.h.

GetDeviceCallable()

template<typename GetDeviceRequestT = Model::GetDeviceRequest>

Model::GetDeviceOutcomeCallable Aws::Braket::BraketClient::GetDeviceCallable ( const GetDeviceRequestT &  request) const

inline

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

Definition at line 202 of file BraketClient.h.

GetJob()

virtual Model::GetJobOutcome Aws::Braket::BraketClient::GetJob ( const Model::GetJobRequest &  request) const

virtual

Retrieves the specified Amazon Braket job.

See Also:

AWS API Reference

GetJobAsync()

template<typename GetJobRequestT = Model::GetJobRequest>

void Aws::Braket::BraketClient::GetJobAsync ( const GetJobRequestT &  request,

const GetJobResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 236 of file BraketClient.h.

GetJobCallable()

template<typename GetJobRequestT = Model::GetJobRequest>

Model::GetJobOutcomeCallable Aws::Braket::BraketClient::GetJobCallable ( const GetJobRequestT &  request) const

inline

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

Definition at line 227 of file BraketClient.h.

GetQuantumTask()

virtual Model::GetQuantumTaskOutcome Aws::Braket::BraketClient::GetQuantumTask ( const Model::GetQuantumTaskRequest &  request) const

virtual

Retrieves the specified quantum task.

See Also:

AWS API Reference

GetQuantumTaskAsync()

template<typename GetQuantumTaskRequestT = Model::GetQuantumTaskRequest>

void Aws::Braket::BraketClient::GetQuantumTaskAsync ( const GetQuantumTaskRequestT &  request,

const GetQuantumTaskResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 261 of file BraketClient.h.

GetQuantumTaskCallable()

template<typename GetQuantumTaskRequestT = Model::GetQuantumTaskRequest>

Model::GetQuantumTaskOutcomeCallable Aws::Braket::BraketClient::GetQuantumTaskCallable ( const GetQuantumTaskRequestT &  request) const

inline

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

Definition at line 252 of file BraketClient.h.

GetServiceName()

static const char * Aws::Braket::BraketClient::GetServiceName ( )

static

ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::Braket::BraketClient::ListTagsForResource ( const Model::ListTagsForResourceRequest &  request) const

virtual

Shows the tags associated with this resource.

See Also:

AWS API Reference

ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void Aws::Braket::BraketClient::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 286 of file BraketClient.h.

ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable Aws::Braket::BraketClient::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 277 of file BraketClient.h.

OverrideEndpoint()

void Aws::Braket::BraketClient::OverrideEndpoint ( const Aws::String &  endpoint)

SearchDevices()

virtual Model::SearchDevicesOutcome Aws::Braket::BraketClient::SearchDevices ( const Model::SearchDevicesRequest &  request) const

virtual

Searches for devices using the specified filters.

See Also:

AWS API Reference

SearchDevicesAsync()

template<typename SearchDevicesRequestT = Model::SearchDevicesRequest>

void Aws::Braket::BraketClient::SearchDevicesAsync ( const SearchDevicesRequestT &  request,

const SearchDevicesResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 312 of file BraketClient.h.

SearchDevicesCallable()

template<typename SearchDevicesRequestT = Model::SearchDevicesRequest>

Model::SearchDevicesOutcomeCallable Aws::Braket::BraketClient::SearchDevicesCallable ( const SearchDevicesRequestT &  request) const

inline

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

Definition at line 303 of file BraketClient.h.

SearchJobs()

virtual Model::SearchJobsOutcome Aws::Braket::BraketClient::SearchJobs ( const Model::SearchJobsRequest &  request) const

virtual

Searches for Amazon Braket jobs that match the specified filter values.

See Also:

AWS API Reference

SearchJobsAsync()

template<typename SearchJobsRequestT = Model::SearchJobsRequest>

void Aws::Braket::BraketClient::SearchJobsAsync ( const SearchJobsRequestT &  request,

const SearchJobsResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 338 of file BraketClient.h.

SearchJobsCallable()

template<typename SearchJobsRequestT = Model::SearchJobsRequest>

Model::SearchJobsOutcomeCallable Aws::Braket::BraketClient::SearchJobsCallable ( const SearchJobsRequestT &  request) const

inline

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

Definition at line 329 of file BraketClient.h.

SearchQuantumTasks()

virtual Model::SearchQuantumTasksOutcome Aws::Braket::BraketClient::SearchQuantumTasks ( const Model::SearchQuantumTasksRequest &  request) const

virtual

Searches for tasks that match the specified filter values.

See Also:

AWS API Reference

SearchQuantumTasksAsync()

template<typename SearchQuantumTasksRequestT = Model::SearchQuantumTasksRequest>

void Aws::Braket::BraketClient::SearchQuantumTasksAsync ( const SearchQuantumTasksRequestT &  request,

const SearchQuantumTasksResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 364 of file BraketClient.h.

SearchQuantumTasksCallable()

template<typename SearchQuantumTasksRequestT = Model::SearchQuantumTasksRequest>

Model::SearchQuantumTasksOutcomeCallable Aws::Braket::BraketClient::SearchQuantumTasksCallable ( const SearchQuantumTasksRequestT &  request) const

inline

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

Definition at line 355 of file BraketClient.h.

TagResource()

virtual Model::TagResourceOutcome Aws::Braket::BraketClient::TagResource ( const Model::TagResourceRequest &  request) const

virtual

Add a tag to the specified resource.

See Also:

AWS API Reference

TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>

void Aws::Braket::BraketClient::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 389 of file BraketClient.h.

TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable Aws::Braket::BraketClient::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 380 of file BraketClient.h.

UntagResource()

virtual Model::UntagResourceOutcome Aws::Braket::BraketClient::UntagResource ( const Model::UntagResourceRequest &  request) const

virtual

Remove tags from a resource.

See Also:

AWS API Reference

UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void Aws::Braket::BraketClient::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 414 of file BraketClient.h.

UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable Aws::Braket::BraketClient::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 405 of file BraketClient.h.

Friends And Related Symbol Documentation

Aws::Client::ClientWithAsyncTemplateMethods< BraketClient >

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

friend

Definition at line 421 of file BraketClient.h.

---

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

• generated/src/aws-cpp-sdk-braket/include/aws/braket/BraketClient.h