Aws::Scheduler::SchedulerClient Class Reference

#include <SchedulerClient.h>

Inheritance diagram for Aws::Scheduler::SchedulerClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS

 

typedef SchedulerClientConfiguration ClientConfigurationType

 

typedef SchedulerEndpointProvider EndpointProviderType

 

Public Types inherited from Aws::Client::AWSJsonClient

typedef AWSClient BASECLASS

 

Public Member Functions

 SchedulerClient (const Aws::Scheduler::SchedulerClientConfiguration &clientConfiguration=Aws::Scheduler::SchedulerClientConfiguration(), std::shared_ptr< SchedulerEndpointProviderBase > endpointProvider=nullptr)

 

 SchedulerClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< SchedulerEndpointProviderBase > endpointProvider=nullptr, const Aws::Scheduler::SchedulerClientConfiguration &clientConfiguration=Aws::Scheduler::SchedulerClientConfiguration())

 

 SchedulerClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< SchedulerEndpointProviderBase > endpointProvider=nullptr, const Aws::Scheduler::SchedulerClientConfiguration &clientConfiguration=Aws::Scheduler::SchedulerClientConfiguration())

 

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

 

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

 

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

 

virtual ~SchedulerClient ()

 

virtual Model::CreateScheduleOutcome CreateSchedule (const Model::CreateScheduleRequest &request) const

 

template<typename CreateScheduleRequestT = Model::CreateScheduleRequest>

Model::CreateScheduleOutcomeCallable CreateScheduleCallable (const CreateScheduleRequestT &request) const

 

template<typename CreateScheduleRequestT = Model::CreateScheduleRequest>

