Class: AWS.DataBrew

var params = {
  Input: { /* required */
    DataCatalogInputDefinition: {
      DatabaseName: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      TempDirectory: {
        Bucket: 'STRING_VALUE', /* required */
        BucketOwner: 'STRING_VALUE',
        Key: 'STRING_VALUE'
      }
    },
    DatabaseInputDefinition: {
      GlueConnectionName: 'STRING_VALUE', /* required */
      DatabaseTableName: 'STRING_VALUE',
      QueryString: 'STRING_VALUE',
      TempDirectory: {
        Bucket: 'STRING_VALUE', /* required */
        BucketOwner: 'STRING_VALUE',
        Key: 'STRING_VALUE'
      }
    },
    Metadata: {
      SourceArn: 'STRING_VALUE'
    },
    S3InputDefinition: {
      Bucket: 'STRING_VALUE', /* required */
      BucketOwner: 'STRING_VALUE',
      Key: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE', /* required */
  Format: CSV | JSON | PARQUET | EXCEL | ORC,
  FormatOptions: {
    Csv: {
      Delimiter: 'STRING_VALUE',
      HeaderRow: true || false
    },
    Excel: {
      HeaderRow: true || false,
      SheetIndexes: [
        'NUMBER_VALUE',
        /* more items */
      ],
      SheetNames: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Json: {
      MultiLine: true || false
    }
  },
  PathOptions: {
    FilesLimit: {
      MaxFiles: 'NUMBER_VALUE', /* required */
      Order: DESCENDING | ASCENDING,
      OrderedBy: LAST_MODIFIED_DATE
    },
    LastModifiedDateCondition: {
      Expression: 'STRING_VALUE', /* required */
      ValuesMap: { /* required */
        '<ValueReference>': 'STRING_VALUE',
        /* '<ValueReference>': ... */
      }
    },
    Parameters: {
      '<PathParameterName>': {
        Name: 'STRING_VALUE', /* required */
        Type: Datetime | Number | String, /* required */
        CreateColumn: true || false,
        DatetimeOptions: {
          Format: 'STRING_VALUE', /* required */
          LocaleCode: 'STRING_VALUE',
          TimezoneOffset: 'STRING_VALUE'
        },
        Filter: {
          Expression: 'STRING_VALUE', /* required */
          ValuesMap: { /* required */
            '<ValueReference>': 'STRING_VALUE',
            /* '<ValueReference>': ... */
          }
        }
      },
      /* '<PathParameterName>': ... */
    }
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
databrew.createDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

  • Format — (String)

    The file format of a dataset that is created from an Amazon S3 file or folder.

    Possible values include:
    • "CSV"
    • "JSON"
    • "PARQUET"
    • "EXCEL"
    • "ORC"
  • FormatOptions — (map)

    Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.

    • Json — (map)

      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 — (map)

      Options that define how Excel input is to be interpreted by DataBrew.

      • SheetNames — (Array<String>)

        One or more named sheets in the Excel file that will be included in the dataset.

      • SheetIndexes — (Array<Integer>)

        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 — (map)

      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 — (map)

    Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3.

    • S3InputDefinition — (map)

      The Amazon S3 location where the data is stored.

      • Bucket — required — (String)

        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 — (map)

      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 — required — (String)

        The name of a database in the Data Catalog.

      • TableName — required — (String)

        The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.

      • TempDirectory — (map)

        Represents an Amazon location where DataBrew can store intermediate results.

        • Bucket — required — (String)

          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 — (map)

      Connection information for dataset input files stored in a database.

      • GlueConnectionName — required — (String)

        The Glue Connection that stores the connection information for the target database.

      • DatabaseTableName — (String)

        The table within the target database.

      • TempDirectory — (map)

        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 — required — (String)

          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 — (map)

      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.

  • PathOptions — (map)

    A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

    • LastModifiedDateCondition — (map)

      If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.

      • Expression — required — (String)

        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 — required — (map<String>)

        The map of substitution variable names to their values used in this filter expression.

    • FilesLimit — (map)

      If provided, this structure imposes a limit on a number of files that should be selected.

      • MaxFiles — required — (Integer)

        The number of Amazon S3 files to select.

      • OrderedBy — (String)

        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.

        Possible values include:
        • "LAST_MODIFIED_DATE"
      • Order — (String)

        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.

        Possible values include:
        • "DESCENDING"
        • "ASCENDING"
    • Parameters — (map<map>)

      A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

      • Name — required — (String)

        The name of the parameter that is used in the dataset's Amazon S3 path.

      • Type — required — (String)

        The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

        Possible values include:
        • "Datetime"
        • "Number"
        • "String"
      • DatetimeOptions — (map)

        Additional parameter options such as a format and a timezone. Required for datetime parameters.

        • Format — required — (String)

          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 — (String)

          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 — (String)

          Optional value for a non-US locale code, needed for correct interpretation of some date formats.

      • CreateColumn — (Boolean)

        Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

      • Filter — (map)

        The optional filter expression structure to apply additional matching criteria to the parameter.

        • Expression — required — (String)

          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 — required — (map<String>)

          The map of substitution variable names to their values used in this filter expression.

  • Tags — (map<String>)

    Metadata tags to apply to this dataset.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the dataset that you created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DatasetName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  OutputLocation: { /* required */
    Bucket: 'STRING_VALUE', /* required */
    BucketOwner: 'STRING_VALUE',
    Key: 'STRING_VALUE'
  },
  RoleArn: 'STRING_VALUE', /* required */
  Configuration: {
    ColumnStatisticsConfigurations: [
      {
        Statistics: { /* required */
          IncludedStatistics: [
            'STRING_VALUE',
            /* more items */
          ],
          Overrides: [
            {
              Parameters: { /* required */
                '<ParameterName>': 'STRING_VALUE',
                /* '<ParameterName>': ... */
              },
              Statistic: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        Selectors: [
          {
            Name: 'STRING_VALUE',
            Regex: 'STRING_VALUE'
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    DatasetStatisticsConfiguration: {
      IncludedStatistics: [
        'STRING_VALUE',
        /* more items */
      ],
      Overrides: [
        {
          Parameters: { /* required */
            '<ParameterName>': 'STRING_VALUE',
            /* '<ParameterName>': ... */
          },
          Statistic: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    EntityDetectorConfiguration: {
      EntityTypes: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      AllowedStatistics: [
        {
          Statistics: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    ProfileColumns: [
      {
        Name: 'STRING_VALUE',
        Regex: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  EncryptionKeyArn: 'STRING_VALUE',
  EncryptionMode: SSE-KMS | SSE-S3,
  JobSample: {
    Mode: FULL_DATASET | CUSTOM_ROWS,
    Size: 'NUMBER_VALUE'
  },
  LogSubscription: ENABLE | DISABLE,
  MaxCapacity: 'NUMBER_VALUE',
  MaxRetries: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  Timeout: 'NUMBER_VALUE',
  ValidationConfigurations: [
    {
      RulesetArn: 'STRING_VALUE', /* required */
      ValidationMode: CHECK_ALL
    },
    /* more items */
  ]
};
databrew.createProfileJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DatasetName — (String)

    The name of the dataset that this job is to act upon.

  • EncryptionKeyArn — (String)

    The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

  • EncryptionMode — (String)

    The encryption mode for the job, which can be one of the following:

    • SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.

    • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

    Possible values include:
    • "SSE-KMS"
    • "SSE-S3"
  • Name — (String)

    The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

  • LogSubscription — (String)

    Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

    Possible values include:
    • "ENABLE"
    • "DISABLE"
  • MaxCapacity — (Integer)

    The maximum number of nodes that DataBrew can use when the job processes data.

  • MaxRetries — (Integer)

    The maximum number of times to retry the job after a job run fails.

  • OutputLocation — (map)

    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 — required — (String)

      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.

  • Configuration — (map)

    Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

    • DatasetStatisticsConfiguration — (map)

      Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.

      • IncludedStatistics — (Array<String>)

        List of included evaluations. When the list is undefined, all supported evaluations will be included.

      • Overrides — (Array<map>)

        List of overrides for evaluations.

        • Statistic — required — (String)

          The name of an evaluation

        • Parameters — required — (map<String>)

          A map that includes overrides of an evaluation’s parameters.

    • ProfileColumns — (Array<map>)

      List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

      • Regex — (String)

        A regular expression for selecting a column from a dataset.

      • Name — (String)

        The name of a column from a dataset.

    • ColumnStatisticsConfigurations — (Array<map>)

      List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.

      • Selectors — (Array<map>)

        List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.

        • Regex — (String)

          A regular expression for selecting a column from a dataset.

        • Name — (String)

          The name of a column from a dataset.

      • Statistics — required — (map)

        Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.

        • IncludedStatistics — (Array<String>)

          List of included evaluations. When the list is undefined, all supported evaluations will be included.

        • Overrides — (Array<map>)

          List of overrides for evaluations.

          • Statistic — required — (String)

            The name of an evaluation

          • Parameters — required — (map<String>)

            A map that includes overrides of an evaluation’s parameters.

    • EntityDetectorConfiguration — (map)

      Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

      • EntityTypes — required — (Array<String>)

        Entity types to detect. Can be any of the following:

        • USA_SSN

        • EMAIL

        • USA_ITIN

        • USA_PASSPORT_NUMBER

        • PHONE_NUMBER

        • USA_DRIVING_LICENSE

        • BANK_ACCOUNT

        • CREDIT_CARD

        • IP_ADDRESS

        • MAC_ADDRESS

        • USA_DEA_NUMBER

        • USA_HCPCS_CODE

        • USA_NATIONAL_PROVIDER_IDENTIFIER

        • USA_NATIONAL_DRUG_CODE

        • USA_HEALTH_INSURANCE_CLAIM_NUMBER

        • USA_MEDICARE_BENEFICIARY_IDENTIFIER

        • USA_CPT_CODE

        • PERSON_NAME

        • DATE

        The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

      • AllowedStatistics — (Array<map>)

        Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

        • Statistics — required — (Array<String>)

          One or more column statistics to allow for columns that contain detected entities.

  • ValidationConfigurations — (Array<map>)

    List of validation configurations that are applied to the profile job.

    • RulesetArn — required — (String)

      The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job.

    • ValidationMode — (String)

      Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset.

      Possible values include:
      • "CHECK_ALL"
  • RoleArn — (String)

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

  • Tags — (map<String>)

    Metadata tags to apply to this job.

  • Timeout — (Integer)

    The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

  • JobSample — (map)

    Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

    • Mode — (String)

      A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

      • FULL_DATASET - The profile job is run on the entire dataset.

      • CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

      Possible values include:
      • "FULL_DATASET"
      • "CUSTOM_ROWS"
    • Size — (Integer)

      The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

      Long.MAX_VALUE = 9223372036854775807

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the job that was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DatasetName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  RecipeName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  Sample: {
    Type: FIRST_N | LAST_N | RANDOM, /* required */
    Size: 'NUMBER_VALUE'
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
databrew.createProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DatasetName — (String)

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

  • Name — (String)

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

  • RecipeName — (String)

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

  • Sample — (map)

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

    • Size — (Integer)

      The number of rows in the sample.

    • Type — required — (String)

      The way in which DataBrew obtains rows from a dataset.

      Possible values include:
      • "FIRST_N"
      • "LAST_N"
      • "RANDOM"
  • RoleArn — (String)

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

  • Tags — (map<String>)

    Metadata tags to apply to this project.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the project that you created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  Steps: [ /* required */
    {
      Action: { /* required */
        Operation: 'STRING_VALUE', /* required */
        Parameters: {
          '<ParameterName>': 'STRING_VALUE',
          /* '<ParameterName>': ... */
        }
      },
      ConditionExpressions: [
        {
          Condition: 'STRING_VALUE', /* required */
          TargetColumn: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
databrew.createRecipe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Description — (String)

    A description for the recipe.

  • Name — (String)

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

  • Steps — (Array<map>)

    An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action and (optionally) an array of condition expressions.

    • Action — required — (map)

      The particular action to be performed in the recipe step.

      • Operation — required — (String)

        The name of a valid DataBrew transformation to be performed on the data.

      • Parameters — (map<String>)

        Contextual parameters for the transformation.

    • ConditionExpressions — (Array<map>)

      One or more conditions that must be met for the recipe step to succeed.

      Note: All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.
      • Condition — required — (String)

        A specific condition to apply to a recipe action. For more information, see Recipe structure in the Glue DataBrew Developer Guide.

      • Value — (String)

        A value that the condition must evaluate to for the condition to succeed.

      • TargetColumn — required — (String)

        A column to apply this condition to.

  • Tags — (map<String>)

    Metadata tags to apply to this recipe.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the recipe that you created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  DataCatalogOutputs: [
    {
      DatabaseName: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      DatabaseOptions: {
        TableName: 'STRING_VALUE', /* required */
        TempDirectory: {
          Bucket: 'STRING_VALUE', /* required */
          BucketOwner: 'STRING_VALUE',
          Key: 'STRING_VALUE'
        }
      },
      Overwrite: true || false,
      S3Options: {
        Location: { /* required */
          Bucket: 'STRING_VALUE', /* required */
          BucketOwner: 'STRING_VALUE',
          Key: 'STRING_VALUE'
        }
      }
    },
    /* more items */
  ],
  DatabaseOutputs: [
    {
      DatabaseOptions: { /* required */
        TableName: 'STRING_VALUE', /* required */
        TempDirectory: {
          Bucket: 'STRING_VALUE', /* required */
          BucketOwner: 'STRING_VALUE',
          Key: 'STRING_VALUE'
        }
      },
      GlueConnectionName: 'STRING_VALUE', /* required */
      DatabaseOutputMode: NEW_TABLE
    },
    /* more items */
  ],
  DatasetName: 'STRING_VALUE',
  EncryptionKeyArn: 'STRING_VALUE',
  EncryptionMode: SSE-KMS | SSE-S3,
  LogSubscription: ENABLE | DISABLE,
  MaxCapacity: 'NUMBER_VALUE',
  MaxRetries: 'NUMBER_VALUE',
  Outputs: [
    {
      Location: { /* required */
        Bucket: 'STRING_VALUE', /* required */
        BucketOwner: 'STRING_VALUE',
        Key: 'STRING_VALUE'
      },
      CompressionFormat: GZIP | LZ4 | SNAPPY | BZIP2 | DEFLATE | LZO | BROTLI | ZSTD | ZLIB,
      Format: CSV | JSON | PARQUET | GLUEPARQUET | AVRO | ORC | XML | TABLEAUHYPER,
      FormatOptions: {
        Csv: {
          Delimiter: 'STRING_VALUE'
        }
      },
      MaxOutputFiles: 'NUMBER_VALUE',
      Overwrite: true || false,
      PartitionColumns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ProjectName: 'STRING_VALUE',
  RecipeReference: {
    Name: 'STRING_VALUE', /* required */
    RecipeVersion: 'STRING_VALUE'
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  Timeout: 'NUMBER_VALUE'
};
databrew.createRecipeJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DatasetName — (String)

    The name of the dataset that this job processes.

  • EncryptionKeyArn — (String)

    The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

  • EncryptionMode — (String)

    The encryption mode for the job, which can be one of the following:

    • SSE-KMS - Server-side encryption with keys managed by KMS.

    • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

    Possible values include:
    • "SSE-KMS"
    • "SSE-S3"
  • Name — (String)

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

  • LogSubscription — (String)

    Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

    Possible values include:
    • "ENABLE"
    • "DISABLE"
  • MaxCapacity — (Integer)

    The maximum number of nodes that DataBrew can consume when the job processes data.

  • MaxRetries — (Integer)

    The maximum number of times to retry the job after a job run fails.

  • Outputs — (Array<map>)

    One or more artifacts that represent the output from running the job.

    • CompressionFormat — (String)

      The compression algorithm used to compress the output text of the job.

      Possible values include:
      • "GZIP"
      • "LZ4"
      • "SNAPPY"
      • "BZIP2"
      • "DEFLATE"
      • "LZO"
      • "BROTLI"
      • "ZSTD"
      • "ZLIB"
    • Format — (String)

      The data format of the output of the job.

      Possible values include:
      • "CSV"
      • "JSON"
      • "PARQUET"
      • "GLUEPARQUET"
      • "AVRO"
      • "ORC"
      • "XML"
      • "TABLEAUHYPER"
    • PartitionColumns — (Array<String>)

      The names of one or more partition columns for the output of the job.

    • Location — required — (map)

      The location in Amazon S3 where the job writes its output.

      • Bucket — required — (String)

        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.

    • Overwrite — (Boolean)

      A value that, if true, means that any data in the location specified for output is overwritten with new output.

    • FormatOptions — (map)

      Represents options that define how DataBrew formats job output files.

      • Csv — (map)

        Represents a set of options that define the structure of comma-separated value (CSV) job output.

        • Delimiter — (String)

          A single character that specifies the delimiter used to create CSV job output.

    • MaxOutputFiles — (Integer)

      Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.

  • DataCatalogOutputs — (Array<map>)

    One or more artifacts that represent the Glue Data Catalog output from running the job.

    • CatalogId — (String)

      The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.

    • DatabaseName — required — (String)

      The name of a database in the Data Catalog.

    • TableName — required — (String)

      The name of a table in the Data Catalog.

    • S3Options — (map)

      Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.

      • Location — required — (map)

        Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.

        • Bucket — required — (String)

          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.

    • DatabaseOptions — (map)

      Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

      • TempDirectory — (map)

        Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.

        • Bucket — required — (String)

          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.

      • TableName — required — (String)

        A prefix for the name of a table DataBrew will create in the database.

    • Overwrite — (Boolean)

      A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.

  • DatabaseOutputs — (Array<map>)

    Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

    • GlueConnectionName — required — (String)

      The Glue connection that stores the connection information for the target database.

    • DatabaseOptions — required — (map)

      Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

      • TempDirectory — (map)

        Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.

        • Bucket — required — (String)

          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.

      • TableName — required — (String)

        A prefix for the name of a table DataBrew will create in the database.

    • DatabaseOutputMode — (String)

      The output mode to write into the database. Currently supported option: NEW_TABLE.

      Possible values include:
      • "NEW_TABLE"
  • ProjectName — (String)

    Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

  • RecipeReference — (map)

    Represents the name and version of a DataBrew recipe.

    • Name — required — (String)

      The name of the recipe.

    • RecipeVersion — (String)

      The identifier for the version for the recipe.

  • RoleArn — (String)

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

  • Tags — (map<String>)

    Metadata tags to apply to this job.

  • Timeout — (Integer)

    The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the job that you created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  Rules: [ /* required */
    {
      CheckExpression: 'STRING_VALUE', /* required */
      Name: 'STRING_VALUE', /* required */
      ColumnSelectors: [
        {
          Name: 'STRING_VALUE',
          Regex: 'STRING_VALUE'
        },
        /* more items */
      ],
      Disabled: true || false,
      SubstitutionMap: {
        '<ValueReference>': 'STRING_VALUE',
        /* '<ValueReference>': ... */
      },
      Threshold: {
        Value: 'NUMBER_VALUE', /* required */
        Type: GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | GREATER_THAN | LESS_THAN,
        Unit: COUNT | PERCENTAGE
      }
    },
    /* more items */
  ],
  TargetArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
databrew.createRuleset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

  • Description — (String)

    The description of the ruleset.

  • TargetArn — (String)

    The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

  • Rules — (Array<map>)

    A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

    • Name — required — (String)

      The name of the rule.

    • Disabled — (Boolean)

      A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

    • CheckExpression — required — (String)

      The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2.

      For more information, see Available checks

    • SubstitutionMap — (map<String>)

      The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "Column A".

    • Threshold — (map)

      The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

      • Value — required — (Float)

        The value of a threshold.

      • Type — (String)

        The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.

        Possible values include:
        • "GREATER_THAN_OR_EQUAL"
        • "LESS_THAN_OR_EQUAL"
        • "GREATER_THAN"
        • "LESS_THAN"
      • Unit — (String)

        Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.

        Possible values include:
        • "COUNT"
        • "PERCENTAGE"
    • ColumnSelectors — (Array<map>)

      List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

      • Regex — (String)

        A regular expression for selecting a column from a dataset.

      • Name — (String)

        The name of a column from a dataset.

  • Tags — (map<String>)

    Metadata tags to apply to the ruleset.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The unique name of the created ruleset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CronExpression: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  JobNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
databrew.createSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobNames — (Array<String>)

    The name or names of one or more jobs to be run.

  • CronExpression — (String)

    The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide.

  • Tags — (map<String>)

    Metadata tags to apply to this schedule.

  • Name — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the schedule that was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.deleteDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the dataset to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the dataset that you deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.deleteJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the job to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the job that you deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.deleteProject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the project to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the project that you deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  RecipeVersion: 'STRING_VALUE' /* required */
};
databrew.deleteRecipeVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the recipe.

  • RecipeVersion — (String)

    The version of the recipe to be deleted. You can specify a numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the recipe that was deleted.

    • RecipeVersion — (String)

      The version of the recipe that was deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.deleteRuleset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the ruleset to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the deleted ruleset.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.deleteSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the schedule to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the schedule that was deleted.

Returns:

• (