Amazon Glue DataBrew Datasets API

The Datasets API from Amazon Glue DataBrew — 2 operation(s) for datasets.

GitHub OpenAPI
Business capability
Information & Data Management BC-610

Operations 5

POST /datasets Create Dataset #
GET /datasets List Datasets #
DELETE /datasets/{Name} Delete Dataset #
GET /datasets/{Name} Describe Dataset #
PUT /datasets/{Name} Update Dataset #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-glue-databrew:amazon-glue-databrew-datasets-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-glue-databrew-datasets-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Glue DataBrew Datasets API
  version: '2017-07-25'
  description: Generated from AWS's published Smithy model for AWS Glue DataBrew. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://databrew.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /datasets:
    post:
      operationId: CreateDataset
      summary: Create Dataset
      description: Creates a new DataBrew dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDatasetResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatasetRequest'
      tags:
      - Datasets
    get:
      operationId: ListDatasets
      summary: List Datasets
      description: Lists all of the DataBrew datasets.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetsResponse'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDatasetsRequest'
      tags:
      - Datasets
  /datasets/{Name}:
    delete:
      operationId: DeleteDataset
      summary: Delete Dataset
      description: Deletes a dataset from DataBrew.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDatasetResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDatasetRequest'
      tags:
      - Datasets
    get:
      operationId: DescribeDataset
      summary: Describe Dataset
      description: Returns the definition of a specific DataBrew dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDatasetResponse'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDatasetRequest'
      tags:
      - Datasets
    put:
      operationId: UpdateDataset
      summary: Update Dataset
      description: Modifies the definition of an existing DataBrew dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDatasetResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatasetRequest'
      tags:
      - Datasets
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: databrew
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateDatasetRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-),
            period (.), and space.
        Format:
          type: string
          enum:
          - CSV
          - JSON
          - PARQUET
          - EXCEL
          - ORC
          description: The file format of a dataset that is created from an Amazon S3 file or folder.
        FormatOptions:
          $ref: '#/components/schemas/FormatOptions'
        Input:
          $ref: '#/components/schemas/Input'
        PathOptions:
          $ref: '#/components/schemas/PathOptions'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Metadata tags to apply to this dataset.
      required:
      - Name
      - Input
    CreateDatasetResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the dataset that you created.
      required:
      - Name
    CsvOptions:
      type: object
      properties:
        Delimiter:
          type: string
          description: A single character that specifies the delimiter being used in the CSV file.
        HeaderRow:
          type: boolean
          description: 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.
    DataCatalogInputDefinition:
      type: object
      properties:
        CatalogId:
          type: string
          description: The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the
            data.
        DatabaseName:
          type: string
          description: The name of a database in the Data Catalog.
        TableName:
          type: string
          description: The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.
        TempDirectory:
          $ref: '#/components/schemas/S3Location'
      required:
      - DatabaseName
      - TableName
    DatabaseInputDefinition:
      type: object
      properties:
        GlueConnectionName:
          type: string
          description: The Glue Connection that stores the connection information for the target database.
        DatabaseTableName:
          type: string
          description: The table within the target database.
        TempDirectory:
          $ref: '#/components/schemas/S3Location'
        QueryString:
          type: string
          description: Custom SQL to run against the provided Glue connection. This SQL will be used as the input for DataBrew
            projects and jobs.
      required:
      - GlueConnectionName
    Dataset:
      type: object
      properties:
        AccountId:
          type: string
          description: The ID of the Amazon Web Services account that owns the dataset.
        CreatedBy:
          type: string
          description: The Amazon Resource Name (ARN) of the user who created the dataset.
        CreateDate:
          type: string
          format: date-time
          description: The date and time that the dataset was created.
        Name:
          type: string
          description: The unique name of the dataset.
        Format:
          type: string
          enum:
          - CSV
          - JSON
          - PARQUET
          - EXCEL
          - ORC
          description: The file format of a dataset that is created from an Amazon S3 file or folder.
        FormatOptions:
          $ref: '#/components/schemas/FormatOptions'
        Input:
          $ref: '#/components/schemas/Input'
        LastModifiedDate:
          type: string
          format: date-time
          description: The last modification date and time of the dataset.
        LastModifiedBy:
          type: string
          description: The Amazon Resource Name (ARN) of the user who last modified the dataset.
        Source:
          type: string
          enum:
          - S3
          - DATA-CATALOG
          - DATABASE
          description: The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.
        PathOptions:
          $ref: '#/components/schemas/PathOptions'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Metadata tags that have been applied to the dataset.
        ResourceArn:
          type: string
          description: The unique Amazon Resource Name (ARN) for the dataset.
      required:
      - Name
      - Input
    DatasetParameter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the parameter that is used in the dataset's Amazon S3 path.
        Type:
          type: string
          enum:
          - Datetime
          - Number
          - String
          description: The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
        DatetimeOptions:
          $ref: '#/components/schemas/DatetimeOptions'
        CreateColumn:
          type: boolean
          description: Optional boolean value that defines whether the captured value of this parameter should be used to
            create a new column in a dataset.
        Filter:
          $ref: '#/components/schemas/FilterExpression'
      required:
      - Name
      - Type
    DatetimeOptions:
      type: object
      properties:
        Format:
          type: string
          description: Required option, that defines the datetime format used for a date parameter in the Amazon S3 path.
            Should use only supported datetime specifiers and separation characters, all literal a-z or A-Z characters should
            be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm".
        TimezoneOffset:
          type: string
          description: Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn't
            be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed.
        LocaleCode:
          type: string
          description: Optional value for a non-US locale code, needed for correct interpretation of some date formats.
      required:
      - Format
    DeleteDatasetRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the dataset to be deleted.
      required:
      - Name
    DeleteDatasetResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the dataset that you deleted.
      required:
      - Name
    DescribeDatasetRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the dataset to be described.
      required:
      - Name
    DescribeDatasetResponse:
      type: object
      properties:
        CreatedBy:
          type: string
          description: The identifier (user name) of the user who created the dataset.
        CreateDate:
          type: string
          format: date-time
          description: The date and time that the dataset was created.
        Name:
          type: string
          description: The name of the dataset.
        Format:
          type: string
          enum:
          - CSV
          - JSON
          - PARQUET
          - EXCEL
          - ORC
          description: The file format of a dataset that is created from an Amazon S3 file or folder.
        FormatOptions:
          $ref: '#/components/schemas/FormatOptions'
        Input:
          $ref: '#/components/schemas/Input'
        LastModifiedDate:
          type: string
          format: date-time
          description: The date and time that the dataset was last modified.
        LastModifiedBy:
          type: string
          description: The identifier (user name) of the user who last modified the dataset.
        Source:
          type: string
          enum:
          - S3
          - DATA-CATALOG
          - DATABASE
          description: The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.
        PathOptions:
          $ref: '#/components/schemas/PathOptions'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Metadata tags associated with this dataset.
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset.
      required:
      - Name
      - Input
    ExcelOptions:
      type: object
      properties:
        SheetNames:
          type: array
          items:
            type: string
          description: One or more named sheets in the Excel file that will be included in the dataset.
        SheetIndexes:
          type: array
          items:
            type: integer
          description: One or more sheet numbers in the Excel file that will be included in the dataset.
        HeaderRow:
          type: boolean
          description: 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.
    FilesLimit:
      type: object
      properties:
        MaxFiles:
          type: integer
          description: The number of Amazon S3 files to select.
        OrderedBy:
          type: string
          enum:
          - LAST_MODIFIED_DATE
          description: 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:
          type: string
          enum:
          - DESCENDING
          - ASCENDING
          description: 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.
      required:
      - MaxFiles
    FilterExpression:
      type: object
      properties:
        Expression:
          type: string
          description: 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:
          type: object
          additionalProperties:
            type: string
          description: The map of substitution variable names to their values used in this filter expression.
      required:
      - Expression
      - ValuesMap
    FormatOptions:
      type: object
      properties:
        Json:
          $ref: '#/components/schemas/JsonOptions'
        Excel:
          $ref: '#/components/schemas/ExcelOptions'
        Csv:
          $ref: '#/components/schemas/CsvOptions'
    Input:
      type: object
      properties:
        S3InputDefinition:
          $ref: '#/components/schemas/S3Location'
        DataCatalogInputDefinition:
          $ref: '#/components/schemas/DataCatalogInputDefinition'
        DatabaseInputDefinition:
          $ref: '#/components/schemas/DatabaseInputDefinition'
        Metadata:
          $ref: '#/components/schemas/Metadata'
    JsonOptions:
      type: object
      properties:
        MultiLine:
          type: boolean
          description: A value that specifies whether JSON input contains embedded new line characters.
    ListDatasetsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of results to return in this request.
        NextToken:
          type: string
          description: The token returned by a previous call to retrieve the next set of results.
    ListDatasetsResponse:
      type: object
      properties:
        Datasets:
          type: array
          items:
            $ref: '#/components/schemas/Dataset'
          description: A list of datasets that are defined.
        NextToken:
          type: string
          description: A token that you can use in a subsequent call to retrieve the next set of results.
      required:
      - Datasets
    Metadata:
      type: object
      properties:
        SourceArn:
          type: string
          description: The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs
            from Amazon AppFlow.
    PathOptions:
      type: object
      properties:
        LastModifiedDateCondition:
          $ref: '#/components/schemas/FilterExpression'
        FilesLimit:
          $ref: '#/components/schemas/FilesLimit'
        Parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DatasetParameter'
          description: A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    S3Location:
      type: object
      properties:
        Bucket:
          type: string
          description: The Amazon S3 bucket name.
        Key:
          type: string
          description: The unique name of the object in the bucket.
        BucketOwner:
          type: string
          description: The Amazon Web Services account ID of the bucket owner.
      required:
      - Bucket
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    UpdateDatasetRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the dataset to be updated.
        Format:
          type: string
          enum:
          - CSV
          - JSON
          - PARQUET
          - EXCEL
          - ORC
          description: The file format of a dataset that is created from an Amazon S3 file or folder.
        FormatOptions:
          $ref: '#/components/schemas/FormatOptions'
        Input:
          $ref: '#/components/schemas/Input'
        PathOptions:
          $ref: '#/components/schemas/PathOptions'
      required:
      - Name
      - Input
    UpdateDatasetResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the dataset that you updated.
      required:
      - Name
    ValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/databrew/service/2017-07-25/databrew-2017-07-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)