Package software.amazon.awssdk.services.scheduler

Interface SchedulerAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SchedulerAsyncClient extends AwsClient
Service client for accessing Amazon EventBridge Scheduler asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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.

  • Field Details

  • Method Details

    • createSchedule

      default CompletableFuture<CreateScheduleResponse> createSchedule(CreateScheduleRequest createScheduleRequest)

      Creates the specified schedule.

      Parameters:
      createScheduleRequest -
      Returns:
      A Java Future containing the result of the CreateSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeds a service quota.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSchedule

      default CompletableFuture<CreateScheduleResponse> createSchedule(Consumer<CreateScheduleRequest.Builder> createScheduleRequest)

      Creates the specified schedule.


      This is a convenience which creates an instance of the CreateScheduleRequest.Builder avoiding the need to create one manually via CreateScheduleRequest.builder()

      Parameters:
      createScheduleRequest - A Consumer that will call methods on CreateScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeds a service quota.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createScheduleGroup

      default CompletableFuture<CreateScheduleGroupResponse> createScheduleGroup(CreateScheduleGroupRequest createScheduleGroupRequest)

      Creates the specified schedule group.

      Parameters:
      createScheduleGroupRequest -
      Returns:
      A Java Future containing the result of the CreateScheduleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeds a service quota.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createScheduleGroup

      default CompletableFuture<CreateScheduleGroupResponse> createScheduleGroup(Consumer<CreateScheduleGroupRequest.Builder> createScheduleGroupRequest)

      Creates the specified schedule group.


      This is a convenience which creates an instance of the CreateScheduleGroupRequest.Builder avoiding the need to create one manually via CreateScheduleGroupRequest.builder()

      Parameters:
      createScheduleGroupRequest - A Consumer that will call methods on CreateScheduleGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateScheduleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException The request exceeds a service quota.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSchedule

      default CompletableFuture<DeleteScheduleResponse> deleteSchedule(DeleteScheduleRequest deleteScheduleRequest)

      Deletes the specified schedule.

      Parameters:
      deleteScheduleRequest -
      Returns:
      A Java Future containing the result of the DeleteSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSchedule

      default CompletableFuture<DeleteScheduleResponse> deleteSchedule(Consumer<DeleteScheduleRequest.Builder> deleteScheduleRequest)

      Deletes the specified schedule.


      This is a convenience which creates an instance of the DeleteScheduleRequest.Builder avoiding the need to create one manually via DeleteScheduleRequest.builder()

      Parameters:
      deleteScheduleRequest - A Consumer that will call methods on DeleteScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteScheduleGroup

      default CompletableFuture<DeleteScheduleGroupResponse> deleteScheduleGroup(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.

      Parameters:
      deleteScheduleGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteScheduleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteScheduleGroup

      default CompletableFuture<DeleteScheduleGroupResponse> deleteScheduleGroup(Consumer<DeleteScheduleGroupRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteScheduleGroupRequest.Builder avoiding the need to create one manually via DeleteScheduleGroupRequest.builder()

      Parameters:
      deleteScheduleGroupRequest - A Consumer that will call methods on DeleteScheduleGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteScheduleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSchedule

      default CompletableFuture<GetScheduleResponse> getSchedule(GetScheduleRequest getScheduleRequest)

      Retrieves the specified schedule.

      Parameters:
      getScheduleRequest -
      Returns:
      A Java Future containing the result of the GetSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSchedule

      default CompletableFuture<GetScheduleResponse> getSchedule(Consumer<GetScheduleRequest.Builder> getScheduleRequest)

      Retrieves the specified schedule.


      This is a convenience which creates an instance of the GetScheduleRequest.Builder avoiding the need to create one manually via GetScheduleRequest.builder()

      Parameters:
      getScheduleRequest - A Consumer that will call methods on GetScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getScheduleGroup

      default CompletableFuture<GetScheduleGroupResponse> getScheduleGroup(GetScheduleGroupRequest getScheduleGroupRequest)

      Retrieves the specified schedule group.

      Parameters:
      getScheduleGroupRequest -
      Returns:
      A Java Future containing the result of the GetScheduleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getScheduleGroup

      default CompletableFuture<GetScheduleGroupResponse> getScheduleGroup(Consumer<GetScheduleGroupRequest.Builder> getScheduleGroupRequest)

      Retrieves the specified schedule group.


      This is a convenience which creates an instance of the GetScheduleGroupRequest.Builder avoiding the need to create one manually via GetScheduleGroupRequest.builder()

      Parameters:
      getScheduleGroupRequest - A Consumer that will call methods on GetScheduleGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetScheduleGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listScheduleGroups

      default CompletableFuture<ListScheduleGroupsResponse> listScheduleGroups(ListScheduleGroupsRequest listScheduleGroupsRequest)

      Returns a paginated list of your schedule groups.

      Parameters:
      listScheduleGroupsRequest -
      Returns:
      A Java Future containing the result of the ListScheduleGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listScheduleGroups

      default CompletableFuture<ListScheduleGroupsResponse> listScheduleGroups(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest)

      Returns a paginated list of your schedule groups.


      This is a convenience which creates an instance of the ListScheduleGroupsRequest.Builder avoiding the need to create one manually via ListScheduleGroupsRequest.builder()

      Parameters:
      listScheduleGroupsRequest - A Consumer that will call methods on ListScheduleGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListScheduleGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listScheduleGroupsPaginator

      default ListScheduleGroupsPublisher listScheduleGroupsPaginator(ListScheduleGroupsRequest listScheduleGroupsRequest)

      This is a variant of listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsPublisher publisher = client.listScheduleGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsPublisher publisher = client.listScheduleGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest) operation.

      Parameters:
      listScheduleGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listScheduleGroupsPaginator

      default ListScheduleGroupsPublisher listScheduleGroupsPaginator(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest)

      This is a variant of listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsPublisher publisher = client.listScheduleGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsPublisher publisher = client.listScheduleGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest) operation.


      This is a convenience which creates an instance of the ListScheduleGroupsRequest.Builder avoiding the need to create one manually via ListScheduleGroupsRequest.builder()

      Parameters:
      listScheduleGroupsRequest - A Consumer that will call methods on ListScheduleGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSchedules

      default CompletableFuture<ListSchedulesResponse> listSchedules(ListSchedulesRequest listSchedulesRequest)

      Returns a paginated list of your EventBridge Scheduler schedules.

      Parameters:
      listSchedulesRequest -
      Returns:
      A Java Future containing the result of the ListSchedules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSchedules

      default CompletableFuture<ListSchedulesResponse> listSchedules(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest)

      Returns a paginated list of your EventBridge Scheduler schedules.


      This is a convenience which creates an instance of the ListSchedulesRequest.Builder avoiding the need to create one manually via ListSchedulesRequest.builder()

      Parameters:
      listSchedulesRequest - A Consumer that will call methods on ListSchedulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSchedules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSchedulesPaginator

      default ListSchedulesPublisher listSchedulesPaginator(ListSchedulesRequest listSchedulesRequest)

      This is a variant of listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher publisher = client.listSchedulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher publisher = client.listSchedulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest) operation.

      Parameters:
      listSchedulesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSchedulesPaginator

      default ListSchedulesPublisher listSchedulesPaginator(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest)

      This is a variant of listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher publisher = client.listSchedulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher publisher = client.listSchedulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest) operation.


      This is a convenience which creates an instance of the ListSchedulesRequest.Builder avoiding the need to create one manually via ListSchedulesRequest.builder()

      Parameters:
      listSchedulesRequest - A Consumer that will call methods on ListSchedulesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists the tags associated with the Scheduler resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists the tags associated with the Scheduler resource.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

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

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

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


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

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

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

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


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSchedule

      default CompletableFuture<UpdateScheduleResponse> updateSchedule(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.

      Parameters:
      updateScheduleRequest -
      Returns:
      A Java Future containing the result of the UpdateSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSchedule

      default CompletableFuture<UpdateScheduleResponse> updateSchedule(Consumer<UpdateScheduleRequest.Builder> 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.


      This is a convenience which creates an instance of the UpdateScheduleRequest.Builder avoiding the need to create one manually via UpdateScheduleRequest.builder()

      Parameters:
      updateScheduleRequest - A Consumer that will call methods on UpdateScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSchedule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error encountered while processing the request.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ResourceNotFoundException The request references a resource which does not exist.
      • ThrottlingException The request was denied due to request throttling.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SchedulerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default SchedulerServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static SchedulerAsyncClient create()
      Create a SchedulerAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SchedulerAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SchedulerAsyncClient.