Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.DataBrew

Inherits:
AWS.Service show all
Identifier:
databrew
API Version:
2017-07-25
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.

Sending a Request Using DataBrew

var databrew = new AWS.DataBrew();
databrew.batchDeleteRecipeVersion(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DataBrew object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var databrew = new AWS.DataBrew({apiVersion: '2017-07-25'});

You can also set the API version globally in AWS.config.apiVersions using the databrew service identifier:

AWS.config.apiVersions = {
  databrew: '2017-07-25',
  // other service API versions
};

var databrew = new AWS.DataBrew();

Version:

  • 2017-07-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DataBrew(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a DataBrew object

var databrew = new AWS.DataBrew({apiVersion: '2017-07-25'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.DataBrew.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.DataBrew.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.DataBrew.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchDeleteRecipeVersion(params = {}, callback) ⇒ AWS.Request

Deletes one or more versions of a recipe at a time.

The entire request will be rejected if:

  • The recipe does not exist.

  • There is an invalid version identifier in the list of versions.

  • The version list is empty.

  • The version list size exceeds 50.

  • The version list contains duplicate entries.

The request will complete successfully, but with partial failures, if:

  • A version does not exist.

  • A version is being used by a job.

  • You specify LATEST_WORKING, but it's being used by a project.

  • The version fails to be deleted.

The LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then LATEST_WORKING will be listed as partial failure in the response.

Service Reference:

Examples:

Calling the batchDeleteRecipeVersion operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RecipeVersions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
databrew.batchDeleteRecipeVersion(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 whose versions are to be deleted.

    • RecipeVersions — (Array<String>)

      An array of version identifiers, for the recipe versions to be deleted. You can specify 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 modified.

      • Errors — (Array<map>)

        Errors, if any, that occurred while attempting to delete the recipe versions.

        • ErrorCode — (String)

          The HTTP status code for the error.

        • ErrorMessage — (String)

          The text of the error message.

        • RecipeVersion — (String)

          The identifier for the recipe version associated with this error.

Returns:

  • (AWS.Request)

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

createDataset(params = {}, callback) ⇒ AWS.Request

Creates a new DataBrew dataset.

Service Reference:

Examples:

Calling the createDataset operation

var params = {
  Input: { /* required */
    DataCatalogInputDefinition: {
      DatabaseName: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      TempDirectory: {
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE'
      }
    },
    DatabaseInputDefinition: {
      DatabaseTableName: 'STRING_VALUE', /* required */
      GlueConnectionName: 'STRING_VALUE', /* required */
      TempDirectory: {
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE'
      }
    },
    S3InputDefinition: {
      Bucket: 'STRING_VALUE', /* required */
      Key: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE', /* required */
  Format: CSV | JSON | PARQUET | EXCEL,
  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 S3 file or folder.

      Possible values include:
      • "CSV"
      • "JSON"
      • "PARQUET"
      • "EXCEL"
    • 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 AWS Glue Data Catalog or Amazon S3.

      • S3InputDefinition — (map)

        The Amazon S3 location where the data is stored.

        • Bucketrequired — (String)

          The S3 bucket name.

        • Key — (String)

          The unique name of the object in the bucket.

      • DataCatalogInputDefinition — (map)

        The AWS Glue Data Catalog parameters for the data.

        • CatalogId — (String)

          The unique identifier of the AWS account that holds the Data Catalog that stores the data.

        • DatabaseNamerequired — (String)

          The name of a database in the Data Catalog.

        • TableNamerequired — (String)

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

        • TempDirectory — (map)

          An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

          • Bucketrequired — (String)

            The S3 bucket name.

          • Key — (String)

            The unique name of the object in the bucket.

      • DatabaseInputDefinition — (map)

        Connection information for dataset input files stored in a database.

        • GlueConnectionNamerequired — (String)

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

        • DatabaseTableNamerequired — (String)

          The table within the target database.

        • TempDirectory — (map)

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

          • Bucketrequired — (String)

            The S3 bucket name.

          • Key — (String)

            The unique name of the object in the bucket.

    • PathOptions — (map)

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

      • LastModifiedDateCondition — (map)

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

        • Expressionrequired — (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.

        • ValuesMaprequired — (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.

        • MaxFilesrequired — (Integer)

          The number of S3 files to select.

        • OrderedBy — (String)

          A criteria to use for 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 S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

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

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

        • Namerequired — (String)

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

        • Typerequired — (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.

          • Formatrequired — (String)

            Required option, that defines the datetime format used for a date parameter in the S3 path. Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character 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 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 loaded as an additional column in the dataset.

        • Filter — (map)

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

          • Expressionrequired — (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.

          • ValuesMaprequired — (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.

createProfileJob(params = {}, callback) ⇒ AWS.Request

Creates a new job to analyze a dataset and create its data profile.

Service Reference:

Examples:

Calling the createProfileJob operation

var params = {
  DatasetName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  OutputLocation: { /* required */
    Bucket: 'STRING_VALUE', /* required */
    Key: 'STRING_VALUE'
  },
  RoleArn: 'STRING_VALUE', /* required */
  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'
};
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 AWS 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 and object key) where DataBrew can read input data, or write output from a job.

      • Bucketrequired — (String)

        The S3 bucket name.

      • Key — (String)

        The unique name of the object in the bucket.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the AWS 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.

createProject(params = {}, callback) ⇒ AWS.Request

Creates a new DataBrew project.

Service Reference:

Examples:

Calling the createProject operation

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.

      • Typerequired — (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 AWS 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.

createRecipe(params = {}, callback) ⇒ AWS.Request

Creates a new DataBrew recipe.

Service Reference:

Examples:

Calling the createRecipe operation

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.

      • Actionrequired — (map)

        The particular action to be performed in the recipe step.

        • Operationrequired — (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.
        • Conditionrequired — (String)

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

        • Value — (String)

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

        • TargetColumnrequired — (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.

createRecipeJob(params = {}, callback) ⇒ AWS.Request

Creates a new job to transform input data, using steps defined in an existing AWS Glue DataBrew recipe

Service Reference:

Examples:

Calling the createRecipeJob operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Outputs: [ /* required */
    {
      Location: { /* required */
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE'
      },
      CompressionFormat: GZIP | LZ4 | SNAPPY | BZIP2 | DEFLATE | LZO | BROTLI | ZSTD | ZLIB,
      Format: CSV | JSON | PARQUET | GLUEPARQUET | AVRO | ORC | XML,
      FormatOptions: {
        Csv: {
          Delimiter: 'STRING_VALUE'
        }
      },
      Overwrite: true || false,
      PartitionColumns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  RoleArn: 'STRING_VALUE', /* required */
  DatasetName: 'STRING_VALUE',
  EncryptionKeyArn: 'STRING_VALUE',
  EncryptionMode: SSE-KMS | SSE-S3,
  LogSubscription: ENABLE | DISABLE,
  MaxCapacity: 'NUMBER_VALUE',
  MaxRetries: 'NUMBER_VALUE',
  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 AWS 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"
      • PartitionColumns — (Array<String>)

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

      • Locationrequired — (map)

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

        • Bucketrequired — (String)

          The S3 bucket name.

        • Key — (String)

          The unique name of the object in the bucket.

      • 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.

    • 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.

      • Namerequired — (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 AWS 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.

createSchedule(params = {}, callback) ⇒ AWS.Request

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.

Service Reference:

Examples:

Calling the createSchedule operation

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 AWS 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.

deleteDataset(params = {}, callback) ⇒ AWS.Request

Deletes a dataset from DataBrew.

Service Reference:

Examples:

Calling the deleteDataset operation

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.

deleteJob(params = {}, callback) ⇒ AWS.Request

Deletes the specified DataBrew job.

Service Reference:

Examples:

Calling the deleteJob operation

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.

deleteProject(params = {}, callback) ⇒ AWS.Request

Deletes an existing DataBrew project.

Service Reference:

Examples:

Calling the deleteProject operation

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.

deleteRecipeVersion(params = {}, callback) ⇒ AWS.Request

Deletes a single version of a DataBrew recipe.

Service Reference:

Examples:

Calling the deleteRecipeVersion operation

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.

deleteSchedule(params = {}, callback) ⇒ AWS.Request

Deletes the specified DataBrew schedule.

Service Reference:

Examples:

Calling the deleteSchedule operation

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:

  • (AWS.Request)

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

describeDataset(params = {}, callback) ⇒ AWS.Request

Returns the definition of a specific DataBrew dataset.

Service Reference:

Examples:

Calling the describeDataset operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.describeDataset(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 described.

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:

      • CreatedBy — (String)

        The identifier (user name) of the user who created the dataset.

      • CreateDate — (Date)

        The date and time that the dataset was created.

      • Name — (String)

        The name of the dataset.

      • Format — (String)

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

        Possible values include:
        • "CSV"
        • "JSON"
        • "PARQUET"
        • "EXCEL"
      • 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 AWS Glue Data Catalog or Amazon S3.

        • S3InputDefinition — (map)

          The Amazon S3 location where the data is stored.

          • Bucketrequired — (String)

            The S3 bucket name.

          • Key — (String)

            The unique name of the object in the bucket.

        • DataCatalogInputDefinition — (map)

          The AWS Glue Data Catalog parameters for the data.

          • CatalogId — (String)

            The unique identifier of the AWS account that holds the Data Catalog that stores the data.

          • DatabaseNamerequired — (String)

            The name of a database in the Data Catalog.

          • TableNamerequired — (String)

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

          • TempDirectory — (map)

            An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

            • Bucketrequired — (String)

              The S3 bucket name.

            • Key — (String)

              The unique name of the object in the bucket.

        • DatabaseInputDefinition — (map)

          Connection information for dataset input files stored in a database.

          • GlueConnectionNamerequired — (String)

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

          • DatabaseTableNamerequired — (String)

            The table within the target database.

          • TempDirectory — (map)

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

            • Bucketrequired — (String)

              The S3 bucket name.

            • Key — (String)

              The unique name of the object in the bucket.

      • LastModifiedDate — (Date)

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

        The location of the data for this dataset, Amazon S3 or the AWS Glue Data Catalog.

        Possible values include:
        • "S3"
        • "DATA-CATALOG"
        • "DATABASE"
      • PathOptions — (map)

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

        • LastModifiedDateCondition — (map)

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

          • Expressionrequired — (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.

          • ValuesMaprequired — (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.

          • MaxFilesrequired — (Integer)

            The number of S3 files to select.

          • OrderedBy — (String)

            A criteria to use for 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 S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

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

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

          • Namerequired — (String)

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

          • Typerequired — (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.

            • Formatrequired — (String)

              Required option, that defines the datetime format used for a date parameter in the S3 path. Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character 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 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 loaded as an additional column in the dataset.

          • Filter — (map)

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

            • Expressionrequired — (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.

            • ValuesMaprequired — (map<String>)

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

      • Tags — (map<String>)

        Metadata tags associated with this dataset.

      • ResourceArn — (String)

        The Amazon Resource Name (ARN) of the dataset.

Returns:

  • (AWS.Request)

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

describeJob(params = {}, callback) ⇒ AWS.Request

Returns the definition of a specific DataBrew job.

Service Reference:

Examples:

Calling the describeJob operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.describeJob(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 described.

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:

      • CreateDate — (Date)

        The date and time that the job was created.

      • CreatedBy — (String)

        The identifier (user name) of the user associated with the creation of the job.

      • DatasetName — (String)

        The dataset that the job acts 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 - Server-side encryption with keys managed by AWS KMS.

        • 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.

      • Type — (String)

        The job type, which must be one of the following:

        • PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.

        • RECIPE - The job applies one or more transformations to a dataset.

        Possible values include:
        • "PROFILE"
        • "RECIPE"
      • LastModifiedBy — (String)

        The identifier (user name) of the user who last modified the job.

      • LastModifiedDate — (Date)

        The date and time that the job was last modified.

      • LogSubscription — (String)

        Indicates whether Amazon CloudWatch logging is enabled for this job.

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

        The maximum number of compute 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"
        • PartitionColumns — (Array<String>)

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

        • Locationrequired — (map)

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

          • Bucketrequired — (String)

            The S3 bucket name.

          • Key — (String)

            The unique name of the object in the bucket.

        • 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.

      • ProjectName — (String)

        The DataBrew project associated with this job.

      • RecipeReference — (map)

        Represents the name and version of a DataBrew recipe.

        • Namerequired — (String)

          The name of the recipe.

        • RecipeVersion — (String)

          The identifier for the version for the recipe.

      • ResourceArn — (String)

        The Amazon Resource Name (ARN) of the job.

      • RoleArn — (String)

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

      • Tags — (map<String>)

        Metadata tags associated with 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.

        • 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

Returns:

  • (AWS.Request)

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

describeJobRun(params = {}, callback) ⇒ AWS.Request

Represents one run of a DataBrew job.

Service Reference:

Examples:

Calling the describeJobRun operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RunId: 'STRING_VALUE' /* required */
};
databrew.describeJobRun(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 being processed during this run.

    • RunId — (String)

      The unique identifier of the job run.

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:

      • Attempt — (Integer)

        The number of times that DataBrew has attempted to run the job.

      • CompletedOn — (Date)

        The date and time when the job completed processing.

      • DatasetName — (String)

        The name of the dataset for the job to process.

      • ErrorMessage — (String)

        A message indicating an error (if any) that was encountered when the job ran.

      • ExecutionTime — (Integer)

        The amount of time, in seconds, during which the job run consumed resources.

      • JobName — (String)

        The name of the job being processed during this run.

      • RunId — (String)

        The unique identifier of the job run.

      • State — (String)

        The current state of the job run entity itself.

        Possible values include:
        • "STARTING"
        • "RUNNING"
        • "STOPPING"
        • "STOPPED"
        • "SUCCEEDED"
        • "FAILED"
        • "TIMEOUT"
      • LogSubscription — (String)

        The current status of Amazon CloudWatch logging for the job run.

        Possible values include:
        • "ENABLE"
        • "DISABLE"
      • LogGroupName — (String)

        The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.

      • Outputs — (Array<map>)

        One or more output artifacts from a job run.

        • 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"
        • PartitionColumns — (Array<String>)

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

        • Locationrequired — (map)

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

          • Bucketrequired — (String)

            The S3 bucket name.

          • Key — (String)

            The unique name of the object in the bucket.

        • 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.

      • RecipeReference — (map)

        Represents the name and version of a DataBrew recipe.

        • Namerequired — (String)

          The name of the recipe.

        • RecipeVersion — (String)

          The identifier for the version for the recipe.

      • StartedBy — (String)

        The Amazon Resource Name (ARN) of the user who started the job run.

      • StartedOn — (Date)

        The date and time when the job run began.

      • 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

Returns:

  • (AWS.Request)

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

describeProject(params = {}, callback) ⇒ AWS.Request

Returns the definition of a specific DataBrew project.

Service Reference:

Examples:

Calling the describeProject operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.describeProject(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 described.

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:

      • CreateDate — (Date)

        The date and time that the project was created.

      • CreatedBy — (String)

        The identifier (user name) of the user who created the project.

      • DatasetName — (String)

        The dataset associated with the project.

      • LastModifiedDate — (Date)

        The date and time that the project was last modified.

      • LastModifiedBy — (String)

        The identifier (user name) of the user who last modified the project.

      • Name — (String)

        The name of the project.

      • RecipeName — (String)

        The recipe associated with this job.

      • ResourceArn — (String)

        The Amazon Resource Name (ARN) of 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.

        • Typerequired — (String)

          The way in which DataBrew obtains rows from a dataset.

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

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

      • Tags — (map<String>)

        Metadata tags associated with this project.

      • SessionStatus — (String)

        Describes the current state of the session:

        • PROVISIONING - allocating resources for the session.

        • INITIALIZING - getting the session ready for first use.

        • ASSIGNED - the session is ready for use.

        Possible values include:
        • "ASSIGNED"
        • "FAILED"
        • "INITIALIZING"
        • "PROVISIONING"
        • "READY"
        • "RECYCLING"
        • "ROTATING"
        • "TERMINATED"
        • "TERMINATING"
        • "UPDATING"
      • OpenedBy — (String)

        The identifier (user name) of the user that opened the project for use.

      • OpenDate — (Date)

        The date and time when the project was opened.

Returns:

  • (AWS.Request)

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

describeRecipe(params = {}, callback) ⇒ AWS.Request

Returns the definition of a specific DataBrew recipe corresponding to a particular version.

Service Reference:

Examples:

Calling the describeRecipe operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RecipeVersion: 'STRING_VALUE'
};
databrew.describeRecipe(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 to be described.

    • RecipeVersion — (String)

      The recipe version identifier. If this parameter isn't specified, then the latest published version is returned.

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:

      • CreatedBy — (String)

        The identifier (user name) of the user who created the recipe.

      • CreateDate — (Date)

        The date and time that the recipe was created.

      • LastModifiedBy — (String)

        The identifier (user name) of the user who last modified the recipe.

      • LastModifiedDate — (Date)

        The date and time that the recipe was last modified.

      • ProjectName — (String)

        The name of the project associated with this recipe.

      • PublishedBy — (String)

        The identifier (user name) of the user who last published the recipe.

      • PublishedDate — (Date)

        The date and time when the recipe was last published.

      • Description — (String)

        The description of the recipe.

      • Name — (String)

        The name of the recipe.

      • Steps — (Array<map>)

        One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.

        • Actionrequired — (map)

          The particular action to be performed in the recipe step.

          • Operationrequired — (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.
          • Conditionrequired — (String)

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

          • Value — (String)

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

          • TargetColumnrequired — (String)

            A column to apply this condition to.

      • Tags — (map<String>)

        Metadata tags associated with this project.

      • ResourceArn — (String)

        The ARN of the recipe.

      • RecipeVersion — (String)

        The recipe version identifier.

Returns:

  • (AWS.Request)

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

describeSchedule(params = {}, callback) ⇒ AWS.Request

Returns the definition of a specific DataBrew schedule.

Service Reference:

Examples:

Calling the describeSchedule operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.describeSchedule(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 described.

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:

      • CreateDate — (Date)

        The date and time that the schedule was created.

      • CreatedBy — (String)

        The identifier (user name) of the user who created the schedule.

      • JobNames — (Array<String>)

        The name or names of one or more jobs to be run by using the schedule.

      • LastModifiedBy — (String)

        The identifier (user name) of the user who last modified the schedule.

      • LastModifiedDate — (Date)

        The date and time that the schedule was last modified.

      • ResourceArn — (String)

        The Amazon Resource Name (ARN) of the schedule.

      • CronExpression — (String)

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

      • Tags — (map<String>)

        Metadata tags associated with this schedule.

      • Name — (String)

        The name of the schedule.

Returns:

  • (AWS.Request)

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

listDatasets(params = {}, callback) ⇒ AWS.Request

Lists all of the DataBrew datasets.

Service Reference:

Examples:

Calling the listDatasets operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
databrew.listDatasets(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in this request.

    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

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:

      • Datasets — (Array<map>)

        A list of datasets that are defined.

        • AccountId — (String)

          The ID of the AWS account that owns the dataset.

        • CreatedBy — (String)

          The Amazon Resource Name (ARN) of the user who created the dataset.

        • CreateDate — (Date)

          The date and time that the dataset was created.

        • Namerequired — (String)

          The unique name of the dataset.

        • Format — (String)

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

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

          A set of options that define how DataBrew interprets the data in the dataset.

          • 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.

        • Inputrequired — (map)

          Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3.

          • S3InputDefinition — (map)

            The Amazon S3 location where the data is stored.

            • Bucketrequired — (String)

              The S3 bucket name.

            • Key — (String)

              The unique name of the object in the bucket.

          • DataCatalogInputDefinition — (map)

            The AWS Glue Data Catalog parameters for the data.

            • CatalogId — (String)

              The unique identifier of the AWS account that holds the Data Catalog that stores the data.

            • DatabaseNamerequired — (String)

              The name of a database in the Data Catalog.

            • TableNamerequired — (String)

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

            • TempDirectory — (map)

              An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

              • Bucketrequired — (String)

                The S3 bucket name.

              • Key — (String)

                The unique name of the object in the bucket.

          • DatabaseInputDefinition — (map)

            Connection information for dataset input files stored in a database.

            • GlueConnectionNamerequired — (String)

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

            • DatabaseTableNamerequired — (String)

              The table within the target database.

            • TempDirectory — (map)

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

              • Bucketrequired — (String)

                The S3 bucket name.

              • Key — (String)

                The unique name of the object in the bucket.

        • LastModifiedDate — (Date)

          The last modification date and time of the dataset.

        • LastModifiedBy — (String)

          The Amazon Resource Name (ARN) of the user who last modified the dataset.

        • Source — (String)

          The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog.

          Possible values include:
          • "S3"
          • "DATA-CATALOG"
          • "DATABASE"
        • PathOptions — (map)

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

          • LastModifiedDateCondition — (map)

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

            • Expressionrequired — (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.

            • ValuesMaprequired — (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.

            • MaxFilesrequired — (Integer)

              The number of S3 files to select.

            • OrderedBy — (String)

              A criteria to use for 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 S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

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

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

            • Namerequired — (String)

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

            • Typerequired — (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.

              • Formatrequired — (String)

                Required option, that defines the datetime format used for a date parameter in the S3 path. Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character 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 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 loaded as an additional column in the dataset.

            • Filter — (map)

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

              • Expressionrequired — (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.

              • ValuesMaprequired — (map<String>)

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

        • Tags — (map<String>)

          Metadata tags that have been applied to the dataset.

        • ResourceArn — (String)

          The unique Amazon Resource Name (ARN) for the dataset.

      • NextToken — (String)

        A token that you can use in a subsequent call to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

listJobRuns(params = {}, callback) ⇒ AWS.Request

Lists all of the previous runs of a particular DataBrew job.

Service Reference:

Examples:

Calling the listJobRuns operation

var params = {
  Name: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
databrew.listJobRuns(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.

    • MaxResults — (Integer)

      The maximum number of results to return in this request.

    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

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:

      • JobRuns — (Array<map>)

        A list of job runs that have occurred for the specified job.

        • Attempt — (Integer)

          The number of times that DataBrew has attempted to run the job.

        • CompletedOn — (Date)

          The date and time when the job completed processing.

        • DatasetName — (String)

          The name of the dataset for the job to process.

        • ErrorMessage — (String)

          A message indicating an error (if any) that was encountered when the job ran.

        • ExecutionTime — (Integer)

          The amount of time, in seconds, during which a job run consumed resources.

        • JobName — (String)

          The name of the job being processed during this run.

        • RunId — (String)

          The unique identifier of the job run.

        • State — (String)

          The current state of the job run entity itself.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "SUCCEEDED"
          • "FAILED"
          • "TIMEOUT"
        • LogSubscription — (String)

          The current status of Amazon CloudWatch logging for the job run.

          Possible values include:
          • "ENABLE"
          • "DISABLE"
        • LogGroupName — (String)

          The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.

        • Outputs — (Array<map>)

          One or more output artifacts from a job run.

          • 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"
          • PartitionColumns — (Array<String>)

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

          • Locationrequired — (map)

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

            • Bucketrequired — (String)

              The S3 bucket name.

            • Key — (String)

              The unique name of the object in the bucket.

          • 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.

        • RecipeReference — (map)

          The set of steps processed by the job.

          • Namerequired — (String)

            The name of the recipe.

          • RecipeVersion — (String)

            The identifier for the version for the recipe.

        • StartedBy — (String)

          The Amazon Resource Name (ARN) of the user who initiated the job run.

        • StartedOn — (Date)

          The date and time when the job run began.

        • JobSample — (map)

          A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 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

      • NextToken — (String)

        A token that you can use in a subsequent call to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

listJobs(params = {}, callback) ⇒ AWS.Request

Lists all of the DataBrew jobs that are defined.

Service Reference:

Examples:

Calling the listJobs operation

var params = {
  DatasetName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProjectName: 'STRING_VALUE'
};
databrew.listJobs(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 a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.

    • MaxResults — (Integer)

      The maximum number of results to return in this request.

    • NextToken — (String)

      A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

    • ProjectName — (String)

      The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified 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:

      • Jobs — (Array<map>)

        A list of jobs that are defined.

        • AccountId — (String)

          The ID of the AWS account that owns the job.

        • CreatedBy — (String)

          The Amazon Resource Name (ARN) of the user who created the job.

        • CreateDate — (Date)

          The date and time that the job was created.

        • DatasetName — (String)

          A dataset that the job is to process.

        • EncryptionKeyArn — (String)

          The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs

        • EncryptionMode — (String)

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

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

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

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

          The unique name of the job.

        • Type — (String)

          The job type of the job, which must be one of the following:

          • PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.

          • RECIPE - A job to apply one or more transformations to a dataset.

          Possible values include:
          • "PROFILE"
          • "RECIPE"
        • LastModifiedBy — (String)

          The Amazon Resource Name (ARN) of the user who last modified the job.

        • LastModifiedDate — (Date)

          The modification date and time of the job.

        • LogSubscription — (String)

          The current status of Amazon CloudWatch logging for the job.

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

          The maximum number of nodes that can be consumed 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 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"
          • PartitionColumns — (Array<String>)

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

          • Locationrequired — (map)

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

            • Bucketrequired — (String)

              The S3 bucket name.

            • Key — (String)

              The unique name of the object in the bucket.

          • 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.

        • ProjectName — (String)

          The name of the project that the job is associated with.

        • RecipeReference — (map)

          A set of steps that the job runs.

          • Namerequired — (String)

            The name of the recipe.

          • RecipeVersion — (String)

            The identifier for the version for the recipe.

        • ResourceArn — (String)

          The unique Amazon Resource Name (ARN) for the job.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) of the role to be assumed for 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.

        • Tags — (map<String>)

          Metadata tags that have been applied to the job.

        • JobSample — (map)

          A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 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

      • NextToken — (String)

        A token that you can use in a subsequent call to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

listProjects(params = {}, callback) ⇒ AWS.Request

Lists all of the DataBrew projects that are defined.

Service Reference:

Examples:

Calling the listProjects operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
databrew.listProjects(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: {})
    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this request.

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:

      • Projects — (Array<map>)

        A list of projects that are defined .

        • AccountId — (String)

          The ID of the AWS account that owns the project.

        • CreateDate — (Date)

          The date and time that the project was created.

        • CreatedBy — (String)

          The Amazon Resource Name (ARN) of the user who crated the project.

        • DatasetName — (String)

          The dataset that the project is to act upon.

        • LastModifiedDate — (Date)

          The last modification date and time for the project.

        • LastModifiedBy — (String)

          The Amazon Resource Name (ARN) of the user who last modified the project.

        • Namerequired — (String)

          The unique name of a project.

        • RecipeNamerequired — (String)

          The name of a recipe that will be developed during a project session.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) for the project.

        • Sample — (map)

          The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset.

          • Size — (Integer)

            The number of rows in the sample.

          • Typerequired — (String)

            The way in which DataBrew obtains rows from a dataset.

            Possible values include:
            • "FIRST_N"
            • "LAST_N"
            • "RANDOM"
        • Tags — (map<String>)

          Metadata tags that have been applied to the project.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) of the role that will be assumed for this project.

        • OpenedBy — (String)

          The Amazon Resource Name (ARN) of the user that opened the project for use.

        • OpenDate — (Date)

          The date and time when the project was opened.

      • NextToken — (String)

        A token that you can use in a subsequent call to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

listRecipes(params = {}, callback) ⇒ AWS.Request

Lists all of the DataBrew recipes that are defined.

Service Reference:

Examples:

Calling the listRecipes operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RecipeVersion: 'STRING_VALUE'
};
databrew.listRecipes(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in this request.

    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

    • RecipeVersion — (String)

      Return only those recipes with a version identifier of LATEST_WORKING or LATEST_PUBLISHED. If RecipeVersion is omitted, ListRecipes returns all of the LATEST_PUBLISHED recipe versions.

      Valid values: LATEST_WORKING | LATEST_PUBLISHED

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:

      • Recipes — (Array<map>)

        A list of recipes that are defined.

        • CreatedBy — (String)

          The Amazon Resource Name (ARN) of the user who created the recipe.

        • CreateDate — (Date)

          The date and time that the recipe was created.

        • LastModifiedBy — (String)

          The Amazon Resource Name (ARN) of the user who last modified the recipe.

        • LastModifiedDate — (Date)

          The last modification date and time of the recipe.

        • ProjectName — (String)

          The name of the project that the recipe is associated with.

        • PublishedBy — (String)

          The Amazon Resource Name (ARN) of the user who published the recipe.

        • PublishedDate — (Date)

          The date and time when the recipe was published.

        • Description — (String)

          The description of the recipe.

        • Namerequired — (String)

          The unique name for the recipe.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) for the recipe.

        • Steps — (Array<map>)

          A list of steps that are defined by the recipe.

          • Actionrequired — (map)

            The particular action to be performed in the recipe step.

            • Operationrequired — (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.
            • Conditionrequired — (String)

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

            • Value — (String)

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

            • TargetColumnrequired — (String)

              A column to apply this condition to.

        • Tags — (map<String>)

          Metadata tags that have been applied to the recipe.

        • RecipeVersion — (String)

          The identifier for the version for the recipe. Must be one of the following:

          • Numeric version (X.Y) - X and Y stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both X and Y are required, and "0.0" isn't a valid version.

          • LATEST_WORKING - the most recent valid version being developed in a DataBrew project.

          • LATEST_PUBLISHED - the most recent published version.

      • NextToken — (String)

        A token that you can use in a subsequent call to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

listRecipeVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.

Service Reference:

Examples:

Calling the listRecipeVersions operation

var params = {
  Name: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
databrew.listRecipeVersions(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in this request.

    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

    • Name — (String)

      The name of the recipe for which to return version information.

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:

      • NextToken — (String)

        A token that you can use in a subsequent call to retrieve the next set of results.

      • Recipes — (Array<map>)

        A list of versions for the specified recipe.

        • CreatedBy — (String)

          The Amazon Resource Name (ARN) of the user who created the recipe.

        • CreateDate — (Date)

          The date and time that the recipe was created.

        • LastModifiedBy — (String)

          The Amazon Resource Name (ARN) of the user who last modified the recipe.

        • LastModifiedDate — (Date)

          The last modification date and time of the recipe.

        • ProjectName — (String)

          The name of the project that the recipe is associated with.

        • PublishedBy — (String)

          The Amazon Resource Name (ARN) of the user who published the recipe.

        • PublishedDate — (Date)

          The date and time when the recipe was published.

        • Description — (String)

          The description of the recipe.

        • Namerequired — (String)

          The unique name for the recipe.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) for the recipe.

        • Steps — (Array<map>)

          A list of steps that are defined by the recipe.

          • Actionrequired — (map)

            The particular action to be performed in the recipe step.

            • Operationrequired — (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.
            • Conditionrequired — (String)

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

            • Value — (String)

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

            • TargetColumnrequired — (String)

              A column to apply this condition to.

        • Tags — (map<String>)

          Metadata tags that have been applied to the recipe.

        • RecipeVersion — (String)

          The identifier for the version for the recipe. Must be one of the following:

          • Numeric version (X.Y) - X and Y stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both X and Y are required, and "0.0" isn't a valid version.

          • LATEST_WORKING - the most recent valid version being developed in a DataBrew project.

          • LATEST_PUBLISHED - the most recent published version.

Returns:

  • (AWS.Request)

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

listSchedules(params = {}, callback) ⇒ AWS.Request

Lists the DataBrew schedules that are defined.

Service Reference:

Examples:

Calling the listSchedules operation

var params = {
  JobName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
databrew.listSchedules(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: {})
    • JobName — (String)

      The name of the job that these schedules apply to.

    • MaxResults — (Integer)

      The maximum number of results to return in this request.

    • NextToken — (String)

      The token returned by a previous call to retrieve the next set of results.

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:

      • Schedules — (Array<map>)

        A list of schedules that are defined.

        • AccountId — (String)

          The ID of the AWS account that owns the schedule.

        • CreatedBy — (String)

          The Amazon Resource Name (ARN) of the user who created the schedule.

        • CreateDate — (Date)

          The date and time that the schedule was created.

        • JobNames — (Array<String>)

          A list of jobs to be run, according to the schedule.

        • LastModifiedBy — (String)

          The Amazon Resource Name (ARN) of the user who last modified the schedule.

        • LastModifiedDate — (Date)

          The date and time when the schedule was last modified.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the schedule.

        • CronExpression — (String)

          The dates and times when the job is to run. For more information, see Cron expressions in the AWS Glue DataBrew Developer Guide.

        • Tags — (map<String>)

          Metadata tags that have been applied to the schedule.

        • Namerequired — (String)

          The name of the schedule.

      • NextToken — (String)

        A token that you can use in a subsequent call to retrieve the next set of results.

Returns:

  • (AWS.Request)

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all the tags for a DataBrew resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
databrew.listTagsForResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.

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:

      • Tags — (map<String>)

        A list of tags associated with the DataBrew resource.

Returns:

  • (AWS.Request)

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

publishRecipe(params = {}, callback) ⇒ AWS.Request

Publishes a new version of a DataBrew recipe.

Service Reference:

Examples:

Calling the publishRecipe operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
databrew.publishRecipe(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 of the recipe to be published, for this version of the recipe.

    • Name — (String)

      The name of the recipe to be published.

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 published.

Returns:

  • (AWS.Request)

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

sendProjectSessionAction(params = {}, callback) ⇒ AWS.Request

Performs a recipe step within an interactive DataBrew session that's currently open.

Service Reference:

Examples:

Calling the sendProjectSessionAction operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ClientSessionId: 'STRING_VALUE',
  Preview: true || false,
  RecipeStep: {
    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 */
    ]
  },
  StepIndex: 'NUMBER_VALUE',
  ViewFrame: {
    StartColumnIndex: 'NUMBER_VALUE', /* required */
    ColumnRange: 'NUMBER_VALUE',
    HiddenColumns: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
databrew.sendProjectSessionAction(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: {})
    • Preview — (Boolean)

      If true, the result of the recipe step will be returned, but not applied.

    • Name — (String)

      The name of the project to apply the action to.

    • RecipeStep — (map)

      Represents a single step from a DataBrew recipe to be performed.

      • Actionrequired — (map)

        The particular action to be performed in the recipe step.

        • Operationrequired — (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.
        • Conditionrequired — (String)

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

        • Value — (String)

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

        • TargetColumnrequired — (String)

          A column to apply this condition to.

    • StepIndex — (Integer)

      The index from which to preview a step. This index is used to preview the result of steps that have already been applied, so that the resulting view frame is from earlier in the view frame stack.

    • ClientSessionId — (String)

      A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.

    • ViewFrame — (map)

      Represents the data being transformed during an action.

      • StartColumnIndexrequired — (Integer)

        The starting index for the range of columns to return in the view frame.

      • ColumnRange — (Integer)

        The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list.

      • HiddenColumns — (Array<String>)

        A list of columns to hide in the view frame.

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:

      • Result — (String)

        A message indicating the result of performing the action.

      • Name — (String)

        The name of the project that was affected by the action.

      • ActionId — (Integer)

        A unique identifier for the action that was performed.

Returns:

  • (AWS.Request)

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

startJobRun(params = {}, callback) ⇒ AWS.Request

Runs a DataBrew job.

Service Reference:

Examples:

Calling the startJobRun operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
databrew.startJobRun(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 run.

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:

      • RunId — (String)

        A system-generated identifier for this particular job run.

Returns:

  • (AWS.Request)

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

startProjectSession(params = {}, callback) ⇒ AWS.Request

Creates an interactive session, enabling you to manipulate data in a DataBrew project.

Service Reference:

Examples:

Calling the startProjectSession operation

var params = {
  Name: 'STRING_VALUE', /* required */
  AssumeControl: true || false
};
databrew.startProjectSession(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 act upon.

    • AssumeControl — (Boolean)

      A value that, if true, enables you to take control of a session, even if a different client is currently accessing the 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 to be acted upon.

      • ClientSessionId — (String)

        A system-generated identifier for the session.

Returns:

  • (AWS.Request)

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

stopJobRun(params = {}, callback) ⇒ AWS.Request

Stops a particular run of a job.

Service Reference:

Examples:

Calling the stopJobRun operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RunId: 'STRING_VALUE' /* required */
};
databrew.stopJobRun(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 stopped.

    • RunId — (String)

      The ID of the job run to be stopped.

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:

      • RunId — (String)

        The ID of the job run that you stopped.

Returns:

  • (AWS.Request)

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

tagResource(params = {}, callback) ⇒ AWS.Request

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
databrew.tagResource(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: {})
    • ResourceArn — (String)

      The DataBrew resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or a recipe.

    • Tags — (map<String>)

      One or more tags to be assigned to the resource.

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.

Returns:

  • (AWS.Request)

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

untagResource(params = {}, callback) ⇒ AWS.Request

Removes metadata tags from a DataBrew resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
databrew.untagResource(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: {})
    • ResourceArn — (String)

      A DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).

    • TagKeys — (Array<String>)

      The tag keys (names) of one or more tags to be removed.

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.

Returns:

  • (AWS.Request)

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

updateDataset(params = {}, callback) ⇒ AWS.Request

Modifies the definition of an existing DataBrew dataset.

Service Reference:

Examples:

Calling the updateDataset operation

var params = {
  Input: { /* required */
    DataCatalogInputDefinition: {
      DatabaseName: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE', /* required */
      CatalogId: 'STRING_VALUE',
      TempDirectory: {
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE'
      }
    },
    DatabaseInputDefinition: {
      DatabaseTableName: 'STRING_VALUE', /* required */
      GlueConnectionName: 'STRING_VALUE', /* required */
      TempDirectory: {
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE'
      }
    },
    S3InputDefinition: {
      Bucket: 'STRING_VALUE', /* required */
      Key: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE', /* required */
  Format: CSV | JSON | PARQUET | EXCEL,
  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>': ... */
    }
  }
};
databrew.updateDataset(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 updated.

    • Format — (String)

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

      Possible values include:
      • "CSV"
      • "JSON"
      • "PARQUET"
      • "EXCEL"
    • 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 AWS Glue Data Catalog or Amazon S3.

      • S3InputDefinition — (map)

        The Amazon S3 location where the data is stored.

        • Bucketrequired — (String)

          The S3 bucket name.

        • Key — (String)

          The unique name of the object in the bucket.

      • DataCatalogInputDefinition — (map)

        The AWS Glue Data Catalog parameters for the data.

        • CatalogId — (String)

          The unique identifier of the AWS account that holds the Data Catalog that stores the data.

        • DatabaseNamerequired — (String)

          The name of a database in the Data Catalog.

        • TableNamerequired — (String)

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

        • TempDirectory — (map)

          An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

          • Bucketrequired — (String)

            The S3 bucket name.

          • Key — (String)

            The unique name of the object in the bucket.

      • DatabaseInputDefinition — (map)

        Connection information for dataset input files stored in a database.

        • GlueConnectionNamerequired — (String)

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

        • DatabaseTableNamerequired — (String)

          The table within the target database.

        • TempDirectory — (map)

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

          • Bucketrequired — (String)

            The S3 bucket name.

          • Key — (String)

            The unique name of the object in the bucket.

    • PathOptions — (map)

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

      • LastModifiedDateCondition — (map)

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

        • Expressionrequired — (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.

        • ValuesMaprequired — (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.

        • MaxFilesrequired — (Integer)

          The number of S3 files to select.

        • OrderedBy — (String)

          A criteria to use for 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 S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

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

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

        • Namerequired — (String)

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

        • Typerequired — (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.

          • Formatrequired — (String)

            Required option, that defines the datetime format used for a date parameter in the S3 path. Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character 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 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 loaded as an additional column in the dataset.

        • Filter — (map)

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

          • Expressionrequired — (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.

          • ValuesMaprequired — (map<String>)

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

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 updated.

Returns:

  • (AWS.Request)

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

updateProfileJob(params = {}, callback) ⇒ AWS.Request

Modifies the definition of an existing profile job.

Service Reference:

Examples:

Calling the updateProfileJob operation

var params = {
  Name: 'STRING_VALUE', /* required */
  OutputLocation: { /* required */
    Bucket: 'STRING_VALUE', /* required */
    Key: 'STRING_VALUE'
  },
  RoleArn: 'STRING_VALUE', /* required */
  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',
  Timeout: 'NUMBER_VALUE'
};
databrew.updateProfileJob(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: {})
    • 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 AWS KMS.

      • 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 updated.

    • 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 compute 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 and object key) where DataBrew can read input data, or write output from a job.

      • Bucketrequired — (String)

        The S3 bucket name.

      • Key — (String)

        The unique name of the object in the bucket.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the 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 for profile jobs, 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 updated.

Returns:

  • (AWS.Request)

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

updateProject(params = {}, callback) ⇒ AWS.Request

Modifies the definition of an existing DataBrew project.

Service Reference:

Examples:

Calling the updateProject operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  Sample: {
    Type: FIRST_N | LAST_N | RANDOM, /* required */
    Size: 'NUMBER_VALUE'
  }
};
databrew.updateProject(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: {})
    • 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.

      • Typerequired — (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 IAM role to be assumed for this request.

    • Name — (String)

      The name of the project to be updated.

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:

      • LastModifiedDate — (Date)

        The date and time that the project was last modified.

      • Name — (String)

        The name of the project that you updated.

Returns:

  • (AWS.Request)

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

updateRecipe(params = {}, callback) ⇒ AWS.Request

Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.

Service Reference:

Examples:

Calling the updateRecipe operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Steps: [
    {
      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 */
  ]
};
databrew.updateRecipe(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 of the recipe.

    • Name — (String)

      The name of the recipe to be updated.

    • Steps — (Array<map>)

      One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.

      • Actionrequired — (map)

        The particular action to be performed in the recipe step.

        • Operationrequired — (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.
        • Conditionrequired — (String)

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

        • Value — (String)

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

        • TargetColumnrequired — (String)

          A column to apply this condition to.

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 updated.

Returns:

  • (AWS.Request)

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

updateRecipeJob(params = {}, callback) ⇒ AWS.Request

Modifies the definition of an existing DataBrew recipe job.

Service Reference:

Examples:

Calling the updateRecipeJob operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Outputs: [ /* required */
    {
      Location: { /* required */
        Bucket: 'STRING_VALUE', /* required */
        Key: 'STRING_VALUE'
      },
      CompressionFormat: GZIP | LZ4 | SNAPPY | BZIP2 | DEFLATE | LZO | BROTLI | ZSTD | ZLIB,
      Format: CSV | JSON | PARQUET | GLUEPARQUET | AVRO | ORC | XML,
      FormatOptions: {
        Csv: {
          Delimiter: 'STRING_VALUE'
        }
      },
      Overwrite: true || false,
      PartitionColumns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  RoleArn: 'STRING_VALUE', /* required */
  EncryptionKeyArn: 'STRING_VALUE',
  EncryptionMode: SSE-KMS | SSE-S3,
  LogSubscription: ENABLE | DISABLE,
  MaxCapacity: 'NUMBER_VALUE',
  MaxRetries: 'NUMBER_VALUE',
  Timeout: 'NUMBER_VALUE'
};
databrew.updateRecipeJob(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: {})
    • 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 AWS KMS.

      • 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 update.

    • 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"
      • PartitionColumns — (Array<String>)

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

      • Locationrequired — (map)

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

        • Bucketrequired — (String)

          The S3 bucket name.

        • Key — (String)

          The unique name of the object in the bucket.

      • 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.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed when DataBrew runs the 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 updated.

Returns:

  • (AWS.Request)

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

updateSchedule(params = {}, callback) ⇒ AWS.Request

Modifies the definition of an existing DataBrew schedule.

Service Reference:

Examples:

Calling the updateSchedule operation

var params = {
  CronExpression: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  JobNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
databrew.updateSchedule(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 for this schedule.

    • 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 AWS Glue DataBrew Developer Guide.

    • Name — (String)

      The name of the schedule to update.

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 updated.

Returns:

  • (AWS.Request)

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