---
title: "GET /datasets/{name}"
method: GET
path: "/datasets/{name}"
---

# GET /datasets/{name}

`GET /datasets/{name}`

Returns the definition of a specific DataBrew dataset.

## Path parameters

- `name` string, required

## Response `200`

Success

- DescribeDatasetResponse
  - `CreatedBy` string — The identifier (user name) of the user who created the dataset.
  - `CreateDate` string, date-time — The date and time that the dataset was created.
  - `Name` string, required — The name of the dataset.
  - `Format` 'CSV' | 'JSON' | 'PARQUET' | 'EXCEL' | 'ORC' — The file format of a dataset that is created from an Amazon S3 file or folder.
  - `FormatOptions` FormatOptions — Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.
    - `Json` object — Options that define how JSON input is to be interpreted by DataBrew.
      - `MultiLine` boolean — A value that specifies whether JSON input contains embedded new line characters.
    - `Excel` object — Options that define how Excel input is to be interpreted by DataBrew.
      - `SheetNames` SheetName[] — One or more named sheets in the Excel file that will be included in the dataset.
      - `SheetIndexes` SheetIndex[] — One or more sheet numbers in the Excel file that will be included in the dataset.
      - `HeaderRow` boolean — A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
    - `Csv` object — Options that define how CSV input is to be interpreted by DataBrew.
      - `Delimiter` string — A single character that specifies the delimiter being used in the CSV file.
      - `HeaderRow` boolean — A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
  - `Input` Input, required — Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.
    - `S3InputDefinition` object — The Amazon S3 location where the data is stored.
      - `Bucket` string, required — The Amazon S3 bucket name.
      - `Key` string — The unique name of the object in the bucket.
      - `BucketOwner` string — The Amazon Web Services account ID of the bucket owner.
    - `DataCatalogInputDefinition` object — The Glue Data Catalog parameters for the data.
      - `CatalogId` string — The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.
      - `DatabaseName` string, required — The name of a database in the Data Catalog.
      - `TableName` string, required — The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.
      - `TempDirectory` object — Represents an Amazon location where DataBrew can store intermediate results.
        - `Bucket` string, required — The Amazon S3 bucket name.
        - `Key` string — The unique name of the object in the bucket.
        - `BucketOwner` string — The Amazon Web Services account ID of the bucket owner.
    - `DatabaseInputDefinition` object — Connection information for dataset input files stored in a database.
      - `GlueConnectionName` string, required — The Glue Connection that stores the connection information for the target database.
      - `DatabaseTableName` string — The table within the target database.
      - `TempDirectory` S3Location — Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
        - `Bucket` string, required — The Amazon S3 bucket name.
        - `Key` string — The unique name of the object in the bucket.
        - `BucketOwner` string — The Amazon Web Services account ID of the bucket owner.
      - `QueryString` string — Custom SQL to run against the provided Glue connection. This SQL will be used as the input for DataBrew projects and jobs.
    - `Metadata` object — Contains additional resource information needed for specific datasets.
      - `SourceArn` string — The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow.
  - `LastModifiedDate` string, date-time — The date and time that the dataset was last modified.
  - `LastModifiedBy` string — The identifier (user name) of the user who last modified the dataset.
  - `Source` 'S3' | 'DATA-CATALOG' | 'DATABASE' — The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.
  - `PathOptions` object — A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
    - `LastModifiedDateCondition` object — If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.
      - `Expression` string, required — The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, "(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)". Substitution variables should start with ':' symbol.
      - `ValuesMap` object, required — The map of substitution variable names to their values used in this filter expression.
    - `FilesLimit` object — If provided, this structure imposes a limit on a number of files that should be selected.
      - `MaxFiles` integer, required — The number of Amazon S3 files to select.
      - `OrderedBy` 'LAST_MODIFIED_DATE' — A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only allowed value.
      - `Order` 'DESCENDING' | 'ASCENDING' — A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Another possible value is ASCENDING.
    - `Parameters` object — A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
  - `Tags` object — Metadata tags associated with this dataset.
  - `ResourceArn` string — The Amazon Resource Name (ARN) of the dataset.

## Other responses

- `480` — ResourceNotFoundException
- `481` — ValidationException

---

[API](https://skmtc.net/aws/apis/databrew.md) · [All operations](https://skmtc.net/aws/apis/databrew/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/databrew/versions/c06b9719d66f/schema)