aws-elixir

View Source AWS.Scheduler (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

create_schedule(client, name, input, options \\ [])

Creates the specified schedule.

create_schedule_group(client, name, input, options \\ [])

Creates the specified schedule group.

delete_schedule(client, name, input, options \\ [])

Deletes the specified schedule.

delete_schedule_group(client, name, input, options \\ [])

Deletes the specified schedule group.

get_schedule(client, name, group_name \\ nil, options \\ [])

Retrieves the specified schedule.

get_schedule_group(client, name, options \\ [])

Retrieves the specified schedule group.

list_schedule_groups(client, max_results \\ nil, name_prefix \\ nil, next_token \\ nil, options \\ [])

Returns a paginated list of your schedule groups.

list_schedules(client, group_name \\ nil, max_results \\ nil, name_prefix \\ nil, next_token \\ nil, state \\ nil, options \\ [])

Returns a paginated list of your EventBridge Scheduler schedules.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags associated with the Scheduler resource.

metadata()
tag_resource(client, resource_arn, input, options \\ [])

Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.

untag_resource(client, resource_arn, input, options \\ [])

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

update_schedule(client, name, input, options \\ [])

Updates the specified schedule.

Link to this section Functions

Link to this function

create_schedule(client, name, input, options \\ [])

View Source

Creates the specified schedule.

Link to this function

create_schedule_group(client, name, input, options \\ [])

View Source

Creates the specified schedule group.

Link to this function

delete_schedule(client, name, input, options \\ [])

View Source

Deletes the specified schedule.

Link to this function

delete_schedule_group(client, name, input, options \\ [])

View Source

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.

Link to this function

get_schedule(client, name, group_name \\ nil, options \\ [])

View Source

Retrieves the specified schedule.

Link to this function

get_schedule_group(client, name, options \\ [])

View Source

Retrieves the specified schedule group.

Link to this function

list_schedule_groups(client, max_results \\ nil, name_prefix \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a paginated list of your schedule groups.

Link to this function

list_schedules(client, group_name \\ nil, max_results \\ nil, name_prefix \\ nil, next_token \\ nil, state \\ nil, options \\ [])

View Source

Returns a paginated list of your EventBridge Scheduler schedules.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags associated with the Scheduler resource.

Link to this function

metadata()

View Source
Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.

You can only assign tags to schedule groups.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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

Link to this function

update_schedule(client, name, input, options \\ [])

View Source

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.