EventBridgeScheduler class

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.

Constructors

EventBridgeScheduler.new({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createSchedule({required FlexibleTimeWindow flexibleTimeWindow, required String name, required String scheduleExpression, required Target target, ActionAfterCompletion? actionAfterCompletion, String? clientToken, String? description, DateTime? endDate, String? groupName, String? kmsKeyArn, String? scheduleExpressionTimezone, DateTime? startDate, ScheduleState? state}) → Future<CreateScheduleOutput>

Creates the specified schedule.

createScheduleGroup({required String name, String? clientToken, List<Tag>? tags}) → Future<CreateScheduleGroupOutput>

Creates the specified schedule group.

deleteSchedule({required String name, String? clientToken, String? groupName}) → Future<void>

Deletes the specified schedule.

deleteScheduleGroup({required String name, String? clientToken}) → Future<void>

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({required String name, String? groupName}) → Future<GetScheduleOutput>

Retrieves the specified schedule.

getScheduleGroup({required String name}) → Future<GetScheduleGroupOutput>

Retrieves the specified schedule group.

listScheduleGroups({int? maxResults, String? namePrefix, String? nextToken}) → Future<ListScheduleGroupsOutput>

Returns a paginated list of your schedule groups.

listSchedules({String? groupName, int? maxResults, String? namePrefix, String? nextToken, ScheduleState? state}) → Future<ListSchedulesOutput>

Returns a paginated list of your EventBridge Scheduler schedules.

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceOutput>

Lists the tags associated with the Scheduler resource.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>

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

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

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

updateSchedule({required FlexibleTimeWindow flexibleTimeWindow, required String name, required String scheduleExpression, required Target target, ActionAfterCompletion? actionAfterCompletion, String? clientToken, String? description, DateTime? endDate, String? groupName, String? kmsKeyArn, String? scheduleExpressionTimezone, DateTime? startDate, ScheduleState? state}) → Future<UpdateScheduleOutput>

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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited