JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.scheduler

Interface AmazonScheduler

  • All Known Subinterfaces:
    AmazonSchedulerAsync
    All Known Implementing Classes:
    AbstractAmazonScheduler, AbstractAmazonSchedulerAsync, AmazonSchedulerAsyncClient, AmazonSchedulerClient 

    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonScheduler
    Interface for accessing Amazon EventBridge Scheduler.

    Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonScheduler 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.

    • Method Detail

      • deleteScheduleGroup

        DeleteScheduleGroupResult 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:
        Result of the DeleteScheduleGroup operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • updateSchedule

        UpdateScheduleResult 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:
        Result of the UpdateSchedule operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /