[ aws . databrew ]

list-projects

Description

Lists all of the DataBrew projects that are defined.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-projects is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Projects

Synopsis

  list-projects
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Output

Projects -> (list)

A list of projects that are defined .

(structure)

Represents all of the attributes of a DataBrew project.

AccountId -> (string)

The ID of the AWS account that owns the project.

CreateDate -> (timestamp)

The date and time that the project was created.

CreatedBy -> (string)

The Amazon Resource Name (ARN) of the user who crated the project.

DatasetName -> (string)

The dataset that the project is to act upon.

LastModifiedDate -> (timestamp)

The last modification date and time for the project.

LastModifiedBy -> (string)

The Amazon Resource Name (ARN) of the user who last modified the project.

Name -> (string)

The unique name of a project.

RecipeName -> (string)

The name of a recipe that will be developed during a project session.

ResourceArn -> (string)

The Amazon Resource Name (ARN) for the project.

Sample -> (structure)

The sample size and sampling type to apply to the data. If this parameter isn’t specified, then the sample will consiste of the first 500 rows from the dataset.

Size -> (integer)

The number of rows in the sample.

Type -> (string)

The way in which DataBrew obtains rows from a dataset.

Tags -> (map)

Metadata tags that have been applied to the project.

key -> (string)

value -> (string)

RoleArn -> (string)

The Amazon Resource Name (ARN) of the role that will be assumed for this project.

OpenedBy -> (string)

The Amazon Resource Name (ARN) of the user that opened the project for use.

OpenDate -> (timestamp)

The date and time when the project was opened.

NextToken -> (string)

A token that you can use in a subsequent call to retrieve the next set of results.