void CreateScheduleAsync (const CreateScheduleRequestT &request, const CreateScheduleResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::CreateScheduleGroupOutcome CreateScheduleGroup (const Model::CreateScheduleGroupRequest &request) const

 

template<typename CreateScheduleGroupRequestT = Model::CreateScheduleGroupRequest>

Model::CreateScheduleGroupOutcomeCallable CreateScheduleGroupCallable (const CreateScheduleGroupRequestT &request) const

 

template<typename CreateScheduleGroupRequestT = Model::CreateScheduleGroupRequest>

void CreateScheduleGroupAsync (const CreateScheduleGroupRequestT &request, const CreateScheduleGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteScheduleOutcome DeleteSchedule (const Model::DeleteScheduleRequest &request) const

 

template<typename DeleteScheduleRequestT = Model::DeleteScheduleRequest>

Model::DeleteScheduleOutcomeCallable DeleteScheduleCallable (const DeleteScheduleRequestT &request) const

 

template<typename DeleteScheduleRequestT = Model::DeleteScheduleRequest>

void DeleteScheduleAsync (const DeleteScheduleRequestT &request, const DeleteScheduleResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::DeleteScheduleGroupOutcome DeleteScheduleGroup (const Model::DeleteScheduleGroupRequest &request) const

 

template<typename DeleteScheduleGroupRequestT = Model::DeleteScheduleGroupRequest>

Model::DeleteScheduleGroupOutcomeCallable DeleteScheduleGroupCallable (const DeleteScheduleGroupRequestT &request) const

 

template<typename DeleteScheduleGroupRequestT = Model::DeleteScheduleGroupRequest>

void DeleteScheduleGroupAsync (const DeleteScheduleGroupRequestT &request, const DeleteScheduleGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetScheduleOutcome GetSchedule (const Model::GetScheduleRequest &request) const

 

template<typename GetScheduleRequestT = Model::GetScheduleRequest>

Model::GetScheduleOutcomeCallable GetScheduleCallable (const GetScheduleRequestT &request) const

 

template<typename GetScheduleRequestT = Model::GetScheduleRequest>

void GetScheduleAsync (const GetScheduleRequestT &request, const GetScheduleResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::GetScheduleGroupOutcome GetScheduleGroup (const Model::GetScheduleGroupRequest &request) const

 

template<typename GetScheduleGroupRequestT = Model::GetScheduleGroupRequest>

Model::GetScheduleGroupOutcomeCallable GetScheduleGroupCallable (const GetScheduleGroupRequestT &request) const

 

template<typename GetScheduleGroupRequestT = Model::GetScheduleGroupRequest>

void GetScheduleGroupAsync (const GetScheduleGroupRequestT &request, const GetScheduleGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

virtual Model::ListScheduleGroupsOutcome ListScheduleGroups (const Model::ListScheduleGroupsRequest &request={}) const

 

template<typename ListScheduleGroupsRequestT = Model::ListScheduleGroupsRequest>

Model::ListScheduleGroupsOutcomeCallable ListScheduleGroupsCallable (const ListScheduleGroupsRequestT &request={}) const

 

template<typename ListScheduleGroupsRequestT = Model::ListScheduleGroupsRequest>

void ListScheduleGroupsAsync (const ListScheduleGroupsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListScheduleGroupsRequestT &request={}) const

 

virtual Model::ListSchedulesOutcome ListSchedules (const Model::ListSchedulesRequest &request={}) const

 

template<typename ListSchedulesRequestT = Model::ListSchedulesRequest>

Model::ListSchedulesOutcomeCallable ListSchedulesCallable (const ListSchedulesRequestT &request={}) const

 

template<typename ListSchedulesRequestT = Model::ListSchedulesRequest>

void ListSchedulesAsync (const ListSchedulesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr, const ListSchedulesRequestT &request={}) 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::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::UpdateScheduleOutcome UpdateSchedule (const Model::UpdateScheduleRequest &request) const

 

template<typename UpdateScheduleRequestT = Model::UpdateScheduleRequest>

Model::UpdateScheduleOutcomeCallable UpdateScheduleCallable (const UpdateScheduleRequestT &request) const

 

template<typename UpdateScheduleRequestT = Model::UpdateScheduleRequest>

void UpdateScheduleAsync (const UpdateScheduleRequestT &request, const UpdateScheduleResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const

 

void OverrideEndpoint (const Aws::String &endpoint)

 

std::shared_ptr< SchedulerEndpointProviderBase > & 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< SchedulerClient >

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

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

 

Friends

class Aws::Client::ClientWithAsyncTemplateMethods< SchedulerClient >

 

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

std::atomic< bool > m_isInitialized

 

std::atomic< size_t > m_operationsProcessed

 

std::condition_variable m_shutdownSignal

 

std::mutex m_shutdownMutex

 

Detailed Description

Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. The following reference lists the available API actions, and data types for EventBridge Scheduler.

Definition at line 26 of file SchedulerClient.h.

Member Typedef Documentation

BASECLASS

typedef Aws::Client::AWSJsonClient Aws::Scheduler::SchedulerClient::BASECLASS

Definition at line 29 of file SchedulerClient.h.

ClientConfigurationType

typedef SchedulerClientConfiguration Aws::Scheduler::SchedulerClient::ClientConfigurationType

Definition at line 33 of file SchedulerClient.h.

EndpointProviderType

typedef SchedulerEndpointProvider Aws::Scheduler::SchedulerClient::EndpointProviderType

Definition at line 34 of file SchedulerClient.h.

Constructor & Destructor Documentation

SchedulerClient() [1/6]

Aws::Scheduler::SchedulerClient::SchedulerClient ( const Aws::Scheduler::SchedulerClientConfiguration &  clientConfiguration = Aws::Scheduler::SchedulerClientConfiguration(),

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

SchedulerClient() [2/6]

Aws::Scheduler::SchedulerClient::SchedulerClient ( const Aws::Auth::AWSCredentials &  credentials,

std::shared_ptr< SchedulerEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Scheduler::SchedulerClientConfiguration &  clientConfiguration = Aws::Scheduler::SchedulerClientConfiguration() 

)

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.

SchedulerClient() [3/6]

Aws::Scheduler::SchedulerClient::SchedulerClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

std::shared_ptr< SchedulerEndpointProviderBase >  endpointProvider = nullptr,

const Aws::Scheduler::SchedulerClientConfiguration &  clientConfiguration = Aws::Scheduler::SchedulerClientConfiguration() 

)

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

SchedulerClient() [4/6]

Aws::Scheduler::SchedulerClient::SchedulerClient ( 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.

SchedulerClient() [5/6]

Aws::Scheduler::SchedulerClient::SchedulerClient ( 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.

SchedulerClient() [6/6]

Aws::Scheduler::SchedulerClient::SchedulerClient ( 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

~SchedulerClient()

virtual Aws::Scheduler::SchedulerClient::~SchedulerClient ( )

virtual

Member Function Documentation

accessEndpointProvider()

std::shared_ptr< SchedulerEndpointProviderBase > & Aws::Scheduler::SchedulerClient::accessEndpointProvider ( )

CreateSchedule()

virtual Model::CreateScheduleOutcome Aws::Scheduler::SchedulerClient::CreateSchedule ( const Model::CreateScheduleRequest &  request) const

virtual

Creates the specified schedule.

See Also:

AWS API Reference

CreateScheduleAsync()

template<typename CreateScheduleRequestT = Model::CreateScheduleRequest>

void Aws::Scheduler::SchedulerClient::CreateScheduleAsync ( const CreateScheduleRequestT &  request,

const CreateScheduleResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 104 of file SchedulerClient.h.

CreateScheduleCallable()

template<typename CreateScheduleRequestT = Model::CreateScheduleRequest>

Model::CreateScheduleOutcomeCallable Aws::Scheduler::SchedulerClient::CreateScheduleCallable ( const CreateScheduleRequestT &  request) const

inline

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

Definition at line 95 of file SchedulerClient.h.

CreateScheduleGroup()

virtual Model::CreateScheduleGroupOutcome Aws::Scheduler::SchedulerClient::CreateScheduleGroup ( const Model::CreateScheduleGroupRequest &  request) const

virtual

Creates the specified schedule group.

See Also:

AWS API Reference

CreateScheduleGroupAsync()

template<typename CreateScheduleGroupRequestT = Model::CreateScheduleGroupRequest>

void Aws::Scheduler::SchedulerClient::CreateScheduleGroupAsync ( const CreateScheduleGroupRequestT &  request,

const CreateScheduleGroupResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 129 of file SchedulerClient.h.

CreateScheduleGroupCallable()

template<typename CreateScheduleGroupRequestT = Model::CreateScheduleGroupRequest>

Model::CreateScheduleGroupOutcomeCallable Aws::Scheduler::SchedulerClient::CreateScheduleGroupCallable ( const CreateScheduleGroupRequestT &  request) const

inline

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

Definition at line 120 of file SchedulerClient.h.

DeleteSchedule()

virtual Model::DeleteScheduleOutcome Aws::Scheduler::SchedulerClient::DeleteSchedule ( const Model::DeleteScheduleRequest &  request) const

virtual

Deletes the specified schedule.

See Also:

AWS API Reference

DeleteScheduleAsync()

template<typename DeleteScheduleRequestT = Model::DeleteScheduleRequest>

void Aws::Scheduler::SchedulerClient::DeleteScheduleAsync ( const DeleteScheduleRequestT &  request,

const DeleteScheduleResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 154 of file SchedulerClient.h.

DeleteScheduleCallable()

template<typename DeleteScheduleRequestT = Model::DeleteScheduleRequest>

Model::DeleteScheduleOutcomeCallable Aws::Scheduler::SchedulerClient::DeleteScheduleCallable ( const DeleteScheduleRequestT &  request) const

inline

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

Definition at line 145 of file SchedulerClient.h.

DeleteScheduleGroup()

virtual Model::DeleteScheduleGroupOutcome Aws::Scheduler::SchedulerClient::DeleteScheduleGroup ( const Model::DeleteScheduleGroupRequest &  request) const

virtual

Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you delete a group, it remains in a DELETING state until all of its associated schedules are deleted. Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets until the schedule group and its associated schedules are deleted.

This operation is eventually consistent.

See Also:

AWS API Reference

DeleteScheduleGroupAsync()

template<typename DeleteScheduleGroupRequestT = Model::DeleteScheduleGroupRequest>

void Aws::Scheduler::SchedulerClient::DeleteScheduleGroupAsync ( const DeleteScheduleGroupRequestT &  request,

const DeleteScheduleGroupResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 186 of file SchedulerClient.h.

DeleteScheduleGroupCallable()

template<typename DeleteScheduleGroupRequestT = Model::DeleteScheduleGroupRequest>

Model::DeleteScheduleGroupOutcomeCallable Aws::Scheduler::SchedulerClient::DeleteScheduleGroupCallable ( const DeleteScheduleGroupRequestT &  request) const

inline

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

Definition at line 177 of file SchedulerClient.h.

GetAllocationTag()

static const char * Aws::Scheduler::SchedulerClient::GetAllocationTag ( )

static

GetSchedule()

virtual Model::GetScheduleOutcome Aws::Scheduler::SchedulerClient::GetSchedule ( const Model::GetScheduleRequest &  request) const

virtual

Retrieves the specified schedule.

See Also:

AWS API Reference

GetScheduleAsync()

template<typename GetScheduleRequestT = Model::GetScheduleRequest>

void Aws::Scheduler::SchedulerClient::GetScheduleAsync ( const GetScheduleRequestT &  request,

const GetScheduleResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 211 of file SchedulerClient.h.

GetScheduleCallable()

template<typename GetScheduleRequestT = Model::GetScheduleRequest>

Model::GetScheduleOutcomeCallable Aws::Scheduler::SchedulerClient::GetScheduleCallable ( const GetScheduleRequestT &  request) const

inline

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

Definition at line 202 of file SchedulerClient.h.

GetScheduleGroup()

virtual Model::GetScheduleGroupOutcome Aws::Scheduler::SchedulerClient::GetScheduleGroup ( const Model::GetScheduleGroupRequest &  request) const

virtual

Retrieves the specified schedule group.

See Also:

AWS API Reference

GetScheduleGroupAsync()

template<typename GetScheduleGroupRequestT = Model::GetScheduleGroupRequest>

void Aws::Scheduler::SchedulerClient::GetScheduleGroupAsync ( const GetScheduleGroupRequestT &  request,

const GetScheduleGroupResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 236 of file SchedulerClient.h.

GetScheduleGroupCallable()

template<typename GetScheduleGroupRequestT = Model::GetScheduleGroupRequest>

Model::GetScheduleGroupOutcomeCallable Aws::Scheduler::SchedulerClient::GetScheduleGroupCallable ( const GetScheduleGroupRequestT &  request) const

inline

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

Definition at line 227 of file SchedulerClient.h.

GetServiceName()

static const char * Aws::Scheduler::SchedulerClient::GetServiceName ( )

static

ListScheduleGroups()

virtual Model::ListScheduleGroupsOutcome Aws::Scheduler::SchedulerClient::ListScheduleGroups ( const Model::ListScheduleGroupsRequest &  request = {}) const

virtual

Returns a paginated list of your schedule groups.

See Also:

AWS API Reference

ListScheduleGroupsAsync()

template<typename ListScheduleGroupsRequestT = Model::ListScheduleGroupsRequest>

void Aws::Scheduler::SchedulerClient::ListScheduleGroupsAsync ( const ListScheduleGroupsResponseReceivedHandler &  handler,

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

const ListScheduleGroupsRequestT &  request = {} 

) const

inline

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

Definition at line 262 of file SchedulerClient.h.

ListScheduleGroupsCallable()

template<typename ListScheduleGroupsRequestT = Model::ListScheduleGroupsRequest>

Model::ListScheduleGroupsOutcomeCallable Aws::Scheduler::SchedulerClient::ListScheduleGroupsCallable ( const ListScheduleGroupsRequestT &  request = {}) const

inline

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

Definition at line 253 of file SchedulerClient.h.

ListSchedules()

virtual Model::ListSchedulesOutcome Aws::Scheduler::SchedulerClient::ListSchedules ( const Model::ListSchedulesRequest &  request = {}) const

virtual

Returns a paginated list of your EventBridge Scheduler schedules.

See Also:

AWS API Reference

ListSchedulesAsync()

template<typename ListSchedulesRequestT = Model::ListSchedulesRequest>

void Aws::Scheduler::SchedulerClient::ListSchedulesAsync ( const ListSchedulesResponseReceivedHandler &  handler,

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

const ListSchedulesRequestT &  request = {} 

) const

inline

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

Definition at line 288 of file SchedulerClient.h.

ListSchedulesCallable()

template<typename ListSchedulesRequestT = Model::ListSchedulesRequest>

Model::ListSchedulesOutcomeCallable Aws::Scheduler::SchedulerClient::ListSchedulesCallable ( const ListSchedulesRequestT &  request = {}) const

inline

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

Definition at line 279 of file SchedulerClient.h.

ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::Scheduler::SchedulerClient::ListTagsForResource ( const Model::ListTagsForResourceRequest &  request) const

virtual

Lists the tags associated with the Scheduler resource.

See Also:

AWS API Reference

ListTagsForResourceAsync()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

void Aws::Scheduler::SchedulerClient::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 314 of file SchedulerClient.h.

ListTagsForResourceCallable()

template<typename ListTagsForResourceRequestT = Model::ListTagsForResourceRequest>

Model::ListTagsForResourceOutcomeCallable Aws::Scheduler::SchedulerClient::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 305 of file SchedulerClient.h.

OverrideEndpoint()

void Aws::Scheduler::SchedulerClient::OverrideEndpoint ( const Aws::String &  endpoint)

TagResource()

virtual Model::TagResourceOutcome Aws::Scheduler::SchedulerClient::TagResource ( const Model::TagResourceRequest &  request) const

virtual

Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.

See Also:

AWS API Reference

TagResourceAsync()

template<typename TagResourceRequestT = Model::TagResourceRequest>

void Aws::Scheduler::SchedulerClient::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 341 of file SchedulerClient.h.

TagResourceCallable()

template<typename TagResourceRequestT = Model::TagResourceRequest>

Model::TagResourceOutcomeCallable Aws::Scheduler::SchedulerClient::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 332 of file SchedulerClient.h.

UntagResource()

virtual Model::UntagResourceOutcome Aws::Scheduler::SchedulerClient::UntagResource ( const Model::UntagResourceRequest &  request) const

virtual

Removes one or more tags from the specified EventBridge Scheduler schedule group.

See Also:

AWS API Reference

UntagResourceAsync()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

void Aws::Scheduler::SchedulerClient::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 367 of file SchedulerClient.h.

UntagResourceCallable()

template<typename UntagResourceRequestT = Model::UntagResourceRequest>

Model::UntagResourceOutcomeCallable Aws::Scheduler::SchedulerClient::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 358 of file SchedulerClient.h.

UpdateSchedule()

virtual Model::UpdateScheduleOutcome Aws::Scheduler::SchedulerClient::UpdateSchedule ( const Model::UpdateScheduleRequest &  request) const

virtual

Updates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses all values, including empty values, specified in the request and overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to its system-default value after the update.

Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all optional parameters for your UpdateSchedule call.

See Also:

AWS API Reference

UpdateScheduleAsync()

template<typename UpdateScheduleRequestT = Model::UpdateScheduleRequest>

void Aws::Scheduler::SchedulerClient::UpdateScheduleAsync ( const UpdateScheduleRequestT &  request,

const UpdateScheduleResponseReceivedHandler &  handler,

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

) const

inline

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

Definition at line 399 of file SchedulerClient.h.

UpdateScheduleCallable()

template<typename UpdateScheduleRequestT = Model::UpdateScheduleRequest>

Model::UpdateScheduleOutcomeCallable Aws::Scheduler::SchedulerClient::UpdateScheduleCallable ( const UpdateScheduleRequestT &  request) const

inline

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

Definition at line 390 of file SchedulerClient.h.

Friends And Related Symbol Documentation

Aws::Client::ClientWithAsyncTemplateMethods< SchedulerClient >

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

friend

Definition at line 406 of file SchedulerClient.h.

---

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

• generated/src/aws-cpp-sdk-scheduler/include/aws/scheduler/SchedulerClient.h