@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSchedulerClient extends AmazonWebServiceClient implements AmazonScheduler
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
Modifier and Type | Method and Description |
---|---|
static AmazonSchedulerClientBuilder |
builder() |
CreateScheduleResult |
createSchedule(CreateScheduleRequest request)
Creates the specified schedule.
|
CreateScheduleGroupResult |
createScheduleGroup(CreateScheduleGroupRequest request)
Creates the specified schedule group.
|
DeleteScheduleResult |
deleteSchedule(DeleteScheduleRequest request)
Deletes the specified schedule.
|
DeleteScheduleGroupResult |
deleteScheduleGroup(DeleteScheduleGroupRequest request)
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 request)
Retrieves the specified schedule.
|
GetScheduleGroupResult |
getScheduleGroup(GetScheduleGroupRequest request)
Retrieves the specified schedule group.
|
ListScheduleGroupsResult |
listScheduleGroups(ListScheduleGroupsRequest request)
Returns a paginated list of your schedule groups.
|
ListSchedulesResult |
listSchedules(ListSchedulesRequest request)
Returns a paginated list of your EventBridge Scheduler schedules.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
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 request)
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified EventBridge Scheduler schedule group.
|
UpdateScheduleResult |
updateSchedule(UpdateScheduleRequest request)
Updates the specified schedule.
|
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
public static AmazonSchedulerClientBuilder builder()
public CreateScheduleResult createSchedule(CreateScheduleRequest request)
Creates the specified schedule.
createSchedule
in interface AmazonScheduler
createScheduleRequest
- 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.public CreateScheduleGroupResult createScheduleGroup(CreateScheduleGroupRequest request)
Creates the specified schedule group.
createScheduleGroup
in interface AmazonScheduler
createScheduleGroupRequest
- 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.public DeleteScheduleResult deleteSchedule(DeleteScheduleRequest request)
Deletes the specified schedule.
deleteSchedule
in interface AmazonScheduler
deleteScheduleRequest
- 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.public DeleteScheduleGroupResult deleteScheduleGroup(DeleteScheduleGroupRequest request)
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.
deleteScheduleGroup
in interface AmazonScheduler
deleteScheduleGroupRequest
- 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.public GetScheduleResult getSchedule(GetScheduleRequest request)
Retrieves the specified schedule.
getSchedule
in interface AmazonScheduler
getScheduleRequest
- 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.public GetScheduleGroupResult getScheduleGroup(GetScheduleGroupRequest request)
Retrieves the specified schedule group.
getScheduleGroup
in interface AmazonScheduler
getScheduleGroupRequest
- 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.public ListScheduleGroupsResult listScheduleGroups(ListScheduleGroupsRequest request)
Returns a paginated list of your schedule groups.
listScheduleGroups
in interface AmazonScheduler
listScheduleGroupsRequest
- 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.public ListSchedulesResult listSchedules(ListSchedulesRequest request)
Returns a paginated list of your EventBridge Scheduler schedules.
listSchedules
in interface AmazonScheduler
listSchedulesRequest
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags associated with the Scheduler resource.
listTagsForResource
in interface AmazonScheduler
listTagsForResourceRequest
- 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.public TagResourceResult tagResource(TagResourceRequest request)
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
tagResource
in interface AmazonScheduler
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the specified EventBridge Scheduler schedule group.
untagResource
in interface AmazonScheduler
untagResourceRequest
- 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.public UpdateScheduleResult updateSchedule(UpdateScheduleRequest request)
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.
updateSchedule
in interface AmazonScheduler
updateScheduleRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AmazonScheduler
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonScheduler
shutdown
in class AmazonWebServiceClient