projects

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

Overview

Name	projects
Type	Resource
Id	aws.databrew.projects

Fields

The following fields are returned by SELECT queries:

describe_project

Name	Datatype	Description
create_date	string (date-time)	The date and time that the project was created.
created_by	string	The identifier (user name) of the user who created the project.
dataset_name	string	The dataset associated with the project.
last_modified_by	string	The identifier (user name) of the user who last modified the project.
last_modified_date	string (date-time)	The date and time that the project was last modified.
name	string	The name of the project.
open_date	string (date-time)	The date and time when the project was opened.
opened_by	string	The identifier (user name) of the user that opened the project for use.
recipe_name	string	The recipe associated with this job.
resource_arn	string	The Amazon Resource Name (ARN) of the project.
role_arn	string	The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
sample	object	Represents the sample size and sampling type for DataBrew to use for interactive data analysis.
session_status	string	Describes the current state of the session: PROVISIONING - allocating resources for the session. INITIALIZING - getting the session ready for first use. ASSIGNED - the session is ready for use. (ASSIGNED, FAILED, INITIALIZING, PROVISIONING, READY, RECYCLING, ROTATING, TERMINATED, TERMINATING, UPDATING)
tags	object	Metadata tags associated with this project.

list_projects

Name	Datatype	Description
account_id	string	The ID of the Amazon Web Services account that owns the project.
create_date	string (date-time)	The date and time that the project was created.
created_by	string	The Amazon Resource Name (ARN) of the user who crated the project.
dataset_name	string	The dataset that the project is to act upon.
last_modified_by	string	The Amazon Resource Name (ARN) of the user who last modified the project.
last_modified_date	string (date-time)	The last modification date and time for the project.
name	string	The unique name of a project.
open_date	string (date-time)	The date and time when the project was opened.
opened_by	string	The Amazon Resource Name (ARN) of the user that opened the project for use.
recipe_name	string	The name of a recipe that will be developed during a project session.
resource_arn	string	The Amazon Resource Name (ARN) for the project.
role_arn	string	The Amazon Resource Name (ARN) of the role that will be assumed for this project.
sample	object	Represents the sample size and sampling type for DataBrew to use for interactive data analysis.
tags	object	Metadata tags that have been applied to the project.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_project	select	name, region		Returns the definition of a specific DataBrew project.
list_projects	select	region	nextToken, maxResults	Lists all of the DataBrew projects that are defined.
create_project	insert	region, DatasetName, RecipeName, RoleArn		Creates a new DataBrew project.
update_project	update	name, region, RoleArn		Modifies the definition of an existing DataBrew project.
delete_project	delete	name, region		Deletes an existing DataBrew project.
send_project_session_action	exec	name, region		Performs a recipe step within an interactive DataBrew session that's currently open.
start_project_session	exec	name, region		Creates an interactive session, enabling you to manipulate data in a DataBrew project.

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 project to act upon.
region	string	AWS region (default: us-east-1)
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_project

Returns the definition of a specific DataBrew project.

SELECT
create_date,
created_by,
dataset_name,
last_modified_by,
last_modified_date,
name,
open_date,
opened_by,
recipe_name,
resource_arn,
role_arn,
sample,
session_status,
tags
FROM aws.databrew.projects
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_projects

Lists all of the DataBrew projects that are defined.

SELECT
account_id,
create_date,
created_by,
dataset_name,
last_modified_by,
last_modified_date,
name,
open_date,
opened_by,
recipe_name,
resource_arn,
role_arn,
sample,
tags
FROM aws.databrew.projects
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_project

Creates a new DataBrew project.

INSERT INTO aws.databrew.projects (
DatasetName,
Name,
RecipeName,
Sample,
RoleArn,
Tags,
region
)
SELECT 
'{{ DatasetName }}' /* required */,
'{{ Name }}',
'{{ RecipeName }}' /* required */,
'{{ Sample }}',
'{{ RoleArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
name
;

Manifest

# Description fields are for documentation purposes
- name: projects
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the projects resource.
  - name: DatasetName
    value: "{{ DatasetName }}"
  - name: Name
    value: "{{ Name }}"
  - name: RecipeName
    value: "{{ RecipeName }}"
  - name: Sample
    description: |
      Represents the sample size and sampling type for DataBrew to use for interactive data analysis.
    value:
      Size: {{ Size }}
      Type: "{{ Type }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_project

Modifies the definition of an existing DataBrew project.

UPDATE aws.databrew.projects
SET 
Sample = '{{ Sample }}',
RoleArn = '{{ RoleArn }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND RoleArn = '{{ RoleArn }}' --required
RETURNING
last_modified_date,
name;

DELETE examples

delete_project

Deletes an existing DataBrew project.

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

Lifecycle Methods

send_project_session_action

Performs a recipe step within an interactive DataBrew session that's currently open.

EXEC aws.databrew.projects.send_project_session_action 
@name='{{ name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Preview": {{ Preview }}, 
"RecipeStep": "{{ RecipeStep }}", 
"StepIndex": {{ StepIndex }}, 
"ClientSessionId": "{{ ClientSessionId }}", 
"ViewFrame": "{{ ViewFrame }}"
}'
;

start_project_session

Creates an interactive session, enabling you to manipulate data in a DataBrew project.

EXEC aws.databrew.projects.start_project_session 
@name='{{ name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"AssumeControl": {{ AssumeControl }}
}'
;