workflow_run_properties
Creates, updates, deletes, gets or lists a workflow_run_properties resource.
Overview
| Name | workflow_run_properties |
| Type | Resource |
| Id | aws.glue.workflow_run_properties |
Fields
The following fields are returned by SELECT queries:
- get_workflow_run_properties
| Name | Datatype | Description |
|---|---|---|
run_properties | object | The workflow run properties which were set during the specified run. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_workflow_run_properties | select | region | Retrieves the workflow run properties which were set during the run. | |
put_workflow_run_properties | replace | region, Name, RunId, RunProperties | Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_workflow_run_properties
Retrieves the workflow run properties which were set during the run.
SELECT
run_properties
FROM aws.glue.workflow_run_properties
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_workflow_run_properties
Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.
REPLACE aws.glue.workflow_run_properties
SET
Name = '{{ Name }}',
RunId = '{{ RunId }}',
RunProperties = '{{ RunProperties }}'
WHERE
region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND RunId = '{{ RunId }}' --required
AND RunProperties = '{{ RunProperties }}' --required;