scheduler/aws.sdk.kotlin.services.scheduler

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createSchedule

inline suspend fun SchedulerClient.createSchedule(crossinline block: CreateScheduleRequest.Builder.() -> Unit): CreateScheduleResponse

Creates the specified schedule.

createScheduleGroup

inline suspend fun SchedulerClient.createScheduleGroup(crossinline block: CreateScheduleGroupRequest.Builder.() -> Unit): CreateScheduleGroupResponse

Creates the specified schedule group.

deleteSchedule

inline suspend fun SchedulerClient.deleteSchedule(crossinline block: DeleteScheduleRequest.Builder.() -> Unit): DeleteScheduleResponse

Deletes the specified schedule.

deleteScheduleGroup

inline suspend fun SchedulerClient.deleteScheduleGroup(crossinline block: DeleteScheduleGroupRequest.Builder.() -> Unit): DeleteScheduleGroupResponse

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.

getSchedule

inline suspend fun SchedulerClient.getSchedule(crossinline block: GetScheduleRequest.Builder.() -> Unit): GetScheduleResponse

Retrieves the specified schedule.

getScheduleGroup

inline suspend fun SchedulerClient.getScheduleGroup(crossinline block: GetScheduleGroupRequest.Builder.() -> Unit): GetScheduleGroupResponse

Retrieves the specified schedule group.

listScheduleGroups

inline suspend fun SchedulerClient.listScheduleGroups(crossinline block: ListScheduleGroupsRequest.Builder.() -> Unit): ListScheduleGroupsResponse

Returns a paginated list of your schedule groups.

listSchedules

inline suspend fun SchedulerClient.listSchedules(crossinline block: ListSchedulesRequest.Builder.() -> Unit): ListSchedulesResponse

Returns a paginated list of your EventBridge Scheduler schedules.

listTagsForResource

inline suspend fun SchedulerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags associated with the Scheduler resource.

tagResource

inline suspend fun SchedulerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun SchedulerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

updateSchedule

inline suspend fun SchedulerClient.updateSchedule(crossinline block: UpdateScheduleRequest.Builder.() -> Unit): UpdateScheduleResponse

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.

withConfig

fun SchedulerClient.withConfig(block: SchedulerClient.Config.Builder.() -> Unit): SchedulerClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.