POST

/projects

http://databrew.{region}.amazonaws.com/projects

Creates a new DataBrew project.

Access Token Required: API Key

Body Params

Namestringrequired

A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Tagsobject

Metadata tags to apply to this project.

Sampleobject

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

RoleArnstringrequired

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed for this request.

RecipeNamestringrequired

The name of an existing recipe to associate with the project.

DatasetNamestringrequired

The name of an existing dataset to associate this project with.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://databrew.{region}.amazonaws.com/projects' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}