Class: AWS.Glue

Inherits:
AWS.Service show all
Identifier:
glue
API Version:
2017-03-31
Defined in:
(unknown)

Overview

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

Service Description

Defines the public endpoint for the AWS Glue service.

Sending a Request Using Glue

var glue = new AWS.Glue();
glue.batchCreatePartition(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 Glue object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var glue = new AWS.Glue({apiVersion: '2017-03-31'});

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

AWS.config.apiVersions = {
  glue: '2017-03-31',
  // other service API versions
};

var glue = new AWS.Glue();

Version:

  • 2017-03-31

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Glue object

var glue = new AWS.Glue({apiVersion: '2017-03-31'});

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

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

  • 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.Glue.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Glue.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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

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

Property Details

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

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

Creates one or more partitions in a batch operation.

Service Reference:

Examples:

Calling the batchCreatePartition operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  PartitionInputList: [ /* required */
    {
      LastAccessTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      LastAnalyzedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      Parameters: {
        '<KeyString>': 'STRING_VALUE',
        /* '<KeyString>': ... */
      },
      StorageDescriptor: {
        BucketColumns: [
          'STRING_VALUE',
          /* more items */
        ],
        Columns: [
          {
            Name: 'STRING_VALUE', /* required */
            Comment: 'STRING_VALUE',
            Type: 'STRING_VALUE'
          },
          /* more items */
        ],
        Compressed: true || false,
        InputFormat: 'STRING_VALUE',
        Location: 'STRING_VALUE',
        NumberOfBuckets: 'NUMBER_VALUE',
        OutputFormat: 'STRING_VALUE',
        Parameters: {
          '<KeyString>': 'STRING_VALUE',
          /* '<KeyString>': ... */
        },
        SerdeInfo: {
          Name: 'STRING_VALUE',
          Parameters: {
            '<KeyString>': 'STRING_VALUE',
            /* '<KeyString>': ... */
          },
          SerializationLibrary: 'STRING_VALUE'
        },
        SkewedInfo: {
          SkewedColumnNames: [
            'STRING_VALUE',
            /* more items */
          ],
          SkewedColumnValueLocationMaps: {
            '<ColumnValuesString>': 'STRING_VALUE',
            /* '<ColumnValuesString>': ... */
          },
          SkewedColumnValues: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        SortColumns: [
          {
            Column: 'STRING_VALUE', /* required */
            SortOrder: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ],
        StoredAsSubDirectories: true || false
      },
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.batchCreatePartition(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: {}) —
    • CatalogId — (String)

      The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID.

    • DatabaseName — (String)

      The name of the metadata database in which the partition is to be created.

    • TableName — (String)

      The name of the metadata table in which the partition is to be created.

    • PartitionInputList — (Array<map>)

      A list of PartitionInput structures that define the partitions to be created.

      • Values — (Array<String>)

        The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

      • LastAccessTime — (Date)

        The last time at which the partition was accessed.

      • StorageDescriptor — (map)

        Provides information about the physical location where the partition is stored.

        • Columns — (Array<map>)

          A list of the Columns in the table.

          • Name — required — (String)

            The name of the Column.

          • Type — (String)

            The datatype of data in the Column.

          • Comment — (String)

            Free-form text comment.

        • Location — (String)

          The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

        • InputFormat — (String)

          The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

        • OutputFormat — (String)

          The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

        • Compressed — (Boolean)

          True if the data in the table is compressed, or False if not.

        • NumberOfBuckets — (Integer)

          Must be specified if the table contains any dimension columns.

        • SerdeInfo — (map)

          Serialization/deserialization (SerDe) information.

          • Name — (String)

            Name of the SerDe.

          • SerializationLibrary — (String)

            Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

          • Parameters — (map<String>)

            These key-value pairs define initialization parameters for the SerDe.

        • BucketColumns — (Array<String>)

          A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

        • SortColumns — (Array<map>)

          A list specifying the sort order of each bucket in the table.

          • Column — required — (String)

            The name of the column.

          • SortOrder — required — (Integer)

            Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

        • Parameters — (map<String>)

          User-supplied properties in key-value form.

        • SkewedInfo — (map)

          Information about values that appear very frequently in a column (skewed values).

          • SkewedColumnNames — (Array<String>)

            A list of names of columns that contain skewed values.

          • SkewedColumnValues — (Array<String>)

            A list of values that appear so frequently as to be considered skewed.

          • SkewedColumnValueLocationMaps — (map<String>)

            A mapping of skewed values to the columns that contain them.

        • StoredAsSubDirectories — (Boolean)

          True if the table data is stored in subdirectories, or False if not.

      • Parameters — (map<String>)

        These key-value pairs define partition parameters.

      • LastAnalyzedTime — (Date)

        The last time at which column statistics were computed for this partition.

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:

      • Errors — (Array<map>)

        Errors encountered when trying to create the requested partitions.

        • PartitionValues — (Array<String>)

          The values that define the partition.

        • ErrorDetail — (map)

          Details about the partition error.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request) —

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

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

Deletes a list of connection definitions from the Data Catalog.

Service Reference:

Examples:

Calling the batchDeleteConnection operation

var params = {
  ConnectionNameList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  CatalogId: 'STRING_VALUE'
};
glue.batchDeleteConnection(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.

    • ConnectionNameList — (Array<String>)

      A list of names of the connections to delete.

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:

      • Succeeded — (Array<String>)

        A list of names of the connection definitions that were successfully deleted.

      • Errors — (map<map>)

        A map of the names of connections that were not successfully deleted to error details.

        • ErrorCode — (String)

          The code associated with this error.

        • ErrorMessage — (String)

          A message describing the error.

Returns:

  • (AWS.Request) —

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

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

Deletes one or more partitions in a batch operation.

Service Reference:

Examples:

Calling the batchDeletePartition operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  PartitionsToDelete: [ /* required */
    {
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.batchDeletePartition(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the partition to be deleted resides. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database in which the table in question resides.

    • TableName — (String)

      The name of the table where the partitions to be deleted is located.

    • PartitionsToDelete — (Array<map>)

      A list of PartitionInput structures that define the partitions to be deleted.

      • Values — required — (Array<String>)

        The list of values.

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:

      • Errors — (Array<map>)

        Errors encountered when trying to delete the requested partitions.

        • PartitionValues — (Array<String>)

          The values that define the partition.

        • ErrorDetail — (map)

          Details about the partition error.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request) —

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

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

Deletes multiple tables at once.

Note: After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.

Service Reference:

Examples:

Calling the batchDeleteTable operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TablesToDelete: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  CatalogId: 'STRING_VALUE'
};
glue.batchDeleteTable(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database where the tables to delete reside. For Hive compatibility, this name is entirely lowercase.

    • TablesToDelete — (Array<String>)

      A list of the table to delete.

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:

      • Errors — (Array<map>)

        A list of errors encountered in attempting to delete the specified tables.

        • TableName — (String)

          Name of the table. For Hive compatibility, this must be entirely lowercase.

        • ErrorDetail — (map)

          Detail about the error.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request) —

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

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

Deletes a specified batch of versions of a table.

Service Reference:

Examples:

Calling the batchDeleteTableVersion operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE', /* required */
  VersionIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  CatalogId: 'STRING_VALUE'
};
glue.batchDeleteTableVersion(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

    • TableName — (String)

      The name of the table. For Hive compatibility, this name is entirely lowercase.

    • VersionIds — (Array<String>)

      A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1.

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:

      • Errors — (Array<map>)

        A list of errors encountered while trying to delete the specified table versions.

        • TableName — (String)

          The name of the table in question.

        • VersionId — (String)

          The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.

        • ErrorDetail — (map)

          Detail about the error.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request) —

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

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

Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

Service Reference:

Examples:

Calling the batchGetCrawlers operation

var params = {
  CrawlerNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
glue.batchGetCrawlers(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: {}) —
    • CrawlerNames — (Array<String>)

      A list of crawler names, which may be the names returned from the ListCrawlers operation.

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:

      • Crawlers — (Array<map>)

        A list of crawler definitions.

        • Name — (String)

          The crawler name.

        • Role — (String)

          The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.

        • Targets — (map)

          A collection of targets to crawl.

          • S3Targets — (Array<map>)

            Specifies Amazon S3 targets.

            • Path — (String)

              The path to the Amazon S3 target.

            • Exclusions — (Array<String>)

              A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

          • JdbcTargets — (Array<map>)

            Specifies JDBC targets.

            • ConnectionName — (String)

              The name of the connection to use to connect to the JDBC target.

            • Path — (String)

              The path of the JDBC target.

            • Exclusions — (Array<String>)

              A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

          • DynamoDBTargets — (Array<map>)

            Specifies DynamoDB targets.

            • Path — (String)

              The name of the DynamoDB table to crawl.

        • DatabaseName — (String)

          The database where metadata is written by this crawler.

        • Description — (String)

          A description of the crawler.

        • Classifiers — (Array<String>)

          A list of custom classifiers associated with the crawler.

        • SchemaChangePolicy — (map)

          Sets the behavior when the crawler finds a changed or deleted object.

          • UpdateBehavior — (String)

            The update behavior when the crawler finds a changed schema.

            Possible values include:
            • "LOG"
            • "UPDATE_IN_DATABASE"
          • DeleteBehavior — (String)

            The deletion behavior when the crawler finds a deleted object.

            Possible values include:
            • "LOG"
            • "DELETE_FROM_DATABASE"
            • "DEPRECATE_IN_DATABASE"
        • State — (String)

          Indicates whether the crawler is running, or whether a run is pending.

          Possible values include:
          • "READY"
          • "RUNNING"
          • "STOPPING"
        • TablePrefix — (String)

          The prefix added to the names of tables that are created.

        • Schedule — (map)

          For scheduled crawlers, the schedule when the crawler runs.

          • ScheduleExpression — (String)

            A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

          • State — (String)

            The state of the schedule.

            Possible values include:
            • "SCHEDULED"
            • "NOT_SCHEDULED"
            • "TRANSITIONING"
        • CrawlElapsedTime — (Integer)

          If the crawler is running, contains the total time elapsed since the last crawl began.

        • CreationTime — (Date)

          The time when the crawler was created.

        • LastUpdated — (Date)

          The time the crawler was last updated.

        • LastCrawl — (map)

          The status of the last crawl, and potentially error information if an error occurred.

          • Status — (String)

            Status of the last crawl.

            Possible values include:
            • "SUCCEEDED"
            • "CANCELLED"
            • "FAILED"
          • ErrorMessage — (String)

            If an error occurred, the error information about the last crawl.

          • LogGroup — (String)

            The log group for the last crawl.

          • LogStream — (String)

            The log stream for the last crawl.

          • MessagePrefix — (String)

            The prefix for a message about this crawl.

          • StartTime — (Date)

            The time at which the crawl started.

        • Version — (Integer)

          The version of the crawler.

        • Configuration — (String)

          Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

        • CrawlerSecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used by this Crawler.

      • CrawlersNotFound — (Array<String>)

        A list of names of crawlers not found.

Returns:

  • (AWS.Request) —

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

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

Returns a list of resource metadata for a given list of DevEndpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

Service Reference:

Examples:

Calling the batchGetDevEndpoints operation

var params = {
  DevEndpointNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
glue.batchGetDevEndpoints(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: {}) —
    • DevEndpointNames — (Array<String>)

      The list of DevEndpoint names, which may be the names returned from the ListDevEndpoint operation.

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:

      • DevEndpoints — (Array<map>)

        A list of DevEndpoint definitions.

        • EndpointName — (String)

          The name of the DevEndpoint.

        • RoleArn — (String)

          The AWS ARN of the IAM role used in this DevEndpoint.

        • SecurityGroupIds — (Array<String>)

          A list of security group identifiers used in this DevEndpoint.

        • SubnetId — (String)

          The subnet ID for this DevEndpoint.

        • YarnEndpointAddress — (String)

          The YARN endpoint address used by this DevEndpoint.

        • PrivateAddress — (String)

          A private IP address to access the DevEndpoint within a VPC, if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your virtual private cloud (VPC).

        • ZeppelinRemoteSparkInterpreterPort — (Integer)

          The Apache Zeppelin port for the remote Apache Spark interpreter.

        • PublicAddress — (String)

          The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-VPC (virtual private cloud) DevEndpoint.

        • Status — (String)

          The current status of this DevEndpoint.

        • NumberOfNodes — (Integer)

          The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

        • AvailabilityZone — (String)

          The AWS availability zone where this DevEndpoint is located.

        • VpcId — (String)

          The ID of the virtual private cloud (VPC) used by this DevEndpoint.

        • ExtraPythonLibsS3Path — (String)

          Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

          Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

        • ExtraJarsS3Path — (String)

          Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

          Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint.

        • FailureReason — (String)

          The reason for a current failure in this DevEndpoint.

        • LastUpdateStatus — (String)

          The status of the last update.

        • CreatedTimestamp — (Date)

          The point in time at which this DevEndpoint was created.

        • LastModifiedTimestamp — (Date)

          The point in time at which this DevEndpoint was last modified.

        • PublicKey — (String)

          The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.

        • PublicKeys — (Array<String>)

          A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

          Note: If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this DevEndpoint.

        • Arguments — (map<String>)

          A map of arguments used to configure the DevEndpoint.

          Note that currently, we only support "--enable-glue-datacatalog": "" as a valid argument.

      • DevEndpointsNotFound — (Array<String>)

        A list of DevEndpoints not found.

Returns:

  • (AWS.Request) —

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

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

Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

Service Reference:

Examples:

Calling the batchGetJobs operation

var params = {
  JobNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
glue.batchGetJobs(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>)

      A list of job names, which may be the names returned from the ListJobs operation.

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 job definitions.

        • Name — (String)

          The name you assign to this job definition.

        • Description — (String)

          Description of the job being defined.

        • LogUri — (String)

          This field is reserved for future use.

        • Role — (String)

          The name or ARN of the IAM role associated with this job.

        • CreatedOn — (Date)

          The time and date that this job definition was created.

        • LastModifiedOn — (Date)

          The last point in time when this job definition was modified.

        • ExecutionProperty — (map)

          An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

          • MaxConcurrentRuns — (Integer)

            The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

        • Command — (map)

          The JobCommand that executes this job.

          • Name — (String)

            The name of the job command: this must be glueetl, for an Apache Spark ETL job, or pythonshell, for a Python shell job.

          • ScriptLocation — (String)

            Specifies the S3 path to a script that executes a job (required).

        • DefaultArguments — (map<String>)

          The default arguments for this job, specified as name-value pairs.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • Connections — (map)

          The connections used for this job.

          • Connections — (Array<String>)

            A list of connections used by the job.

        • MaxRetries — (Integer)

          The maximum number of times to retry this job after a JobRun fails.

        • AllocatedCapacity — (Integer)

          This field is deprecated, use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

        • Timeout — (Integer)

          The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

        • MaxCapacity — (Float)

          The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

          Do not set Max Capacity if using WorkerType and NumberOfWorkers.

          The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job:

          • When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

          • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

        • WorkerType — (String)

          The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

          • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

          • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

          • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

          Possible values include:
          • "Standard"
          • "G.1X"
          • "G.2X"
        • NumberOfWorkers — (Integer)

          The number of workers of a defined workerType that are allocated when a job runs.

          The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this job.

        • NotificationProperty — (map)

          Specifies configuration properties of a job notification.

          • NotifyDelayAfter — (Integer)

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

      • JobsNotFound — (Array<String>)

        A list of names of jobs not found.

Returns:

  • (AWS.Request) —

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

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

Retrieves partitions in a batch request.

Service Reference:

Examples:

Calling the batchGetPartition operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  PartitionsToGet: [ /* required */
    {
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.batchGetPartition(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database where the partitions reside.

    • TableName — (String)

      The name of the partitions' table.

    • PartitionsToGet — (Array<map>)

      A list of partition values identifying the partitions to retrieve.

      • Values — required — (Array<String>)

        The list of values.

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:

      • Partitions — (Array<map>)

        A list of the requested partitions.

        • Values — (Array<String>)

          The values of the partition.

        • DatabaseName — (String)

          The name of the catalog database where the table in question is located.

        • TableName — (String)

          The name of the table in question.

        • CreationTime — (Date)

          The time at which the partition was created.

        • LastAccessTime — (Date)

          The last time at which the partition was accessed.

        • StorageDescriptor — (map)

          Provides information about the physical location where the partition is stored.

          • Columns — (Array<map>)

            A list of the Columns in the table.

            • Name — required — (String)

              The name of the Column.

            • Type — (String)

              The datatype of data in the Column.

            • Comment — (String)

              Free-form text comment.

          • Location — (String)

            The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

          • InputFormat — (String)

            The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

          • OutputFormat — (String)

            The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

          • Compressed — (Boolean)

            True if the data in the table is compressed, or False if not.

          • NumberOfBuckets — (Integer)

            Must be specified if the table contains any dimension columns.

          • SerdeInfo — (map)

            Serialization/deserialization (SerDe) information.

            • Name — (String)

              Name of the SerDe.

            • SerializationLibrary — (String)

              Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

            • Parameters — (map<String>)

              These key-value pairs define initialization parameters for the SerDe.

          • BucketColumns — (Array<String>)

            A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

          • SortColumns — (Array<map>)

            A list specifying the sort order of each bucket in the table.

            • Column — required — (String)

              The name of the column.

            • SortOrder — required — (Integer)

              Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

          • Parameters — (map<String>)

            User-supplied properties in key-value form.

          • SkewedInfo — (map)

            Information about values that appear very frequently in a column (skewed values).

            • SkewedColumnNames — (Array<String>)

              A list of names of columns that contain skewed values.

            • SkewedColumnValues — (Array<String>)

              A list of values that appear so frequently as to be considered skewed.

            • SkewedColumnValueLocationMaps — (map<String>)

              A mapping of skewed values to the columns that contain them.

          • StoredAsSubDirectories — (Boolean)

            True if the table data is stored in subdirectories, or False if not.

        • Parameters — (map<String>)

          These key-value pairs define partition parameters.

        • LastAnalyzedTime — (Date)

          The last time at which column statistics were computed for this partition.

      • UnprocessedKeys — (Array<map>)

        A list of the partition values in the request for which partions were not returned.

        • Values — required — (Array<String>)

          The list of values.

Returns:

  • (AWS.Request) —

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

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

Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

Service Reference:

Examples:

Calling the batchGetTriggers operation

var params = {
  TriggerNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
glue.batchGetTriggers(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: {}) —
    • TriggerNames — (Array<String>)

      A list of trigger names, which may be the names returned from the ListTriggers operation.

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:

      • Triggers — (Array<map>)

        A list of trigger definitions.

        • Name — (String)

          Name of the trigger.

        • Id — (String)

          Reserved for future use.

        • Type — (String)

          The type of trigger that this is.

          Possible values include:
          • "SCHEDULED"
          • "CONDITIONAL"
          • "ON_DEMAND"
        • State — (String)

          The current state of the trigger.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "ACTIVATING"
          • "ACTIVATED"
          • "DEACTIVATING"
          • "DEACTIVATED"
          • "DELETING"
          • "UPDATING"
        • Description — (String)

          A description of this trigger.

        • Schedule — (String)

          A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

        • Actions — (Array<map>)

          The actions initiated by this trigger.

          • JobName — (String)

            The name of a job to be executed.

          • Arguments — (map<String>)

            The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

            You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

            For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

            For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • Timeout — (Integer)

            The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

          • NotificationProperty — (map)

            Specifies configuration properties of a job run notification.

            • NotifyDelayAfter — (Integer)

              After a job run starts, the number of minutes to wait before sending a job run delay notification.

          • SecurityConfiguration — (String)

            The name of the SecurityConfiguration structure to be used with this action.

        • Predicate — (map)

          The predicate of this trigger, which defines when it will fire.

          • Logical — (String)

            Optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

            Possible values include:
            • "AND"
            • "ANY"
          • Conditions — (Array<map>)

            A list of the conditions that determine when the trigger will fire.

            • LogicalOperator — (String)

              A logical operator.

              Possible values include:
              • "EQUALS"
            • JobName — (String)

              The name of the Job to whose JobRuns this condition applies and on which this trigger waits.

            • State — (String)

              The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT and FAILED.

              Possible values include:
              • "STARTING"
              • "RUNNING"
              • "STOPPING"
              • "STOPPED"
              • "SUCCEEDED"
              • "FAILED"
              • "TIMEOUT"
      • TriggersNotFound — (Array<String>)

        A list of names of triggers not found.

Returns:

  • (AWS.Request) —

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

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

Stops one or more job runs for a specified job definition.

Service Reference:

Examples:

Calling the batchStopJobRun operation

var params = {
  JobName: 'STRING_VALUE', /* required */
  JobRunIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
glue.batchStopJobRun(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 definition for which to stop job runs.

    • JobRunIds — (Array<String>)

      A list of the JobRunIds that should be stopped for that job definition.

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:

      • SuccessfulSubmissions — (Array<map>)

        A list of the JobRuns that were successfully submitted for stopping.

        • JobName — (String)

          The name of the job definition used in the job run that was stopped.

        • JobRunId — (String)

          The JobRunId of the job run that was stopped.

      • Errors — (Array<map>)

        A list of the errors that were encountered in tryng to stop JobRuns, including the JobRunId for which each error was encountered and details about the error.

        • JobName — (String)

          The name of the job definition used in the job run in question.

        • JobRunId — (String)

          The JobRunId of the job run in question.

        • ErrorDetail — (map)

          Specifies details about the error that was encountered.

          • ErrorCode — (String)

            The code associated with this error.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request) —

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

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

Creates a classifier in the user's account. This may be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.

Service Reference:

Examples:

Calling the createClassifier operation

var params = {
  CsvClassifier: {
    Name: 'STRING_VALUE', /* required */
    AllowSingleColumn: true || false,
    ContainsHeader: UNKNOWN | PRESENT | ABSENT,
    Delimiter: 'STRING_VALUE',
    DisableValueTrimming: true || false,
    Header: [
      'STRING_VALUE',
      /* more items */
    ],
    QuoteSymbol: 'STRING_VALUE'
  },
  GrokClassifier: {
    Classification: 'STRING_VALUE', /* required */
    GrokPattern: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE', /* required */
    CustomPatterns: 'STRING_VALUE'
  },
  JsonClassifier: {
    JsonPath: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE' /* required */
  },
  XMLClassifier: {
    Classification: 'STRING_VALUE', /* required */
    Name: 'STRING_VALUE', /* required */
    RowTag: 'STRING_VALUE'
  }
};
glue.createClassifier(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: {}) —
    • GrokClassifier — (map)

      A GrokClassifier object specifying the classifier to create.

      • Classification — required — (String)

        An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.

      • Name — required — (String)

        The name of the new classifier.

      • GrokPattern — required — (String)

        The grok pattern used by this classifier.

      • CustomPatterns — (String)

        Optional custom grok patterns used by this classifier.

    • XMLClassifier — (map)

      An XMLClassifier object specifying the classifier to create.

      • Classification — required — (String)

        An identifier of the data format that the classifier matches.

      • Name — required — (String)

        The name of the classifier.

      • RowTag — (String)

        The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

    • JsonClassifier — (map)

      A JsonClassifier object specifying the classifier to create.

      • Name — required — (String)

        The name of the classifier.

      • JsonPath — required — (String)

        A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

    • CsvClassifier — (map)

      A CsvClassifier object specifying the classifier to create.

      • Name — required — (String)

        The name of the classifier.

      • Delimiter — (String)

        A custom symbol to denote what separates each column entry in the row.

      • QuoteSymbol — (String)

        A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.

      • ContainsHeader — (String)

        Indicates whether the CSV file contains a header.

        Possible values include:
        • "UNKNOWN"
        • "PRESENT"
        • "ABSENT"
      • Header — (Array<String>)

        A list of strings representing column names.

      • DisableValueTrimming — (Boolean)

        Specifies not to trim values before identifying the type of column values. The default value is true.

      • AllowSingleColumn — (Boolean)

        Enables the processing of files that contain only one column.

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.

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

Creates a connection definition in the Data Catalog.

Service Reference:

Examples:

Calling the createConnection operation

var params = {
  ConnectionInput: { /* required */
    ConnectionProperties: { /* required */
      '<ConnectionPropertyKey>': 'STRING_VALUE',
      /* '<ConnectionPropertyKey>': ... */
    },
    ConnectionType: JDBC | SFTP, /* required */
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE',
    MatchCriteria: [
      'STRING_VALUE',
      /* more items */
    ],
    PhysicalConnectionRequirements: {
      AvailabilityZone: 'STRING_VALUE',
      SecurityGroupIdList: [
        'STRING_VALUE',
        /* more items */
      ],
      SubnetId: 'STRING_VALUE'
    }
  },
  CatalogId: 'STRING_VALUE'
};
glue.createConnection(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which to create the connection. If none is provided, the AWS account ID is used by default.

    • ConnectionInput — (map)

      A ConnectionInput object defining the connection to create.

      • Name — required — (String)

        The name of the connection.

      • Description — (String)

        The description of the connection.

      • ConnectionType — required — (String)

        The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

        Possible values include:
        • "JDBC"
        • "SFTP"
      • MatchCriteria — (Array<String>)

        A list of criteria that can be used in selecting this connection.

      • ConnectionProperties — required — (map<String>)

        These key-value pairs define parameters for the connection.

      • PhysicalConnectionRequirements — (map)

        A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

        • SubnetId — (String)

          The subnet ID used by the connection.

        • SecurityGroupIdList — (Array<String>)

          The security group ID list used by the connection.

        • AvailabilityZone — (String)

          The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

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.

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

Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.

Service Reference:

Examples:

Calling the createCrawler operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  Targets: { /* required */
    DynamoDBTargets: [
      {
        Path: 'STRING_VALUE'
      },
      /* more items */
    ],
    JdbcTargets: [
      {
        ConnectionName: 'STRING_VALUE',
        Exclusions: [
          'STRING_VALUE',
          /* more items */
        ],
        Path: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Targets: [
      {
        Exclusions: [
          'STRING_VALUE',
          /* more items */
        ],
        Path: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  Classifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  Configuration: 'STRING_VALUE',
  CrawlerSecurityConfiguration: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Schedule: 'STRING_VALUE',
  SchemaChangePolicy: {
    DeleteBehavior: LOG | DELETE_FROM_DATABASE | DEPRECATE_IN_DATABASE,
    UpdateBehavior: LOG | UPDATE_IN_DATABASE
  },
  TablePrefix: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glue.createCrawler(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)

      Name of the new crawler.

    • Role — (String)

      The IAM role (or ARN of an IAM role) used by the new crawler to access customer resources.

    • DatabaseName — (String)

      The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

    • Description — (String)

      A description of the new crawler.

    • Targets — (map)

      A list of collection of targets to crawl.

      • S3Targets — (Array<map>)

        Specifies Amazon S3 targets.

        • Path — (String)

          The path to the Amazon S3 target.

        • Exclusions — (Array<String>)

          A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

      • JdbcTargets — (Array<map>)

        Specifies JDBC targets.

        • ConnectionName — (String)

          The name of the connection to use to connect to the JDBC target.

        • Path — (String)

          The path of the JDBC target.

        • Exclusions — (Array<String>)

          A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

      • DynamoDBTargets — (Array<map>)

        Specifies DynamoDB targets.

        • Path — (String)

          The name of the DynamoDB table to crawl.

    • Schedule — (String)

      A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

    • Classifiers — (Array<String>)

      A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

    • TablePrefix — (String)

      The table prefix used for catalog tables that are created.

    • SchemaChangePolicy — (map)

      Policy for the crawler's update and deletion behavior.

      • UpdateBehavior — (String)

        The update behavior when the crawler finds a changed schema.

        Possible values include:
        • "LOG"
        • "UPDATE_IN_DATABASE"
      • DeleteBehavior — (String)

        The deletion behavior when the crawler finds a deleted object.

        Possible values include:
        • "LOG"
        • "DELETE_FROM_DATABASE"
        • "DEPRECATE_IN_DATABASE"
    • Configuration — (String)

      Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

    • CrawlerSecurityConfiguration — (String)

      The name of the SecurityConfiguration structure to be used by this Crawler.

    • Tags — (map<String>)

      The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

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.

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

Creates a new database in a Data Catalog.

Service Reference:

Examples:

Calling the createDatabase operation

var params = {
  DatabaseInput: { /* required */
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE',
    LocationUri: 'STRING_VALUE',
    Parameters: {
      '<KeyString>': 'STRING_VALUE',
      /* '<KeyString>': ... */
    }
  },
  CatalogId: 'STRING_VALUE'
};
glue.createDatabase(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which to create the database. If none is supplied, the AWS account ID is used by default.

    • DatabaseInput — (map)

      A DatabaseInput object defining the metadata database to create in the catalog.

      • Name — required — (String)

        Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

      • Description — (String)

        Description of the database

      • LocationUri — (String)

        The location of the database (for example, an HDFS path).

      • Parameters — (map<String>)

        Thes key-value pairs define parameters and properties of the database.

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.

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

Creates a new DevEndpoint.

Service Reference:

Examples:

Calling the createDevEndpoint operation

var params = {
  EndpointName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  Arguments: {
    '<GenericString>': 'STRING_VALUE',
    /* '<GenericString>': ... */
  },
  ExtraJarsS3Path: 'STRING_VALUE',
  ExtraPythonLibsS3Path: 'STRING_VALUE',
  NumberOfNodes: 'NUMBER_VALUE',
  PublicKey: 'STRING_VALUE',
  PublicKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  SecurityConfiguration: 'STRING_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SubnetId: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glue.createDevEndpoint(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: {}) —
    • EndpointName — (String)

      The name to be assigned to the new DevEndpoint.

    • RoleArn — (String)

      The IAM role for the DevEndpoint.

    • SecurityGroupIds — (Array<String>)

      Security group IDs for the security groups to be used by the new DevEndpoint.

    • SubnetId — (String)

      The subnet ID for the new DevEndpoint to use.

    • PublicKey — (String)

      The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.

    • PublicKeys — (Array<String>)

      A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

      Note: If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
    • NumberOfNodes — (Integer)

      The number of AWS Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.

    • ExtraPythonLibsS3Path — (String)

      Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

      Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

    • ExtraJarsS3Path — (String)

      Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

    • SecurityConfiguration — (String)

      The name of the SecurityConfiguration structure to be used with this DevEndpoint.

    • Tags — (map<String>)

      The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

    • Arguments — (map<String>)

      A map of arguments used to configure the DevEndpoint.

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:

      • EndpointName — (String)

        The name assigned to the new DevEndpoint.

      • Status — (String)

        The current status of the new DevEndpoint.

      • SecurityGroupIds — (Array<String>)

        The security groups assigned to the new DevEndpoint.

      • SubnetId — (String)

        The subnet ID assigned to the new DevEndpoint.

      • RoleArn — (String)

        The AWS ARN of the role assigned to the new DevEndpoint.

      • YarnEndpointAddress — (String)

        The address of the YARN endpoint used by this DevEndpoint.

      • ZeppelinRemoteSparkInterpreterPort — (Integer)

        The Apache Zeppelin port for the remote Apache Spark interpreter.

      • NumberOfNodes — (Integer)

        The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

      • AvailabilityZone — (String)

        The AWS availability zone where this DevEndpoint is located.

      • VpcId — (String)

        The ID of the VPC used by this DevEndpoint.

      • ExtraPythonLibsS3Path — (String)

        Path(s) to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint.

      • ExtraJarsS3Path — (String)

        Path to one or more Java Jars in an S3 bucket that will be loaded in your DevEndpoint.

      • FailureReason — (String)

        The reason for a current failure in this DevEndpoint.

      • SecurityConfiguration — (String)

        The name of the SecurityConfiguration structure being used with this DevEndpoint.

      • CreatedTimestamp — (Date)

        The point in time at which this DevEndpoint was created.

      • Arguments — (map<String>)

        The map of arguments used to configure this DevEndpoint.

Returns:

  • (AWS.Request) —

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

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

Creates a new job definition.

Service Reference:

Examples:

Calling the createJob operation

var params = {
  Command: { /* required */
    Name: 'STRING_VALUE',
    ScriptLocation: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE', /* required */
  Role: 'STRING_VALUE', /* required */
  AllocatedCapacity: 'NUMBER_VALUE',
  Connections: {
    Connections: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  DefaultArguments: {
    '<GenericString>': 'STRING_VALUE',
    /* '<GenericString>': ... */
  },
  Description: 'STRING_VALUE',
  ExecutionProperty: {
    MaxConcurrentRuns: 'NUMBER_VALUE'
  },
  LogUri: 'STRING_VALUE',
  MaxCapacity: 'NUMBER_VALUE',
  MaxRetries: 'NUMBER_VALUE',
  NotificationProperty: {
    NotifyDelayAfter: 'NUMBER_VALUE'
  },
  NumberOfWorkers: 'NUMBER_VALUE',
  SecurityConfiguration: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  Timeout: 'NUMBER_VALUE',
  WorkerType: Standard | G.1X | G.2X
};
glue.createJob(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 you assign to this job definition. It must be unique in your account.

    • Description — (String)

      Description of the job being defined.

    • LogUri — (String)

      This field is reserved for future use.

    • Role — (String)

      The name or ARN of the IAM role associated with this job.

    • ExecutionProperty — (map)

      An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

      • MaxConcurrentRuns — (Integer)

        The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

    • Command — (map)

      The JobCommand that executes this job.

      • Name — (String)

        The name of the job command: this must be glueetl, for an Apache Spark ETL job, or pythonshell, for a Python shell job.

      • ScriptLocation — (String)

        Specifies the S3 path to a script that executes a job (required).

    • DefaultArguments — (map<String>)

      The default arguments for this job.

      You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

      For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

      For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

    • Connections — (map)

      The connections used for this job.

      • Connections — (Array<String>)

        A list of connections used by the job.

    • MaxRetries — (Integer)

      The maximum number of times to retry this job if it fails.

    • AllocatedCapacity — (Integer)

      This parameter is deprecated. Use MaxCapacity instead.

      The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

    • Timeout — (Integer)

      The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

    • MaxCapacity — (Float)

      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

      Do not set Max Capacity if using WorkerType and NumberOfWorkers.

      The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job:

      • When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

      • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

    • NotificationProperty — (map)

      Specifies configuration properties of a job notification.

      • NotifyDelayAfter — (Integer)

        After a job run starts, the number of minutes to wait before sending a job run delay notification.

    • WorkerType — (String)

      The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

      Possible values include:
      • "Standard"
      • "G.1X"
      • "G.2X"
    • NumberOfWorkers — (Integer)

      The number of workers of a defined workerType that are allocated when a job runs.

      The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

    • SecurityConfiguration — (String)

      The name of the SecurityConfiguration structure to be used with this job.

    • Tags — (map<String>)

      The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Name — (String)

        The unique name that was provided for this job definition.

Returns:

  • (AWS.Request) —

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

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

Creates a new partition.

Service Reference:

Examples:

Calling the createPartition operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  PartitionInput: { /* required */
    LastAccessTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    LastAnalyzedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    Parameters: {
      '<KeyString>': 'STRING_VALUE',
      /* '<KeyString>': ... */
    },
    StorageDescriptor: {
      BucketColumns: [
        'STRING_VALUE',
        /* more items */
      ],
      Columns: [
        {
          Name: 'STRING_VALUE', /* required */
          Comment: 'STRING_VALUE',
          Type: 'STRING_VALUE'
        },
        /* more items */
      ],
      Compressed: true || false,
      InputFormat: 'STRING_VALUE',
      Location: 'STRING_VALUE',
      NumberOfBuckets: 'NUMBER_VALUE',
      OutputFormat: 'STRING_VALUE',
      Parameters: {
        '<KeyString>': 'STRING_VALUE',
        /* '<KeyString>': ... */
      },
      SerdeInfo: {
        Name: 'STRING_VALUE',
        Parameters: {
          '<KeyString>': 'STRING_VALUE',
          /* '<KeyString>': ... */
        },
        SerializationLibrary: 'STRING_VALUE'
      },
      SkewedInfo: {
        SkewedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ],
        SkewedColumnValueLocationMaps: {
          '<ColumnValuesString>': 'STRING_VALUE',
          /* '<ColumnValuesString>': ... */
        },
        SkewedColumnValues: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      SortColumns: [
        {
          Column: 'STRING_VALUE', /* required */
          SortOrder: 'NUMBER_VALUE' /* required */
        },
        /* more items */
      ],
      StoredAsSubDirectories: true || false
    },
    Values: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.createPartition(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: {}) —
    • CatalogId — (String)

      The ID of the catalog in which the partion is to be created. Currently, this should be the AWS account ID.

    • DatabaseName — (String)

      The name of the metadata database in which the partition is to be created.

    • TableName — (String)

      The name of the metadata table in which the partition is to be created.

    • PartitionInput — (map)

      A PartitionInput structure defining the partition to be created.

      • Values — (Array<String>)

        The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

      • LastAccessTime — (Date)

        The last time at which the partition was accessed.

      • StorageDescriptor — (map)

        Provides information about the physical location where the partition is stored.

        • Columns — (Array<map>)

          A list of the Columns in the table.

          • Name — required — (String)

            The name of the Column.

          • Type — (String)

            The datatype of data in the Column.

          • Comment — (String)

            Free-form text comment.

        • Location — (String)

          The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

        • InputFormat — (String)

          The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

        • OutputFormat — (String)

          The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

        • Compressed — (Boolean)

          True if the data in the table is compressed, or False if not.

        • NumberOfBuckets — (Integer)

          Must be specified if the table contains any dimension columns.

        • SerdeInfo — (map)

          Serialization/deserialization (SerDe) information.

          • Name — (String)

            Name of the SerDe.

          • SerializationLibrary — (String)

            Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

          • Parameters — (map<String>)

            These key-value pairs define initialization parameters for the SerDe.

        • BucketColumns — (Array<String>)

          A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

        • SortColumns — (Array<map>)

          A list specifying the sort order of each bucket in the table.

          • Column — required — (String)

            The name of the column.

          • SortOrder — required — (Integer)

            Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

        • Parameters — (map<String>)

          User-supplied properties in key-value form.

        • SkewedInfo — (map)

          Information about values that appear very frequently in a column (skewed values).

          • SkewedColumnNames — (Array<String>)

            A list of names of columns that contain skewed values.

          • SkewedColumnValues — (Array<String>)

            A list of values that appear so frequently as to be considered skewed.

          • SkewedColumnValueLocationMaps — (map<String>)

            A mapping of skewed values to the columns that contain them.

        • StoredAsSubDirectories — (Boolean)

          True if the table data is stored in subdirectories, or False if not.

      • Parameters — (map<String>)

        These key-value pairs define partition parameters.

      • LastAnalyzedTime — (Date)

        The last time at which column statistics were computed for this partition.

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.

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

Transforms a directed acyclic graph (DAG) into code.

Service Reference:

Examples:

Calling the createScript operation

var params = {
  DagEdges: [
    {
      Source: 'STRING_VALUE', /* required */
      Target: 'STRING_VALUE', /* required */
      TargetParameter: 'STRING_VALUE'
    },
    /* more items */
  ],
  DagNodes: [
    {
      Args: [ /* required */
        {
          Name: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE', /* required */
          Param: true || false
        },
        /* more items */
      ],
      Id: 'STRING_VALUE', /* required */
      NodeType: 'STRING_VALUE', /* required */
      LineNumber: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  Language: PYTHON | SCALA
};
glue.createScript(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: {}) —
    • DagNodes — (Array<map>)

      A list of the nodes in the DAG.

      • Id — required — (String)

        A node identifier that is unique within the node's graph.

      • NodeType — required — (String)

        The type of node this is.

      • Args — required — (Array<map>)

        Properties of the node, in the form of name-value pairs.

        • Name — required — (String)

          The name of the argument or property.

        • Value — required — (String)

          The value of the argument or property.

        • Param — (Boolean)

          True if the value is used as a parameter.

      • LineNumber — (Integer)

        The line number of the node.

    • DagEdges — (Array<map>)

      A list of the edges in the DAG.

      • Source — required — (String)

        The ID of the node at which the edge starts.

      • Target — required — (String)

        The ID of the node at which the edge ends.

      • TargetParameter — (String)

        The target of the edge.

    • Language — (String)

      The programming language of the resulting code from the DAG.

      Possible values include:
      • "PYTHON"
      • "SCALA"

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:

      • PythonScript — (String)

        The Python script generated from the DAG.

      • ScalaCode — (String)

        The Scala code generated from the DAG.

Returns:

  • (AWS.Request) —

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

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

Creates a new security configuration.

Service Reference:

Examples:

Calling the createSecurityConfiguration operation

var params = {
  EncryptionConfiguration: { /* required */
    CloudWatchEncryption: {
      CloudWatchEncryptionMode: DISABLED | SSE-KMS,
      KmsKeyArn: 'STRING_VALUE'
    },
    JobBookmarksEncryption: {
      JobBookmarksEncryptionMode: DISABLED | CSE-KMS,
      KmsKeyArn: 'STRING_VALUE'
    },
    S3Encryption: [
      {
        KmsKeyArn: 'STRING_VALUE',
        S3EncryptionMode: DISABLED | SSE-KMS | SSE-S3
      },
      /* more items */
    ]
  },
  Name: 'STRING_VALUE' /* required */
};
glue.createSecurityConfiguration(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 for the new security configuration.

    • EncryptionConfiguration — (map)

      The encryption configuration for the new security configuration.

      • S3Encryption — (Array<map>)

        The encryption configuration for S3 data.

        • S3EncryptionMode — (String)

          The encryption mode to use for S3 data.

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

          The AWS ARN of the KMS key to be used to encrypt the data.

      • CloudWatchEncryption — (map)

        The encryption configuration for CloudWatch.

        • CloudWatchEncryptionMode — (String)

          The encryption mode to use for CloudWatch data.

          Possible values include:
          • "DISABLED"
          • "SSE-KMS"
        • KmsKeyArn — (String)

          The AWS ARN of the KMS key to be used to encrypt the data.

      • JobBookmarksEncryption — (map)

        The encryption configuration for Job Bookmarks.

        • JobBookmarksEncryptionMode — (String)

          The encryption mode to use for Job bookmarks data.

          Possible values include:
          • "DISABLED"
          • "CSE-KMS"
        • KmsKeyArn — (String)

          The AWS ARN of the KMS key to be used to encrypt the data.

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 assigned to the new security configuration.

      • CreatedTimestamp — (Date)

        The time at which the new security configuration was created.

Returns:

  • (AWS.Request) —

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

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

Creates a new table definition in the Data Catalog.

Service Reference:

Examples:

Calling the createTable operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TableInput: { /* required */
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE',
    LastAccessTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    LastAnalyzedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    Owner: 'STRING_VALUE',
    Parameters: {
      '<KeyString>': 'STRING_VALUE',
      /* '<KeyString>': ... */
    },
    PartitionKeys: [
      {
        Name: 'STRING_VALUE', /* required */
        Comment: 'STRING_VALUE',
        Type: 'STRING_VALUE'
      },
      /* more items */
    ],
    Retention: 'NUMBER_VALUE',
    StorageDescriptor: {
      BucketColumns: [
        'STRING_VALUE',
        /* more items */
      ],
      Columns: [
        {
          Name: 'STRING_VALUE', /* required */
          Comment: 'STRING_VALUE',
          Type: 'STRING_VALUE'
        },
        /* more items */
      ],
      Compressed: true || false,
      InputFormat: 'STRING_VALUE',
      Location: 'STRING_VALUE',
      NumberOfBuckets: 'NUMBER_VALUE',
      OutputFormat: 'STRING_VALUE',
      Parameters: {
        '<KeyString>': 'STRING_VALUE',
        /* '<KeyString>': ... */
      },
      SerdeInfo: {
        Name: 'STRING_VALUE',
        Parameters: {
          '<KeyString>': 'STRING_VALUE',
          /* '<KeyString>': ... */
        },
        SerializationLibrary: 'STRING_VALUE'
      },
      SkewedInfo: {
        SkewedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ],
        SkewedColumnValueLocationMaps: {
          '<ColumnValuesString>': 'STRING_VALUE',
          /* '<ColumnValuesString>': ... */
        },
        SkewedColumnValues: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      SortColumns: [
        {
          Column: 'STRING_VALUE', /* required */
          SortOrder: 'NUMBER_VALUE' /* required */
        },
        /* more items */
      ],
      StoredAsSubDirectories: true || false
    },
    TableType: 'STRING_VALUE',
    ViewExpandedText: 'STRING_VALUE',
    ViewOriginalText: 'STRING_VALUE'
  },
  CatalogId: 'STRING_VALUE'
};
glue.createTable(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which to create the Table. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.

    • TableInput — (map)

      The TableInput object that defines the metadata table to create in the catalog.

      • Name — required — (String)

        Name of the table. For Hive compatibility, this is folded to lowercase when it is stored.

      • Description — (String)

        Description of the table.

      • Owner — (String)

        Owner of the table.

      • LastAccessTime — (Date)

        Last time the table was accessed.

      • LastAnalyzedTime — (Date)

        Last time column statistics were computed for this table.

      • Retention — (Integer)

        Retention time for this table.

      • StorageDescriptor — (map)

        A storage descriptor containing information about the physical storage of this table.

        • Columns — (Array<map>)

          A list of the Columns in the table.

          • Name — required — (String)

            The name of the Column.

          • Type — (String)

            The datatype of data in the Column.

          • Comment — (String)

            Free-form text comment.

        • Location — (String)

          The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

        • InputFormat — (String)

          The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

        • OutputFormat — (String)

          The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

        • Compressed — (Boolean)

          True if the data in the table is compressed, or False if not.

        • NumberOfBuckets — (Integer)

          Must be specified if the table contains any dimension columns.

        • SerdeInfo — (map)

          Serialization/deserialization (SerDe) information.

          • Name — (String)

            Name of the SerDe.

          • SerializationLibrary — (String)

            Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

          • Parameters — (map<String>)

            These key-value pairs define initialization parameters for the SerDe.

        • BucketColumns — (Array<String>)

          A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

        • SortColumns — (Array<map>)

          A list specifying the sort order of each bucket in the table.

          • Column — required — (String)

            The name of the column.

          • SortOrder — required — (Integer)

            Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

        • Parameters — (map<String>)

          User-supplied properties in key-value form.

        • SkewedInfo — (map)

          Information about values that appear very frequently in a column (skewed values).

          • SkewedColumnNames — (Array<String>)

            A list of names of columns that contain skewed values.

          • SkewedColumnValues — (Array<String>)

            A list of values that appear so frequently as to be considered skewed.

          • SkewedColumnValueLocationMaps — (map<String>)

            A mapping of skewed values to the columns that contain them.

        • StoredAsSubDirectories — (Boolean)

          True if the table data is stored in subdirectories, or False if not.

      • PartitionKeys — (Array<map>)

        A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

        When creating a table used by Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

        "PartitionKeys": []

        • Name — required — (String)

          The name of the Column.

        • Type — (String)

          The datatype of data in the Column.

        • Comment — (String)

          Free-form text comment.

      • ViewOriginalText — (String)

        If the table is a view, the original text of the view; otherwise null.

      • ViewExpandedText — (String)

        If the table is a view, the expanded text of the view; otherwise null.

      • TableType — (String)

        The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

      • Parameters — (map<String>)

        These key-value pairs define properties associated with the table.

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.

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

Creates a new trigger.

Service Reference:

Examples:

Calling the createTrigger operation

var params = {
  Actions: [ /* required */
    {
      Arguments: {
        '<GenericString>': 'STRING_VALUE',
        /* '<GenericString>': ... */
      },
      JobName: 'STRING_VALUE',
      NotificationProperty: {
        NotifyDelayAfter: 'NUMBER_VALUE'
      },
      SecurityConfiguration: 'STRING_VALUE',
      Timeout: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  Type: SCHEDULED | CONDITIONAL | ON_DEMAND, /* required */
  Description: 'STRING_VALUE',
  Predicate: {
    Conditions: [
      {
        JobName: 'STRING_VALUE',
        LogicalOperator: EQUALS,
        State: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT
      },
      /* more items */
    ],
    Logical: AND | ANY
  },
  Schedule: 'STRING_VALUE',
  StartOnCreation: true || false,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glue.createTrigger(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 trigger.

    • Type — (String)

      The type of the new trigger.

      Possible values include:
      • "SCHEDULED"
      • "CONDITIONAL"
      • "ON_DEMAND"
    • Schedule — (String)

      A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

      This field is required when the trigger type is SCHEDULED.

    • Predicate — (map)

      A predicate to specify when the new trigger should fire.

      This field is required when the trigger type is CONDITIONAL.

      • Logical — (String)

        Optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

        Possible values include:
        • "AND"
        • "ANY"
      • Conditions — (Array<map>)

        A list of the conditions that determine when the trigger will fire.

        • LogicalOperator — (String)

          A logical operator.

          Possible values include:
          • "EQUALS"
        • JobName — (String)

          The name of the Job to whose JobRuns this condition applies and on which this trigger waits.

        • State — (String)

          The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT and FAILED.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "SUCCEEDED"
          • "FAILED"
          • "TIMEOUT"
    • Actions — (Array<map>)

      The actions initiated by this trigger when it fires.

      • JobName — (String)

        The name of a job to be executed.

      • Arguments — (map<String>)

        The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

        For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

      • Timeout — (Integer)

        The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

      • NotificationProperty — (map)

        Specifies configuration properties of a job run notification.

        • NotifyDelayAfter — (Integer)

          After a job run starts, the number of minutes to wait before sending a job run delay notification.

      • SecurityConfiguration — (String)

        The name of the SecurityConfiguration structure to be used with this action.

    • Description — (String)

      A description of the new trigger.

    • StartOnCreation — (Boolean)

      Set to true to start SCHEDULED and CONDITIONAL triggers when created. True not supported for ON_DEMAND triggers.

    • Tags — (map<String>)

      The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

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

Returns:

  • (AWS.Request) —

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

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

Creates a new function definition in the Data Catalog.

Service Reference:

Examples:

Calling the createUserDefinedFunction operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  FunctionInput: { /* required */
    ClassName: 'STRING_VALUE',
    FunctionName: 'STRING_VALUE',
    OwnerName: 'STRING_VALUE',
    OwnerType: USER | ROLE | GROUP,
    ResourceUris: [
      {
        ResourceType: JAR | FILE | ARCHIVE,
        Uri: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  CatalogId: 'STRING_VALUE'
};
glue.createUserDefinedFunction(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which to create the function. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database in which to create the function.

    • FunctionInput — (map)

      A FunctionInput object that defines the function to create in the Data Catalog.

      • FunctionName — (String)

        The name of the function.

      • ClassName — (String)

        The Java class that contains the function code.

      • OwnerName — (String)

        The owner of the function.

      • OwnerType — (String)

        The owner type.

        Possible values include:
        • "USER"
        • "ROLE"
        • "GROUP"
      • ResourceUris — (Array<map>)

        The resource URIs for the function.

        • ResourceType — (String)

          The type of the resource.

          Possible values include:
          • "JAR"
          • "FILE"
          • "ARCHIVE"
        • Uri — (String)

          The URI for accessing 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.

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

Removes a classifier from the Data Catalog.

Service Reference:

Examples:

Calling the deleteClassifier operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.deleteClassifier(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)

      Name of the classifier to remove.

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.

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

Deletes a connection from the Data Catalog.

Service Reference:

Examples:

Calling the deleteConnection operation

var params = {
  ConnectionName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.deleteConnection(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.

    • ConnectionName — (String)

      The name of the connection to delete.

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.

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

Removes a specified crawler from the Data Catalog, unless the crawler state is RUNNING.

Service Reference:

Examples:

Calling the deleteCrawler operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.deleteCrawler(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)

      Name of the crawler to remove.

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.

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

Removes a specified Database from a Data Catalog.

Note: After completing this operation, you will no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database.

Service Reference:

Examples:

Calling the deleteDatabase operation

var params = {
  Name: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.deleteDatabase(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.

    • Name — (String)

      The name of the Database to delete. For Hive compatibility, this must be all lowercase.

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.

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

Deletes a specified DevEndpoint.

Service Reference:

Examples:

Calling the deleteDevEndpoint operation

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

      The name of the DevEndpoint.

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.

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

Deletes a specified job definition. If the job definition is not found, no exception is thrown.

Service Reference:

Examples:

Calling the deleteJob operation

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

      The name of the job definition to delete.

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:

      • JobName — (String)

        The name of the job definition that was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes a specified partition.

Service Reference:

Examples:

Calling the deletePartition operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  PartitionValues: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.deletePartition(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the partition to be deleted resides. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database in which the table in question resides.

    • TableName — (String)

      The name of the table where the partition to be deleted is located.

    • PartitionValues — (Array<String>)

      The values that define the partition.

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.

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

Deletes a specified policy.

Service Reference:

Examples:

Calling the deleteResourcePolicy operation

var params = {
  PolicyHashCondition: 'STRING_VALUE'
};
glue.deleteResourcePolicy(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: {}) —
    • PolicyHashCondition — (String)

      The hash value returned when this policy was set.

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.

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

Deletes a specified security configuration.

Service Reference:

Examples:

Calling the deleteSecurityConfiguration operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.deleteSecurityConfiguration(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 security configuration to delete.

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.

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

Removes a table definition from the Data Catalog.

Note: After completing this operation, you will no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure immediate deletion of all related resources, before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.

Service Reference:

Examples:

Calling the deleteTable operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.deleteTable(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

    • Name — (String)

      The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.

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.

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

Deletes a specified version of a table.

Service Reference:

Examples:

Calling the deleteTableVersion operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.deleteTableVersion(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

    • TableName — (String)

      The name of the table. For Hive compatibility, this name is entirely lowercase.

    • VersionId — (String)

      The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.

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.

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

Deletes a specified trigger. If the trigger is not found, no exception is thrown.

Service Reference:

Examples:

Calling the deleteTrigger operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.deleteTrigger(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 trigger to delete.

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 trigger that was deleted.

Returns:

  • (AWS.Request) —

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

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

Deletes an existing function definition from the Data Catalog.

Service Reference:

Examples:

Calling the deleteUserDefinedFunction operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  FunctionName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.deleteUserDefinedFunction(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database where the function is located.

    • FunctionName — (String)

      The name of the function definition 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.

Returns:

  • (AWS.Request) —

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

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

Retrieves the status of a migration operation.

Service Reference:

Examples:

Calling the getCatalogImportStatus operation

var params = {
  CatalogId: 'STRING_VALUE'
};
glue.getCatalogImportStatus(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: {}) —
    • CatalogId — (String)

      The ID of the catalog to migrate. Currently, this should be the AWS account ID.

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:

      • ImportStatus — (map)

        The status of the specified catalog migration.

        • ImportCompleted — (Boolean)

          True if the migration has completed, or False otherwise.

        • ImportTime — (Date)

          The time that the migration was started.

        • ImportedBy — (String)

          The name of the person who initiated the migration.

Returns:

  • (AWS.Request) —

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

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

Retrieve a classifier by name.

Service Reference:

Examples:

Calling the getClassifier operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.getClassifier(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)

      Name of the classifier to retrieve.

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:

      • Classifier — (map)

        The requested classifier.

        • GrokClassifier — (map)

          A GrokClassifier object.

          • Name — required — (String)

            The name of the classifier.

          • Classification — required — (String)

            An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

          • CreationTime — (Date)

            The time this classifier was registered.

          • LastUpdated — (Date)

            The time this classifier was last updated.

          • Version — (Integer)

            The version of this classifier.

          • GrokPattern — required — (String)

            The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifers.

          • CustomPatterns — (String)

            Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifers.

        • XMLClassifier — (map)

          An XMLClassifier object.

          • Name — required — (String)

            The name of the classifier.

          • Classification — required — (String)

            An identifier of the data format that the classifier matches.

          • CreationTime — (Date)

            The time this classifier was registered.

          • LastUpdated — (Date)

            The time this classifier was last updated.

          • Version — (Integer)

            The version of this classifier.

          • RowTag — (String)

            The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

        • JsonClassifier — (map)

          A JsonClassifier object.

          • Name — required — (String)

            The name of the classifier.

          • CreationTime — (Date)

            The time this classifier was registered.

          • LastUpdated — (Date)

            The time this classifier was last updated.

          • Version — (Integer)

            The version of this classifier.

          • JsonPath — required — (String)

            A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

        • CsvClassifier — (map)

          A CSVClassifier object.

          • Name — required — (String)

            The name of the classifier.

          • CreationTime — (Date)

            The time this classifier was registered.

          • LastUpdated — (Date)

            The time this classifier was last updated.

          • Version — (Integer)

            The version of this classifier.

          • Delimiter — (String)

            A custom symbol to denote what separates each column entry in the row.

          • QuoteSymbol — (String)

            A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.

          • ContainsHeader — (String)

            Indicates whether the CSV file contains a header.

            Possible values include:
            • "UNKNOWN"
            • "PRESENT"
            • "ABSENT"
          • Header — (Array<String>)

            A list of strings representing column names.

          • DisableValueTrimming — (Boolean)

            Specifies not to trim values before identifying the type of column values. The default value is true.

          • AllowSingleColumn — (Boolean)

            Enables the processing of files that contain only one column.

Returns:

  • (AWS.Request) —

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

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

Lists all classifier objects in the Data Catalog.

Service Reference:

Examples:

Calling the getClassifiers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getClassifiers(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)

      Size of the list to return (optional).

    • NextToken — (String)

      An optional continuation token.

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:

      • Classifiers — (Array<map>)

        The requested list of classifier objects.

        • GrokClassifier — (map)

          A GrokClassifier object.

          • Name — required — (String)

            The name of the classifier.

          • Classification — required — (String)

            An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

          • CreationTime — (Date)

            The time this classifier was registered.

          • LastUpdated — (Date)

            The time this classifier was last updated.

          • Version — (Integer)

            The version of this classifier.

          • GrokPattern — required — (String)

            The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifers.

          • CustomPatterns — (String)

            Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifers.

        • XMLClassifier — (map)

          An XMLClassifier object.

          • Name — required — (String)

            The name of the classifier.

          • Classification — required — (String)

            An identifier of the data format that the classifier matches.

          • CreationTime — (Date)

            The time this classifier was registered.

          • LastUpdated — (Date)

            The time this classifier was last updated.

          • Version — (Integer)

            The version of this classifier.

          • RowTag — (String)

            The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

        • JsonClassifier — (map)

          A JsonClassifier object.

          • Name — required — (String)

            The name of the classifier.

          • CreationTime — (Date)

            The time this classifier was registered.

          • LastUpdated — (Date)

            The time this classifier was last updated.

          • Version — (Integer)

            The version of this classifier.

          • JsonPath — required — (String)

            A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

        • CsvClassifier — (map)

          A CSVClassifier object.

          • Name — required — (String)

            The name of the classifier.

          • CreationTime — (Date)

            The time this classifier was registered.

          • LastUpdated — (Date)

            The time this classifier was last updated.

          • Version — (Integer)

            The version of this classifier.

          • Delimiter — (String)

            A custom symbol to denote what separates each column entry in the row.

          • QuoteSymbol — (String)

            A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.

          • ContainsHeader — (String)

            Indicates whether the CSV file contains a header.

            Possible values include:
            • "UNKNOWN"
            • "PRESENT"
            • "ABSENT"
          • Header — (Array<String>)

            A list of strings representing column names.

          • DisableValueTrimming — (Boolean)

            Specifies not to trim values before identifying the type of column values. The default value is true.

          • AllowSingleColumn — (Boolean)

            Enables the processing of files that contain only one column.

      • NextToken — (String)

        A continuation token.

Returns:

  • (AWS.Request) —

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

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

Retrieves a connection definition from the Data Catalog.

Service Reference:

Examples:

Calling the getConnection operation

var params = {
  Name: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  HidePassword: true || false
};
glue.getConnection(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.

    • Name — (String)

      The name of the connection definition to retrieve.

    • HidePassword — (Boolean)

      Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.

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:

      • Connection — (map)

        The requested connection definition.

        • Name — (String)

          The name of the connection definition.

        • Description — (String)

          The description of the connection.

        • ConnectionType — (String)

          The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

          Possible values include:
          • "JDBC"
          • "SFTP"
        • MatchCriteria — (Array<String>)

          A list of criteria that can be used in selecting this connection.

        • ConnectionProperties — (map<String>)

          These key-value pairs define parameters for the connection:

          • HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.

          • PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.

          • USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME".

          • PASSWORD - A password, if one is used, for the user name.

          • ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

          • JDBC_DRIVER_JAR_URI - The Amazon S3 path of the JAR file that contains the JDBC driver to use.

          • JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

          • JDBC_ENGINE - The name of the JDBC engine to use.

          • JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

          • CONFIG_FILES - (Reserved for future use).

          • INSTANCE_ID - The instance ID to use.

          • JDBC_CONNECTION_URL - The URL for the JDBC connection.

          • JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching will be enforced for the JDBC connection on the client. The default is false.

        • PhysicalConnectionRequirements — (map)

          A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.

          • SubnetId — (String)

            The subnet ID used by the connection.

          • SecurityGroupIdList — (Array<String>)

            The security group ID list used by the connection.

          • AvailabilityZone — (String)

            The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

        • CreationTime — (Date)

          The time that this connection definition was created.

        • LastUpdatedTime — (Date)

          The last time that this connection definition was updated.

        • LastUpdatedBy — (String)

          The user, group, or role that last updated this connection definition.

Returns:

  • (AWS.Request) —

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

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

Retrieves a list of connection definitions from the Data Catalog.

Service Reference:

Examples:

Calling the getConnections operation

var params = {
  CatalogId: 'STRING_VALUE',
  Filter: {
    ConnectionType: JDBC | SFTP,
    MatchCriteria: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  HidePassword: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getConnections(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.

    • Filter — (map)

      A filter that controls which connections will be returned.

      • MatchCriteria — (Array<String>)

        A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.

      • ConnectionType — (String)

        The type of connections to return. Currently, only JDBC is supported; SFTP is not supported.

        Possible values include:
        • "JDBC"
        • "SFTP"
    • HidePassword — (Boolean)

      Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but does have permission to access the rest of the connection properties.

    • NextToken — (String)

      A continuation token, if this is a continuation call.

    • MaxResults — (Integer)

      The maximum number of connections to return in one response.

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:

      • ConnectionList — (Array<map>)

        A list of requested connection definitions.

        • Name — (String)

          The name of the connection definition.

        • Description — (String)

          The description of the connection.

        • ConnectionType — (String)

          The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

          Possible values include:
          • "JDBC"
          • "SFTP"
        • MatchCriteria — (Array<String>)

          A list of criteria that can be used in selecting this connection.

        • ConnectionProperties — (map<String>)

          These key-value pairs define parameters for the connection:

          • HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.

          • PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.

          • USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME".

          • PASSWORD - A password, if one is used, for the user name.

          • ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

          • JDBC_DRIVER_JAR_URI - The Amazon S3 path of the JAR file that contains the JDBC driver to use.

          • JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

          • JDBC_ENGINE - The name of the JDBC engine to use.

          • JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

          • CONFIG_FILES - (Reserved for future use).

          • INSTANCE_ID - The instance ID to use.

          • JDBC_CONNECTION_URL - The URL for the JDBC connection.

          • JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching will be enforced for the JDBC connection on the client. The default is false.

        • PhysicalConnectionRequirements — (map)

          A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.

          • SubnetId — (String)

            The subnet ID used by the connection.

          • SecurityGroupIdList — (Array<String>)

            The security group ID list used by the connection.

          • AvailabilityZone — (String)

            The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

        • CreationTime — (Date)

          The time that this connection definition was created.

        • LastUpdatedTime — (Date)

          The last time that this connection definition was updated.

        • LastUpdatedBy — (String)

          The user, group, or role that last updated this connection definition.

      • NextToken — (String)

        A continuation token, if the list of connections returned does not include the last of the filtered connections.

Returns:

  • (AWS.Request) —

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

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

Retrieves metadata for a specified crawler.

Service Reference:

Examples:

Calling the getCrawler operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.getCrawler(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)

      Name of the crawler to retrieve metadata for.

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:

      • Crawler — (map)

        The metadata for the specified crawler.

        • Name — (String)

          The crawler name.

        • Role — (String)

          The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.

        • Targets — (map)

          A collection of targets to crawl.

          • S3Targets — (Array<map>)

            Specifies Amazon S3 targets.

            • Path — (String)

              The path to the Amazon S3 target.

            • Exclusions — (Array<String>)

              A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

          • JdbcTargets — (Array<map>)

            Specifies JDBC targets.

            • ConnectionName — (String)

              The name of the connection to use to connect to the JDBC target.

            • Path — (String)

              The path of the JDBC target.

            • Exclusions — (Array<String>)

              A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

          • DynamoDBTargets — (Array<map>)

            Specifies DynamoDB targets.

            • Path — (String)

              The name of the DynamoDB table to crawl.

        • DatabaseName — (String)

          The database where metadata is written by this crawler.

        • Description — (String)

          A description of the crawler.

        • Classifiers — (Array<String>)

          A list of custom classifiers associated with the crawler.

        • SchemaChangePolicy — (map)

          Sets the behavior when the crawler finds a changed or deleted object.

          • UpdateBehavior — (String)

            The update behavior when the crawler finds a changed schema.

            Possible values include:
            • "LOG"
            • "UPDATE_IN_DATABASE"
          • DeleteBehavior — (String)

            The deletion behavior when the crawler finds a deleted object.

            Possible values include:
            • "LOG"
            • "DELETE_FROM_DATABASE"
            • "DEPRECATE_IN_DATABASE"
        • State — (String)

          Indicates whether the crawler is running, or whether a run is pending.

          Possible values include:
          • "READY"
          • "RUNNING"
          • "STOPPING"
        • TablePrefix — (String)

          The prefix added to the names of tables that are created.

        • Schedule — (map)

          For scheduled crawlers, the schedule when the crawler runs.

          • ScheduleExpression — (String)

            A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

          • State — (String)

            The state of the schedule.

            Possible values include:
            • "SCHEDULED"
            • "NOT_SCHEDULED"
            • "TRANSITIONING"
        • CrawlElapsedTime — (Integer)

          If the crawler is running, contains the total time elapsed since the last crawl began.

        • CreationTime — (Date)

          The time when the crawler was created.

        • LastUpdated — (Date)

          The time the crawler was last updated.

        • LastCrawl — (map)

          The status of the last crawl, and potentially error information if an error occurred.

          • Status — (String)

            Status of the last crawl.

            Possible values include:
            • "SUCCEEDED"
            • "CANCELLED"
            • "FAILED"
          • ErrorMessage — (String)

            If an error occurred, the error information about the last crawl.

          • LogGroup — (String)

            The log group for the last crawl.

          • LogStream — (String)

            The log stream for the last crawl.

          • MessagePrefix — (String)

            The prefix for a message about this crawl.

          • StartTime — (Date)

            The time at which the crawl started.

        • Version — (Integer)

          The version of the crawler.

        • Configuration — (String)

          Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

        • CrawlerSecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used by this Crawler.

Returns:

  • (AWS.Request) —

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

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

Retrieves metrics about specified crawlers.

Service Reference:

Examples:

Calling the getCrawlerMetrics operation

var params = {
  CrawlerNameList: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getCrawlerMetrics(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: {}) —
    • CrawlerNameList — (Array<String>)

      A list of the names of crawlers about which to retrieve metrics.

    • MaxResults — (Integer)

      The maximum size of a list to return.

    • NextToken — (String)

      A continuation token, if this is a continuation call.

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:

      • CrawlerMetricsList — (Array<map>)

        A list of metrics for the specified crawler.

        • CrawlerName — (String)

          The name of the crawler.

        • TimeLeftSeconds — (Float)

          The estimated time left to complete a running crawl.

        • StillEstimating — (Boolean)

          True if the crawler is still estimating how long it will take to complete this run.

        • LastRuntimeSeconds — (Float)

          The duration of the crawler's most recent run, in seconds.

        • MedianRuntimeSeconds — (Float)

          The median duration of this crawler's runs, in seconds.

        • TablesCreated — (Integer)

          The number of tables created by this crawler.

        • TablesUpdated — (Integer)

          The number of tables updated by this crawler.

        • TablesDeleted — (Integer)

          The number of tables deleted by this crawler.

      • NextToken — (String)

        A continuation token, if the returned list does not contain the last metric available.

Returns:

  • (AWS.Request) —

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

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

Retrieves metadata for all crawlers defined in the customer account.

Service Reference:

Examples:

Calling the getCrawlers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getCrawlers(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 number of crawlers to return on each call.

    • NextToken — (String)

      A continuation token, if this is a continuation 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:

      • Crawlers — (Array<map>)

        A list of crawler metadata.

        • Name — (String)

          The crawler name.

        • Role — (String)

          The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.

        • Targets — (map)

          A collection of targets to crawl.

          • S3Targets — (Array<map>)

            Specifies Amazon S3 targets.

            • Path — (String)

              The path to the Amazon S3 target.

            • Exclusions — (Array<String>)

              A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

          • JdbcTargets — (Array<map>)

            Specifies JDBC targets.

            • ConnectionName — (String)

              The name of the connection to use to connect to the JDBC target.

            • Path — (String)

              The path of the JDBC target.

            • Exclusions — (Array<String>)

              A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

          • DynamoDBTargets — (Array<map>)

            Specifies DynamoDB targets.

            • Path — (String)

              The name of the DynamoDB table to crawl.

        • DatabaseName — (String)

          The database where metadata is written by this crawler.

        • Description — (String)

          A description of the crawler.

        • Classifiers — (Array<String>)

          A list of custom classifiers associated with the crawler.

        • SchemaChangePolicy — (map)

          Sets the behavior when the crawler finds a changed or deleted object.

          • UpdateBehavior — (String)

            The update behavior when the crawler finds a changed schema.

            Possible values include:
            • "LOG"
            • "UPDATE_IN_DATABASE"
          • DeleteBehavior — (String)

            The deletion behavior when the crawler finds a deleted object.

            Possible values include:
            • "LOG"
            • "DELETE_FROM_DATABASE"
            • "DEPRECATE_IN_DATABASE"
        • State — (String)

          Indicates whether the crawler is running, or whether a run is pending.

          Possible values include:
          • "READY"
          • "RUNNING"
          • "STOPPING"
        • TablePrefix — (String)

          The prefix added to the names of tables that are created.

        • Schedule — (map)

          For scheduled crawlers, the schedule when the crawler runs.

          • ScheduleExpression — (String)

            A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

          • State — (String)

            The state of the schedule.

            Possible values include:
            • "SCHEDULED"
            • "NOT_SCHEDULED"
            • "TRANSITIONING"
        • CrawlElapsedTime — (Integer)

          If the crawler is running, contains the total time elapsed since the last crawl began.

        • CreationTime — (Date)

          The time when the crawler was created.

        • LastUpdated — (Date)

          The time the crawler was last updated.

        • LastCrawl — (map)

          The status of the last crawl, and potentially error information if an error occurred.

          • Status — (String)

            Status of the last crawl.

            Possible values include:
            • "SUCCEEDED"
            • "CANCELLED"
            • "FAILED"
          • ErrorMessage — (String)

            If an error occurred, the error information about the last crawl.

          • LogGroup — (String)

            The log group for the last crawl.

          • LogStream — (String)

            The log stream for the last crawl.

          • MessagePrefix — (String)

            The prefix for a message about this crawl.

          • StartTime — (Date)

            The time at which the crawl started.

        • Version — (Integer)

          The version of the crawler.

        • Configuration — (String)

          Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

        • CrawlerSecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used by this Crawler.

      • NextToken — (String)

        A continuation token, if the returned list has not reached the end of those defined in this customer account.

Returns:

  • (AWS.Request) —

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

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

Retrieves the definition of a specified database.

Service Reference:

Examples:

Calling the getDatabase operation

var params = {
  Name: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.getDatabase(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which the database resides. If none is supplied, the AWS account ID is used by default.

    • Name — (String)

      The name of the database to retrieve. For Hive compatibility, this should be all lowercase.

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:

      • Database — (map)

        The definition of the specified database in the catalog.

        • Name — required — (String)

          Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

        • Description — (String)

          Description of the database.

        • LocationUri — (String)

          The location of the database (for example, an HDFS path).

        • Parameters — (map<String>)

          These key-value pairs define parameters and properties of the database.

        • CreateTime — (Date)

          The time at which the metadata database was created in the catalog.

Returns:

  • (AWS.Request) —

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

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

Retrieves all Databases defined in a given Data Catalog.

Service Reference:

Examples:

Calling the getDatabases operation

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

      The ID of the Data Catalog from which to retrieve Databases. If none is supplied, the AWS account ID is used by default.

    • NextToken — (String)

      A continuation token, if this is a continuation call.

    • MaxResults — (Integer)

      The maximum number of databases to return in one response.

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:

      • DatabaseList — (Array<map>)

        A list of Database objects from the specified catalog.

        • Name — required — (String)

          Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

        • Description — (String)

          Description of the database.

        • LocationUri — (String)

          The location of the database (for example, an HDFS path).

        • Parameters — (map<String>)

          These key-value pairs define parameters and properties of the database.

        • CreateTime — (Date)

          The time at which the metadata database was created in the catalog.

      • NextToken — (String)

        A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

Returns:

  • (AWS.Request) —

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

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

Retrieves the security configuration for a specified catalog.

Service Reference:

Examples:

Calling the getDataCatalogEncryptionSettings operation

var params = {
  CatalogId: 'STRING_VALUE'
};
glue.getDataCatalogEncryptionSettings(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog for which to retrieve the security configuration. If none is provided, the AWS account ID is used by default.

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:

      • DataCatalogEncryptionSettings — (map)

        The requested security configuration.

        • EncryptionAtRest — (map)

          Specifies the encryption-at-rest configuration for the Data Catalog.

          • CatalogEncryptionMode — required — (String)

            The encryption-at-rest mode for encrypting Data Catalog data.

            Possible values include:
            • "DISABLED"
            • "SSE-KMS"
          • SseAwsKmsKeyId — (String)

            The ID of the AWS KMS key to use for encryption at rest.

        • ConnectionPasswordEncryption — (map)

          When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.

          • ReturnConnectionPasswordEncrypted — required — (Boolean)

            When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.

          • AwsKmsKeyId — (String)

            An AWS KMS key that is used to encrypt the connection password.

            If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

            You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

Returns:

  • (AWS.Request) —

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

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

Transforms a Python script into a directed acyclic graph (DAG).

Service Reference:

Examples:

Calling the getDataflowGraph operation

var params = {
  PythonScript: 'STRING_VALUE'
};
glue.getDataflowGraph(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: {}) —
    • PythonScript — (String)

      The Python script to transform.

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:

      • DagNodes — (Array<map>)

        A list of the nodes in the resulting DAG.

        • Id — required — (String)

          A node identifier that is unique within the node's graph.

        • NodeType — required — (String)

          The type of node this is.

        • Args — required — (Array<map>)

          Properties of the node, in the form of name-value pairs.

          • Name — required — (String)

            The name of the argument or property.

          • Value — required — (String)

            The value of the argument or property.

          • Param — (Boolean)

            True if the value is used as a parameter.

        • LineNumber — (Integer)

          The line number of the node.

      • DagEdges — (Array<map>)

        A list of the edges in the resulting DAG.

        • Source — required — (String)

          The ID of the node at which the edge starts.

        • Target — required — (String)

          The ID of the node at which the edge ends.

        • TargetParameter — (String)

          The target of the edge.

Returns:

  • (AWS.Request) —

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

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

Retrieves information about a specified DevEndpoint.

Note: When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address.

Service Reference:

Examples:

Calling the getDevEndpoint operation

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

      Name of the DevEndpoint for which to retrieve 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:

      • DevEndpoint — (map)

        A DevEndpoint definition.

        • EndpointName — (String)

          The name of the DevEndpoint.

        • RoleArn — (String)

          The AWS ARN of the IAM role used in this DevEndpoint.

        • SecurityGroupIds — (Array<String>)

          A list of security group identifiers used in this DevEndpoint.

        • SubnetId — (String)

          The subnet ID for this DevEndpoint.

        • YarnEndpointAddress — (String)

          The YARN endpoint address used by this DevEndpoint.

        • PrivateAddress — (String)

          A private IP address to access the DevEndpoint within a VPC, if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your virtual private cloud (VPC).

        • ZeppelinRemoteSparkInterpreterPort — (Integer)

          The Apache Zeppelin port for the remote Apache Spark interpreter.

        • PublicAddress — (String)

          The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-VPC (virtual private cloud) DevEndpoint.

        • Status — (String)

          The current status of this DevEndpoint.

        • NumberOfNodes — (Integer)

          The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

        • AvailabilityZone — (String)

          The AWS availability zone where this DevEndpoint is located.

        • VpcId — (String)

          The ID of the virtual private cloud (VPC) used by this DevEndpoint.

        • ExtraPythonLibsS3Path — (String)

          Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

          Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

        • ExtraJarsS3Path — (String)

          Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

          Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint.

        • FailureReason — (String)

          The reason for a current failure in this DevEndpoint.

        • LastUpdateStatus — (String)

          The status of the last update.

        • CreatedTimestamp — (Date)

          The point in time at which this DevEndpoint was created.

        • LastModifiedTimestamp — (Date)

          The point in time at which this DevEndpoint was last modified.

        • PublicKey — (String)

          The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.

        • PublicKeys — (Array<String>)

          A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

          Note: If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this DevEndpoint.

        • Arguments — (map<String>)

          A map of arguments used to configure the DevEndpoint.

          Note that currently, we only support "--enable-glue-datacatalog": "" as a valid argument.

Returns:

  • (AWS.Request) —

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

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

Retrieves all the DevEndpoints in this AWS account.

Note: When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address.

Service Reference:

Examples:

Calling the getDevEndpoints operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getDevEndpoints(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 size of information to return.

    • NextToken — (String)

      A continuation token, if this is a continuation call.

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:

      • DevEndpoints — (Array<map>)

        A list of DevEndpoint definitions.

        • EndpointName — (String)

          The name of the DevEndpoint.

        • RoleArn — (String)

          The AWS ARN of the IAM role used in this DevEndpoint.

        • SecurityGroupIds — (Array<String>)

          A list of security group identifiers used in this DevEndpoint.

        • SubnetId — (String)

          The subnet ID for this DevEndpoint.

        • YarnEndpointAddress — (String)

          The YARN endpoint address used by this DevEndpoint.

        • PrivateAddress — (String)

          A private IP address to access the DevEndpoint within a VPC, if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your virtual private cloud (VPC).

        • ZeppelinRemoteSparkInterpreterPort — (Integer)

          The Apache Zeppelin port for the remote Apache Spark interpreter.

        • PublicAddress — (String)

          The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-VPC (virtual private cloud) DevEndpoint.

        • Status — (String)

          The current status of this DevEndpoint.

        • NumberOfNodes — (Integer)

          The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

        • AvailabilityZone — (String)

          The AWS availability zone where this DevEndpoint is located.

        • VpcId — (String)

          The ID of the virtual private cloud (VPC) used by this DevEndpoint.

        • ExtraPythonLibsS3Path — (String)

          Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

          Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

        • ExtraJarsS3Path — (String)

          Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

          Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint.

        • FailureReason — (String)

          The reason for a current failure in this DevEndpoint.

        • LastUpdateStatus — (String)

          The status of the last update.

        • CreatedTimestamp — (Date)

          The point in time at which this DevEndpoint was created.

        • LastModifiedTimestamp — (Date)

          The point in time at which this DevEndpoint was last modified.

        • PublicKey — (String)

          The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.

        • PublicKeys — (Array<String>)

          A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

          Note: If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this DevEndpoint.

        • Arguments — (map<String>)

          A map of arguments used to configure the DevEndpoint.

          Note that currently, we only support "--enable-glue-datacatalog": "" as a valid argument.

      • NextToken — (String)

        A continuation token, if not all DevEndpoint definitions have yet been returned.

Returns:

  • (AWS.Request) —

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

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

Retrieves an existing job definition.

Service Reference:

Examples:

Calling the getJob operation

var params = {
  JobName: 'STRING_VALUE' /* required */
};
glue.getJob(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 definition to retrieve.

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:

      • Job — (map)

        The requested job definition.

        • Name — (String)

          The name you assign to this job definition.

        • Description — (String)

          Description of the job being defined.

        • LogUri — (String)

          This field is reserved for future use.

        • Role — (String)

          The name or ARN of the IAM role associated with this job.

        • CreatedOn — (Date)

          The time and date that this job definition was created.

        • LastModifiedOn — (Date)

          The last point in time when this job definition was modified.

        • ExecutionProperty — (map)

          An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

          • MaxConcurrentRuns — (Integer)

            The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

        • Command — (map)

          The JobCommand that executes this job.

          • Name — (String)

            The name of the job command: this must be glueetl, for an Apache Spark ETL job, or pythonshell, for a Python shell job.

          • ScriptLocation — (String)

            Specifies the S3 path to a script that executes a job (required).

        • DefaultArguments — (map<String>)

          The default arguments for this job, specified as name-value pairs.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • Connections — (map)

          The connections used for this job.

          • Connections — (Array<String>)

            A list of connections used by the job.

        • MaxRetries — (Integer)

          The maximum number of times to retry this job after a JobRun fails.

        • AllocatedCapacity — (Integer)

          This field is deprecated, use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

        • Timeout — (Integer)

          The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

        • MaxCapacity — (Float)

          The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

          Do not set Max Capacity if using WorkerType and NumberOfWorkers.

          The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job:

          • When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

          • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

        • WorkerType — (String)

          The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

          • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

          • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

          • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

          Possible values include:
          • "Standard"
          • "G.1X"
          • "G.2X"
        • NumberOfWorkers — (Integer)

          The number of workers of a defined workerType that are allocated when a job runs.

          The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this job.

        • NotificationProperty — (map)

          Specifies configuration properties of a job notification.

          • NotifyDelayAfter — (Integer)

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

Returns:

  • (AWS.Request) —

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

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

Retrieves the metadata for a given job run.

Service Reference:

Examples:

Calling the getJobRun operation

var params = {
  JobName: 'STRING_VALUE', /* required */
  RunId: 'STRING_VALUE', /* required */
  PredecessorsIncluded: true || false
};
glue.getJobRun(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)

      Name of the job definition being run.

    • RunId — (String)

      The ID of the job run.

    • PredecessorsIncluded — (Boolean)

      True if a list of predecessor runs should be 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:

      • JobRun — (map)

        The requested job-run metadata.

        • Id — (String)

          The ID of this job run.

        • Attempt — (Integer)

          The number of the attempt to run this job.

        • PreviousRunId — (String)

          The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

        • TriggerName — (String)

          The name of the trigger that started this job run.

        • JobName — (String)

          The name of the job definition being used in this run.

        • StartedOn — (Date)

          The date and time at which this job run was started.

        • LastModifiedOn — (Date)

          The last time this job run was modified.

        • CompletedOn — (Date)

          The date and time this job run completed.

        • JobRunState — (String)

          The current state of the job run.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "SUCCEEDED"
          • "FAILED"
          • "TIMEOUT"
        • Arguments — (map<String>)

          The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • ErrorMessage — (String)

          An error message associated with this job run.

        • PredecessorRuns — (Array<map>)

          A list of predecessors to this job run.

          • JobName — (String)

            The name of the job definition used by the predecessor job run.

          • RunId — (String)

            The job-run ID of the predecessor job run.

        • AllocatedCapacity — (Integer)

          This field is deprecated, use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

        • ExecutionTime — (Integer)

          The amount of time (in seconds) that the job run consumed resources.

        • Timeout — (Integer)

          The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

        • MaxCapacity — (Float)

          The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

          Do not set Max Capacity if using WorkerType and NumberOfWorkers.

          The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job:

          • When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

          • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

        • NotificationProperty — (map)

          Specifies configuration properties of a job run notification.

          • NotifyDelayAfter — (Integer)

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

        • WorkerType — (String)

          The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

          • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

          • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

          • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

          Possible values include:
          • "Standard"
          • "G.1X"
          • "G.2X"
        • NumberOfWorkers — (Integer)

          The number of workers of a defined workerType that are allocated when a job runs.

          The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this job run.

        • LogGroupName — (String)

          The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration will be used to encrypt the log group.

Returns:

  • (AWS.Request) —

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

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

Retrieves metadata for all runs of a given job definition.

Service Reference:

Examples:

Calling the getJobRuns operation

var params = {
  JobName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getJobRuns(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 definition for which to retrieve all job runs.

    • NextToken — (String)

      A continuation token, if this is a continuation call.

    • MaxResults — (Integer)

      The maximum size of the response.

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-run metatdata objects.

        • Id — (String)

          The ID of this job run.

        • Attempt — (Integer)

          The number of the attempt to run this job.

        • PreviousRunId — (String)

          The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

        • TriggerName — (String)

          The name of the trigger that started this job run.

        • JobName — (String)

          The name of the job definition being used in this run.

        • StartedOn — (Date)

          The date and time at which this job run was started.

        • LastModifiedOn — (Date)

          The last time this job run was modified.

        • CompletedOn — (Date)

          The date and time this job run completed.

        • JobRunState — (String)

          The current state of the job run.

          Possible values include:
          • "STARTING"
          • "RUNNING"
          • "STOPPING"
          • "STOPPED"
          • "SUCCEEDED"
          • "FAILED"
          • "TIMEOUT"
        • Arguments — (map<String>)

          The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • ErrorMessage — (String)

          An error message associated with this job run.

        • PredecessorRuns — (Array<map>)

          A list of predecessors to this job run.

          • JobName — (String)

            The name of the job definition used by the predecessor job run.

          • RunId — (String)

            The job-run ID of the predecessor job run.

        • AllocatedCapacity — (Integer)

          This field is deprecated, use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

        • ExecutionTime — (Integer)

          The amount of time (in seconds) that the job run consumed resources.

        • Timeout — (Integer)

          The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

        • MaxCapacity — (Float)

          The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

          Do not set Max Capacity if using WorkerType and NumberOfWorkers.

          The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job:

          • When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

          • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

        • NotificationProperty — (map)

          Specifies configuration properties of a job run notification.

          • NotifyDelayAfter — (Integer)

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

        • WorkerType — (String)

          The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

          • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

          • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

          • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

          Possible values include:
          • "Standard"
          • "G.1X"
          • "G.2X"
        • NumberOfWorkers — (Integer)

          The number of workers of a defined workerType that are allocated when a job runs.

          The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this job run.

        • LogGroupName — (String)

          The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration will be used to encrypt the log group.

      • NextToken — (String)

        A continuation token, if not all reequested job runs have been returned.

Returns:

  • (AWS.Request) —

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

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

Retrieves all current job definitions.

Service Reference:

Examples:

Calling the getJobs operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getJobs(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)

      A continuation token, if this is a continuation call.

    • MaxResults — (Integer)

      The maximum size of the response.

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 job definitions.

        • Name — (String)

          The name you assign to this job definition.

        • Description — (String)

          Description of the job being defined.

        • LogUri — (String)

          This field is reserved for future use.

        • Role — (String)

          The name or ARN of the IAM role associated with this job.

        • CreatedOn — (Date)

          The time and date that this job definition was created.

        • LastModifiedOn — (Date)

          The last point in time when this job definition was modified.

        • ExecutionProperty — (map)

          An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

          • MaxConcurrentRuns — (Integer)

            The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

        • Command — (map)

          The JobCommand that executes this job.

          • Name — (String)

            The name of the job command: this must be glueetl, for an Apache Spark ETL job, or pythonshell, for a Python shell job.

          • ScriptLocation — (String)

            Specifies the S3 path to a script that executes a job (required).

        • DefaultArguments — (map<String>)

          The default arguments for this job, specified as name-value pairs.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • Connections — (map)

          The connections used for this job.

          • Connections — (Array<String>)

            A list of connections used by the job.

        • MaxRetries — (Integer)

          The maximum number of times to retry this job after a JobRun fails.

        • AllocatedCapacity — (Integer)

          This field is deprecated, use MaxCapacity instead.

          The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

        • Timeout — (Integer)

          The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

        • MaxCapacity — (Float)

          The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

          Do not set Max Capacity if using WorkerType and NumberOfWorkers.

          The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job:

          • When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

          • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

        • WorkerType — (String)

          The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

          • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

          • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

          • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

          Possible values include:
          • "Standard"
          • "G.1X"
          • "G.2X"
        • NumberOfWorkers — (Integer)

          The number of workers of a defined workerType that are allocated when a job runs.

          The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this job.

        • NotificationProperty — (map)

          Specifies configuration properties of a job notification.

          • NotifyDelayAfter — (Integer)

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

      • NextToken — (String)

        A continuation token, if not all job definitions have yet been returned.

Returns:

  • (AWS.Request) —

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

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

Creates mappings.

Service Reference:

Examples:

Calling the getMapping operation

var params = {
  Source: { /* required */
    DatabaseName: 'STRING_VALUE', /* required */
    TableName: 'STRING_VALUE' /* required */
  },
  Location: {
    DynamoDB: [
      {
        Name: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE', /* required */
        Param: true || false
      },
      /* more items */
    ],
    Jdbc: [
      {
        Name: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE', /* required */
        Param: true || false
      },
      /* more items */
    ],
    S3: [
      {
        Name: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE', /* required */
        Param: true || false
      },
      /* more items */
    ]
  },
  Sinks: [
    {
      DatabaseName: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
glue.getMapping(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: {}) —
    • Source — (map)

      Specifies the source table.

      • DatabaseName — required — (String)

        The database in which the table metadata resides.

      • TableName — required — (String)

        The name of the table in question.

    • Sinks — (Array<map>)

      A list of target tables.

      • DatabaseName — required — (String)

        The database in which the table metadata resides.

      • TableName — required — (String)

        The name of the table in question.

    • Location — (map)

      Parameters for the mapping.

      • Jdbc — (Array<map>)

        A JDBC location.

        • Name — required — (String)

          The name of the argument or property.

        • Value — required — (String)

          The value of the argument or property.

        • Param — (Boolean)

          True if the value is used as a parameter.

      • S3 — (Array<map>)

        An Amazon S3 location.

        • Name — required — (String)

          The name of the argument or property.

        • Value — required — (String)

          The value of the argument or property.

        • Param — (Boolean)

          True if the value is used as a parameter.

      • DynamoDB — (Array<map>)

        A DynamoDB Table location.

        • Name — required — (String)

          The name of the argument or property.

        • Value — required — (String)

          The value of the argument or property.

        • Param — (Boolean)

          True if the value is used as a parameter.

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:

      • Mapping — (Array<map>)

        A list of mappings to the specified targets.

        • SourceTable — (String)

          The name of the source table.

        • SourcePath — (String)

          The source path.

        • SourceType — (String)

          The source type.

        • TargetTable — (String)

          The target table.

        • TargetPath — (String)

          The target path.

        • TargetType — (String)

          The target type.

Returns:

  • (AWS.Request) —

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

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

Retrieves information about a specified partition.

Service Reference:

Examples:

Calling the getPartition operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  PartitionValues: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.getPartition(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the partition in question resides. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database where the partition resides.

    • TableName — (String)

      The name of the partition's table.

    • PartitionValues — (Array<String>)

      The values that define the partition.

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:

      • Partition — (map)

        The requested information, in the form of a Partition object.

        • Values — (Array<String>)

          The values of the partition.

        • DatabaseName — (String)

          The name of the catalog database where the table in question is located.

        • TableName — (String)

          The name of the table in question.

        • CreationTime — (Date)

          The time at which the partition was created.

        • LastAccessTime — (Date)

          The last time at which the partition was accessed.

        • StorageDescriptor — (map)

          Provides information about the physical location where the partition is stored.

          • Columns — (Array<map>)

            A list of the Columns in the table.

            • Name — required — (String)

              The name of the Column.

            • Type — (String)

              The datatype of data in the Column.

            • Comment — (String)

              Free-form text comment.

          • Location — (String)

            The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

          • InputFormat — (String)

            The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

          • OutputFormat — (String)

            The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

          • Compressed — (Boolean)

            True if the data in the table is compressed, or False if not.

          • NumberOfBuckets — (Integer)

            Must be specified if the table contains any dimension columns.

          • SerdeInfo — (map)

            Serialization/deserialization (SerDe) information.

            • Name — (String)

              Name of the SerDe.

            • SerializationLibrary — (String)

              Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

            • Parameters — (map<String>)

              These key-value pairs define initialization parameters for the SerDe.

          • BucketColumns — (Array<String>)

            A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

          • SortColumns — (Array<map>)

            A list specifying the sort order of each bucket in the table.

            • Column — required — (String)

              The name of the column.

            • SortOrder — required — (Integer)

              Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

          • Parameters — (map<String>)

            User-supplied properties in key-value form.

          • SkewedInfo — (map)

            Information about values that appear very frequently in a column (skewed values).

            • SkewedColumnNames — (Array<String>)

              A list of names of columns that contain skewed values.

            • SkewedColumnValues — (Array<String>)

              A list of values that appear so frequently as to be considered skewed.

            • SkewedColumnValueLocationMaps — (map<String>)

              A mapping of skewed values to the columns that contain them.

          • StoredAsSubDirectories — (Boolean)

            True if the table data is stored in subdirectories, or False if not.

        • Parameters — (map<String>)

          These key-value pairs define partition parameters.

        • LastAnalyzedTime — (Date)

          The last time at which column statistics were computed for this partition.

Returns:

  • (AWS.Request) —

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

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

Retrieves information about the partitions in a table.

Service Reference:

Examples:

Calling the getPartitions operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  Expression: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Segment: {
    SegmentNumber: 'NUMBER_VALUE', /* required */
    TotalSegments: 'NUMBER_VALUE' /* required */
  }
};
glue.getPartitions(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database where the partitions reside.

    • TableName — (String)

      The name of the partitions' table.

    • Expression — (String)

      An expression filtering the partitions to be returned.

      The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.

      Operators: The following are the operators that you can use in the Expression API call:

      =

      Checks if the values of the two operands are equal or not; if yes, then the condition becomes true.

      Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

      (a = b) is not true.

      < >

      Checks if the values of two operands are equal or not; if the values are not equal, then the condition becomes true.

      Example: (a < > b) is true.

      >

      Checks if the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.

      Example: (a > b) is not true.

      <

      Checks if the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.

      Example: (a < b) is true.

      >=

      Checks if the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.

      Example: (a >= b) is not true.

      <=

      Checks if the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.

      Example: (a <= b) is true.

      AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

      Logical operators.

      Supported Partition Key Types: The following are the the supported partition keys.

      • string

      • date

      • timestamp

      • int

      • bigint

      • long

      • tinyint

      • smallint

      • decimal

      If an invalid type is encountered, an exception is thrown.

      The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING, to be compatible with the catalog partitions.

      Sample API Call:

    • NextToken — (String)

      A continuation token, if this is not the first call to retrieve these partitions.

    • Segment — (map)

      The segment of the table's partitions to scan in this request.

      • SegmentNumber — required — (Integer)

        The zero-based index number of the this segment. For example, if the total number of segments is 4, SegmentNumber values will range from zero through three.

      • TotalSegments — required — (Integer)

        The total numer of segments.

    • MaxResults — (Integer)

      The maximum number of partitions to return in a single response.

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:

      • Partitions — (Array<map>)

        A list of requested partitions.

        • Values — (Array<String>)

          The values of the partition.

        • DatabaseName — (String)

          The name of the catalog database where the table in question is located.

        • TableName — (String)

          The name of the table in question.

        • CreationTime — (Date)

          The time at which the partition was created.

        • LastAccessTime — (Date)

          The last time at which the partition was accessed.

        • StorageDescriptor — (map)

          Provides information about the physical location where the partition is stored.

          • Columns — (Array<map>)

            A list of the Columns in the table.

            • Name — required — (String)

              The name of the Column.

            • Type — (String)

              The datatype of data in the Column.

            • Comment — (String)

              Free-form text comment.

          • Location — (String)

            The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

          • InputFormat — (String)

            The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

          • OutputFormat — (String)

            The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

          • Compressed — (Boolean)

            True if the data in the table is compressed, or False if not.

          • NumberOfBuckets — (Integer)

            Must be specified if the table contains any dimension columns.

          • SerdeInfo — (map)

            Serialization/deserialization (SerDe) information.

            • Name — (String)

              Name of the SerDe.

            • SerializationLibrary — (String)

              Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

            • Parameters — (map<String>)

              These key-value pairs define initialization parameters for the SerDe.

          • BucketColumns — (Array<String>)

            A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

          • SortColumns — (Array<map>)

            A list specifying the sort order of each bucket in the table.

            • Column — required — (String)

              The name of the column.

            • SortOrder — required — (Integer)

              Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

          • Parameters — (map<String>)

            User-supplied properties in key-value form.

          • SkewedInfo — (map)

            Information about values that appear very frequently in a column (skewed values).

            • SkewedColumnNames — (Array<String>)

              A list of names of columns that contain skewed values.

            • SkewedColumnValues — (Array<String>)

              A list of values that appear so frequently as to be considered skewed.

            • SkewedColumnValueLocationMaps — (map<String>)

              A mapping of skewed values to the columns that contain them.

          • StoredAsSubDirectories — (Boolean)

            True if the table data is stored in subdirectories, or False if not.

        • Parameters — (map<String>)

          These key-value pairs define partition parameters.

        • LastAnalyzedTime — (Date)

          The last time at which column statistics were computed for this partition.

      • NextToken — (String)

        A continuation token, if the returned list of partitions does not does not include the last one.

Returns:

  • (AWS.Request) —

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

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

Gets code to perform a specified mapping.

Service Reference:

Examples:

Calling the getPlan operation

var params = {
  Mapping: [ /* required */
    {
      SourcePath: 'STRING_VALUE',
      SourceTable: 'STRING_VALUE',
      SourceType: 'STRING_VALUE',
      TargetPath: 'STRING_VALUE',
      TargetTable: 'STRING_VALUE',
      TargetType: 'STRING_VALUE'
    },
    /* more items */
  ],
  Source: { /* required */
    DatabaseName: 'STRING_VALUE', /* required */
    TableName: 'STRING_VALUE' /* required */
  },
  Language: PYTHON | SCALA,
  Location: {
    DynamoDB: [
      {
        Name: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE', /* required */
        Param: true || false
      },
      /* more items */
    ],
    Jdbc: [
      {
        Name: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE', /* required */
        Param: true || false
      },
      /* more items */
    ],
    S3: [
      {
        Name: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE', /* required */
        Param: true || false
      },
      /* more items */
    ]
  },
  Sinks: [
    {
      DatabaseName: 'STRING_VALUE', /* required */
      TableName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
glue.getPlan(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: {}) —
    • Mapping — (Array<map>)

      The list of mappings from a source table to target tables.

      • SourceTable — (String)

        The name of the source table.

      • SourcePath — (String)

        The source path.

      • SourceType — (String)

        The source type.

      • TargetTable — (String)

        The target table.

      • TargetPath — (String)

        The target path.

      • TargetType — (String)

        The target type.

    • Source — (map)

      The source table.

      • DatabaseName — required — (String)

        The database in which the table metadata resides.

      • TableName — required — (String)

        The name of the table in question.

    • Sinks — (Array<map>)

      The target tables.

      • DatabaseName — required — (String)

        The database in which the table metadata resides.

      • TableName — required — (String)

        The name of the table in question.

    • Location — (map)

      Parameters for the mapping.

      • Jdbc — (Array<map>)

        A JDBC location.

        • Name — required — (String)

          The name of the argument or property.

        • Value — required — (String)

          The value of the argument or property.

        • Param — (Boolean)

          True if the value is used as a parameter.

      • S3 — (Array<map>)

        An Amazon S3 location.

        • Name — required — (String)

          The name of the argument or property.

        • Value — required — (String)

          The value of the argument or property.

        • Param — (Boolean)

          True if the value is used as a parameter.

      • DynamoDB — (Array<map>)

        A DynamoDB Table location.

        • Name — required — (String)

          The name of the argument or property.

        • Value — required — (String)

          The value of the argument or property.

        • Param — (Boolean)

          True if the value is used as a parameter.

    • Language — (String)

      The programming language of the code to perform the mapping.

      Possible values include:
      • "PYTHON"
      • "SCALA"

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:

      • PythonScript — (String)

        A Python script to perform the mapping.

      • ScalaCode — (String)

        Scala code to perform the mapping.

Returns:

  • (AWS.Request) —

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

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

Retrieves a specified resource policy.

Service Reference:

Examples:

Calling the getResourcePolicy operation

var params = {
};
glue.getResourcePolicy(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: {})

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:

      • PolicyInJson — (String)

        Contains the requested policy document, in JSON format.

      • PolicyHash — (String)

        Contains the hash value associated with this policy.

      • CreateTime — (Date)

        The date and time at which the policy was created.

      • UpdateTime — (Date)

        The date and time at which the policy was last updated.

Returns:

  • (AWS.Request) —

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

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

Retrieves a specified security configuration.

Service Reference:

Examples:

Calling the getSecurityConfiguration operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.getSecurityConfiguration(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 security configuration to retrieve.

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:

      • SecurityConfiguration — (map)

        The requested security configuration

        • Name — (String)

          The name of the security configuration.

        • CreatedTimeStamp — (Date)

          The time at which this security configuration was created.

        • EncryptionConfiguration — (map)

          The encryption configuration associated with this security configuration.

          • S3Encryption — (Array<map>)

            The encryption configuration for S3 data.

            • S3EncryptionMode — (String)

              The encryption mode to use for S3 data.

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

              The AWS ARN of the KMS key to be used to encrypt the data.

          • CloudWatchEncryption — (map)

            The encryption configuration for CloudWatch.

            • CloudWatchEncryptionMode — (String)

              The encryption mode to use for CloudWatch data.

              Possible values include:
              • "DISABLED"
              • "SSE-KMS"
            • KmsKeyArn — (String)

              The AWS ARN of the KMS key to be used to encrypt the data.

          • JobBookmarksEncryption — (map)

            The encryption configuration for Job Bookmarks.

            • JobBookmarksEncryptionMode — (String)

              The encryption mode to use for Job bookmarks data.

              Possible values include:
              • "DISABLED"
              • "CSE-KMS"
            • KmsKeyArn — (String)

              The AWS ARN of the KMS key to be used to encrypt the data.

Returns:

  • (AWS.Request) —

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

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

Retrieves a list of all security configurations.

Service Reference:

Examples:

Calling the getSecurityConfigurations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getSecurityConfigurations(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.

    • NextToken — (String)

      A continuation token, if this is a continuation call.

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:

      • SecurityConfigurations — (Array<map>)

        A list of security configurations.

        • Name — (String)

          The name of the security configuration.

        • CreatedTimeStamp — (Date)

          The time at which this security configuration was created.

        • EncryptionConfiguration — (map)

          The encryption configuration associated with this security configuration.

          • S3Encryption — (Array<map>)

            The encryption configuration for S3 data.

            • S3EncryptionMode — (String)

              The encryption mode to use for S3 data.

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

              The AWS ARN of the KMS key to be used to encrypt the data.

          • CloudWatchEncryption — (map)

            The encryption configuration for CloudWatch.

            • CloudWatchEncryptionMode — (String)

              The encryption mode to use for CloudWatch data.

              Possible values include:
              • "DISABLED"
              • "SSE-KMS"
            • KmsKeyArn — (String)

              The AWS ARN of the KMS key to be used to encrypt the data.

          • JobBookmarksEncryption — (map)

            The encryption configuration for Job Bookmarks.

            • JobBookmarksEncryptionMode — (String)

              The encryption mode to use for Job bookmarks data.

              Possible values include:
              • "DISABLED"
              • "CSE-KMS"
            • KmsKeyArn — (String)

              The AWS ARN of the KMS key to be used to encrypt the data.

      • NextToken — (String)

        A continuation token, if there are more security configurations to return.

Returns:

  • (AWS.Request) —

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

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

Retrieves the Table definition in a Data Catalog for a specified table.

Service Reference:

Examples:

Calling the getTable operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.getTable(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

    • Name — (String)

      The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

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:

      • Table — (map)

        The Table object that defines the specified table.

        • Name — required — (String)

          Name of the table. For Hive compatibility, this must be entirely lowercase.

        • DatabaseName — (String)

          Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

        • Description — (String)

          Description of the table.

        • Owner — (String)

          Owner of the table.

        • CreateTime — (Date)

          Time when the table definition was created in the Data Catalog.

        • UpdateTime — (Date)

          Last time the table was updated.

        • LastAccessTime — (Date)

          Last time the table was accessed. This is usually taken from HDFS, and may not be reliable.

        • LastAnalyzedTime — (Date)

          Last time column statistics were computed for this table.

        • Retention — (Integer)

          Retention time for this table.

        • StorageDescriptor — (map)

          A storage descriptor containing information about the physical storage of this table.

          • Columns — (Array<map>)

            A list of the Columns in the table.

            • Name — required — (String)

              The name of the Column.

            • Type — (String)

              The datatype of data in the Column.

            • Comment — (String)

              Free-form text comment.

          • Location — (String)

            The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

          • InputFormat — (String)

            The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

          • OutputFormat — (String)

            The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

          • Compressed — (Boolean)

            True if the data in the table is compressed, or False if not.

          • NumberOfBuckets — (Integer)

            Must be specified if the table contains any dimension columns.

          • SerdeInfo — (map)

            Serialization/deserialization (SerDe) information.

            • Name — (String)

              Name of the SerDe.

            • SerializationLibrary — (String)

              Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

            • Parameters — (map<String>)

              These key-value pairs define initialization parameters for the SerDe.

          • BucketColumns — (Array<String>)

            A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

          • SortColumns — (Array<map>)

            A list specifying the sort order of each bucket in the table.

            • Column — required — (String)

              The name of the column.

            • SortOrder — required — (Integer)

              Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

          • Parameters — (map<String>)

            User-supplied properties in key-value form.

          • SkewedInfo — (map)

            Information about values that appear very frequently in a column (skewed values).

            • SkewedColumnNames — (Array<String>)

              A list of names of columns that contain skewed values.

            • SkewedColumnValues — (Array<String>)

              A list of values that appear so frequently as to be considered skewed.

            • SkewedColumnValueLocationMaps — (map<String>)

              A mapping of skewed values to the columns that contain them.

          • StoredAsSubDirectories — (Boolean)

            True if the table data is stored in subdirectories, or False if not.

        • PartitionKeys — (Array<map>)

          A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

          When creating a table used by Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

          "PartitionKeys": []

          • Name — required — (String)

            The name of the Column.

          • Type — (String)

            The datatype of data in the Column.

          • Comment — (String)

            Free-form text comment.

        • ViewOriginalText — (String)

          If the table is a view, the original text of the view; otherwise null.

        • ViewExpandedText — (String)

          If the table is a view, the expanded text of the view; otherwise null.

        • TableType — (String)

          The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

        • Parameters — (map<String>)

          These key-value pairs define properties associated with the table.

        • CreatedBy — (String)

          Person or entity who created the table.

Returns:

  • (AWS.Request) —

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

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

Retrieves the definitions of some or all of the tables in a given Database.

Service Reference:

Examples:

Calling the getTables operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  Expression: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getTables(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

    • Expression — (String)

      A regular expression pattern. If present, only those tables whose names match the pattern are returned.

    • NextToken — (String)

      A continuation token, included if this is a continuation call.

    • MaxResults — (Integer)

      The maximum number of tables to return in a single response.

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:

      • TableList — (Array<map>)

        A list of the requested Table objects.

        • Name — required — (String)

          Name of the table. For Hive compatibility, this must be entirely lowercase.

        • DatabaseName — (String)

          Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

        • Description — (String)

          Description of the table.

        • Owner — (String)

          Owner of the table.

        • CreateTime — (Date)

          Time when the table definition was created in the Data Catalog.

        • UpdateTime — (Date)

          Last time the table was updated.

        • LastAccessTime — (Date)

          Last time the table was accessed. This is usually taken from HDFS, and may not be reliable.

        • LastAnalyzedTime — (Date)

          Last time column statistics were computed for this table.

        • Retention — (Integer)

          Retention time for this table.

        • StorageDescriptor — (map)

          A storage descriptor containing information about the physical storage of this table.

          • Columns — (Array<map>)

            A list of the Columns in the table.

            • Name — required — (String)

              The name of the Column.

            • Type — (String)

              The datatype of data in the Column.

            • Comment — (String)

              Free-form text comment.

          • Location — (String)

            The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

          • InputFormat — (String)

            The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

          • OutputFormat — (String)

            The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

          • Compressed — (Boolean)

            True if the data in the table is compressed, or False if not.

          • NumberOfBuckets — (Integer)

            Must be specified if the table contains any dimension columns.

          • SerdeInfo — (map)

            Serialization/deserialization (SerDe) information.

            • Name — (String)

              Name of the SerDe.

            • SerializationLibrary — (String)

              Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

            • Parameters — (map<String>)

              These key-value pairs define initialization parameters for the SerDe.

          • BucketColumns — (Array<String>)

            A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

          • SortColumns — (Array<map>)

            A list specifying the sort order of each bucket in the table.

            • Column — required — (String)

              The name of the column.

            • SortOrder — required — (Integer)

              Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

          • Parameters — (map<String>)

            User-supplied properties in key-value form.

          • SkewedInfo — (map)

            Information about values that appear very frequently in a column (skewed values).

            • SkewedColumnNames — (Array<String>)

              A list of names of columns that contain skewed values.

            • SkewedColumnValues — (Array<String>)

              A list of values that appear so frequently as to be considered skewed.

            • SkewedColumnValueLocationMaps — (map<String>)

              A mapping of skewed values to the columns that contain them.

          • StoredAsSubDirectories — (Boolean)

            True if the table data is stored in subdirectories, or False if not.

        • PartitionKeys — (Array<map>)

          A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

          When creating a table used by Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

          "PartitionKeys": []

          • Name — required — (String)

            The name of the Column.

          • Type — (String)

            The datatype of data in the Column.

          • Comment — (String)

            Free-form text comment.

        • ViewOriginalText — (String)

          If the table is a view, the original text of the view; otherwise null.

        • ViewExpandedText — (String)

          If the table is a view, the expanded text of the view; otherwise null.

        • TableType — (String)

          The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

        • Parameters — (map<String>)

          These key-value pairs define properties associated with the table.

        • CreatedBy — (String)

          Person or entity who created the table.

      • NextToken — (String)

        A continuation token, present if the current list segment is not the last.

Returns:

  • (AWS.Request) —

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

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

Retrieves a specified version of a table.

Service Reference:

Examples:

Calling the getTableVersion operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  VersionId: 'STRING_VALUE'
};
glue.getTableVersion(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

    • TableName — (String)

      The name of the table. For Hive compatibility, this name is entirely lowercase.

    • VersionId — (String)

      The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.

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:

      • TableVersion — (map)

        The requested table version.

        • Table — (map)

          The table in question

          • Name — required — (String)

            Name of the table. For Hive compatibility, this must be entirely lowercase.

          • DatabaseName — (String)

            Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

          • Description — (String)

            Description of the table.

          • Owner — (String)

            Owner of the table.

          • CreateTime — (Date)

            Time when the table definition was created in the Data Catalog.

          • UpdateTime — (Date)

            Last time the table was updated.

          • LastAccessTime — (Date)

            Last time the table was accessed. This is usually taken from HDFS, and may not be reliable.

          • LastAnalyzedTime — (Date)

            Last time column statistics were computed for this table.

          • Retention — (Integer)

            Retention time for this table.

          • StorageDescriptor — (map)

            A storage descriptor containing information about the physical storage of this table.

            • Columns — (Array<map>)

              A list of the Columns in the table.

              • Name — required — (String)

                The name of the Column.

              • Type — (String)

                The datatype of data in the Column.

              • Comment — (String)

                Free-form text comment.

            • Location — (String)

              The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

            • InputFormat — (String)

              The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

            • OutputFormat — (String)

              The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

            • Compressed — (Boolean)

              True if the data in the table is compressed, or False if not.

            • NumberOfBuckets — (Integer)

              Must be specified if the table contains any dimension columns.

            • SerdeInfo — (map)

              Serialization/deserialization (SerDe) information.

              • Name — (String)

                Name of the SerDe.

              • SerializationLibrary — (String)

                Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

              • Parameters — (map<String>)

                These key-value pairs define initialization parameters for the SerDe.

            • BucketColumns — (Array<String>)

              A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

            • SortColumns — (Array<map>)

              A list specifying the sort order of each bucket in the table.

              • Column — required — (String)

                The name of the column.

              • SortOrder — required — (Integer)

                Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

            • Parameters — (map<String>)

              User-supplied properties in key-value form.

            • SkewedInfo — (map)

              Information about values that appear very frequently in a column (skewed values).

              • SkewedColumnNames — (Array<String>)

                A list of names of columns that contain skewed values.

              • SkewedColumnValues — (Array<String>)

                A list of values that appear so frequently as to be considered skewed.

              • SkewedColumnValueLocationMaps — (map<String>)

                A mapping of skewed values to the columns that contain them.

            • StoredAsSubDirectories — (Boolean)

              True if the table data is stored in subdirectories, or False if not.

          • PartitionKeys — (Array<map>)

            A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

            When creating a table used by Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

            "PartitionKeys": []

            • Name — required — (String)

              The name of the Column.

            • Type — (String)

              The datatype of data in the Column.

            • Comment — (String)

              Free-form text comment.

          • ViewOriginalText — (String)

            If the table is a view, the original text of the view; otherwise null.

          • ViewExpandedText — (String)

            If the table is a view, the expanded text of the view; otherwise null.

          • TableType — (String)

            The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

          • Parameters — (map<String>)

            These key-value pairs define properties associated with the table.

          • CreatedBy — (String)

            Person or entity who created the table.

        • VersionId — (String)

          The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.

Returns:

  • (AWS.Request) —

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

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

Retrieves a list of strings that identify available versions of a specified table.

Service Reference:

Examples:

Calling the getTableVersions operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getTableVersions(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the tables reside. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

    • TableName — (String)

      The name of the table. For Hive compatibility, this name is entirely lowercase.

    • NextToken — (String)

      A continuation token, if this is not the first call.

    • MaxResults — (Integer)

      The maximum number of table versions to return in one response.

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:

      • TableVersions — (Array<map>)

        A list of strings identifying available versions of the specified table.

        • Table — (map)

          The table in question

          • Name — required — (String)

            Name of the table. For Hive compatibility, this must be entirely lowercase.

          • DatabaseName — (String)

            Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase.

          • Description — (String)

            Description of the table.

          • Owner — (String)

            Owner of the table.

          • CreateTime — (Date)

            Time when the table definition was created in the Data Catalog.

          • UpdateTime — (Date)

            Last time the table was updated.

          • LastAccessTime — (Date)

            Last time the table was accessed. This is usually taken from HDFS, and may not be reliable.

          • LastAnalyzedTime — (Date)

            Last time column statistics were computed for this table.

          • Retention — (Integer)

            Retention time for this table.

          • StorageDescriptor — (map)

            A storage descriptor containing information about the physical storage of this table.

            • Columns — (Array<map>)

              A list of the Columns in the table.

              • Name — required — (String)

                The name of the Column.

              • Type — (String)

                The datatype of data in the Column.

              • Comment — (String)

                Free-form text comment.

            • Location — (String)

              The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

            • InputFormat — (String)

              The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

            • OutputFormat — (String)

              The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

            • Compressed — (Boolean)

              True if the data in the table is compressed, or False if not.

            • NumberOfBuckets — (Integer)

              Must be specified if the table contains any dimension columns.

            • SerdeInfo — (map)

              Serialization/deserialization (SerDe) information.

              • Name — (String)

                Name of the SerDe.

              • SerializationLibrary — (String)

                Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

              • Parameters — (map<String>)

                These key-value pairs define initialization parameters for the SerDe.

            • BucketColumns — (Array<String>)

              A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

            • SortColumns — (Array<map>)

              A list specifying the sort order of each bucket in the table.

              • Column — required — (String)

                The name of the column.

              • SortOrder — required — (Integer)

                Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

            • Parameters — (map<String>)

              User-supplied properties in key-value form.

            • SkewedInfo — (map)

              Information about values that appear very frequently in a column (skewed values).

              • SkewedColumnNames — (Array<String>)

                A list of names of columns that contain skewed values.

              • SkewedColumnValues — (Array<String>)

                A list of values that appear so frequently as to be considered skewed.

              • SkewedColumnValueLocationMaps — (map<String>)

                A mapping of skewed values to the columns that contain them.

            • StoredAsSubDirectories — (Boolean)

              True if the table data is stored in subdirectories, or False if not.

          • PartitionKeys — (Array<map>)

            A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

            When creating a table used by Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

            "PartitionKeys": []

            • Name — required — (String)

              The name of the Column.

            • Type — (String)

              The datatype of data in the Column.

            • Comment — (String)

              Free-form text comment.

          • ViewOriginalText — (String)

            If the table is a view, the original text of the view; otherwise null.

          • ViewExpandedText — (String)

            If the table is a view, the expanded text of the view; otherwise null.

          • TableType — (String)

            The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

          • Parameters — (map<String>)

            These key-value pairs define properties associated with the table.

          • CreatedBy — (String)

            Person or entity who created the table.

        • VersionId — (String)

          The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.

      • NextToken — (String)

        A continuation token, if the list of available versions does not include the last one.

Returns:

  • (AWS.Request) —

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

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

Retrieves a list of tags associated with a resource.

Service Reference:

Examples:

Calling the getTags operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
glue.getTags(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 ARN of the resource for which to retrieve tags.

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>)

        The requested tags.

Returns:

  • (AWS.Request) —

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

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

Retrieves the definition of a trigger.

Service Reference:

Examples:

Calling the getTrigger operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.getTrigger(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 trigger to retrieve.

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:

      • Trigger — (map)

        The requested trigger definition.

        • Name — (String)

          Name of the trigger.

        • Id — (String)

          Reserved for future use.

        • Type — (String)

          The type of trigger that this is.

          Possible values include:
          • "SCHEDULED"
          • "CONDITIONAL"
          • "ON_DEMAND"
        • State — (String)

          The current state of the trigger.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "ACTIVATING"
          • "ACTIVATED"
          • "DEACTIVATING"
          • "DEACTIVATED"
          • "DELETING"
          • "UPDATING"
        • Description — (String)

          A description of this trigger.

        • Schedule — (String)

          A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

        • Actions — (Array<map>)

          The actions initiated by this trigger.

          • JobName — (String)

            The name of a job to be executed.

          • Arguments — (map<String>)

            The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

            You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

            For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

            For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • Timeout — (Integer)

            The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

          • NotificationProperty — (map)

            Specifies configuration properties of a job run notification.

            • NotifyDelayAfter — (Integer)

              After a job run starts, the number of minutes to wait before sending a job run delay notification.

          • SecurityConfiguration — (String)

            The name of the SecurityConfiguration structure to be used with this action.

        • Predicate — (map)

          The predicate of this trigger, which defines when it will fire.

          • Logical — (String)

            Optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

            Possible values include:
            • "AND"
            • "ANY"
          • Conditions — (Array<map>)

            A list of the conditions that determine when the trigger will fire.

            • LogicalOperator — (String)

              A logical operator.

              Possible values include:
              • "EQUALS"
            • JobName — (String)

              The name of the Job to whose JobRuns this condition applies and on which this trigger waits.

            • State — (String)

              The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT and FAILED.

              Possible values include:
              • "STARTING"
              • "RUNNING"
              • "STOPPING"
              • "STOPPED"
              • "SUCCEEDED"
              • "FAILED"
              • "TIMEOUT"

Returns:

  • (AWS.Request) —

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

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

Gets all the triggers associated with a job.

Service Reference:

Examples:

Calling the getTriggers operation

var params = {
  DependentJobName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getTriggers(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)

      A continuation token, if this is a continuation call.

    • DependentJobName — (String)

      The name of the job for which to retrieve triggers. The trigger that can start this job will be returned, and if there is no such trigger, all triggers will be returned.

    • MaxResults — (Integer)

      The maximum size of the response.

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:

      • Triggers — (Array<map>)

        A list of triggers for the specified job.

        • Name — (String)

          Name of the trigger.

        • Id — (String)

          Reserved for future use.

        • Type — (String)

          The type of trigger that this is.

          Possible values include:
          • "SCHEDULED"
          • "CONDITIONAL"
          • "ON_DEMAND"
        • State — (String)

          The current state of the trigger.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "ACTIVATING"
          • "ACTIVATED"
          • "DEACTIVATING"
          • "DEACTIVATED"
          • "DELETING"
          • "UPDATING"
        • Description — (String)

          A description of this trigger.

        • Schedule — (String)

          A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

        • Actions — (Array<map>)

          The actions initiated by this trigger.

          • JobName — (String)

            The name of a job to be executed.

          • Arguments — (map<String>)

            The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

            You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

            For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

            For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • Timeout — (Integer)

            The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

          • NotificationProperty — (map)

            Specifies configuration properties of a job run notification.

            • NotifyDelayAfter — (Integer)

              After a job run starts, the number of minutes to wait before sending a job run delay notification.

          • SecurityConfiguration — (String)

            The name of the SecurityConfiguration structure to be used with this action.

        • Predicate — (map)

          The predicate of this trigger, which defines when it will fire.

          • Logical — (String)

            Optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

            Possible values include:
            • "AND"
            • "ANY"
          • Conditions — (Array<map>)

            A list of the conditions that determine when the trigger will fire.

            • LogicalOperator — (String)

              A logical operator.

              Possible values include:
              • "EQUALS"
            • JobName — (String)

              The name of the Job to whose JobRuns this condition applies and on which this trigger waits.

            • State — (String)

              The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT and FAILED.

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

        A continuation token, if not all the requested triggers have yet been returned.

Returns:

  • (AWS.Request) —

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

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

Retrieves a specified function definition from the Data Catalog.

Service Reference:

Examples:

Calling the getUserDefinedFunction operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  FunctionName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.getUserDefinedFunction(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the function to be retrieved is located. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database where the function is located.

    • FunctionName — (String)

      The name of the function.

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:

      • UserDefinedFunction — (map)

        The requested function definition.

        • FunctionName — (String)

          The name of the function.

        • ClassName — (String)

          The Java class that contains the function code.

        • OwnerName — (String)

          The owner of the function.

        • OwnerType — (String)

          The owner type.

          Possible values include:
          • "USER"
          • "ROLE"
          • "GROUP"
        • CreateTime — (Date)

          The time at which the function was created.

        • ResourceUris — (Array<map>)

          The resource URIs for the function.

          • ResourceType — (String)

            The type of the resource.

            Possible values include:
            • "JAR"
            • "FILE"
            • "ARCHIVE"
          • Uri — (String)

            The URI for accessing the resource.

Returns:

  • (AWS.Request) —

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

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

Retrieves a multiple function definitions from the Data Catalog.

Service Reference:

Examples:

Calling the getUserDefinedFunctions operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  Pattern: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
glue.getUserDefinedFunctions(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the functions to be retrieved are located. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database where the functions are located.

    • Pattern — (String)

      An optional function-name pattern string that filters the function definitions returned.

    • NextToken — (String)

      A continuation token, if this is a continuation call.

    • MaxResults — (Integer)

      The maximum number of functions to return in one response.

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:

      • UserDefinedFunctions — (Array<map>)

        A list of requested function definitions.

        • FunctionName — (String)

          The name of the function.

        • ClassName — (String)

          The Java class that contains the function code.

        • OwnerName — (String)

          The owner of the function.

        • OwnerType — (String)

          The owner type.

          Possible values include:
          • "USER"
          • "ROLE"
          • "GROUP"
        • CreateTime — (Date)

          The time at which the function was created.

        • ResourceUris — (Array<map>)

          The resource URIs for the function.

          • ResourceType — (String)

            The type of the resource.

            Possible values include:
            • "JAR"
            • "FILE"
            • "ARCHIVE"
          • Uri — (String)

            The URI for accessing the resource.

      • NextToken — (String)

        A continuation token, if the list of functions returned does not include the last requested function.

Returns:

  • (AWS.Request) —

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

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

Imports an existing Athena Data Catalog to AWS Glue

Service Reference:

Examples:

Calling the importCatalogToGlue operation

var params = {
  CatalogId: 'STRING_VALUE'
};
glue.importCatalogToGlue(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: {}) —
    • CatalogId — (String)

      The ID of the catalog to import. Currently, this should be the AWS account ID.

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.

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

Retrieves the names of all crawler resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved.

Service Reference:

Examples:

Calling the listCrawlers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glue.listCrawlers(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 size of a list to return.

    • NextToken — (String)

      A continuation token, if this is a continuation request.

    • Tags — (map<String>)

      Specifies to return only these tagged resources.

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:

      • CrawlerNames — (Array<String>)

        The names of all crawlers in the account, or the crawlers with the specified tags.

      • NextToken — (String)

        A continuation token, if the returned list does not contain the last metric available.

Returns:

  • (AWS.Request) —

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

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

Retrieves the names of all DevEndpoint resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved.

Service Reference:

Examples:

Calling the listDevEndpoints operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glue.listDevEndpoints(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)

      A continuation token, if this is a continuation request.

    • MaxResults — (Integer)

      The maximum size of a list to return.

    • Tags — (map<String>)

      Specifies to return only these tagged resources.

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:

      • DevEndpointNames — (Array<String>)

        The names of all DevEndpoints in the account, or the DevEndpoints with the specified tags.

      • NextToken — (String)

        A continuation token, if the returned list does not contain the last metric available.

Returns:

  • (AWS.Request) —

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

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

Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved.

Service Reference:

Examples:

Calling the listJobs operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glue.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: {}) —
    • NextToken — (String)

      A continuation token, if this is a continuation request.

    • MaxResults — (Integer)

      The maximum size of a list to return.

    • Tags — (map<String>)

      Specifies to return only these tagged resources.

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:

      • JobNames — (Array<String>)

        The names of all jobs in the account, or the jobs with the specified tags.

      • NextToken — (String)

        A continuation token, if the returned list does not contain the last metric available.

Returns:

  • (AWS.Request) —

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

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

Retrieves the names of all trigger resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag will be retrieved.

Service Reference:

Examples:

Calling the listTriggers operation

var params = {
  DependentJobName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glue.listTriggers(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)

      A continuation token, if this is a continuation request.

    • DependentJobName — (String)

      The name of the job for which to retrieve triggers. The trigger that can start this job will be returned, and if there is no such trigger, all triggers will be returned.

    • MaxResults — (Integer)

      The maximum size of a list to return.

    • Tags — (map<String>)

      Specifies to return only these tagged resources.

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:

      • TriggerNames — (Array<String>)

        The names of all triggers in the account, or the triggers with the specified tags.

      • NextToken — (String)

        A continuation token, if the returned list does not contain the last metric available.

Returns:

  • (AWS.Request) —

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

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

Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.

Service Reference:

Examples:

Calling the putDataCatalogEncryptionSettings operation

var params = {
  DataCatalogEncryptionSettings: { /* required */
    ConnectionPasswordEncryption: {
      ReturnConnectionPasswordEncrypted: true || false, /* required */
      AwsKmsKeyId: 'STRING_VALUE'
    },
    EncryptionAtRest: {
      CatalogEncryptionMode: DISABLED | SSE-KMS, /* required */
      SseAwsKmsKeyId: 'STRING_VALUE'
    }
  },
  CatalogId: 'STRING_VALUE'
};
glue.putDataCatalogEncryptionSettings(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog for which to set the security configuration. If none is provided, the AWS account ID is used by default.

    • DataCatalogEncryptionSettings — (map)

      The security configuration to set.

      • EncryptionAtRest — (map)

        Specifies the encryption-at-rest configuration for the Data Catalog.

        • CatalogEncryptionMode — required — (String)

          The encryption-at-rest mode for encrypting Data Catalog data.

          Possible values include:
          • "DISABLED"
          • "SSE-KMS"
        • SseAwsKmsKeyId — (String)

          The ID of the AWS KMS key to use for encryption at rest.

      • ConnectionPasswordEncryption — (map)

        When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.

        • ReturnConnectionPasswordEncrypted — required — (Boolean)

          When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.

        • AwsKmsKeyId — (String)

          An AWS KMS key that is used to encrypt the connection password.

          If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

          You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

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.

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

Sets the Data Catalog resource policy for access control.

Service Reference:

Examples:

Calling the putResourcePolicy operation

var params = {
  PolicyInJson: 'STRING_VALUE', /* required */
  PolicyExistsCondition: MUST_EXIST | NOT_EXIST | NONE,
  PolicyHashCondition: 'STRING_VALUE'
};
glue.putResourcePolicy(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: {}) —
    • PolicyInJson — (String)

      Contains the policy document to set, in JSON format.

    • PolicyHashCondition — (String)

      The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.

    • PolicyExistsCondition — (String)

      A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call will not depend on the existence of a policy.

      Possible values include:
      • "MUST_EXIST"
      • "NOT_EXIST"
      • "NONE"

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:

      • PolicyHash — (String)

        A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.

Returns:

  • (AWS.Request) —

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

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

Resets a bookmark entry.

Service Reference:

Examples:

Calling the resetJobBookmark operation

var params = {
  JobName: 'STRING_VALUE' /* required */
};
glue.resetJobBookmark(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 in question.

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:

      • JobBookmarkEntry — (map)

        The reset bookmark entry.

        • JobName — (String)

          Name of the job in question.

        • Version — (Integer)

          Version of the job.

        • Run — (Integer)

          The run ID number.

        • Attempt — (Integer)

          The attempt ID number.

        • JobBookmark — (String)

          The bookmark itself.

Returns:

  • (AWS.Request) —

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

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

Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.

Service Reference:

Examples:

Calling the startCrawler operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.startCrawler(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)

      Name of the crawler to start.

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.

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

Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.

Service Reference:

Examples:

Calling the startCrawlerSchedule operation

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

      Name of the crawler to schedule.

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.

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

Starts a job run using a job definition.

Service Reference:

Examples:

Calling the startJobRun operation

var params = {
  JobName: 'STRING_VALUE', /* required */
  AllocatedCapacity: 'NUMBER_VALUE',
  Arguments: {
    '<GenericString>': 'STRING_VALUE',
    /* '<GenericString>': ... */
  },
  JobRunId: 'STRING_VALUE',
  MaxCapacity: 'NUMBER_VALUE',
  NotificationProperty: {
    NotifyDelayAfter: 'NUMBER_VALUE'
  },
  NumberOfWorkers: 'NUMBER_VALUE',
  SecurityConfiguration: 'STRING_VALUE',
  Timeout: 'NUMBER_VALUE',
  WorkerType: Standard | G.1X | G.2X
};
glue.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: {}) —
    • JobName — (String)

      The name of the job definition to use.

    • JobRunId — (String)

      The ID of a previous JobRun to retry.

    • Arguments — (map<String>)

      The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

      You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

      For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

      For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

    • AllocatedCapacity — (Integer)

      This field is deprecated, use MaxCapacity instead.

      The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

    • Timeout — (Integer)

      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

    • MaxCapacity — (Float)

      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

      Do not set Max Capacity if using WorkerType and NumberOfWorkers.

      The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job:

      • When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

      • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

    • WorkerType — (String)

      The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

      Possible values include:
      • "Standard"
      • "G.1X"
      • "G.2X"
    • NumberOfWorkers — (Integer)

      The number of workers of a defined workerType that are allocated when a job runs.

      The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

    • SecurityConfiguration — (String)

      The name of the SecurityConfiguration structure to be used with this job run.

    • NotificationProperty — (map)

      Specifies configuration properties of a job run notification.

      • NotifyDelayAfter — (Integer)

        After a job run starts, the number of minutes to wait before sending a job run delay notification.

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:

      • JobRunId — (String)

        The ID assigned to this job run.

Returns:

  • (AWS.Request) —

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

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

Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.

Service Reference:

Examples:

Calling the startTrigger operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.startTrigger(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 trigger to start.

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 trigger that was started.

Returns:

  • (AWS.Request) —

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

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

If the specified crawler is running, stops the crawl.

Service Reference:

Examples:

Calling the stopCrawler operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.stopCrawler(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)

      Name of the crawler to stop.

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.

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

Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running.

Service Reference:

Examples:

Calling the stopCrawlerSchedule operation

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

      Name of the crawler whose schedule state to set.

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.

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

Stops a specified trigger.

Service Reference:

Examples:

Calling the stopTrigger operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
glue.stopTrigger(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 trigger to stop.

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 trigger that was stopped.

Returns:

  • (AWS.Request) —

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

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

Adds tags to a resource. A tag is a label you can assign to an AWS resource. In AWS Glue, you can tag only certain resources. For information about what resources you can tag, see AWS Tags in AWS Glue.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagsToAdd: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glue.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 ARN of the AWS Glue resource to which to add the tags. For more information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern.

    • TagsToAdd — (map<String>)

      Tags to add to this 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 tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagsToRemove: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
glue.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)

      The ARN of the resource from which to remove the tags.

    • TagsToRemove — (Array<String>)

      Tags to remove from this 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.

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

Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).

Service Reference:

Examples:

Calling the updateClassifier operation

var params = {
  CsvClassifier: {
    Name: 'STRING_VALUE', /* required */
    AllowSingleColumn: true || false,
    ContainsHeader: UNKNOWN | PRESENT | ABSENT,
    Delimiter: 'STRING_VALUE',
    DisableValueTrimming: true || false,
    Header: [
      'STRING_VALUE',
      /* more items */
    ],
    QuoteSymbol: 'STRING_VALUE'
  },
  GrokClassifier: {
    Name: 'STRING_VALUE', /* required */
    Classification: 'STRING_VALUE',
    CustomPatterns: 'STRING_VALUE',
    GrokPattern: 'STRING_VALUE'
  },
  JsonClassifier: {
    Name: 'STRING_VALUE', /* required */
    JsonPath: 'STRING_VALUE'
  },
  XMLClassifier: {
    Name: 'STRING_VALUE', /* required */
    Classification: 'STRING_VALUE',
    RowTag: 'STRING_VALUE'
  }
};
glue.updateClassifier(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: {}) —
    • GrokClassifier — (map)

      A GrokClassifier object with updated fields.

      • Name — required — (String)

        The name of the GrokClassifier.

      • Classification — (String)

        An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.

      • GrokPattern — (String)

        The grok pattern used by this classifier.

      • CustomPatterns — (String)

        Optional custom grok patterns used by this classifier.

    • XMLClassifier — (map)

      An XMLClassifier object with updated fields.

      • Name — required — (String)

        The name of the classifier.

      • Classification — (String)

        An identifier of the data format that the classifier matches.

      • RowTag — (String)

        The XML tag designating the element that contains each record in an XML document being parsed. Note that this cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a="A" item_b="B"></row> is okay, but <row item_a="A" item_b="B" /> is not).

    • JsonClassifier — (map)

      A JsonClassifier object with updated fields.

      • Name — required — (String)

        The name of the classifier.

      • JsonPath — (String)

        A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

    • CsvClassifier — (map)

      A CsvClassifier object with updated fields.

      • Name — required — (String)

        The name of the classifier.

      • Delimiter — (String)

        A custom symbol to denote what separates each column entry in the row.

      • QuoteSymbol — (String)

        A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.

      • ContainsHeader — (String)

        Indicates whether the CSV file contains a header.

        Possible values include:
        • "UNKNOWN"
        • "PRESENT"
        • "ABSENT"
      • Header — (Array<String>)

        A list of strings representing column names.

      • DisableValueTrimming — (Boolean)

        Specifies not to trim values before identifying the type of column values. The default value is true.

      • AllowSingleColumn — (Boolean)

        Enables the processing of files that contain only one column.

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.

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

Updates a connection definition in the Data Catalog.

Service Reference:

Examples:

Calling the updateConnection operation

var params = {
  ConnectionInput: { /* required */
    ConnectionProperties: { /* required */
      '<ConnectionPropertyKey>': 'STRING_VALUE',
      /* '<ConnectionPropertyKey>': ... */
    },
    ConnectionType: JDBC | SFTP, /* required */
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE',
    MatchCriteria: [
      'STRING_VALUE',
      /* more items */
    ],
    PhysicalConnectionRequirements: {
      AvailabilityZone: 'STRING_VALUE',
      SecurityGroupIdList: [
        'STRING_VALUE',
        /* more items */
      ],
      SubnetId: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.updateConnection(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.

    • Name — (String)

      The name of the connection definition to update.

    • ConnectionInput — (map)

      A ConnectionInput object that redefines the connection in question.

      • Name — required — (String)

        The name of the connection.

      • Description — (String)

        The description of the connection.

      • ConnectionType — required — (String)

        The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

        Possible values include:
        • "JDBC"
        • "SFTP"
      • MatchCriteria — (Array<String>)

        A list of criteria that can be used in selecting this connection.

      • ConnectionProperties — required — (map<String>)

        These key-value pairs define parameters for the connection.

      • PhysicalConnectionRequirements — (map)

        A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

        • SubnetId — (String)

          The subnet ID used by the connection.

        • SecurityGroupIdList — (Array<String>)

          The security group ID list used by the connection.

        • AvailabilityZone — (String)

          The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

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.

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

Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.

Service Reference:

Examples:

Calling the updateCrawler operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Classifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  Configuration: 'STRING_VALUE',
  CrawlerSecurityConfiguration: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Role: 'STRING_VALUE',
  Schedule: 'STRING_VALUE',
  SchemaChangePolicy: {
    DeleteBehavior: LOG | DELETE_FROM_DATABASE | DEPRECATE_IN_DATABASE,
    UpdateBehavior: LOG | UPDATE_IN_DATABASE
  },
  TablePrefix: 'STRING_VALUE',
  Targets: {
    DynamoDBTargets: [
      {
        Path: 'STRING_VALUE'
      },
      /* more items */
    ],
    JdbcTargets: [
      {
        ConnectionName: 'STRING_VALUE',
        Exclusions: [
          'STRING_VALUE',
          /* more items */
        ],
        Path: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Targets: [
      {
        Exclusions: [
          'STRING_VALUE',
          /* more items */
        ],
        Path: 'STRING_VALUE'
      },
      /* more items */
    ]
  }
};
glue.updateCrawler(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)

      Name of the new crawler.

    • Role — (String)

      The IAM role (or ARN of an IAM role) used by the new crawler to access customer resources.

    • DatabaseName — (String)

      The AWS Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.

    • Description — (String)

      A description of the new crawler.

    • Targets — (map)

      A list of targets to crawl.

      • S3Targets — (Array<map>)

        Specifies Amazon S3 targets.

        • Path — (String)

          The path to the Amazon S3 target.

        • Exclusions — (Array<String>)

          A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

      • JdbcTargets — (Array<map>)

        Specifies JDBC targets.

        • ConnectionName — (String)

          The name of the connection to use to connect to the JDBC target.

        • Path — (String)

          The path of the JDBC target.

        • Exclusions — (Array<String>)

          A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

      • DynamoDBTargets — (Array<map>)

        Specifies DynamoDB targets.

        • Path — (String)

          The name of the DynamoDB table to crawl.

    • Schedule — (String)

      A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

    • Classifiers — (Array<String>)

      A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

    • TablePrefix — (String)

      The table prefix used for catalog tables that are created.

    • SchemaChangePolicy — (map)

      Policy for the crawler's update and deletion behavior.

      • UpdateBehavior — (String)

        The update behavior when the crawler finds a changed schema.

        Possible values include:
        • "LOG"
        • "UPDATE_IN_DATABASE"
      • DeleteBehavior — (String)

        The deletion behavior when the crawler finds a deleted object.

        Possible values include:
        • "LOG"
        • "DELETE_FROM_DATABASE"
        • "DEPRECATE_IN_DATABASE"
    • Configuration — (String)

      Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

    • CrawlerSecurityConfiguration — (String)

      The name of the SecurityConfiguration structure to be used by this Crawler.

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.

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

Updates the schedule of a crawler using a cron expression.

Service Reference:

Examples:

Calling the updateCrawlerSchedule operation

var params = {
  CrawlerName: 'STRING_VALUE', /* required */
  Schedule: 'STRING_VALUE'
};
glue.updateCrawlerSchedule(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: {}) —
    • CrawlerName — (String)

      Name of the crawler whose schedule to update.

    • Schedule — (String)

      The updated cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

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.

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

Updates an existing database definition in a Data Catalog.

Service Reference:

Examples:

Calling the updateDatabase operation

var params = {
  DatabaseInput: { /* required */
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE',
    LocationUri: 'STRING_VALUE',
    Parameters: {
      '<KeyString>': 'STRING_VALUE',
      /* '<KeyString>': ... */
    }
  },
  Name: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.updateDatabase(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog in which the metadata database resides. If none is supplied, the AWS account ID is used by default.

    • Name — (String)

      The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.

    • DatabaseInput — (map)

      A DatabaseInput object specifying the new definition of the metadata database in the catalog.

      • Name — required — (String)

        Name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

      • Description — (String)

        Description of the database

      • LocationUri — (String)

        The location of the database (for example, an HDFS path).

      • Parameters — (map<String>)

        Thes key-value pairs define parameters and properties of the database.

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.

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

Updates a specified DevEndpoint.

Service Reference:

Examples:

Calling the updateDevEndpoint operation

var params = {
  EndpointName: 'STRING_VALUE', /* required */
  AddArguments: {
    '<GenericString>': 'STRING_VALUE',
    /* '<GenericString>': ... */
  },
  AddPublicKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  CustomLibraries: {
    ExtraJarsS3Path: 'STRING_VALUE',
    ExtraPythonLibsS3Path: 'STRING_VALUE'
  },
  DeleteArguments: [
    'STRING_VALUE',
    /* more items */
  ],
  DeletePublicKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  PublicKey: 'STRING_VALUE',
  UpdateEtlLibraries: true || false
};
glue.updateDevEndpoint(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: {}) —
    • EndpointName — (String)

      The name of the DevEndpoint to be updated.

    • PublicKey — (String)

      The public key for the DevEndpoint to use.

    • AddPublicKeys — (Array<String>)

      The list of public keys for the DevEndpoint to use.

    • DeletePublicKeys — (Array<String>)

      The list of public keys to be deleted from the DevEndpoint.

    • CustomLibraries — (map)

      Custom Python or Java libraries to be loaded in the DevEndpoint.

      • ExtraPythonLibsS3Path — (String)

        Path(s) to one or more Python libraries in an S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

        Please note that only pure Python libraries can currently be used on a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

      • ExtraJarsS3Path — (String)

        Path to one or more Java Jars in an S3 bucket that should be loaded in your DevEndpoint.

        Please note that only pure Java/Scala libraries can currently be used on a DevEndpoint.

    • UpdateEtlLibraries — (Boolean)

      True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False otherwise.

    • DeleteArguments — (Array<String>)

      The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint.

    • AddArguments — (map<String>)

      The map of arguments to add the map of arguments used to configure the DevEndpoint.

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.

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

Updates an existing job definition.

Service Reference:

Examples:

Calling the updateJob operation

var params = {
  JobName: 'STRING_VALUE', /* required */
  JobUpdate: { /* required */
    AllocatedCapacity: 'NUMBER_VALUE',
    Command: {
      Name: 'STRING_VALUE',
      ScriptLocation: 'STRING_VALUE'
    },
    Connections: {
      Connections: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    DefaultArguments: {
      '<GenericString>': 'STRING_VALUE',
      /* '<GenericString>': ... */
    },
    Description: 'STRING_VALUE',
    ExecutionProperty: {
      MaxConcurrentRuns: 'NUMBER_VALUE'
    },
    LogUri: 'STRING_VALUE',
    MaxCapacity: 'NUMBER_VALUE',
    MaxRetries: 'NUMBER_VALUE',
    NotificationProperty: {
      NotifyDelayAfter: 'NUMBER_VALUE'
    },
    NumberOfWorkers: 'NUMBER_VALUE',
    Role: 'STRING_VALUE',
    SecurityConfiguration: 'STRING_VALUE',
    Timeout: 'NUMBER_VALUE',
    WorkerType: Standard | G.1X | G.2X
  }
};
glue.updateJob(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)

      Name of the job definition to update.

    • JobUpdate — (map)

      Specifies the values with which to update the job definition.

      • Description — (String)

        Description of the job being defined.

      • LogUri — (String)

        This field is reserved for future use.

      • Role — (String)

        The name or ARN of the IAM role associated with this job (required).

      • ExecutionProperty — (map)

        An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

        • MaxConcurrentRuns — (Integer)

          The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

      • Command — (map)

        The JobCommand that executes this job (required).

        • Name — (String)

          The name of the job command: this must be glueetl, for an Apache Spark ETL job, or pythonshell, for a Python shell job.

        • ScriptLocation — (String)

          Specifies the S3 path to a script that executes a job (required).

      • DefaultArguments — (map<String>)

        The default arguments for this job.

        You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

        For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

        For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

      • Connections — (map)

        The connections used for this job.

        • Connections — (Array<String>)

          A list of connections used by the job.

      • MaxRetries — (Integer)

        The maximum number of times to retry this job if it fails.

      • AllocatedCapacity — (Integer)

        This field is deprecated. Use MaxCapacity instead.

        The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

      • Timeout — (Integer)

        The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

      • MaxCapacity — (Float)

        The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

        Do not set Max Capacity if using WorkerType and NumberOfWorkers.

        The value that can be allocated for MaxCapacity depends on whether you are running a python shell job, or an Apache Spark ETL job:

        • When you specify a python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

        • When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

      • WorkerType — (String)

        The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

        • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

        • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

        • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

        Possible values include:
        • "Standard"
        • "G.1X"
        • "G.2X"
      • NumberOfWorkers — (Integer)

        The number of workers of a defined workerType that are allocated when a job runs.

        The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

      • SecurityConfiguration — (String)

        The name of the SecurityConfiguration structure to be used with this job.

      • NotificationProperty — (map)

        Specifies configuration properties of a job notification.

        • NotifyDelayAfter — (Integer)

          After a job run starts, the number of minutes to wait before sending a job run delay notification.

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:

      • JobName — (String)

        Returns the name of the updated job definition.

Returns:

  • (AWS.Request) —

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

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

Updates a partition.

Service Reference:

Examples:

Calling the updatePartition operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  PartitionInput: { /* required */
    LastAccessTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    LastAnalyzedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    Parameters: {
      '<KeyString>': 'STRING_VALUE',
      /* '<KeyString>': ... */
    },
    StorageDescriptor: {
      BucketColumns: [
        'STRING_VALUE',
        /* more items */
      ],
      Columns: [
        {
          Name: 'STRING_VALUE', /* required */
          Comment: 'STRING_VALUE',
          Type: 'STRING_VALUE'
        },
        /* more items */
      ],
      Compressed: true || false,
      InputFormat: 'STRING_VALUE',
      Location: 'STRING_VALUE',
      NumberOfBuckets: 'NUMBER_VALUE',
      OutputFormat: 'STRING_VALUE',
      Parameters: {
        '<KeyString>': 'STRING_VALUE',
        /* '<KeyString>': ... */
      },
      SerdeInfo: {
        Name: 'STRING_VALUE',
        Parameters: {
          '<KeyString>': 'STRING_VALUE',
          /* '<KeyString>': ... */
        },
        SerializationLibrary: 'STRING_VALUE'
      },
      SkewedInfo: {
        SkewedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ],
        SkewedColumnValueLocationMaps: {
          '<ColumnValuesString>': 'STRING_VALUE',
          /* '<ColumnValuesString>': ... */
        },
        SkewedColumnValues: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      SortColumns: [
        {
          Column: 'STRING_VALUE', /* required */
          SortOrder: 'NUMBER_VALUE' /* required */
        },
        /* more items */
      ],
      StoredAsSubDirectories: true || false
    },
    Values: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  PartitionValueList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TableName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.updatePartition(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the partition to be updated resides. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database in which the table in question resides.

    • TableName — (String)

      The name of the table where the partition to be updated is located.

    • PartitionValueList — (Array<String>)

      A list of the values defining the partition.

    • PartitionInput — (map)

      The new partition object to which to update the partition.

      • Values — (Array<String>)

        The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

      • LastAccessTime — (Date)

        The last time at which the partition was accessed.

      • StorageDescriptor — (map)

        Provides information about the physical location where the partition is stored.

        • Columns — (Array<map>)

          A list of the Columns in the table.

          • Name — required — (String)

            The name of the Column.

          • Type — (String)

            The datatype of data in the Column.

          • Comment — (String)

            Free-form text comment.

        • Location — (String)

          The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

        • InputFormat — (String)

          The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

        • OutputFormat — (String)

          The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

        • Compressed — (Boolean)

          True if the data in the table is compressed, or False if not.

        • NumberOfBuckets — (Integer)

          Must be specified if the table contains any dimension columns.

        • SerdeInfo — (map)

          Serialization/deserialization (SerDe) information.

          • Name — (String)

            Name of the SerDe.

          • SerializationLibrary — (String)

            Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

          • Parameters — (map<String>)

            These key-value pairs define initialization parameters for the SerDe.

        • BucketColumns — (Array<String>)

          A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

        • SortColumns — (Array<map>)

          A list specifying the sort order of each bucket in the table.

          • Column — required — (String)

            The name of the column.

          • SortOrder — required — (Integer)

            Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

        • Parameters — (map<String>)

          User-supplied properties in key-value form.

        • SkewedInfo — (map)

          Information about values that appear very frequently in a column (skewed values).

          • SkewedColumnNames — (Array<String>)

            A list of names of columns that contain skewed values.

          • SkewedColumnValues — (Array<String>)

            A list of values that appear so frequently as to be considered skewed.

          • SkewedColumnValueLocationMaps — (map<String>)

            A mapping of skewed values to the columns that contain them.

        • StoredAsSubDirectories — (Boolean)

          True if the table data is stored in subdirectories, or False if not.

      • Parameters — (map<String>)

        These key-value pairs define partition parameters.

      • LastAnalyzedTime — (Date)

        The last time at which column statistics were computed for this partition.

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.

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

Updates a metadata table in the Data Catalog.

Service Reference:

Examples:

Calling the updateTable operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  TableInput: { /* required */
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE',
    LastAccessTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    LastAnalyzedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    Owner: 'STRING_VALUE',
    Parameters: {
      '<KeyString>': 'STRING_VALUE',
      /* '<KeyString>': ... */
    },
    PartitionKeys: [
      {
        Name: 'STRING_VALUE', /* required */
        Comment: 'STRING_VALUE',
        Type: 'STRING_VALUE'
      },
      /* more items */
    ],
    Retention: 'NUMBER_VALUE',
    StorageDescriptor: {
      BucketColumns: [
        'STRING_VALUE',
        /* more items */
      ],
      Columns: [
        {
          Name: 'STRING_VALUE', /* required */
          Comment: 'STRING_VALUE',
          Type: 'STRING_VALUE'
        },
        /* more items */
      ],
      Compressed: true || false,
      InputFormat: 'STRING_VALUE',
      Location: 'STRING_VALUE',
      NumberOfBuckets: 'NUMBER_VALUE',
      OutputFormat: 'STRING_VALUE',
      Parameters: {
        '<KeyString>': 'STRING_VALUE',
        /* '<KeyString>': ... */
      },
      SerdeInfo: {
        Name: 'STRING_VALUE',
        Parameters: {
          '<KeyString>': 'STRING_VALUE',
          /* '<KeyString>': ... */
        },
        SerializationLibrary: 'STRING_VALUE'
      },
      SkewedInfo: {
        SkewedColumnNames: [
          'STRING_VALUE',
          /* more items */
        ],
        SkewedColumnValueLocationMaps: {
          '<ColumnValuesString>': 'STRING_VALUE',
          /* '<ColumnValuesString>': ... */
        },
        SkewedColumnValues: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      SortColumns: [
        {
          Column: 'STRING_VALUE', /* required */
          SortOrder: 'NUMBER_VALUE' /* required */
        },
        /* more items */
      ],
      StoredAsSubDirectories: true || false
    },
    TableType: 'STRING_VALUE',
    ViewExpandedText: 'STRING_VALUE',
    ViewOriginalText: 'STRING_VALUE'
  },
  CatalogId: 'STRING_VALUE',
  SkipArchive: true || false
};
glue.updateTable(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the table resides. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

    • TableInput — (map)

      An updated TableInput object to define the metadata table in the catalog.

      • Name — required — (String)

        Name of the table. For Hive compatibility, this is folded to lowercase when it is stored.

      • Description — (String)

        Description of the table.

      • Owner — (String)

        Owner of the table.

      • LastAccessTime — (Date)

        Last time the table was accessed.

      • LastAnalyzedTime — (Date)

        Last time column statistics were computed for this table.

      • Retention — (Integer)

        Retention time for this table.

      • StorageDescriptor — (map)

        A storage descriptor containing information about the physical storage of this table.

        • Columns — (Array<map>)

          A list of the Columns in the table.

          • Name — required — (String)

            The name of the Column.

          • Type — (String)

            The datatype of data in the Column.

          • Comment — (String)

            Free-form text comment.

        • Location — (String)

          The physical location of the table. By default this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

        • InputFormat — (String)

          The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

        • OutputFormat — (String)

          The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

        • Compressed — (Boolean)

          True if the data in the table is compressed, or False if not.

        • NumberOfBuckets — (Integer)

          Must be specified if the table contains any dimension columns.

        • SerdeInfo — (map)

          Serialization/deserialization (SerDe) information.

          • Name — (String)

            Name of the SerDe.

          • SerializationLibrary — (String)

            Usually the class that implements the SerDe. An example is: org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

          • Parameters — (map<String>)

            These key-value pairs define initialization parameters for the SerDe.

        • BucketColumns — (Array<String>)

          A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

        • SortColumns — (Array<map>)

          A list specifying the sort order of each bucket in the table.

          • Column — required — (String)

            The name of the column.

          • SortOrder — required — (Integer)

            Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

        • Parameters — (map<String>)

          User-supplied properties in key-value form.

        • SkewedInfo — (map)

          Information about values that appear very frequently in a column (skewed values).

          • SkewedColumnNames — (Array<String>)

            A list of names of columns that contain skewed values.

          • SkewedColumnValues — (Array<String>)

            A list of values that appear so frequently as to be considered skewed.

          • SkewedColumnValueLocationMaps — (map<String>)

            A mapping of skewed values to the columns that contain them.

        • StoredAsSubDirectories — (Boolean)

          True if the table data is stored in subdirectories, or False if not.

      • PartitionKeys — (Array<map>)

        A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

        When creating a table used by Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

        "PartitionKeys": []

        • Name — required — (String)

          The name of the Column.

        • Type — (String)

          The datatype of data in the Column.

        • Comment — (String)

          Free-form text comment.

      • ViewOriginalText — (String)

        If the table is a view, the original text of the view; otherwise null.

      • ViewExpandedText — (String)

        If the table is a view, the expanded text of the view; otherwise null.

      • TableType — (String)

        The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

      • Parameters — (map<String>)

        These key-value pairs define properties associated with the table.

    • SkipArchive — (Boolean)

      By default, UpdateTable always creates an archived version of the table before updating it. If skipArchive is set to true, however, UpdateTable does not create the archived version.

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.

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

Updates a trigger definition.

Service Reference:

Examples:

Calling the updateTrigger operation

var params = {
  Name: 'STRING_VALUE', /* required */
  TriggerUpdate: { /* required */
    Actions: [
      {
        Arguments: {
          '<GenericString>': 'STRING_VALUE',
          /* '<GenericString>': ... */
        },
        JobName: 'STRING_VALUE',
        NotificationProperty: {
          NotifyDelayAfter: 'NUMBER_VALUE'
        },
        SecurityConfiguration: 'STRING_VALUE',
        Timeout: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Description: 'STRING_VALUE',
    Name: 'STRING_VALUE',
    Predicate: {
      Conditions: [
        {
          JobName: 'STRING_VALUE',
          LogicalOperator: EQUALS,
          State: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT
        },
        /* more items */
      ],
      Logical: AND | ANY
    },
    Schedule: 'STRING_VALUE'
  }
};
glue.updateTrigger(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 trigger to update.

    • TriggerUpdate — (map)

      The new values with which to update the trigger.

      • Name — (String)

        Reserved for future use.

      • Description — (String)

        A description of this trigger.

      • Schedule — (String)

        A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

      • Actions — (Array<map>)

        The actions initiated by this trigger.

        • JobName — (String)

          The name of a job to be executed.

        • Arguments — (map<String>)

          The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

          You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

          For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

          For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

        • Timeout — (Integer)

          The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

        • NotificationProperty — (map)

          Specifies configuration properties of a job run notification.

          • NotifyDelayAfter — (Integer)

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

        • SecurityConfiguration — (String)

          The name of the SecurityConfiguration structure to be used with this action.

      • Predicate — (map)

        The predicate of this trigger, which defines when it will fire.

        • Logical — (String)

          Optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

          Possible values include:
          • "AND"
          • "ANY"
        • Conditions — (Array<map>)

          A list of the conditions that determine when the trigger will fire.

          • LogicalOperator — (String)

            A logical operator.

            Possible values include:
            • "EQUALS"
          • JobName — (String)

            The name of the Job to whose JobRuns this condition applies and on which this trigger waits.

          • State — (String)

            The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT and FAILED.

            Possible values include:
            • "STARTING"
            • "RUNNING"
            • "STOPPING"
            • "STOPPED"
            • "SUCCEEDED"
            • "FAILED"
            • "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:

      • Trigger — (map)

        The resulting trigger definition.

        • Name — (String)

          Name of the trigger.

        • Id — (String)

          Reserved for future use.

        • Type — (String)

          The type of trigger that this is.

          Possible values include:
          • "SCHEDULED"
          • "CONDITIONAL"
          • "ON_DEMAND"
        • State — (String)

          The current state of the trigger.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "ACTIVATING"
          • "ACTIVATED"
          • "DEACTIVATING"
          • "DEACTIVATED"
          • "DELETING"
          • "UPDATING"
        • Description — (String)

          A description of this trigger.

        • Schedule — (String)

          A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

        • Actions — (Array<map>)

          The actions initiated by this trigger.

          • JobName — (String)

            The name of a job to be executed.

          • Arguments — (map<String>)

            The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

            You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

            For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

            For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

          • Timeout — (Integer)

            The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

          • NotificationProperty — (map)

            Specifies configuration properties of a job run notification.

            • NotifyDelayAfter — (Integer)

              After a job run starts, the number of minutes to wait before sending a job run delay notification.

          • SecurityConfiguration — (String)

            The name of the SecurityConfiguration structure to be used with this action.

        • Predicate — (map)

          The predicate of this trigger, which defines when it will fire.

          • Logical — (String)

            Optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

            Possible values include:
            • "AND"
            • "ANY"
          • Conditions — (Array<map>)

            A list of the conditions that determine when the trigger will fire.

            • LogicalOperator — (String)

              A logical operator.

              Possible values include:
              • "EQUALS"
            • JobName — (String)

              The name of the Job to whose JobRuns this condition applies and on which this trigger waits.

            • State — (String)

              The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT and FAILED.

              Possible values include:
              • "STARTING"
              • "RUNNING"
              • "STOPPING"
              • "STOPPED"
              • "SUCCEEDED"
              • "FAILED"
              • "TIMEOUT"

Returns:

  • (AWS.Request) —

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

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

Updates an existing function definition in the Data Catalog.

Service Reference:

Examples:

Calling the updateUserDefinedFunction operation

var params = {
  DatabaseName: 'STRING_VALUE', /* required */
  FunctionInput: { /* required */
    ClassName: 'STRING_VALUE',
    FunctionName: 'STRING_VALUE',
    OwnerName: 'STRING_VALUE',
    OwnerType: USER | ROLE | GROUP,
    ResourceUris: [
      {
        ResourceType: JAR | FILE | ARCHIVE,
        Uri: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  FunctionName: 'STRING_VALUE', /* required */
  CatalogId: 'STRING_VALUE'
};
glue.updateUserDefinedFunction(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: {}) —
    • CatalogId — (String)

      The ID of the Data Catalog where the function to be updated is located. If none is supplied, the AWS account ID is used by default.

    • DatabaseName — (String)

      The name of the catalog database where the function to be updated is located.

    • FunctionName — (String)

      The name of the function.

    • FunctionInput — (map)

      A FunctionInput object that re-defines the function in the Data Catalog.

      • FunctionName — (String)

        The name of the function.

      • ClassName — (String)

        The Java class that contains the function code.

      • OwnerName — (String)

        The owner of the function.

      • OwnerType — (String)

        The owner type.

        Possible values include:
        • "USER"
        • "ROLE"
        • "GROUP"
      • ResourceUris — (Array<map>)

        The resource URIs for the function.

        • ResourceType — (String)

          The type of the resource.

          Possible values include:
          • "JAR"
          • "FILE"
          • "ARCHIVE"
        • Uri — (String)

          The URI for accessing 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.