@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_METRIC ENDPOINT_PREFIX builder, createSchedule, createScheduleGroup, deleteSchedule, deleteScheduleGroup, getCachedResponseMetadata, getSchedule, getScheduleGroup, listScheduleGroups, listSchedules, listTagsForResource, tagResource, untagResource, updateSchedule addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait createSchedule, createScheduleGroup, deleteSchedule, deleteScheduleGroup, getCachedResponseMetadata, getSchedule, getScheduleGroup, listScheduleGroups, listSchedules, listTagsForResource, tagResource, untagResource, updateSchedule public static AmazonSchedulerAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateScheduleResult> createScheduleAsync(CreateScheduleRequest request)
AmazonSchedulerAsync Creates the specified schedule.
createScheduleAsync in interface AmazonSchedulerAsync public Future<CreateScheduleResult> createScheduleAsync(CreateScheduleRequest request, AsyncHandler<CreateScheduleRequest,CreateScheduleResult> asyncHandler)
AmazonSchedulerAsync Creates the specified schedule.
createScheduleAsync in interface AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Creates the specified schedule group.
createScheduleGroupAsync in interface AmazonSchedulerAsync public Future<CreateScheduleGroupResult> createScheduleGroupAsync(CreateScheduleGroupRequest request, AsyncHandler<CreateScheduleGroupRequest,CreateScheduleGroupResult> asyncHandler)
AmazonSchedulerAsync Creates the specified schedule group.
createScheduleGroupAsync in interface AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Deletes the specified schedule.
deleteScheduleAsync in interface AmazonSchedulerAsync public Future<DeleteScheduleResult> deleteScheduleAsync(DeleteScheduleRequest request, AsyncHandler<DeleteScheduleRequest,DeleteScheduleResult> asyncHandler)
AmazonSchedulerAsync Deletes the specified schedule.
deleteScheduleAsync in interface AmazonSchedulerAsync asyncHandler - 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 AmazonSchedulerAsync public 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 AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Retrieves the specified schedule.
getScheduleAsync in interface AmazonSchedulerAsync public Future<GetScheduleResult> getScheduleAsync(GetScheduleRequest request, AsyncHandler<GetScheduleRequest,GetScheduleResult> asyncHandler)
AmazonSchedulerAsync Retrieves the specified schedule.
getScheduleAsync in interface AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Retrieves the specified schedule group.
getScheduleGroupAsync in interface AmazonSchedulerAsync public Future<GetScheduleGroupResult> getScheduleGroupAsync(GetScheduleGroupRequest request, AsyncHandler<GetScheduleGroupRequest,GetScheduleGroupResult> asyncHandler)
AmazonSchedulerAsync Retrieves the specified schedule group.
getScheduleGroupAsync in interface AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Returns a paginated list of your schedule groups.
listScheduleGroupsAsync in interface AmazonSchedulerAsync public Future<ListScheduleGroupsResult> listScheduleGroupsAsync(ListScheduleGroupsRequest request, AsyncHandler<ListScheduleGroupsRequest,ListScheduleGroupsResult> asyncHandler)
AmazonSchedulerAsync Returns a paginated list of your schedule groups.
listScheduleGroupsAsync in interface AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Returns a paginated list of your EventBridge Scheduler schedules.
listSchedulesAsync in interface AmazonSchedulerAsync public Future<ListSchedulesResult> listSchedulesAsync(ListSchedulesRequest request, AsyncHandler<ListSchedulesRequest,ListSchedulesResult> asyncHandler)
AmazonSchedulerAsync Returns a paginated list of your EventBridge Scheduler schedules.
listSchedulesAsync in interface AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Lists the tags associated with the Scheduler resource.
listTagsForResourceAsync in interface AmazonSchedulerAsync public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonSchedulerAsync Lists the tags associated with the Scheduler resource.
listTagsForResourceAsync in interface AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
tagResourceAsync in interface AmazonSchedulerAsync public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonSchedulerAsync Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
tagResourceAsync in interface AmazonSchedulerAsync asyncHandler - 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)
AmazonSchedulerAsync Removes one or more tags from the specified EventBridge Scheduler schedule group.
untagResourceAsync in interface AmazonSchedulerAsync public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonSchedulerAsync Removes one or more tags from the specified EventBridge Scheduler schedule group.
untagResourceAsync in interface AmazonSchedulerAsync asyncHandler - 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 AmazonSchedulerAsync public 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 AmazonSchedulerAsync asyncHandler - 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 AmazonScheduler shutdown in class AmazonSchedulerClient