[ aws . databrew ]



Returns the definition of a specific DataBrew project.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--name (string)

The name of the project to be described.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


CreateDate -> (timestamp)

The date and time that the project was created.

CreatedBy -> (string)

The identifier (user name) of the user who created the project.

DatasetName -> (string)

The dataset associated with the project.

LastModifiedDate -> (timestamp)

The date and time that the project was last modified.

LastModifiedBy -> (string)

The identifier (user name) of the user who last modified the project.

Name -> (string)

The name of the project.

RecipeName -> (string)

The recipe associated with this job.

ResourceArn -> (string)

The Amazon Resource Name (ARN) of the project.

Sample -> (structure)

Represents the sample size and sampling type for DataBrew to use for interactive data analysis.

Size -> (integer)

The number of rows in the sample.

Type -> (string)

The way in which DataBrew obtains rows from a dataset.

RoleArn -> (string)

The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Tags -> (map)

Metadata tags associated with this project.

key -> (string)

value -> (string)

SessionStatus -> (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.

OpenedBy -> (string)

The identifier (user name) of the user that opened the project for use.

OpenDate -> (timestamp)

The date and time when the project was opened.