@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSchedulerAsync extends AmazonScheduler
AsyncHandler can be used to
receive notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonSchedulerAsync instead.
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.
ENDPOINT_PREFIXcreateSchedule, createScheduleGroup, deleteSchedule, deleteScheduleGroup, getCachedResponseMetadata, getSchedule, getScheduleGroup, listScheduleGroups, listSchedules, listTagsForResource, shutdown, tagResource, untagResource, updateScheduleFuture<CreateScheduleResult> createScheduleAsync(CreateScheduleRequest createScheduleRequest)
Creates the specified schedule.
createScheduleRequest - Future<CreateScheduleResult> createScheduleAsync(CreateScheduleRequest createScheduleRequest, AsyncHandler<CreateScheduleRequest,CreateScheduleResult> asyncHandler)
Creates the specified schedule.
createScheduleRequest - 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.Future<CreateScheduleGroupResult> createScheduleGroupAsync(CreateScheduleGroupRequest createScheduleGroupRequest)
Creates the specified schedule group.
createScheduleGroupRequest - Future<CreateScheduleGroupResult> createScheduleGroupAsync(CreateScheduleGroupRequest createScheduleGroupRequest, AsyncHandler<CreateScheduleGroupRequest,CreateScheduleGroupResult> asyncHandler)
Creates the specified schedule group.
createScheduleGroupRequest - 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.Future<DeleteScheduleResult> deleteScheduleAsync(DeleteScheduleRequest deleteScheduleRequest)
Deletes the specified schedule.
deleteScheduleRequest - Future<DeleteScheduleResult> deleteScheduleAsync(DeleteScheduleRequest deleteScheduleRequest, AsyncHandler<DeleteScheduleRequest,DeleteScheduleResult> asyncHandler)
Deletes the specified schedule.
deleteScheduleRequest - 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.Future<DeleteScheduleGroupResult> deleteScheduleGroupAsync(DeleteScheduleGroupRequest deleteScheduleGroupRequest)
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.
deleteScheduleGroupRequest - Future<DeleteScheduleGroupResult> deleteScheduleGroupAsync(DeleteScheduleGroupRequest deleteScheduleGroupRequest, AsyncHandler<DeleteScheduleGroupRequest,DeleteScheduleGroupResult> asyncHandler)
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.
deleteScheduleGroupRequest - 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.Future<GetScheduleResult> getScheduleAsync(GetScheduleRequest getScheduleRequest)
Retrieves the specified schedule.
getScheduleRequest - Future<GetScheduleResult> getScheduleAsync(GetScheduleRequest getScheduleRequest, AsyncHandler<GetScheduleRequest,GetScheduleResult> asyncHandler)
Retrieves the specified schedule.
getScheduleRequest - 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.Future<GetScheduleGroupResult> getScheduleGroupAsync(GetScheduleGroupRequest getScheduleGroupRequest)
Retrieves the specified schedule group.
getScheduleGroupRequest - Future<GetScheduleGroupResult> getScheduleGroupAsync(GetScheduleGroupRequest getScheduleGroupRequest, AsyncHandler<GetScheduleGroupRequest,GetScheduleGroupResult> asyncHandler)
Retrieves the specified schedule group.
getScheduleGroupRequest - 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.Future<ListScheduleGroupsResult> listScheduleGroupsAsync(ListScheduleGroupsRequest listScheduleGroupsRequest)
Returns a paginated list of your schedule groups.
listScheduleGroupsRequest - Future<ListScheduleGroupsResult> listScheduleGroupsAsync(ListScheduleGroupsRequest listScheduleGroupsRequest, AsyncHandler<ListScheduleGroupsRequest,ListScheduleGroupsResult> asyncHandler)
Returns a paginated list of your schedule groups.
listScheduleGroupsRequest - 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.Future<ListSchedulesResult> listSchedulesAsync(ListSchedulesRequest listSchedulesRequest)
Returns a paginated list of your EventBridge Scheduler schedules.
listSchedulesRequest - Future<ListSchedulesResult> listSchedulesAsync(ListSchedulesRequest listSchedulesRequest, AsyncHandler<ListSchedulesRequest,ListSchedulesResult> asyncHandler)
Returns a paginated list of your EventBridge Scheduler schedules.
listSchedulesRequest - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with the Scheduler resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags associated with the Scheduler resource.
listTagsForResourceRequest - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
tagResourceRequest - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified EventBridge Scheduler schedule group.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from the specified EventBridge Scheduler schedule group.
untagResourceRequest - 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.Future<UpdateScheduleResult> updateScheduleAsync(UpdateScheduleRequest updateScheduleRequest)
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.
updateScheduleRequest - Future<UpdateScheduleResult> updateScheduleAsync(UpdateScheduleRequest updateScheduleRequest, AsyncHandler<UpdateScheduleRequest,UpdateScheduleResult> asyncHandler)
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.
updateScheduleRequest - 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.