data_source_runs

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

Overview

Name	data_source_runs
Type	Resource
Id	aws.datazone.data_source_runs

Fields

The following fields are returned by SELECT queries:

get_data_source_run

Name	Datatype	Description
id	string	The ID of the data source run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
created_at	string (date-time)	The timestamp of when the data source run was created.
data_source_configuration_snapshot	string	The configuration snapshot of the data source run.
data_source_id	string	The ID of the data source for this data source run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
domain_id	string	The ID of the domain in which this data source run was performed. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
error_message	object	The details of the error message that is returned if the operation cannot be successfully completed.
lineage_summary	object	The summary of the data lineage.
project_id	string	The ID of the project in which this data source run occured. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
run_statistics_for_assets	object	The asset statistics from this data source run.
started_at	string (date-time)	The timestamp of when this data source run started.
status	string	The status of this data source run. (REQUESTED, RUNNING, FAILED, PARTIALLY_SUCCEEDED, SUCCESS)
stopped_at	string (date-time)	The timestamp of when this data source run stopped.
type_	string	The type of this data source run. (PRIORITIZED, SCHEDULED)
updated_at	string (date-time)	The timestamp of when this data source run was updated.

list_data_source_runs

Name	Datatype	Description
id	string	The identifier of the data source run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
created_at	string (date-time)	The timestamp of when a data source run was created.
data_source_id	string	The identifier of the data source of the data source run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
error_message	object	The details of the error message that is returned if the operation cannot be successfully completed.
lineage_summary	object	The run lineage summary of a data source.
project_id	string	The project ID of the data source run. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
run_statistics_for_assets	object	The asset statistics from the data source run.
started_at	string (date-time)	The timestamp of when a data source run was started.
status	string	The status of the data source run. (REQUESTED, RUNNING, FAILED, PARTIALLY_SUCCEEDED, SUCCESS)
stopped_at	string (date-time)	The timestamp of when a data source run was stopped.
type_	string	The type of the data source run. (PRIORITIZED, SCHEDULED)
updated_at	string (date-time)	The timestamp of when a data source run was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_source_run	select	domain_identifier, identifier, region		Gets an Amazon DataZone data source run.
list_data_source_runs	select	domain_identifier, data_source_identifier, region	status, nextToken, maxResults	Lists data source runs in Amazon DataZone.

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
data_source_identifier	string	The identifier of the data source.
domain_identifier	string	The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.
identifier	string	The ID of the data source run.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of runs to return in a single call to ListDataSourceRuns. When the number of runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSourceRuns to list the next set of runs.
nextToken	string	When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.
status	string	The status of the data source.

SELECT examples

get_data_source_run

Gets an Amazon DataZone data source run.

SELECT
id,
created_at,
data_source_configuration_snapshot,
data_source_id,
domain_id,
error_message,
lineage_summary,
project_id,
run_statistics_for_assets,
started_at,
status,
stopped_at,
type_,
updated_at
FROM aws.datazone.data_source_runs
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_data_source_runs

Lists data source runs in Amazon DataZone.

SELECT
id,
created_at,
data_source_id,
error_message,
lineage_summary,
project_id,
run_statistics_for_assets,
started_at,
status,
stopped_at,
type_,
updated_at
FROM aws.datazone.data_source_runs
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND data_source_identifier = '{{ data_source_identifier }}' -- required
AND region = '{{ region }}' -- required
AND status = '{{ status }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;