Interface SchedulerClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SchedulerClientBuilder
builder()
Create a builder that can be used to configure and create aSchedulerClient
.static SchedulerClient
create()
Create aSchedulerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateScheduleResponse
createSchedule
(Consumer<CreateScheduleRequest.Builder> createScheduleRequest) Creates the specified schedule.default CreateScheduleResponse
createSchedule
(CreateScheduleRequest createScheduleRequest) Creates the specified schedule.default CreateScheduleGroupResponse
createScheduleGroup
(Consumer<CreateScheduleGroupRequest.Builder> createScheduleGroupRequest) Creates the specified schedule group.default CreateScheduleGroupResponse
createScheduleGroup
(CreateScheduleGroupRequest createScheduleGroupRequest) Creates the specified schedule group.default DeleteScheduleResponse
deleteSchedule
(Consumer<DeleteScheduleRequest.Builder> deleteScheduleRequest) Deletes the specified schedule.default DeleteScheduleResponse
deleteSchedule
(DeleteScheduleRequest deleteScheduleRequest) Deletes the specified schedule.default DeleteScheduleGroupResponse
deleteScheduleGroup
(Consumer<DeleteScheduleGroupRequest.Builder> deleteScheduleGroupRequest) Deletes the specified schedule group.default DeleteScheduleGroupResponse
deleteScheduleGroup
(DeleteScheduleGroupRequest deleteScheduleGroupRequest) Deletes the specified schedule group.default GetScheduleResponse
getSchedule
(Consumer<GetScheduleRequest.Builder> getScheduleRequest) Retrieves the specified schedule.default GetScheduleResponse
getSchedule
(GetScheduleRequest getScheduleRequest) Retrieves the specified schedule.default GetScheduleGroupResponse
getScheduleGroup
(Consumer<GetScheduleGroupRequest.Builder> getScheduleGroupRequest) Retrieves the specified schedule group.default GetScheduleGroupResponse
getScheduleGroup
(GetScheduleGroupRequest getScheduleGroupRequest) Retrieves the specified schedule group.default ListScheduleGroupsResponse
listScheduleGroups
(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest) Returns a paginated list of your schedule groups.default ListScheduleGroupsResponse
listScheduleGroups
(ListScheduleGroupsRequest listScheduleGroupsRequest) Returns a paginated list of your schedule groups.default ListScheduleGroupsIterable
listScheduleGroupsPaginator
(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest) This is a variant oflistScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest)
operation.default ListScheduleGroupsIterable
listScheduleGroupsPaginator
(ListScheduleGroupsRequest listScheduleGroupsRequest) This is a variant oflistScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest)
operation.default ListSchedulesResponse
listSchedules
(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest) Returns a paginated list of your EventBridge Scheduler schedules.default ListSchedulesResponse
listSchedules
(ListSchedulesRequest listSchedulesRequest) Returns a paginated list of your EventBridge Scheduler schedules.default ListSchedulesIterable
listSchedulesPaginator
(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest) This is a variant oflistSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest)
operation.default ListSchedulesIterable
listSchedulesPaginator
(ListSchedulesRequest listSchedulesRequest) This is a variant oflistSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with the Scheduler resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with the Scheduler resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from the specified EventBridge Scheduler schedule group.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from the specified EventBridge Scheduler schedule group.default UpdateScheduleResponse
updateSchedule
(Consumer<UpdateScheduleRequest.Builder> updateScheduleRequest) Updates the specified schedule.default UpdateScheduleResponse
updateSchedule
(UpdateScheduleRequest updateScheduleRequest) Updates the specified schedule.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createSchedule
default CreateScheduleResponse createSchedule(CreateScheduleRequest createScheduleRequest) throws ServiceQuotaExceededException, ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Creates the specified schedule.
- Parameters:
createScheduleRequest
-- Returns:
- Result of the CreateSchedule operation returned by the service.
- See Also:
-
createSchedule
default CreateScheduleResponse createSchedule(Consumer<CreateScheduleRequest.Builder> createScheduleRequest) throws ServiceQuotaExceededException, ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Creates the specified schedule.
This is a convenience which creates an instance of the
CreateScheduleRequest.Builder
avoiding the need to create one manually viaCreateScheduleRequest.builder()
- Parameters:
createScheduleRequest
- AConsumer
that will call methods onCreateScheduleRequest.Builder
to create a request.- Returns:
- Result of the CreateSchedule operation returned by the service.
- See Also:
-
createScheduleGroup
default CreateScheduleGroupResponse createScheduleGroup(CreateScheduleGroupRequest createScheduleGroupRequest) throws ServiceQuotaExceededException, ValidationException, InternalServerException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Creates the specified schedule group.
- Parameters:
createScheduleGroupRequest
-- Returns:
- Result of the CreateScheduleGroup operation returned by the service.
- See Also:
-
createScheduleGroup
default CreateScheduleGroupResponse createScheduleGroup(Consumer<CreateScheduleGroupRequest.Builder> createScheduleGroupRequest) throws ServiceQuotaExceededException, ValidationException, InternalServerException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Creates the specified schedule group.
This is a convenience which creates an instance of the
CreateScheduleGroupRequest.Builder
avoiding the need to create one manually viaCreateScheduleGroupRequest.builder()
- Parameters:
createScheduleGroupRequest
- AConsumer
that will call methods onCreateScheduleGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateScheduleGroup operation returned by the service.
- See Also:
-
deleteSchedule
default DeleteScheduleResponse deleteSchedule(DeleteScheduleRequest deleteScheduleRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Deletes the specified schedule.
- Parameters:
deleteScheduleRequest
-- Returns:
- Result of the DeleteSchedule operation returned by the service.
- See Also:
-
deleteSchedule
default DeleteScheduleResponse deleteSchedule(Consumer<DeleteScheduleRequest.Builder> deleteScheduleRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Deletes the specified schedule.
This is a convenience which creates an instance of the
DeleteScheduleRequest.Builder
avoiding the need to create one manually viaDeleteScheduleRequest.builder()
- Parameters:
deleteScheduleRequest
- AConsumer
that will call methods onDeleteScheduleRequest.Builder
to create a request.- Returns:
- Result of the DeleteSchedule operation returned by the service.
- See Also:
-
deleteScheduleGroup
default DeleteScheduleGroupResponse deleteScheduleGroup(DeleteScheduleGroupRequest deleteScheduleGroupRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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.
- See Also:
-
deleteScheduleGroup
default DeleteScheduleGroupResponse deleteScheduleGroup(Consumer<DeleteScheduleGroupRequest.Builder> deleteScheduleGroupRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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 viaDeleteScheduleGroupRequest.builder()
- Parameters:
deleteScheduleGroupRequest
- AConsumer
that will call methods onDeleteScheduleGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteScheduleGroup operation returned by the service.
- See Also:
-
getSchedule
default GetScheduleResponse getSchedule(GetScheduleRequest getScheduleRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Retrieves the specified schedule.
- Parameters:
getScheduleRequest
-- Returns:
- Result of the GetSchedule operation returned by the service.
- See Also:
-
getSchedule
default GetScheduleResponse getSchedule(Consumer<GetScheduleRequest.Builder> getScheduleRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Retrieves the specified schedule.
This is a convenience which creates an instance of the
GetScheduleRequest.Builder
avoiding the need to create one manually viaGetScheduleRequest.builder()
- Parameters:
getScheduleRequest
- AConsumer
that will call methods onGetScheduleRequest.Builder
to create a request.- Returns:
- Result of the GetSchedule operation returned by the service.
- See Also:
-
getScheduleGroup
default GetScheduleGroupResponse getScheduleGroup(GetScheduleGroupRequest getScheduleGroupRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Retrieves the specified schedule group.
- Parameters:
getScheduleGroupRequest
-- Returns:
- Result of the GetScheduleGroup operation returned by the service.
- See Also:
-
getScheduleGroup
default GetScheduleGroupResponse getScheduleGroup(Consumer<GetScheduleGroupRequest.Builder> getScheduleGroupRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Retrieves the specified schedule group.
This is a convenience which creates an instance of the
GetScheduleGroupRequest.Builder
avoiding the need to create one manually viaGetScheduleGroupRequest.builder()
- Parameters:
getScheduleGroupRequest
- AConsumer
that will call methods onGetScheduleGroupRequest.Builder
to create a request.- Returns:
- Result of the GetScheduleGroup operation returned by the service.
- See Also:
-
listScheduleGroups
default ListScheduleGroupsResponse listScheduleGroups(ListScheduleGroupsRequest listScheduleGroupsRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Returns a paginated list of your schedule groups.
- Parameters:
listScheduleGroupsRequest
-- Returns:
- Result of the ListScheduleGroups operation returned by the service.
- See Also:
-
listScheduleGroups
default ListScheduleGroupsResponse listScheduleGroups(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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 viaListScheduleGroupsRequest.builder()
- Parameters:
listScheduleGroupsRequest
- AConsumer
that will call methods onListScheduleGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListScheduleGroups operation returned by the service.
- See Also:
-
listScheduleGroupsPaginator
default ListScheduleGroupsIterable listScheduleGroupsPaginator(ListScheduleGroupsRequest listScheduleGroupsRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException This is a variant of
listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsIterable responses = client.listScheduleGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsIterable responses = client .listScheduleGroupsPaginator(request); for (software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsIterable responses = client.listScheduleGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listScheduleGroupsPaginator
default ListScheduleGroupsIterable listScheduleGroupsPaginator(Consumer<ListScheduleGroupsRequest.Builder> listScheduleGroupsRequest) throws ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException This is a variant of
listScheduleGroups(software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsIterable responses = client.listScheduleGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsIterable responses = client .listScheduleGroupsPaginator(request); for (software.amazon.awssdk.services.scheduler.model.ListScheduleGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.scheduler.paginators.ListScheduleGroupsIterable responses = client.listScheduleGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListScheduleGroupsRequest.builder()
- Parameters:
listScheduleGroupsRequest
- AConsumer
that will call methods onListScheduleGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSchedules
default ListSchedulesResponse listSchedules(ListSchedulesRequest listSchedulesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Returns a paginated list of your EventBridge Scheduler schedules.
- Parameters:
listSchedulesRequest
-- Returns:
- Result of the ListSchedules operation returned by the service.
- See Also:
-
listSchedules
default ListSchedulesResponse listSchedules(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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 viaListSchedulesRequest.builder()
- Parameters:
listSchedulesRequest
- AConsumer
that will call methods onListSchedulesRequest.Builder
to create a request.- Returns:
- Result of the ListSchedules operation returned by the service.
- See Also:
-
listSchedulesPaginator
default ListSchedulesIterable listSchedulesPaginator(ListSchedulesRequest listSchedulesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException This is a variant of
listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.scheduler.paginators.ListSchedulesIterable responses = client.listSchedulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.scheduler.paginators.ListSchedulesIterable responses = client.listSchedulesPaginator(request); for (software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.scheduler.paginators.ListSchedulesIterable responses = client.listSchedulesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listSchedulesPaginator
default ListSchedulesIterable listSchedulesPaginator(Consumer<ListSchedulesRequest.Builder> listSchedulesRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException This is a variant of
listSchedules(software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.scheduler.paginators.ListSchedulesIterable responses = client.listSchedulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.scheduler.paginators.ListSchedulesIterable responses = client.listSchedulesPaginator(request); for (software.amazon.awssdk.services.scheduler.model.ListSchedulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.scheduler.paginators.ListSchedulesIterable responses = client.listSchedulesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListSchedulesRequest.builder()
- Parameters:
listSchedulesRequest
- AConsumer
that will call methods onListSchedulesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Lists the tags associated with the Scheduler resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException Removes one or more tags from the specified EventBridge Scheduler schedule group.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateSchedule
default UpdateScheduleResponse updateSchedule(UpdateScheduleRequest updateScheduleRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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 yourUpdateSchedule
call.- Parameters:
updateScheduleRequest
-- Returns:
- Result of the UpdateSchedule operation returned by the service.
- See Also:
-
updateSchedule
default UpdateScheduleResponse updateSchedule(Consumer<UpdateScheduleRequest.Builder> updateScheduleRequest) throws ValidationException, InternalServerException, ConflictException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, SchedulerException 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 yourUpdateSchedule
call.
This is a convenience which creates an instance of the
UpdateScheduleRequest.Builder
avoiding the need to create one manually viaUpdateScheduleRequest.builder()
- Parameters:
updateScheduleRequest
- AConsumer
that will call methods onUpdateScheduleRequest.Builder
to create a request.- Returns:
- Result of the UpdateSchedule operation returned by the service.
- See Also:
-
create
Create aSchedulerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSchedulerClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-