Aws::Scheduler::SchedulerClient Class Reference

#include <SchedulerClient.h>

Inheritance diagram for Aws::Scheduler::SchedulerClient:

Public Types
typedef Aws::Client::AWSJsonClient	BASECLASS
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=Aws::MakeShared< SchedulerEndpointProvider >(ALLOCATION_TAG))
	SchedulerClient (const Aws::Auth::AWSCredentials &credentials, std::shared_ptr< SchedulerEndpointProviderBase > endpointProvider=Aws::MakeShared< SchedulerEndpointProvider >(ALLOCATION_TAG), const Aws::Scheduler::SchedulerClientConfiguration &clientConfiguration=Aws::Scheduler::SchedulerClientConfiguration())
	SchedulerClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, std::shared_ptr< SchedulerEndpointProviderBase > endpointProvider=Aws::MakeShared< SchedulerEndpointProvider >(ALLOCATION_TAG), 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
virtual Model::CreateScheduleOutcomeCallable	CreateScheduleCallable (const Model::CreateScheduleRequest &request) const
virtual void	CreateScheduleAsync (const Model::CreateScheduleRequest &request, const CreateScheduleResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::CreateScheduleGroupOutcome	CreateScheduleGroup (const Model::CreateScheduleGroupRequest &request) const
virtual Model::CreateScheduleGroupOutcomeCallable	CreateScheduleGroupCallable (const Model::CreateScheduleGroupRequest &request) const
virtual void	CreateScheduleGroupAsync (const Model::CreateScheduleGroupRequest &request, const CreateScheduleGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::DeleteScheduleOutcome	DeleteSchedule (const Model::DeleteScheduleRequest &request) const
virtual Model::DeleteScheduleOutcomeCallable	DeleteScheduleCallable (const Model::DeleteScheduleRequest &request) const
virtual void	DeleteScheduleAsync (const Model::DeleteScheduleRequest &request, const DeleteScheduleResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::DeleteScheduleGroupOutcome	DeleteScheduleGroup (const Model::DeleteScheduleGroupRequest &request) const
virtual Model::DeleteScheduleGroupOutcomeCallable	DeleteScheduleGroupCallable (const Model::DeleteScheduleGroupRequest &request) const
virtual void	DeleteScheduleGroupAsync (const Model::DeleteScheduleGroupRequest &request, const DeleteScheduleGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::GetScheduleOutcome	GetSchedule (const Model::GetScheduleRequest &request) const
virtual Model::GetScheduleOutcomeCallable	GetScheduleCallable (const Model::GetScheduleRequest &request) const
virtual void	GetScheduleAsync (const Model::GetScheduleRequest &request, const GetScheduleResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::GetScheduleGroupOutcome	GetScheduleGroup (const Model::GetScheduleGroupRequest &request) const
virtual Model::GetScheduleGroupOutcomeCallable	GetScheduleGroupCallable (const Model::GetScheduleGroupRequest &request) const
virtual void	GetScheduleGroupAsync (const Model::GetScheduleGroupRequest &request, const GetScheduleGroupResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::ListScheduleGroupsOutcome	ListScheduleGroups (const Model::ListScheduleGroupsRequest &request) const
virtual Model::ListScheduleGroupsOutcomeCallable	ListScheduleGroupsCallable (const Model::ListScheduleGroupsRequest &request) const
virtual void	ListScheduleGroupsAsync (const Model::ListScheduleGroupsRequest &request, const ListScheduleGroupsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::ListSchedulesOutcome	ListSchedules (const Model::ListSchedulesRequest &request) const
virtual Model::ListSchedulesOutcomeCallable	ListSchedulesCallable (const Model::ListSchedulesRequest &request) const
virtual void	ListSchedulesAsync (const Model::ListSchedulesRequest &request, const ListSchedulesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::ListTagsForResourceOutcome	ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
virtual Model::ListTagsForResourceOutcomeCallable	ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
virtual void	ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::TagResourceOutcome	TagResource (const Model::TagResourceRequest &request) const
virtual Model::TagResourceOutcomeCallable	TagResourceCallable (const Model::TagResourceRequest &request) const
virtual void	TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::UntagResourceOutcome	UntagResource (const Model::UntagResourceRequest &request) const
virtual Model::UntagResourceOutcomeCallable	UntagResourceCallable (const Model::UntagResourceRequest &request) const
virtual void	UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
virtual Model::UpdateScheduleOutcome	UpdateSchedule (const Model::UpdateScheduleRequest &request) const
virtual Model::UpdateScheduleOutcomeCallable	UpdateScheduleCallable (const Model::UpdateScheduleRequest &request) const
virtual void	UpdateScheduleAsync (const Model::UpdateScheduleRequest &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)
Aws::String	GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
Aws::String	GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) 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)
Aws::String	GeneratePresignedUrl (const Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) 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)
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
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)
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)
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
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
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
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
void	DisableRequestProcessing ()
void	EnableRequestProcessing ()
virtual const char *	GetServiceClientName () const
virtual void	SetServiceClientName (const Aws::String &name)
Public Member Functions inherited from Aws::Client::ClientWithAsyncTemplateMethods< SchedulerClient >
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 Attributes
static const char *	SERVICE_NAME
static const char *	ALLOCATION_TAG

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 AWSError< CoreErrors >	BuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const=0
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< 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

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.

Constructor & Destructor Documentation

SchedulerClient() [1/6]

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

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 = Aws::MakeShared< SchedulerEndpointProvider >(ALLOCATION_TAG),
		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 = Aws::MakeShared< SchedulerEndpointProvider >(ALLOCATION_TAG),
		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()

virtual void Aws::Scheduler::SchedulerClient::CreateScheduleAsync ( const Model::CreateScheduleRequest &  request, const CreateScheduleResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

CreateScheduleCallable()

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

virtual

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

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()

virtual void Aws::Scheduler::SchedulerClient::CreateScheduleGroupAsync ( const Model::CreateScheduleGroupRequest &  request, const CreateScheduleGroupResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

CreateScheduleGroupCallable()

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

virtual

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

DeleteSchedule()

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

virtual

Deletes the specified schedule.

See Also:

AWS API Reference

DeleteScheduleAsync()

virtual void Aws::Scheduler::SchedulerClient::DeleteScheduleAsync ( const Model::DeleteScheduleRequest &  request, const DeleteScheduleResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

DeleteScheduleCallable()

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

virtual

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

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()

virtual void Aws::Scheduler::SchedulerClient::DeleteScheduleGroupAsync ( const Model::DeleteScheduleGroupRequest &  request, const DeleteScheduleGroupResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

DeleteScheduleGroupCallable()

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

virtual

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

GetSchedule()

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

virtual

Retrieves the specified schedule.

See Also:

AWS API Reference

GetScheduleAsync()

virtual void Aws::Scheduler::SchedulerClient::GetScheduleAsync ( const Model::GetScheduleRequest &  request, const GetScheduleResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

GetScheduleCallable()

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

virtual

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

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()

virtual void Aws::Scheduler::SchedulerClient::GetScheduleGroupAsync ( const Model::GetScheduleGroupRequest &  request, const GetScheduleGroupResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

GetScheduleGroupCallable()

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

virtual

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

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()

virtual void Aws::Scheduler::SchedulerClient::ListScheduleGroupsAsync ( const Model::ListScheduleGroupsRequest &  request, const ListScheduleGroupsResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

ListScheduleGroupsCallable()

virtual Model::ListScheduleGroupsOutcomeCallable Aws::Scheduler::SchedulerClient::ListScheduleGroupsCallable ( const Model::ListScheduleGroupsRequest &  request ) const

virtual

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

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()

virtual void Aws::Scheduler::SchedulerClient::ListSchedulesAsync ( const Model::ListSchedulesRequest &  request, const ListSchedulesResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

ListSchedulesCallable()

virtual Model::ListSchedulesOutcomeCallable Aws::Scheduler::SchedulerClient::ListSchedulesCallable ( const Model::ListSchedulesRequest &  request ) const

virtual

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

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()

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

virtual

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

ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::Scheduler::SchedulerClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest &  request ) const

virtual

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

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()

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

virtual

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

TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::Scheduler::SchedulerClient::TagResourceCallable ( const Model::TagResourceRequest &  request ) const

virtual

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

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()

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

virtual

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

UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::Scheduler::SchedulerClient::UntagResourceCallable ( const Model::UntagResourceRequest &  request ) const

virtual

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

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()

virtual void Aws::Scheduler::SchedulerClient::UpdateScheduleAsync ( const Model::UpdateScheduleRequest &  request, const UpdateScheduleResponseReceivedHandler &  handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr  ) const

virtual

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

UpdateScheduleCallable()

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

virtual

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

Friends And Related Symbol Documentation

Aws::Client::ClientWithAsyncTemplateMethods< SchedulerClient >

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

friend

Definition at line 307 of file SchedulerClient.h.

Member Data Documentation

ALLOCATION_TAG

const char* Aws::Scheduler::SchedulerClient::ALLOCATION_TAG

static

Definition at line 31 of file SchedulerClient.h.

SERVICE_NAME

const char* Aws::Scheduler::SchedulerClient::SERVICE_NAME

static

Definition at line 30 of file SchedulerClient.h.

---

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

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