@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSchedulerAsyncClient extends AmazonSchedulerClient implements AmazonSchedulerAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createSchedule, createScheduleGroup, deleteSchedule, deleteScheduleGroup, getCachedResponseMetadata, getSchedule, getScheduleGroup, listScheduleGroups, listSchedules, listTagsForResource, tagResource, untagResource, updateScheduleaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateSchedule, createScheduleGroup, deleteSchedule, deleteScheduleGroup, getCachedResponseMetadata, getSchedule, getScheduleGroup, listScheduleGroups, listSchedules, listTagsForResource, tagResource, untagResource, updateSchedulepublic static AmazonSchedulerAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateScheduleResult> createScheduleAsync(CreateScheduleRequest request)
AmazonSchedulerAsyncCreates the specified schedule.
createScheduleAsync in interface AmazonSchedulerAsyncpublic Future<CreateScheduleResult> createScheduleAsync(CreateScheduleRequest request, AsyncHandler<CreateScheduleRequest,CreateScheduleResult> asyncHandler)
AmazonSchedulerAsyncCreates the specified schedule.
createScheduleAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateScheduleGroupResult> createScheduleGroupAsync(CreateScheduleGroupRequest request)
AmazonSchedulerAsyncCreates the specified schedule group.
createScheduleGroupAsync in interface AmazonSchedulerAsyncpublic Future<CreateScheduleGroupResult> createScheduleGroupAsync(CreateScheduleGroupRequest request, AsyncHandler<CreateScheduleGroupRequest,CreateScheduleGroupResult> asyncHandler)
AmazonSchedulerAsyncCreates the specified schedule group.
createScheduleGroupAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteScheduleResult> deleteScheduleAsync(DeleteScheduleRequest request)
AmazonSchedulerAsyncDeletes the specified schedule.
deleteScheduleAsync in interface AmazonSchedulerAsyncpublic Future<DeleteScheduleResult> deleteScheduleAsync(DeleteScheduleRequest request, AsyncHandler<DeleteScheduleRequest,DeleteScheduleResult> asyncHandler)
AmazonSchedulerAsyncDeletes the specified schedule.
deleteScheduleAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteScheduleGroupResult> deleteScheduleGroupAsync(DeleteScheduleGroupRequest request)
AmazonSchedulerAsync
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.
deleteScheduleGroupAsync in interface AmazonSchedulerAsyncpublic Future<DeleteScheduleGroupResult> deleteScheduleGroupAsync(DeleteScheduleGroupRequest request, AsyncHandler<DeleteScheduleGroupRequest,DeleteScheduleGroupResult> asyncHandler)
AmazonSchedulerAsync
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.
deleteScheduleGroupAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetScheduleResult> getScheduleAsync(GetScheduleRequest request)
AmazonSchedulerAsyncRetrieves the specified schedule.
getScheduleAsync in interface AmazonSchedulerAsyncpublic Future<GetScheduleResult> getScheduleAsync(GetScheduleRequest request, AsyncHandler<GetScheduleRequest,GetScheduleResult> asyncHandler)
AmazonSchedulerAsyncRetrieves the specified schedule.
getScheduleAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetScheduleGroupResult> getScheduleGroupAsync(GetScheduleGroupRequest request)
AmazonSchedulerAsyncRetrieves the specified schedule group.
getScheduleGroupAsync in interface AmazonSchedulerAsyncpublic Future<GetScheduleGroupResult> getScheduleGroupAsync(GetScheduleGroupRequest request, AsyncHandler<GetScheduleGroupRequest,GetScheduleGroupResult> asyncHandler)
AmazonSchedulerAsyncRetrieves the specified schedule group.
getScheduleGroupAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListScheduleGroupsResult> listScheduleGroupsAsync(ListScheduleGroupsRequest request)
AmazonSchedulerAsyncReturns a paginated list of your schedule groups.
listScheduleGroupsAsync in interface AmazonSchedulerAsyncpublic Future<ListScheduleGroupsResult> listScheduleGroupsAsync(ListScheduleGroupsRequest request, AsyncHandler<ListScheduleGroupsRequest,ListScheduleGroupsResult> asyncHandler)
AmazonSchedulerAsyncReturns a paginated list of your schedule groups.
listScheduleGroupsAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSchedulesResult> listSchedulesAsync(ListSchedulesRequest request)
AmazonSchedulerAsyncReturns a paginated list of your EventBridge Scheduler schedules.
listSchedulesAsync in interface AmazonSchedulerAsyncpublic Future<ListSchedulesResult> listSchedulesAsync(ListSchedulesRequest request, AsyncHandler<ListSchedulesRequest,ListSchedulesResult> asyncHandler)
AmazonSchedulerAsyncReturns a paginated list of your EventBridge Scheduler schedules.
listSchedulesAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonSchedulerAsyncLists the tags associated with the Scheduler resource.
listTagsForResourceAsync in interface AmazonSchedulerAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonSchedulerAsyncLists the tags associated with the Scheduler resource.
listTagsForResourceAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonSchedulerAsyncAssigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
tagResourceAsync in interface AmazonSchedulerAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonSchedulerAsyncAssigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
tagResourceAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonSchedulerAsyncRemoves one or more tags from the specified EventBridge Scheduler schedule group.
untagResourceAsync in interface AmazonSchedulerAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonSchedulerAsyncRemoves one or more tags from the specified EventBridge Scheduler schedule group.
untagResourceAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateScheduleResult> updateScheduleAsync(UpdateScheduleRequest request)
AmazonSchedulerAsync
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.
updateScheduleAsync in interface AmazonSchedulerAsyncpublic Future<UpdateScheduleResult> updateScheduleAsync(UpdateScheduleRequest request, AsyncHandler<UpdateScheduleRequest,UpdateScheduleResult> asyncHandler)
AmazonSchedulerAsync
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.
updateScheduleAsync in interface AmazonSchedulerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonSchedulershutdown in class AmazonSchedulerClient