Amazon Glue DataBrew · JSON Structure

Glue Databrew Dataset Parameter Structure

Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset.

Type: object Properties: 5 Required: 2
Data AnalyticsData PreparationETLMachine Learning

DatasetParameter is a JSON Structure definition published by Amazon Glue DataBrew, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Name Type DatetimeOptions CreateColumn Filter

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-glue-databrew/refs/heads/main/json-structure/glue-databrew-dataset-parameter-structure.json",
  "name": "DatasetParameter",
  "description": "Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset.",
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PathParameterName"
        },
        {
          "description": "The name of the parameter that is used in the dataset's Amazon S3 path."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ParameterType"
        },
        {
          "description": "The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'."
        }
      ]
    },
    "DatetimeOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DatetimeOptions"
        },
        {
          "description": "Additional parameter options such as a format and a timezone. Required for datetime parameters."
        }
      ]
    },
    "CreateColumn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateColumn"
        },
        {
          "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": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterExpression"
        },
        {
          "description": "The optional filter expression structure to apply additional matching criteria to the parameter."
        }
      ]
    }
  },
  "required": [
    "Name",
    "Type"
  ]
}