schedule_groups

Creates, updates, deletes, gets or lists a schedule_groups resource.

Overview

Name	schedule_groups
Type	Resource
Id	aws.scheduler.schedule_groups

Fields

The following fields are returned by SELECT queries:

get_schedule_group

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the schedule group. (pattern: <code>^arn:aws(-[a-z]+)?:scheduler:[a-z0-9-]+:\d{12}:schedule-group/[0-9a-zA-Z-_.]+$</code>)
creation_date	string (date-time)	The time at which the schedule group was created.
last_modification_date	string (date-time)	The time at which the schedule group was last modified.
name	string	The name of the schedule group. (pattern: <code>^[0-9a-zA-Z-_.]+$</code>)
state	string	Specifies the state of the schedule group. (ACTIVE, DELETING)

list_schedule_groups

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the schedule group. (pattern: <code>^arn:aws(-[a-z]+)?:scheduler:[a-z0-9-]+:\d{12}:schedule-group/[0-9a-zA-Z-_.]+$</code>)
creation_date	string (date-time)	The time at which the schedule group was created.
last_modification_date	string (date-time)	The time at which the schedule group was last modified.
name	string	The name of the schedule group. (pattern: <code>^[0-9a-zA-Z-_.]+$</code>)
state	string	Specifies the state of the schedule group. (ACTIVE, DELETING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_schedule_group	select	name, region		Retrieves the specified schedule group.
list_schedule_groups	select	region	MaxResults, NamePrefix, NextToken	Returns a paginated list of your schedule groups.
create_schedule_group	insert	name, region		Creates the specified schedule group.
delete_schedule_group	delete	name, region	clientToken	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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the schedule group to delete.
region	string	AWS region (default: us-east-1)
MaxResults	integer	If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
NamePrefix	string	The name prefix that you can use to return a filtered list of your schedule groups.
NextToken	string	The token returned by a previous call to retrieve the next set of results.
clientToken	string	Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

SELECT examples

get_schedule_group

Retrieves the specified schedule group.

SELECT
arn,
creation_date,
last_modification_date,
name,
state
FROM aws.scheduler.schedule_groups
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_schedule_groups

Returns a paginated list of your schedule groups.

SELECT
arn,
creation_date,
last_modification_date,
name,
state
FROM aws.scheduler.schedule_groups
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NamePrefix = '{{ NamePrefix }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_schedule_group

Creates the specified schedule group.

INSERT INTO aws.scheduler.schedule_groups (
ClientToken,
Tags,
name,
region
)
SELECT 
'{{ ClientToken }}',
'{{ Tags }}',
'{{ name }}',
'{{ region }}'
RETURNING
schedule_group_arn
;

Manifest

# Description fields are for documentation purposes
- name: schedule_groups
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the schedule_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the schedule_groups resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_schedule_group

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.

DELETE FROM aws.scheduler.schedule_groups
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;