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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateScheduleResult	createSchedule(CreateScheduleRequest createScheduleRequest) Creates the specified schedule.
CreateScheduleGroupResult	createScheduleGroup(CreateScheduleGroupRequest createScheduleGroupRequest) Creates the specified schedule group.
DeleteScheduleResult	deleteSchedule(DeleteScheduleRequest deleteScheduleRequest) Deletes the specified schedule.
DeleteScheduleGroupResult	deleteScheduleGroup(DeleteScheduleGroupRequest deleteScheduleGroupRequest) Deletes the specified schedule group.
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.
GetScheduleResult	getSchedule(GetScheduleRequest getScheduleRequest) Retrieves the specified schedule.
GetScheduleGroupResult	getScheduleGroup(GetScheduleGroupRequest getScheduleGroupRequest) Retrieves the specified schedule group.
ListScheduleGroupsResult	listScheduleGroups(ListScheduleGroupsRequest listScheduleGroupsRequest) Returns a paginated list of your schedule groups.
ListSchedulesResult	listSchedules(ListSchedulesRequest listSchedulesRequest) Returns a paginated list of your EventBridge Scheduler schedules.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with the Scheduler resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified EventBridge Scheduler schedule group.
UpdateScheduleResult	updateSchedule(UpdateScheduleRequest updateScheduleRequest) Updates the specified schedule.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createSchedule

CreateScheduleResult createSchedule(CreateScheduleRequest createScheduleRequest)

Creates the specified schedule.

Parameters:

createScheduleRequest -

Returns:

Result of the CreateSchedule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createScheduleGroup

CreateScheduleGroupResult createScheduleGroup(CreateScheduleGroupRequest createScheduleGroupRequest)

Creates the specified schedule group.

Parameters:

createScheduleGroupRequest -

Returns:

Result of the CreateScheduleGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteSchedule

DeleteScheduleResult deleteSchedule(DeleteScheduleRequest deleteScheduleRequest)

Deletes the specified schedule.

Parameters:

deleteScheduleRequest -

Returns:

Result of the DeleteSchedule 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

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

getSchedule

GetScheduleResult getSchedule(GetScheduleRequest getScheduleRequest)

Retrieves the specified schedule.

Parameters:

getScheduleRequest -

Returns:

Result of the GetSchedule 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.

ResourceNotFoundException - The request references a resource which does not exist.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getScheduleGroup

GetScheduleGroupResult getScheduleGroup(GetScheduleGroupRequest getScheduleGroupRequest)

Retrieves the specified schedule group.

Parameters:

getScheduleGroupRequest -

Returns:

Result of the GetScheduleGroup 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.

ResourceNotFoundException - The request references a resource which does not exist.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listScheduleGroups

ListScheduleGroupsResult listScheduleGroups(ListScheduleGroupsRequest listScheduleGroupsRequest)

Returns a paginated list of your schedule groups.

Parameters:

listScheduleGroupsRequest -

Returns:

Result of the ListScheduleGroups 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.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listSchedules

ListSchedulesResult listSchedules(ListSchedulesRequest listSchedulesRequest)

Returns a paginated list of your EventBridge Scheduler schedules.

Parameters:

listSchedulesRequest -

Returns:

Result of the ListSchedules 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.

ResourceNotFoundException - The request references a resource which does not exist.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags associated with the Scheduler resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource 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.

ResourceNotFoundException - The request references a resource which does not exist.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

tagResource

TagResourceResult 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:

Result of the TagResource 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

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource 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.