schedules

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

Overview

Name	schedules
Type	Resource
Id	aws.databrew.schedules

Fields

The following fields are returned by SELECT queries:

describe_schedule

Name	Datatype	Description
create_date	string (date-time)	The date and time that the schedule was created.
created_by	string	The identifier (user name) of the user who created the schedule.
cron_expression	string	The date or dates and time or times when the jobs are to be run for the schedule. For more information, see Cron expressions in the Glue DataBrew Developer Guide.
job_names	array	The name or names of one or more jobs to be run by using the schedule.
last_modified_by	string	The identifier (user name) of the user who last modified the schedule.
last_modified_date	string (date-time)	The date and time that the schedule was last modified.
name	string	The name of the schedule.
resource_arn	string	The Amazon Resource Name (ARN) of the schedule.
tags	object	Metadata tags associated with this schedule.

list_schedules

Name	Datatype	Description
account_id	string	The ID of the Amazon Web Services account that owns the schedule.
create_date	string (date-time)	The date and time that the schedule was created.
created_by	string	The Amazon Resource Name (ARN) of the user who created the schedule.
cron_expression	string	The dates and times when the job is to run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.
job_names	array	A list of jobs to be run, according to the schedule.
last_modified_by	string	The Amazon Resource Name (ARN) of the user who last modified the schedule.
last_modified_date	string (date-time)	The date and time when the schedule was last modified.
name	string	The name of the schedule.
resource_arn	string	The Amazon Resource Name (ARN) of the schedule.
tags	object	Metadata tags that have been applied to the schedule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_schedule	select	name, region		Returns the definition of a specific DataBrew schedule.
list_schedules	select	region	jobName, maxResults, nextToken	Lists the DataBrew schedules that are defined.
create_schedule	insert	region, CronExpression		Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
update_schedule	update	name, region, CronExpression		Modifies the definition of an existing DataBrew schedule.
delete_schedule	delete	name, region		Deletes the specified DataBrew schedule.

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 to be deleted.
region	string	AWS region (default: us-east-1)
jobName	string	The name of the job that these schedules apply to.
maxResults	integer	The maximum number of results to return in this request.
nextToken	string	The token returned by a previous call to retrieve the next set of results.

SELECT examples

describe_schedule

Returns the definition of a specific DataBrew schedule.

SELECT
create_date,
created_by,
cron_expression,
job_names,
last_modified_by,
last_modified_date,
name,
resource_arn,
tags
FROM aws.databrew.schedules
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_schedules

Lists the DataBrew schedules that are defined.

SELECT
account_id,
create_date,
created_by,
cron_expression,
job_names,
last_modified_by,
last_modified_date,
name,
resource_arn,
tags
FROM aws.databrew.schedules
WHERE region = '{{ region }}' -- required
AND jobName = '{{ jobName }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_schedule

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.

INSERT INTO aws.databrew.schedules (
JobNames,
CronExpression,
Tags,
Name,
region
)
SELECT 
'{{ JobNames }}',
'{{ CronExpression }}' /* required */,
'{{ Tags }}',
'{{ Name }}',
'{{ region }}'
RETURNING
name
;

Manifest

# Description fields are for documentation purposes
- name: schedules
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the schedules resource.
  - name: JobNames
    value:
      - "{{ JobNames }}"
  - name: CronExpression
    value: "{{ CronExpression }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: Name
    value: "{{ Name }}"

UPDATE examples

update_schedule

Modifies the definition of an existing DataBrew schedule.

UPDATE aws.databrew.schedules
SET 
JobNames = '{{ JobNames }}',
CronExpression = '{{ CronExpression }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND CronExpression = '{{ CronExpression }}' --required
RETURNING
name;

DELETE examples

delete_schedule

Deletes the specified DataBrew schedule.

DELETE FROM aws.databrew.schedules
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;