Class: AWS.Glue
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Glue
- 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 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 collapse
-
new AWS.Glue(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
batchCreatePartition(params = {}, callback) ⇒ AWS.Request
Creates one or more partitions in a batch operation.
.
-
batchDeleteConnection(params = {}, callback) ⇒ AWS.Request
Deletes a list of connection definitions from the Data Catalog.
.
-
batchDeletePartition(params = {}, callback) ⇒ AWS.Request
Deletes one or more partitions in a batch operation.
.
-
batchDeleteTable(params = {}, callback) ⇒ AWS.Request
Deletes multiple tables at once.
Note: After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table.- batchDeleteTableVersion(params = {}, callback) ⇒ AWS.Request
Deletes a specified batch of versions of a table.
.
- batchGetBlueprints(params = {}, callback) ⇒ AWS.Request
Retrieves information about a list of blueprints.
.
- batchGetCrawlers(params = {}, callback) ⇒ AWS.Request
Returns a list of resource metadata for a given list of crawler names.
- batchGetCustomEntityTypes(params = {}, callback) ⇒ AWS.Request
Retrieves the details for the custom patterns specified by a list of names.
.
- batchGetDataQualityResult(params = {}, callback) ⇒ AWS.Request
Retrieves a list of data quality results for the specified result IDs.
.
- batchGetDevEndpoints(params = {}, callback) ⇒ AWS.Request
Returns a list of resource metadata for a given list of development endpoint names.
- batchGetJobs(params = {}, callback) ⇒ AWS.Request
Returns a list of resource metadata for a given list of job names.
- batchGetPartition(params = {}, callback) ⇒ AWS.Request
Retrieves partitions in a batch request.
.
- batchGetTableOptimizer(params = {}, callback) ⇒ AWS.Request
Returns the configuration for the specified table optimizers.
.
- batchGetTriggers(params = {}, callback) ⇒ AWS.Request
Returns a list of resource metadata for a given list of trigger names.
- batchGetWorkflows(params = {}, callback) ⇒ AWS.Request
Returns a list of resource metadata for a given list of workflow names.
- batchPutDataQualityStatisticAnnotation(params = {}, callback) ⇒ AWS.Request
Annotate datapoints over time for a specific data quality statistic.
.
- batchStopJobRun(params = {}, callback) ⇒ AWS.Request
Stops one or more job runs for a specified job definition.
.
- batchUpdatePartition(params = {}, callback) ⇒ AWS.Request
Updates one or more partitions in a batch operation.
.
- cancelDataQualityRuleRecommendationRun(params = {}, callback) ⇒ AWS.Request
Cancels the specified recommendation run that was being used to generate rules.
.
- cancelDataQualityRulesetEvaluationRun(params = {}, callback) ⇒ AWS.Request
Cancels a run where a ruleset is being evaluated against a data source.
.
- cancelMLTaskRun(params = {}, callback) ⇒ AWS.Request
Cancels (stops) a task run.
- cancelStatement(params = {}, callback) ⇒ AWS.Request
Cancels the statement.
.
- checkSchemaVersionValidity(params = {}, callback) ⇒ AWS.Request
Validates the supplied schema.
- createBlueprint(params = {}, callback) ⇒ AWS.Request
Registers a blueprint with Glue.
.
- createClassifier(params = {}, callback) ⇒ AWS.Request
Creates a classifier in the user's account.
- createConnection(params = {}, callback) ⇒ AWS.Request
Creates a connection definition in the Data Catalog.
Connections used for creating federated resources require the IAM
.glue:PassConnection
permission.- createCrawler(params = {}, callback) ⇒ AWS.Request
Creates a new crawler with specified targets, role, configuration, and optional schedule.
- createCustomEntityType(params = {}, callback) ⇒ AWS.Request
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words.
- createDatabase(params = {}, callback) ⇒ AWS.Request
Creates a new database in a Data Catalog.
.
- createDataQualityRuleset(params = {}, callback) ⇒ AWS.Request
Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL).
- createDevEndpoint(params = {}, callback) ⇒ AWS.Request
Creates a new development endpoint.
.
- createJob(params = {}, callback) ⇒ AWS.Request
Creates a new job definition.
.
- createMLTransform(params = {}, callback) ⇒ AWS.Request
Creates an Glue machine learning transform.
- createPartition(params = {}, callback) ⇒ AWS.Request
Creates a new partition.
.
- createPartitionIndex(params = {}, callback) ⇒ AWS.Request
Creates a specified partition index in an existing table.
.
- createRegistry(params = {}, callback) ⇒ AWS.Request
Creates a new registry which may be used to hold a collection of schemas.
.
- createSchema(params = {}, callback) ⇒ AWS.Request
Creates a new schema set and registers the schema definition.
- createScript(params = {}, callback) ⇒ AWS.Request
Transforms a directed acyclic graph (DAG) into code.
.
- createSecurityConfiguration(params = {}, callback) ⇒ AWS.Request
Creates a new security configuration.
- createSession(params = {}, callback) ⇒ AWS.Request
Creates a new session.
.
- createTable(params = {}, callback) ⇒ AWS.Request
Creates a new table definition in the Data Catalog.
.
- createTableOptimizer(params = {}, callback) ⇒ AWS.Request
Creates a new table optimizer for a specific function.
- createTrigger(params = {}, callback) ⇒ AWS.Request
Creates a new trigger.
.
- createUsageProfile(params = {}, callback) ⇒ AWS.Request
Creates an Glue usage profile.
.
- createUserDefinedFunction(params = {}, callback) ⇒ AWS.Request
Creates a new function definition in the Data Catalog.
.
- createWorkflow(params = {}, callback) ⇒ AWS.Request
Creates a new workflow.
.
- deleteBlueprint(params = {}, callback) ⇒ AWS.Request
Deletes an existing blueprint.
.
- deleteClassifier(params = {}, callback) ⇒ AWS.Request
Removes a classifier from the Data Catalog.
.
- deleteColumnStatisticsForPartition(params = {}, callback) ⇒ AWS.Request
Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is
.DeletePartition
.- deleteColumnStatisticsForTable(params = {}, callback) ⇒ AWS.Request
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
.DeleteTable
.- deleteConnection(params = {}, callback) ⇒ AWS.Request
Deletes a connection from the Data Catalog.
.
- deleteCrawler(params = {}, callback) ⇒ AWS.Request
Removes a specified crawler from the Glue Data Catalog, unless the crawler state is
RUNNING
..
- deleteCustomEntityType(params = {}, callback) ⇒ AWS.Request
Deletes a custom pattern by specifying its name.
.
- deleteDatabase(params = {}, callback) ⇒ AWS.Request
Removes a specified database from a Data Catalog.
Note: After completing this operation, you 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.- deleteDataQualityRuleset(params = {}, callback) ⇒ AWS.Request
Deletes a data quality ruleset.
.
- deleteDevEndpoint(params = {}, callback) ⇒ AWS.Request
Deletes a specified development endpoint.
.
- deleteJob(params = {}, callback) ⇒ AWS.Request
Deletes a specified job definition.
- deleteMLTransform(params = {}, callback) ⇒ AWS.Request
Deletes an Glue machine learning transform.
- deletePartition(params = {}, callback) ⇒ AWS.Request
Deletes a specified partition.
.
- deletePartitionIndex(params = {}, callback) ⇒ AWS.Request
Deletes a specified partition index from an existing table.
.
- deleteRegistry(params = {}, callback) ⇒ AWS.Request
Delete the entire registry including schema and all of its versions.
- deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request
Deletes a specified policy.
.
- deleteSchema(params = {}, callback) ⇒ AWS.Request
Deletes the entire schema set, including the schema set and all of its versions.
- deleteSchemaVersions(params = {}, callback) ⇒ AWS.Request
Remove versions from the specified schema.
- deleteSecurityConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes a specified security configuration.
.
- deleteSession(params = {}, callback) ⇒ AWS.Request
Deletes the session.
.
- deleteTable(params = {}, callback) ⇒ AWS.Request
Removes a table definition from the Data Catalog.
Note: After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table.- deleteTableOptimizer(params = {}, callback) ⇒ AWS.Request
Deletes an optimizer and all associated metadata for a table.
- deleteTableVersion(params = {}, callback) ⇒ AWS.Request
Deletes a specified version of a table.
.
- deleteTrigger(params = {}, callback) ⇒ AWS.Request
Deletes a specified trigger.
- deleteUsageProfile(params = {}, callback) ⇒ AWS.Request
Deletes the Glue specified usage profile.
.
- deleteUserDefinedFunction(params = {}, callback) ⇒ AWS.Request
Deletes an existing function definition from the Data Catalog.
.
- deleteWorkflow(params = {}, callback) ⇒ AWS.Request
Deletes a workflow.
.
- getBlueprint(params = {}, callback) ⇒ AWS.Request
Retrieves the details of a blueprint.
.
- getBlueprintRun(params = {}, callback) ⇒ AWS.Request
Retrieves the details of a blueprint run.
.
- getBlueprintRuns(params = {}, callback) ⇒ AWS.Request
Retrieves the details of blueprint runs for a specified blueprint.
.
- getCatalogImportStatus(params = {}, callback) ⇒ AWS.Request
Retrieves the status of a migration operation.
.
- getClassifier(params = {}, callback) ⇒ AWS.Request
Retrieve a classifier by name.
.
- getClassifiers(params = {}, callback) ⇒ AWS.Request
Lists all classifier objects in the Data Catalog.
.
- getColumnStatisticsForPartition(params = {}, callback) ⇒ AWS.Request
Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
.GetPartition
.- getColumnStatisticsForTable(params = {}, callback) ⇒ AWS.Request
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
.GetTable
.- getColumnStatisticsTaskRun(params = {}, callback) ⇒ AWS.Request
Get the associated metadata/information for a task run, given a task run ID.
.
- getColumnStatisticsTaskRuns(params = {}, callback) ⇒ AWS.Request
Retrieves information about all runs associated with the specified table.
.
- getConnection(params = {}, callback) ⇒ AWS.Request
Retrieves a connection definition from the Data Catalog.
.
- getConnections(params = {}, callback) ⇒ AWS.Request
Retrieves a list of connection definitions from the Data Catalog.
.
- getCrawler(params = {}, callback) ⇒ AWS.Request
Retrieves metadata for a specified crawler.
.
- getCrawlerMetrics(params = {}, callback) ⇒ AWS.Request
Retrieves metrics about specified crawlers.
.
- getCrawlers(params = {}, callback) ⇒ AWS.Request
Retrieves metadata for all crawlers defined in the customer account.
.
- getCustomEntityType(params = {}, callback) ⇒ AWS.Request
Retrieves the details of a custom pattern by specifying its name.
.
- getDatabase(params = {}, callback) ⇒ AWS.Request
Retrieves the definition of a specified database.
.
- getDatabases(params = {}, callback) ⇒ AWS.Request
Retrieves all databases defined in a given Data Catalog.
.
- getDataCatalogEncryptionSettings(params = {}, callback) ⇒ AWS.Request
Retrieves the security configuration for a specified catalog.
.
- getDataflowGraph(params = {}, callback) ⇒ AWS.Request
Transforms a Python script into a directed acyclic graph (DAG).
- getDataQualityModel(params = {}, callback) ⇒ AWS.Request
Retrieve the training status of the model along with more information (CompletedOn, StartedOn, FailureReason).
.
- getDataQualityModelResult(params = {}, callback) ⇒ AWS.Request
Retrieve a statistic's predictions for a given Profile ID.
.
- getDataQualityResult(params = {}, callback) ⇒ AWS.Request
Retrieves the result of a data quality rule evaluation.
.
- getDataQualityRuleRecommendationRun(params = {}, callback) ⇒ AWS.Request
Gets the specified recommendation run that was used to generate rules.
.
- getDataQualityRuleset(params = {}, callback) ⇒ AWS.Request
Returns an existing ruleset by identifier or name.
.
- getDataQualityRulesetEvaluationRun(params = {}, callback) ⇒ AWS.Request
Retrieves a specific run where a ruleset is evaluated against a data source.
.
- getDevEndpoint(params = {}, callback) ⇒ AWS.Request
Retrieves information about a specified development endpoint.
Note: When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated.- getDevEndpoints(params = {}, callback) ⇒ AWS.Request
Retrieves all the development endpoints in this Amazon Web Services account.
Note: When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated.- getJob(params = {}, callback) ⇒ AWS.Request
Retrieves an existing job definition.
.
- getJobBookmark(params = {}, callback) ⇒ AWS.Request
Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
.- getJobRun(params = {}, callback) ⇒ AWS.Request
Retrieves the metadata for a given job run.
- getJobRuns(params = {}, callback) ⇒ AWS.Request
Retrieves metadata for all runs of a given job definition.
.
- getJobs(params = {}, callback) ⇒ AWS.Request
Retrieves all current job definitions.
.
- getMapping(params = {}, callback) ⇒ AWS.Request
Creates mappings.
.
- getMLTaskRun(params = {}, callback) ⇒ AWS.Request
Gets details for a specific task run on a machine learning transform.
- getMLTaskRuns(params = {}, callback) ⇒ AWS.Request
Gets a list of runs for a machine learning transform.
- getMLTransform(params = {}, callback) ⇒ AWS.Request
Gets an Glue machine learning transform artifact and all its corresponding metadata.
- getMLTransforms(params = {}, callback) ⇒ AWS.Request
Gets a sortable, filterable list of existing Glue machine learning transforms.
- getPartition(params = {}, callback) ⇒ AWS.Request
Retrieves information about a specified partition.
.
- getPartitionIndexes(params = {}, callback) ⇒ AWS.Request
Retrieves the partition indexes associated with a table.
.
- getPartitions(params = {}, callback) ⇒ AWS.Request
Retrieves information about the partitions in a table.
.
- getPlan(params = {}, callback) ⇒ AWS.Request
Gets code to perform a specified mapping.
.
- getRegistry(params = {}, callback) ⇒ AWS.Request
Describes the specified registry in detail.
.
- getResourcePolicies(params = {}, callback) ⇒ AWS.Request
Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants.
- getResourcePolicy(params = {}, callback) ⇒ AWS.Request
Retrieves a specified resource policy.
.
- getSchema(params = {}, callback) ⇒ AWS.Request
Describes the specified schema in detail.
.
- getSchemaByDefinition(params = {}, callback) ⇒ AWS.Request
Retrieves a schema by the
SchemaDefinition
.- getSchemaVersion(params = {}, callback) ⇒ AWS.Request
Get the specified schema by its unique ID assigned when a version of the schema is created or registered.
- getSchemaVersionsDiff(params = {}, callback) ⇒ AWS.Request
Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
.- getSecurityConfiguration(params = {}, callback) ⇒ AWS.Request
Retrieves a specified security configuration.
.
- getSecurityConfigurations(params = {}, callback) ⇒ AWS.Request
Retrieves a list of all security configurations.
.
- getSession(params = {}, callback) ⇒ AWS.Request
Retrieves the session.
.
- getStatement(params = {}, callback) ⇒ AWS.Request
Retrieves the statement.
.
- getTable(params = {}, callback) ⇒ AWS.Request
Retrieves the
Table
definition in a Data Catalog for a specified table..
- getTableOptimizer(params = {}, callback) ⇒ AWS.Request
Returns the configuration of all optimizers associated with a specified table.
.
- getTables(params = {}, callback) ⇒ AWS.Request
Retrieves the definitions of some or all of the tables in a given
Database
..
- getTableVersion(params = {}, callback) ⇒ AWS.Request
Retrieves a specified version of a table.
.
- getTableVersions(params = {}, callback) ⇒ AWS.Request
Retrieves a list of strings that identify available versions of a specified table.
.
- getTags(params = {}, callback) ⇒ AWS.Request
Retrieves a list of tags associated with a resource.
.
- getTrigger(params = {}, callback) ⇒ AWS.Request
Retrieves the definition of a trigger.
.
- getTriggers(params = {}, callback) ⇒ AWS.Request
Gets all the triggers associated with a job.
.
- getUnfilteredPartitionMetadata(params = {}, callback) ⇒ AWS.Request
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
.glue:GetPartition
.- getUnfilteredPartitionsMetadata(params = {}, callback) ⇒ AWS.Request
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
.glue:GetPartitions
.- getUnfilteredTableMetadata(params = {}, callback) ⇒ AWS.Request
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
For IAM authorization, the public IAM action associated with this API is
.glue:GetTable
.- getUsageProfile(params = {}, callback) ⇒ AWS.Request
Retrieves information about the specified Glue usage profile.
.
- getUserDefinedFunction(params = {}, callback) ⇒ AWS.Request
Retrieves a specified function definition from the Data Catalog.
.
- getUserDefinedFunctions(params = {}, callback) ⇒ AWS.Request
Retrieves multiple function definitions from the Data Catalog.
.
- getWorkflow(params = {}, callback) ⇒ AWS.Request
Retrieves resource metadata for a workflow.
.
- getWorkflowRun(params = {}, callback) ⇒ AWS.Request
Retrieves the metadata for a given workflow run.
- getWorkflowRunProperties(params = {}, callback) ⇒ AWS.Request
Retrieves the workflow run properties which were set during the run.
.
- getWorkflowRuns(params = {}, callback) ⇒ AWS.Request
Retrieves metadata for all runs of a given workflow.
.
- importCatalogToGlue(params = {}, callback) ⇒ AWS.Request
Imports an existing Amazon Athena Data Catalog to Glue.
.
- listBlueprints(params = {}, callback) ⇒ AWS.Request
Lists all the blueprint names in an account.
.
- listColumnStatisticsTaskRuns(params = {}, callback) ⇒ AWS.Request
List all task runs for a particular account.
.
- listCrawlers(params = {}, callback) ⇒ AWS.Request
Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag.
- listCrawls(params = {}, callback) ⇒ AWS.Request
Returns all the crawls of a specified crawler.
- listCustomEntityTypes(params = {}, callback) ⇒ AWS.Request
Lists all the custom patterns that have been created.
.
- listDataQualityResults(params = {}, callback) ⇒ AWS.Request
Returns all data quality execution results for your account.
.
- listDataQualityRuleRecommendationRuns(params = {}, callback) ⇒ AWS.Request
Lists the recommendation runs meeting the filter criteria.
.
- listDataQualityRulesetEvaluationRuns(params = {}, callback) ⇒ AWS.Request
Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
.
- listDataQualityRulesets(params = {}, callback) ⇒ AWS.Request
Returns a paginated list of rulesets for the specified list of Glue tables.
.
- listDataQualityStatisticAnnotations(params = {}, callback) ⇒ AWS.Request
Retrieve annotations for a data quality statistic.
.
- listDataQualityStatistics(params = {}, callback) ⇒ AWS.Request
Retrieves a list of data quality statistics.
.
- listDevEndpoints(params = {}, callback) ⇒ AWS.Request
Retrieves the names of all
DevEndpoint
resources in this Amazon Web Services account, or the resources with the specified tag.- listJobs(params = {}, callback) ⇒ AWS.Request
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag.
- listMLTransforms(params = {}, callback) ⇒ AWS.Request
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag.
- listRegistries(params = {}, callback) ⇒ AWS.Request
Returns a list of registries that you have created, with minimal registry information.
- listSchemas(params = {}, callback) ⇒ AWS.Request
Returns a list of schemas with minimal details.
- listSchemaVersions(params = {}, callback) ⇒ AWS.Request
Returns a list of schema versions that you have created, with minimal information.
- listSessions(params = {}, callback) ⇒ AWS.Request
Retrieve a list of sessions.
.
- listStatements(params = {}, callback) ⇒ AWS.Request
Lists statements for the session.
.
- listTableOptimizerRuns(params = {}, callback) ⇒ AWS.Request
Lists the history of previous optimizer runs for a specific table.
.
- listTriggers(params = {}, callback) ⇒ AWS.Request
Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag.
- listUsageProfiles(params = {}, callback) ⇒ AWS.Request
List all the Glue usage profiles.
.
- listWorkflows(params = {}, callback) ⇒ AWS.Request
Lists names of workflows created in the account.
.
- putDataCatalogEncryptionSettings(params = {}, callback) ⇒ AWS.Request
Sets the security configuration for a specified catalog.
- putDataQualityProfileAnnotation(params = {}, callback) ⇒ AWS.Request
Annotate all datapoints for a Profile.
.
- putResourcePolicy(params = {}, callback) ⇒ AWS.Request
Sets the Data Catalog resource policy for access control.
.
- putSchemaVersionMetadata(params = {}, callback) ⇒ AWS.Request
Puts the metadata key value pair for a specified schema version ID.
- putWorkflowRunProperties(params = {}, callback) ⇒ AWS.Request
Puts the specified workflow run properties for the given workflow run.
- querySchemaVersionMetadata(params = {}, callback) ⇒ AWS.Request
Queries for the schema version metadata information.
- registerSchemaVersion(params = {}, callback) ⇒ AWS.Request
Adds a new version to the existing schema.
- removeSchemaVersionMetadata(params = {}, callback) ⇒ AWS.Request
Removes a key value pair from the schema version metadata for the specified schema version ID.
.
- resetJobBookmark(params = {}, callback) ⇒ AWS.Request
Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
.- resumeWorkflowRun(params = {}, callback) ⇒ AWS.Request
Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run.
- runStatement(params = {}, callback) ⇒ AWS.Request
Executes the statement.
.
- searchTables(params = {}, callback) ⇒ AWS.Request
Searches a set of tables based on properties in the table metadata as well as on the parent database.
- startBlueprintRun(params = {}, callback) ⇒ AWS.Request
Starts a new run of the specified blueprint.
.
- startColumnStatisticsTaskRun(params = {}, callback) ⇒ AWS.Request
Starts a column statistics task run, for a specified table and columns.
.
- startCrawler(params = {}, callback) ⇒ AWS.Request
Starts a crawl using the specified crawler, regardless of what is scheduled.
- 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 alreadySCHEDULED
..
- startDataQualityRuleRecommendationRun(params = {}, callback) ⇒ AWS.Request
Starts a recommendation run that is used to generate rules when you don't know what rules to write.
- startDataQualityRulesetEvaluationRun(params = {}, callback) ⇒ AWS.Request
Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table).
- startExportLabelsTaskRun(params = {}, callback) ⇒ AWS.Request
Begins an asynchronous task to export all labeled data for a particular transform.
- startImportLabelsTaskRun(params = {}, callback) ⇒ AWS.Request
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality.
- startJobRun(params = {}, callback) ⇒ AWS.Request
Starts a job run using a job definition.
.
- startMLEvaluationTaskRun(params = {}, callback) ⇒ AWS.Request
Starts a task to estimate the quality of the transform.
- startMLLabelingSetGenerationTaskRun(params = {}, callback) ⇒ AWS.Request
Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.
When the
StartMLLabelingSetGenerationTaskRun
finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.In the case of the
FindMatches
transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”After the labeling process is finished, you can upload your labels with a call to
StartImportLabelsTaskRun
.- startTrigger(params = {}, callback) ⇒ AWS.Request
Starts an existing trigger.
- startWorkflowRun(params = {}, callback) ⇒ AWS.Request
Starts a new run of the specified workflow.
.
- stopColumnStatisticsTaskRun(params = {}, callback) ⇒ AWS.Request
Stops a task run for the specified table.
.
- stopCrawler(params = {}, callback) ⇒ AWS.Request
If the specified crawler is running, stops the crawl.
.
- 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..
- stopSession(params = {}, callback) ⇒ AWS.Request
Stops the session.
.
- stopTrigger(params = {}, callback) ⇒ AWS.Request
Stops a specified trigger.
.
- stopWorkflowRun(params = {}, callback) ⇒ AWS.Request
Stops the execution of the specified workflow run.
.
- tagResource(params = {}, callback) ⇒ AWS.Request
Adds tags to a resource.
- untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from a resource.
.
- updateBlueprint(params = {}, callback) ⇒ AWS.Request
Updates a registered blueprint.
.
- updateClassifier(params = {}, callback) ⇒ AWS.Request
Modifies an existing classifier (a
GrokClassifier
, anXMLClassifier
, aJsonClassifier
, or aCsvClassifier
, depending on which field is present)..
- updateColumnStatisticsForPartition(params = {}, callback) ⇒ AWS.Request
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
.UpdatePartition
.- updateColumnStatisticsForTable(params = {}, callback) ⇒ AWS.Request
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
.UpdateTable
.- updateConnection(params = {}, callback) ⇒ AWS.Request
Updates a connection definition in the Data Catalog.
.
- updateCrawler(params = {}, callback) ⇒ AWS.Request
Updates a crawler.
- updateCrawlerSchedule(params = {}, callback) ⇒ AWS.Request
Updates the schedule of a crawler using a
cron
expression.- updateDatabase(params = {}, callback) ⇒ AWS.Request
Updates an existing database definition in a Data Catalog.
.
- updateDataQualityRuleset(params = {}, callback) ⇒ AWS.Request
Updates the specified data quality ruleset.
.
- updateDevEndpoint(params = {}, callback) ⇒ AWS.Request
Updates a specified development endpoint.
.
- updateJob(params = {}, callback) ⇒ AWS.Request
Updates an existing job definition.
- updateJobFromSourceControl(params = {}, callback) ⇒ AWS.Request
Synchronizes a job from the source control repository.
- updateMLTransform(params = {}, callback) ⇒ AWS.Request
Updates an existing machine learning transform.
- updatePartition(params = {}, callback) ⇒ AWS.Request
Updates a partition.
.
- updateRegistry(params = {}, callback) ⇒ AWS.Request
Updates an existing registry which is used to hold a collection of schemas.
- updateSchema(params = {}, callback) ⇒ AWS.Request
Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting.
- updateSourceControlFromJob(params = {}, callback) ⇒ AWS.Request
Synchronizes a job to the source control repository.
- updateTable(params = {}, callback) ⇒ AWS.Request
Updates a metadata table in the Data Catalog.
.
- updateTableOptimizer(params = {}, callback) ⇒ AWS.Request
Updates the configuration for an existing table optimizer.
.
- updateTrigger(params = {}, callback) ⇒ AWS.Request
Updates a trigger definition.
.
- updateUsageProfile(params = {}, callback) ⇒ AWS.Request
Update an Glue usage profile.
.
- updateUserDefinedFunction(params = {}, callback) ⇒ AWS.Request
Updates an existing function definition in the Data Catalog.
.
- updateWorkflow(params = {}, callback) ⇒ AWS.Request
Updates an existing workflow.
.
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|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.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.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
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 totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
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: { AdditionalLocations: [ 'STRING_VALUE', /* more items */ ], BucketColumns: [ 'STRING_VALUE', /* more items */ ], Columns: [ { Name: 'STRING_VALUE', /* required */ Comment: 'STRING_VALUE', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, 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>': ... */ }, SchemaReference: { SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: 'NUMBER_VALUE' }, 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 partition is to be created. Currently, this should be the Amazon Web Services 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.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
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. Thedata
object has the following properties:Errors
— (Array<map>
)The errors encountered when trying to create the requested partitions.
PartitionValues
— (Array<String>
)The values that define the partition.
ErrorDetail
— (map
)The details about the partition error.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
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 Amazon Web Services 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. Thedata
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.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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 that contains the partitions to be deleted.
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. Thedata
object has the following properties:Errors
— (Array<map>
)The errors encountered when trying to delete the requested partitions.
PartitionValues
— (Array<String>
)The values that define the partition.
ErrorDetail
— (map
)The details about the partition error.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
batchDeleteTable(params = {}, callback) ⇒ AWS.Request
Deletes multiple tables at once.
Note: After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure the immediate deletion of all related resources, before callingBatchDeleteTable
, useDeleteTableVersion
orBatchDeleteTableVersion
, andDeletePartition
orBatchDeletePartition
, 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', TransactionId: '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 provided, the Amazon Web Services account ID is used by default.
DatabaseName
— (String
)The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.
TablesToDelete
— (Array<String>
)A list of the table to delete.
TransactionId
— (String
)The transaction ID at which to delete the table contents.
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. Thedata
object has the following properties:Errors
— (Array<map>
)A list of errors encountered in attempting to delete the specified tables.
TableName
— (String
)The name of the table. For Hive compatibility, this must be entirely lowercase.
ErrorDetail
— (map
)The details about the error.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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. Thedata
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
)The details about the error.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
batchGetBlueprints(params = {}, callback) ⇒ AWS.Request
Retrieves information about a list of blueprints.
Service Reference:
Examples:
Calling the batchGetBlueprints operation
var params = { Names: [ /* required */ 'STRING_VALUE', /* more items */ ], IncludeBlueprint: true || false, IncludeParameterSpec: true || false }; glue.batchGetBlueprints(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: {})
—
Names
— (Array<String>
)A list of blueprint names.
IncludeBlueprint
— (Boolean
)Specifies whether or not to include the blueprint in the response.
IncludeParameterSpec
— (Boolean
)Specifies whether or not to include the parameters, as a JSON string, for the blueprint in 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. Thedata
object has the following properties:Blueprints
— (Array<map>
)Returns a list of blueprint as a
Blueprints
object.Name
— (String
)The name of the blueprint.
Description
— (String
)The description of the blueprint.
CreatedOn
— (Date
)The date and time the blueprint was registered.
LastModifiedOn
— (Date
)The date and time the blueprint was last modified.
ParameterSpec
— (String
)A JSON string that indicates the list of parameter specifications for the blueprint.
BlueprintLocation
— (String
)Specifies the path in Amazon S3 where the blueprint is published.
BlueprintServiceLocation
— (String
)Specifies a path in Amazon S3 where the blueprint is copied when you call
CreateBlueprint/UpdateBlueprint
to register the blueprint in Glue.Status
— (String
)The status of the blueprint registration.
-
Creating — The blueprint registration is in progress.
-
Active — The blueprint has been successfully registered.
-
Updating — An update to the blueprint registration is in progress.
-
Failed — The blueprint registration failed.
"CREATING"
"ACTIVE"
"UPDATING"
"FAILED"
-
ErrorMessage
— (String
)An error message.
LastActiveDefinition
— (map
)When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
Description
— (String
)The description of the blueprint.
LastModifiedOn
— (Date
)The date and time the blueprint was last modified.
ParameterSpec
— (String
)A JSON string specifying the parameters for the blueprint.
BlueprintLocation
— (String
)Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
BlueprintServiceLocation
— (String
)Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
MissingBlueprints
— (Array<String>
)Returns a list of
BlueprintNames
that were not found.
-
(AWS.Response)
—
Returns:
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 might 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. Thedata
object has the following properties:Crawlers
— (Array<map>
)A list of crawler definitions.
Name
— (String
)The name of the crawler.
Role
— (String
)The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
Targets
— (map
)A collection of targets to crawl.
S3Targets
— (Array<map>
)Specifies Amazon Simple Storage Service (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.
ConnectionName
— (String
)The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize
— (Integer
)Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
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.
EnableAdditionalMetadata
— (Array<String>
)Specify a value of
RAWTYPES
orCOMMENTS
to enable additional metadata in table responses.RAWTYPES
provides the native-level datatype.COMMENTS
provides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
MongoDBTargets
— (Array<map>
)Specifies Amazon DocumentDB or MongoDB targets.
ConnectionName
— (String
)The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path
— (String
)The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.
DynamoDBTargets
— (Array<map>
)Specifies Amazon DynamoDB targets.
Path
— (String
)The name of the DynamoDB table to crawl.
scanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.scanRate
— (Float
)The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets
— (Array<map>
)Specifies Glue Data Catalog targets.
DatabaseName
— required — (String
)The name of the database to be synchronized.
Tables
— required — (Array<String>
)A list of the tables to be synchronized.
ConnectionName
— (String
)The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a
Catalog
connection type paired with aNETWORK
Connection type.EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
DeltaTargets
— (Array<map>
)Specifies Delta data store targets.
DeltaTables
— (Array<String>
)A list of the Amazon S3 paths to the Delta tables.
ConnectionName
— (String
)The name of the connection to use to connect to the Delta table target.
WriteManifest
— (Boolean
)Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable
— (Boolean
)Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets
— (Array<map>
)Specifies Apache Iceberg data store targets.
Paths
— (Array<String>
)One or more Amazon S3 paths that contains Iceberg metadata folders as
s3://bucket/prefix
.ConnectionName
— (String
)The name of the connection to use to connect to the Iceberg target.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets
— (Array<map>
)Specifies Apache Hudi data store targets.
Paths
— (Array<String>
)An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
ConnectionName
— (String
)The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
DatabaseName
— (String
)The name of the database in which the crawler's output is stored.
Description
— (String
)A description of the crawler.
Classifiers
— (Array<String>
)A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
RecrawlPolicy
— (map
)A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior
— (String
)Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of
CRAWL_EVERYTHING
specifies crawling the entire dataset again.A value of
CRAWL_NEW_FOLDERS_ONLY
specifies crawling only folders that were added since the last crawler run.A value of
Possible values include:CRAWL_EVENT_MODE
specifies crawling only the changes identified by Amazon S3 events."CRAWL_EVERYTHING"
"CRAWL_NEW_FOLDERS_ONLY"
"CRAWL_EVENT_MODE"
SchemaChangePolicy
— (map
)The policy that specifies update and delete behaviors for the crawler.
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"
LineageConfiguration
— (map
)A configuration that specifies whether data lineage is enabled for the crawler.
CrawlerLineageSettings
— (String
)Specifies whether data lineage is enabled for the crawler. Valid values are:
-
ENABLE: enables data lineage for the crawler
-
DISABLE: disables data lineage for the crawler
"ENABLE"
"DISABLE"
-
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 that the crawler was created.
LastUpdated
— (Date
)The time that 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 Setting crawler configuration options.
CrawlerSecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used by this crawler.LakeFormationConfiguration
— (map
)Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
UseLakeFormationCredentials
— (Boolean
)Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId
— (String
)Required for cross account crawls. For same account crawls as the target data, this can be left as null.
CrawlersNotFound
— (Array<String>
)A list of names of crawlers that were not found.
-
(AWS.Response)
—
Returns:
batchGetCustomEntityTypes(params = {}, callback) ⇒ AWS.Request
Retrieves the details for the custom patterns specified by a list of names.
Service Reference:
Examples:
Calling the batchGetCustomEntityTypes operation
var params = { Names: [ /* required */ 'STRING_VALUE', /* more items */ ] }; glue.batchGetCustomEntityTypes(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: {})
—
Names
— (Array<String>
)A list of names of the custom patterns that you want 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. Thedata
object has the following properties:CustomEntityTypes
— (Array<map>
)A list of
CustomEntityType
objects representing the custom patterns that have been created.Name
— required — (String
)A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
RegexString
— required — (String
)A regular expression string that is used for detecting sensitive data in a custom pattern.
ContextWords
— (Array<String>
)A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
CustomEntityTypesNotFound
— (Array<String>
)A list of the names of custom patterns that were not found.
-
(AWS.Response)
—
Returns:
batchGetDataQualityResult(params = {}, callback) ⇒ AWS.Request
Retrieves a list of data quality results for the specified result IDs.
Service Reference:
Examples:
Calling the batchGetDataQualityResult operation
var params = { ResultIds: [ /* required */ 'STRING_VALUE', /* more items */ ] }; glue.batchGetDataQualityResult(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: {})
—
ResultIds
— (Array<String>
)A list of unique result IDs for the data quality results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Results
— (Array<map>
)A list of
DataQualityResult
objects representing the data quality results.ResultId
— (String
)A unique result ID for the data quality result.
ProfileId
— (String
)The Profile ID for the data quality result.
Score
— (Float
)An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
DataSource
— (map
)The table associated with the data quality result, if any.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
RulesetName
— (String
)The name of the ruleset associated with the data quality result.
EvaluationContext
— (String
)In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the
evaluationContext
can differentiate the nodes.StartedOn
— (Date
)The date and time when this data quality run started.
CompletedOn
— (Date
)The date and time when this data quality run completed.
JobName
— (String
)The job name associated with the data quality result, if any.
JobRunId
— (String
)The job run ID associated with the data quality result, if any.
RulesetEvaluationRunId
— (String
)The unique run ID for the ruleset evaluation for this data quality result.
RuleResults
— (Array<map>
)A list of
DataQualityRuleResult
objects representing the results for each rule.Name
— (String
)The name of the data quality rule.
Description
— (String
)A description of the data quality rule.
EvaluationMessage
— (String
)An evaluation message.
Result
— (String
)A pass or fail status for the rule.
Possible values include:"PASS"
"FAIL"
"ERROR"
EvaluatedMetrics
— (map<Float>
)A map of metrics associated with the evaluation of the rule.
EvaluatedRule
— (String
)The evaluated rule.
AnalyzerResults
— (Array<map>
)A list of
DataQualityAnalyzerResult
objects representing the results for each analyzer.Name
— (String
)The name of the data quality analyzer.
Description
— (String
)A description of the data quality analyzer.
EvaluationMessage
— (String
)An evaluation message.
EvaluatedMetrics
— (map<Float>
)A map of metrics associated with the evaluation of the analyzer.
Observations
— (Array<map>
)A list of
DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.Description
— (String
)A description of the data quality observation.
MetricBasedObservation
— (map
)An object of type
MetricBasedObservation
representing the observation that is based on evaluated data quality metrics.MetricName
— (String
)The name of the data quality metric used for generating the observation.
StatisticId
— (String
)The Statistic ID.
MetricValues
— (map
)An object of type
DataQualityMetricValues
representing the analysis of the data quality metric value.ActualValue
— (Float
)The actual value of the data quality metric.
ExpectedValue
— (Float
)The expected value of the data quality metric according to the analysis of historical data.
LowerLimit
— (Float
)The lower limit of the data quality metric value according to the analysis of historical data.
UpperLimit
— (Float
)The upper limit of the data quality metric value according to the analysis of historical data.
NewRules
— (Array<String>
)A list of new data quality rules generated as part of the observation based on the data quality metric value.
ResultsNotFound
— (Array<String>
)A list of result IDs for which results were not found.
-
(AWS.Response)
—
Returns:
batchGetDevEndpoints(params = {}, callback) ⇒ AWS.Request
Returns a list of resource metadata for a given list of development endpoint 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 might be the names returned from theListDevEndpoint
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. Thedata
object has the following properties:DevEndpoints
— (Array<map>
)A list of
DevEndpoint
definitions.EndpointName
— (String
)The name of the
DevEndpoint
.RoleArn
— (String
)The Amazon Resource Name (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 theDevEndpoint
is created within one. ThePrivateAddress
field is present only when you create theDevEndpoint
within your VPC.ZeppelinRemoteSparkInterpreterPort
— (Integer
)The Apache Zeppelin port for the remote Apache Spark interpreter.
PublicAddress
— (String
)The public IP address used by this
DevEndpoint
. ThePublicAddress
field is present only when you create a non-virtual private cloud (VPC)DevEndpoint
.Status
— (String
)The current status of this
DevEndpoint
.WorkerType
— (String
)The type of predefined worker that is allocated to the development endpoint. 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
Possible values include:G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk."Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
GlueVersion
— (String
)Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated to the development endpoint.The maximum number of workers you can define are 299 for
G.1X
, and 149 forG.2X
.NumberOfNodes
— (Integer
)The number of Glue Data Processing Units (DPUs) allocated to this
DevEndpoint
.AvailabilityZone
— (String
)The Amazon Web Services Availability Zone where this
DevEndpoint
is located.VpcId
— (String
)The ID of the virtual private cloud (VPC) used by this
DevEndpoint
.ExtraPythonLibsS3Path
— (String
)The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
DevEndpoint
. Multiple values must be complete paths separated by a comma.Note: You can only use pure Python libraries with aDevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.ExtraJarsS3Path
— (String
)The path to one or more Java
.jar
files in an S3 bucket that should be loaded in yourDevEndpoint
.Note: You can only use pure Java/Scala libraries with aDevEndpoint
.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 because the recommended attribute to use is public keys.PublicKeys
— (Array<String>
)A list of public keys to be used by the
DevEndpoints
for authentication. Using 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 theUpdateDevEndpoint
API operation with the public key content in thedeletePublicKeys
attribute, and the list of new keys in theaddPublicKeys
attribute.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with thisDevEndpoint
.Arguments
— (map<String>
)A map of arguments used to configure the
DevEndpoint
.Valid arguments are:
-
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.-
DevEndpointsNotFound
— (Array<String>
)A list of
DevEndpoints
not found.
-
(AWS.Response)
—
Returns:
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 might 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. Thedata
object has the following properties:Jobs
— (Array<map>
)A list of job definitions.
Name
— (String
)The name you assign to this job definition.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Description
— (String
)A description of the job.
LogUri
— (String
)This field is reserved for future use.
Role
— (String
)The name or Amazon Resource Name (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 runs this job.Name
— (String
)The name of the job command. For an Apache Spark ETL job, this must be
glueetl
. For a Python shell job, it must bepythonshell
. For an Apache Spark streaming ETL job, this must begluestreaming
. For a Ray job, this must beglueray
.ScriptLocation
— (String
)Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
PythonVersion
— (String
)The Python version being used to run a Python shell job. Allowed values are 2 or 3.
Runtime
— (String
)In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
DefaultArguments
— (map<String>
)The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
NonOverridableArguments
— (map<String>
)Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
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 Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; 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 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) for batch jobs.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CodeGenConfigurationNodes
— (map<map>
)The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
AthenaConnectorSource
— (map
)Specifies a connector to an Amazon Athena data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
ConnectionTable
— (String
)The name of the table in the data source.
SchemaName
— required — (String
)The name of the Cloudwatch log group to read from. For example,
/aws-glue/jobs/output
.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom Athena source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
JDBCConnectorSource
— (map
)Specifies a connector to a JDBC data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
AdditionalOptions
— (map
)Additional connection options for the connector.
FilterPredicate
— (String
)Extra condition clause to filter data from source. For example:
BillingCity='Mountain View'
When using a query instead of a table name, you should validate that the query works with the specified
filterPredicate
.PartitionColumn
— (String
)The name of an integer column that is used for partitioning. This option works only when it's included with
lowerBound
,upperBound
, andnumPartitions
. This option works the same way as in the Spark SQL JDBC reader.LowerBound
— (Integer
)The minimum value of
partitionColumn
that is used to decide partition stride.UpperBound
— (Integer
)The maximum value of
partitionColumn
that is used to decide partition stride.NumPartitions
— (Integer
)The number of partitions. This value, along with
lowerBound
(inclusive) andupperBound
(exclusive), form partition strides for generatedWHERE
clause expressions that are used to split thepartitionColumn
.JobBookmarkKeys
— (Array<String>
)The name of the job bookmark keys on which to sort.
JobBookmarkKeysSortOrder
— (String
)Specifies an ascending or descending sort order.
DataTypeMapping
— (map<String>
)Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option
"dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC typeFLOAT
into the JavaString
type by calling theResultSet.getString()
method of the driver, and uses it to build the Glue record. TheResultSet
object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
ConnectionTable
— (String
)The name of the table in the data source.
Query
— (String
)The table or SQL query to get the data from. You can specify either
ConnectionTable
orquery
, but not both.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom JDBC source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorSource
— (map
)Specifies a connector to an Apache Spark data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies data schema for the custom spark source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogSource
— (map
)Specifies a data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
RedshiftSource
— (map
)Specifies an Amazon Redshift data store.
Name
— required — (String
)The name of the Amazon Redshift data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
S3CatalogSource
— (map
)Specifies an Amazon S3 data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
S3CsvSource
— (map
)Specifies a command-separated value (CSV) data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
Separator
— required — (String
)Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
Possible values include:"comma"
"ctrla"
"pipe"
"semicolon"
"tab"
Escaper
— (String
)Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is
none
. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n
,\r
,\t
, and\0
).QuoteChar
— required — (String
)Specifies the character to use for quoting. The default is a double quote:
Possible values include:'"'
. Set this to-1
to turn off quoting entirely."quote"
"quillemet"
"single_quote"
"disabled"
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.WithHeader
— (Boolean
)A Boolean value that specifies whether to treat the first line as a header. The default value is
False
.WriteHeader
— (Boolean
)A Boolean value that specifies whether to write the header to output. The default value is
True
.SkipFirst
— (Boolean
)A Boolean value that specifies whether to skip the first data line. The default value is
False
.OptimizePerformance
— (Boolean
)A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 CSV source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3JsonSource
— (map
)Specifies a JSON data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
JsonPath
— (String
)A JsonPath string defining the JSON data.
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 JSON source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3ParquetSource
— (map
)Specifies an Apache Parquet data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 Parquet source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
RelationalCatalogSource
— (map
)Specifies a relational catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
DynamoDBCatalogSource
— (map
)Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
JDBCConnectorTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectionTable
— required — (String
)The name of the table in the data target.
ConnectorName
— required — (String
)The name of a connector that will be used.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the JDBC target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorTarget
— (map
)Specifies a target that uses an Apache Spark connector.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of a connection for an Apache Spark connector.
ConnectorName
— required — (String
)The name of an Apache Spark connector.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom spark target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogTarget
— (map
)Specifies a target that uses a Glue Data Catalog table.
Name
— required — (String
)The name of your data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)The partition keys used to distribute data across multiple partitions or shards based on a specific key or set of key.
Database
— required — (String
)The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
Table
— required — (String
)The table that defines the schema of your output data. This table must already exist in the Data Catalog.
RedshiftTarget
— (map
)Specifies a target that uses Amazon Redshift.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
UpsertRedshiftOptions
— (map
)The set of options to configure an upsert operation when writing to a Redshift target.
TableLocation
— (String
)The physical location of the Redshift table.
ConnectionName
— (String
)The name of the connection to use to write to Redshift.
UpsertKeys
— (Array<String>
)The keys used to determine whether to perform an update or insert.
S3CatalogTarget
— (map
)Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3GlueParquetTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
S3DirectTarget
— (map
)Specifies a data target that writes to Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
"gzip"
and"bzip"
).Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
ApplyMapping
— (map
)Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Mapping
— required — (Array<map>
)Specifies the mapping of data property keys in the data source to data property keys in the data target.
ToKey
— (String
)After the apply mapping, what the name of the column should be. Can be the same as
FromPath
.FromPath
— (Array<String>
)The table or column to be modified.
FromType
— (String
)The type of the data to be modified.
ToType
— (String
)The data type that the data is to be modified to.
Dropped
— (Boolean
)If true, then the column is removed.
SelectFields
— (map
)Specifies a transform that chooses the data property keys that you want to keep.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
DropFields
— (map
)Specifies a transform that chooses the data property keys that you want to drop.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
RenameField
— (map
)Specifies a transform that renames a single data property key.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
SourcePath
— required — (Array<String>
)A JSON path to a variable in the data structure for the source data.
TargetPath
— required — (Array<String>
)A JSON path to a variable in the data structure for the target data.
Spigot
— (map
)Specifies a transform that writes samples of the data to an Amazon S3 bucket.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Path
— required — (String
)A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
Topk
— (Integer
)Specifies a number of records to write starting from the beginning of the dataset.
Prob
— (Float
)The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
Join
— (map
)Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
JoinType
— required — (String
)Specifies the type of join to be performed on the datasets.
Possible values include:"equijoin"
"left"
"right"
"outer"
"leftsemi"
"leftanti"
Columns
— required — (Array<map>
)A list of the two columns to be joined.
From
— required — (String
)The column to be joined.
Keys
— required — (Array<Array<String>>
)The key of the column to be joined.
SplitFields
— (map
)Specifies a transform that splits data property keys into two
DynamicFrames
. The output is a collection ofDynamicFrames
: one with selected data property keys, and one with the remaining data property keys.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
SelectFromCollection
— (map
)Specifies a transform that chooses one
DynamicFrame
from a collection ofDynamicFrames
. The output is the selectedDynamicFrame
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Index
— required — (Integer
)The index for the DynamicFrame to be selected.
FillMissingValues
— (map
)Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
ImputedPath
— required — (String
)A JSON path to a variable in the data structure for the dataset that is imputed.
FilledPath
— (String
)A JSON path to a variable in the data structure for the dataset that is filled.
Filter
— (map
)Specifies a transform that splits a dataset into two, based on a filter condition.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
LogicalOperator
— required — (String
)The operator used to filter rows by comparing the key value to a specified value.
Possible values include:"AND"
"OR"
Filters
— required — (Array<map>
)Specifies a filter expression.
Operation
— required — (String
)The type of operation to perform in the expression.
Possible values include:"EQ"
"LT"
"GT"
"LTE"
"GTE"
"REGEX"
"ISNULL"
Negated
— (Boolean
)Whether the expression is to be negated.
Values
— required — (Array<map>
)A list of filter values.
Type
— required — (String
)The type of filter value.
Possible values include:"COLUMNEXTRACTED"
"CONSTANT"
Value
— required — (Array<String>
)The value to be associated.
CustomCode
— (map
)Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Code
— required — (String
)The custom code that is used to perform the data transformation.
ClassName
— required — (String
)The name defined for the custom code node class.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom code transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkSQL
— (map
)Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single
DynamicFrame
.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
SqlQuery
— required — (String
)A SQL query that must use Spark SQL syntax and return a single data set.
SqlAliases
— required — (Array<map>
)A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify
From
as MyDataSource, andAlias
as SqlName, then in your SQL you can do:select * from SqlName
and that gets data from MyDataSource.
From
— required — (String
)A table, or a column in a table.
Alias
— required — (String
)A temporary name given to a table, or a column in a table.
OutputSchemas
— (Array<map>
)Specifies the data schema for the SparkSQL transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
DirectKinesisSource
— (map
)Specifies a direct Amazon Kinesis data source.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DirectKafkaSource
— (map
)Specifies an Apache Kafka data store.
Name
— required — (String
)The name of the data store.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKinesisSource
— (map
)Specifies a Kinesis data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKafkaSource
— (map
)Specifies an Apache Kafka data store in the Data Catalog.
Name
— required — (String
)The name of the data store.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DropNullFields
— (map
)Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
NullCheckBoxList
— (map
)A structure that represents whether certain values are recognized as null values for removal.
IsEmpty
— (Boolean
)Specifies that an empty string is considered as a null value.
IsNullString
— (Boolean
)Specifies that a value spelling out the word 'null' is considered as a null value.
IsNegOne
— (Boolean
)Specifies that an integer value of -1 is considered as a null value.
NullTextList
— (Array<map>
)A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The
DropNullFields
transform removes custom null values only if both the value of the null placeholder and the datatype match the data.Value
— required — (String
)The value of the null placeholder.
Datatype
— required — (map
)The datatype of the value.
Id
— required — (String
)The datatype of the value.
Label
— required — (String
)A label assigned to the datatype.
Merge
— (map
)Specifies a transform that merges a
DynamicFrame
with a stagingDynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Source
— required — (String
)The source
DynamicFrame
that will be merged with a stagingDynamicFrame
.PrimaryKeys
— required — (Array<Array<String>>
)The list of primary key fields to match records from the source and staging dynamic frames.
Union
— (map
)Specifies a transform that combines the rows from two or more datasets into a single result.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
UnionType
— required — (String
)Indicates the type of Union transform.
Specify
ALL
to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.Specify
Possible values include:DISTINCT
to remove duplicate rows in the resulting DynamicFrame."ALL"
"DISTINCT"
PIIDetection
— (map
)Specifies a transform that identifies, removes or masks PII data.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
PiiType
— required — (String
)Indicates the type of PIIDetection transform.
Possible values include:"RowAudit"
"RowMasking"
"ColumnAudit"
"ColumnMasking"
EntityTypesToDetect
— required — (Array<String>
)Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
OutputColumnName
— (String
)Indicates the output column name that will contain any entity type detected in that row.
SampleFraction
— (Float
)Indicates the fraction of the data to sample when scanning for PII entities.
ThresholdFraction
— (Float
)Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
MaskValue
— (String
)Indicates the value that will replace the detected entity.
Aggregate
— (map
)Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)Specifies the fields and rows to use as inputs for the aggregate transform.
Groups
— required — (Array<Array<String>>
)Specifies the fields to group by.
Aggs
— required — (Array<map>
)Specifies the aggregate functions to be performed on specified fields.
Column
— required — (Array<String>
)Specifies the column on the data set on which the aggregation function will be applied.
AggFunc
— required — (String
)Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
Possible values include:"avg"
"countDistinct"
"count"
"first"
"last"
"kurtosis"
"max"
"min"
"skewness"
"stddev_samp"
"stddev_pop"
"sum"
"sumDistinct"
"var_samp"
"var_pop"
DropDuplicates
— (map
)Specifies a transform that removes rows of repeating data from a data set.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Columns
— (Array<Array<String>>
)The name of the columns to be merged or removed if repeating.
GovernedCatalogTarget
— (map
)Specifies a data target that writes to a goverened catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the governed catalog.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
GovernedCatalogSource
— (map
)Specifies a data source in a goverened Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
MicrosoftSQLServerCatalogSource
— (map
)Specifies a Microsoft SQL server data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MySQLCatalogSource
— (map
)Specifies a MySQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
OracleSQLCatalogSource
— (map
)Specifies an Oracle data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
PostgreSQLCatalogSource
— (map
)Specifies a PostgresSQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MicrosoftSQLServerCatalogTarget
— (map
)Specifies a target that uses Microsoft SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
MySQLCatalogTarget
— (map
)Specifies a target that uses MySQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
OracleSQLCatalogTarget
— (map
)Specifies a target that uses Oracle SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
PostgreSQLCatalogTarget
— (map
)Specifies a target that uses Postgres SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
DynamicTransform
— (map
)Specifies a custom visual transform created by a user.
Name
— required — (String
)Specifies the name of the dynamic transform.
TransformName
— required — (String
)Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
Inputs
— required — (Array<String>
)Specifies the inputs for the dynamic transform that are required.
Parameters
— (Array<map>
)Specifies the parameters of the dynamic transform.
Name
— required — (String
)Specifies the name of the parameter in the config file of the dynamic transform.
Type
— required — (String
)Specifies the parameter type in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
ValidationRule
— (String
)Specifies the validation rule in the config file of the dynamic transform.
ValidationMessage
— (String
)Specifies the validation message in the config file of the dynamic transform.
Value
— (Array<String>
)Specifies the value of the parameter in the config file of the dynamic transform.
ListType
— (String
)Specifies the list type of the parameter in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
IsOptional
— (Boolean
)Specifies whether the parameter is optional or not in the config file of the dynamic transform.
FunctionName
— required — (String
)Specifies the name of the function of the dynamic transform.
Path
— required — (String
)Specifies the path of the dynamic transform source and config files.
Version
— (String
)This field is not used and will be deprecated in future release.
OutputSchemas
— (Array<map>
)Specifies the data schema for the dynamic transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
EvaluateDataQuality
— (map
)Specifies your data quality evaluation criteria.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
Output
— (String
)The output of your data quality evaluation.
Possible values include:"PrimaryInput"
"EvaluationResults"
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
S3CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiSource
— (map
)Specifies a Hudi data source stored in Amazon S3.
Name
— required — (String
)The name of the Hudi source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiCatalogTarget
— (map
)Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3HudiDirectTarget
— (map
)Specifies a target that writes to a Hudi data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Path
— required — (String
)The Amazon S3 path of your Hudi data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"lzo"
"uncompressed"
"snappy"
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
DirectJDBCSource
— (map
)Specifies the direct JDBC source connection.
Name
— required — (String
)The name of the JDBC source connection.
Database
— required — (String
)The database of the JDBC source connection.
Table
— required — (String
)The table of the JDBC source connection.
ConnectionName
— required — (String
)The connection name of the JDBC source.
ConnectionType
— required — (String
)The connection type of the JDBC source.
Possible values include:"sqlserver"
"mysql"
"oracle"
"postgresql"
"redshift"
RedshiftTmpDir
— (String
)The temp directory of the JDBC Redshift source.
S3CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaSource
— (map
)Specifies a Delta Lake data source stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaCatalogTarget
— (map
)Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3DeltaDirectTarget
— (map
)Specifies a target that writes to a Delta Lake data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)The Amazon S3 path of your Delta Lake data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."uncompressed"
"snappy"
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
AmazonRedshiftSource
— (map
)Specifies a target that writes to a data source in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift source.
Data
— (map
)Specifies the data of the Amazon Reshift source node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AmazonRedshiftTarget
— (map
)Specifies a target that writes to a data target in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift target.
Data
— (map
)Specifies the data of the Amazon Redshift target node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
EvaluateDataQualityMultiFrame
— (map
)Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation. The first input in this list is the primary data source.
AdditionalDataSources
— (map<String>
)The aliases of all data sources except primary.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
AdditionalOptions
— (map<String>
)Options to configure runtime behavior of the transform.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
Recipe
— (map
)Specifies a Glue DataBrew recipe node.
Name
— required — (String
)The name of the Glue Studio node.
Inputs
— required — (Array<String>
)The nodes that are inputs to the recipe node, identified by id.
RecipeReference
— (map
)A reference to the DataBrew recipe used by the node.
RecipeArn
— required — (String
)The ARN of the DataBrew recipe.
RecipeVersion
— required — (String
)The RecipeVersion of the DataBrew recipe.
RecipeSteps
— (Array<map>
)Transform steps used in the recipe node.
Action
— required — (map
)The transformation action of the recipe step.
Operation
— required — (String
)The operation of the recipe action.
Parameters
— (map<String>
)The parameters of the recipe action.
ConditionExpressions
— (Array<map>
)The condition expressions for the recipe step.
Condition
— required — (String
)The condition of the condition expression.
Value
— (String
)The value of the condition expression.
TargetColumn
— required — (String
)The target column of the condition expressions.
SnowflakeSource
— (map
)Specifies a Snowflake data source.
Name
— required — (String
)The name of the Snowflake data source.
Data
— required — (map
)Configuration for the Snowflake data source.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
OutputSchemas
— (Array<map>
)Specifies user-defined schemas for your output data.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SnowflakeTarget
— (map
)Specifies a target that writes to a Snowflake data source.
Name
— required — (String
)The name of the Snowflake target.
Data
— required — (map
)Specifies the data of the Snowflake target node.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ConnectorDataSource
— (map
)Specifies a source generated with standard connection options.
Name
— required — (String
)The name of this source node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
OutputSchemas
— (Array<map>
)Specifies the data schema for this source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
ConnectorDataTarget
— (map
)Specifies a target generated with standard connection options.
Name
— required — (String
)The name of this target node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
SourceControlDetails
— (map
)The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Provider
— (String
)The provider for the remote repository.
Possible values include:"GITHUB"
"GITLAB"
"BITBUCKET"
"AWS_CODE_COMMIT"
Repository
— (String
)The name of the remote repository that contains the job artifacts.
Owner
— (String
)The owner of the remote repository that contains the job artifacts.
Branch
— (String
)An optional branch in the remote repository.
Folder
— (String
)An optional folder in the remote repository.
LastCommitId
— (String
)The last commit ID for a commit in the remote repository.
AuthStrategy
— (String
)The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
Possible values include:"PERSONAL_ACCESS_TOKEN"
"AWS_SECRETS_MANAGER"
AuthToken
— (String
)The value of an authorization token.
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job.
JobsNotFound
— (Array<String>
)A list of names of jobs not found.
-
(AWS.Response)
—
Returns:
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 Amazon Web Services 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. Thedata
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 in which to create the partition.
TableName
— (String
)The name of the database table in which to create the partition.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
Parameters
— (map<String>
)These key-value pairs define partition parameters.
LastAnalyzedTime
— (Date
)The last time at which column statistics were computed for this partition.
CatalogId
— (String
)The ID of the Data Catalog in which the partition resides.
UnprocessedKeys
— (Array<map>
)A list of the partition values in the request for which partitions were not returned.
Values
— required — (Array<String>
)The list of values.
-
(AWS.Response)
—
Returns:
batchGetTableOptimizer(params = {}, callback) ⇒ AWS.Request
Returns the configuration for the specified table optimizers.
Service Reference:
Examples:
Calling the batchGetTableOptimizer operation
var params = { Entries: [ /* required */ { catalogId: 'STRING_VALUE', databaseName: 'STRING_VALUE', tableName: 'STRING_VALUE', type: compaction }, /* more items */ ] }; glue.batchGetTableOptimizer(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: {})
—
Entries
— (Array<map>
)A list of
BatchGetTableOptimizerEntry
objects specifying the table optimizers to retrieve.catalogId
— (String
)The Catalog ID of the table.
databaseName
— (String
)The name of the database in the catalog in which the table resides.
tableName
— (String
)The name of the table.
type
— (String
)The type of table optimizer.
Possible values include:"compaction"
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. Thedata
object has the following properties:TableOptimizers
— (Array<map>
)A list of
BatchTableOptimizer
objects.catalogId
— (String
)The Catalog ID of the table.
databaseName
— (String
)The name of the database in the catalog in which the table resides.
tableName
— (String
)The name of the table.
tableOptimizer
— (map
)A
TableOptimizer
object that contains details on the configuration and last run of a table optimzer.type
— (String
)The type of table optimizer. Currently, the only valid value is
Possible values include:compaction
."compaction"
configuration
— (map
)A
TableOptimizerConfiguration
object that was specified when creating or updating a table optimizer.roleArn
— (String
)A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.
enabled
— (Boolean
)Whether table optimization is enabled.
lastRun
— (map
)A
TableOptimizerRun
object representing the last run of the table optimizer.eventType
— (String
)An event type representing the status of the table optimizer run.
Possible values include:"starting"
"completed"
"failed"
"in_progress"
startTimestamp
— (Date
)Represents the epoch timestamp at which the compaction job was started within Lake Formation.
endTimestamp
— (Date
)Represents the epoch timestamp at which the compaction job ended.
metrics
— (map
)A
RunMetrics
object containing metrics for the optimizer run.NumberOfBytesCompacted
— (String
)The number of bytes removed by the compaction job run.
NumberOfFilesCompacted
— (String
)The number of files removed by the compaction job run.
NumberOfDpus
— (String
)The number of DPU hours consumed by the job.
JobDurationInHour
— (String
)The duration of the job in hours.
error
— (String
)An error that occured during the optimizer run.
Failures
— (Array<map>
)A list of errors from the operation.
error
— (map
)An
ErrorDetail
object containing code and message details about the error.ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
catalogId
— (String
)The Catalog ID of the table.
databaseName
— (String
)The name of the database in the catalog in which the table resides.
tableName
— (String
)The name of the table.
type
— (String
)The type of table optimizer.
Possible values include:"compaction"
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Triggers
— (Array<map>
)A list of trigger definitions.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
TriggersNotFound
— (Array<String>
)A list of names of triggers not found.
-
(AWS.Response)
—
Returns:
batchGetWorkflows(params = {}, callback) ⇒ AWS.Request
Returns a list of resource metadata for a given list of workflow names. After calling the
ListWorkflows
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 batchGetWorkflows operation
var params = { Names: [ /* required */ 'STRING_VALUE', /* more items */ ], IncludeGraph: true || false }; glue.batchGetWorkflows(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: {})
—
Names
— (Array<String>
)A list of workflow names, which may be the names returned from the
ListWorkflows
operation.IncludeGraph
— (Boolean
)Specifies whether to include a graph when returning the workflow resource metadata.
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. Thedata
object has the following properties:Workflows
— (Array<map>
)A list of workflow resource metadata.
Name
— (String
)The name of the workflow.
Description
— (String
)A description of the workflow.
DefaultRunProperties
— (map<String>
)A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
CreatedOn
— (Date
)The date and time when the workflow was created.
LastModifiedOn
— (Date
)The date and time when the workflow was last modified.
LastRun
— (map
)The information about the last execution of the workflow.
Name
— (String
)Name of the workflow that was run.
WorkflowRunId
— (String
)The ID of this workflow run.
PreviousRunId
— (String
)The ID of the previous workflow run.
WorkflowRunProperties
— (map<String>
)The workflow run properties which were set during the run.
StartedOn
— (Date
)The date and time when the workflow run was started.
CompletedOn
— (Date
)The date and time when the workflow run completed.
Status
— (String
)The status of the workflow run.
Possible values include:"RUNNING"
"COMPLETED"
"STOPPING"
"STOPPED"
"ERROR"
ErrorMessage
— (String
)This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow:
foo
."Statistics
— (map
)The statistics of the run.
TotalActions
— (Integer
)Total number of Actions in the workflow run.
TimeoutActions
— (Integer
)Total number of Actions that timed out.
FailedActions
— (Integer
)Total number of Actions that have failed.
StoppedActions
— (Integer
)Total number of Actions that have stopped.
SucceededActions
— (Integer
)Total number of Actions that have succeeded.
RunningActions
— (Integer
)Total number Actions in running state.
ErroredActions
— (Integer
)Indicates the count of job runs in the ERROR state in the workflow run.
WaitingActions
— (Integer
)Indicates the count of job runs in WAITING state in the workflow run.
Graph
— (map
)The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes
— (Array<map>
)A list of the the Glue components belong to the workflow represented as nodes.
Type
— (String
)The type of Glue component represented by the node.
Possible values include:"CRAWLER"
"JOB"
"TRIGGER"
Name
— (String
)The name of the Glue component represented by the node.
UniqueId
— (String
)The unique Id assigned to the node within the workflow.
TriggerDetails
— (map
)Details of the Trigger when the node represents a Trigger.
Trigger
— (map
)The information of the trigger represented by the trigger node.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails
— (map
)Details of the Job when the node represents a Job.
JobRuns
— (Array<map>
)The information for the job runs represented by the job node.
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 theStartJobRun
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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
StartedOn
— (Date
)The date and time at which this job run was started.
LastModifiedOn
— (Date
)The last time that this job run was modified.
CompletedOn
— (Date
)The date and time that this job run completed.
JobRunState
— (String
)The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs 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 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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 Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption isNONE
. If you add a role name andSecurityConfiguration
name (in other words,/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds
— (Float
)This field can be set for either job runs with execution class
FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X
, 2 forG.2X
, or 0.25 forG.025X
workers). This value may be different than theexecutionEngineRuntime
*MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than theMaxCapacity
. Therefore, it is possible that the value ofDPUSeconds
is less thanexecutionEngineRuntime
*MaxCapacity
.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job run.
StateDetail
— (String
)This field holds details that pertain to the state of a job run. The field is nullable.
For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.
CrawlerDetails
— (map
)Details of the crawler when the node represents a crawler.
Crawls
— (Array<map>
)A list of crawls represented by the crawl node.
State
— (String
)The state of the crawler.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
StartedOn
— (Date
)The date and time on which the crawl started.
CompletedOn
— (Date
)The date and time on which the crawl completed.
ErrorMessage
— (String
)The error message associated with the crawl.
LogGroup
— (String
)The log group associated with the crawl.
LogStream
— (String
)The log stream associated with the crawl.
Edges
— (Array<map>
)A list of all the directed connections between the nodes belonging to the workflow.
SourceId
— (String
)The unique of the node within the workflow where the edge starts.
DestinationId
— (String
)The unique of the node within the workflow where the edge ends.
StartingEventBatchCondition
— (map
)The batch condition that started the workflow run.
BatchSize
— (Integer
)Number of events in the batch.
BatchWindow
— (Integer
)Duration of the batch window in seconds.
Graph
— (map
)The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes
— (Array<map>
)A list of the the Glue components belong to the workflow represented as nodes.
Type
— (String
)The type of Glue component represented by the node.
Possible values include:"CRAWLER"
"JOB"
"TRIGGER"
Name
— (String
)The name of the Glue component represented by the node.
UniqueId
— (String
)The unique Id assigned to the node within the workflow.
TriggerDetails
— (map
)Details of the Trigger when the node represents a Trigger.
Trigger
— (map
)The information of the trigger represented by the trigger node.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails
— (map
)Details of the Job when the node represents a Job.
JobRuns
— (Array<map>
)The information for the job runs represented by the job node.
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 theStartJobRun
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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
StartedOn
— (Date
)The date and time at which this job run was started.
LastModifiedOn
— (Date
)The last time that this job run was modified.
CompletedOn
— (Date
)The date and time that this job run completed.
JobRunState
— (String
)The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs 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 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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 Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption isNONE
. If you add a role name andSecurityConfiguration
name (in other words,/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds
— (Float
)This field can be set for either job runs with execution class
FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X
, 2 forG.2X
, or 0.25 forG.025X
workers). This value may be different than theexecutionEngineRuntime
*MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than theMaxCapacity
. Therefore, it is possible that the value ofDPUSeconds
is less thanexecutionEngineRuntime
*MaxCapacity
.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job run.
StateDetail
— (String
)This field holds details that pertain to the state of a job run. The field is nullable.
For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.
CrawlerDetails
— (map
)Details of the crawler when the node represents a crawler.
Crawls
— (Array<map>
)A list of crawls represented by the crawl node.
State
— (String
)The state of the crawler.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
StartedOn
— (Date
)The date and time on which the crawl started.
CompletedOn
— (Date
)The date and time on which the crawl completed.
ErrorMessage
— (String
)The error message associated with the crawl.
LogGroup
— (String
)The log group associated with the crawl.
LogStream
— (String
)The log stream associated with the crawl.
Edges
— (Array<map>
)A list of all the directed connections between the nodes belonging to the workflow.
SourceId
— (String
)The unique of the node within the workflow where the edge starts.
DestinationId
— (String
)The unique of the node within the workflow where the edge ends.
MaxConcurrentRuns
— (Integer
)You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
BlueprintDetails
— (map
)This structure indicates the details of the blueprint that this particular workflow is created from.
BlueprintName
— (String
)The name of the blueprint.
RunId
— (String
)The run ID for this blueprint.
MissingWorkflows
— (Array<String>
)A list of names of workflows not found.
-
(AWS.Response)
—
Returns:
batchPutDataQualityStatisticAnnotation(params = {}, callback) ⇒ AWS.Request
Annotate datapoints over time for a specific data quality statistic.
Service Reference:
Examples:
Calling the batchPutDataQualityStatisticAnnotation operation
var params = { InclusionAnnotations: [ /* required */ { InclusionAnnotation: INCLUDE | EXCLUDE, ProfileId: 'STRING_VALUE', StatisticId: 'STRING_VALUE' }, /* more items */ ], ClientToken: 'STRING_VALUE' }; glue.batchPutDataQualityStatisticAnnotation(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: {})
—
InclusionAnnotations
— (Array<map>
)A list of
DatapointInclusionAnnotation
's.ProfileId
— (String
)The ID of the data quality profile the statistic belongs to.
StatisticId
— (String
)The Statistic ID.
InclusionAnnotation
— (String
)The inclusion annotation value to apply to the statistic.
Possible values include:"INCLUDE"
"EXCLUDE"
ClientToken
— (String
)Client 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. Thedata
object has the following properties:FailedInclusionAnnotations
— (Array<map>
)A list of
AnnotationError
's.ProfileId
— (String
)The Profile ID for the failed annotation.
StatisticId
— (String
)The Statistic ID for the failed annotation.
FailureReason
— (String
)The reason why the annotation failed.
-
(AWS.Response)
—
Returns:
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. Thedata
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 trying to stop
JobRuns
, including theJobRunId
for which each error was encountered and details about the error.JobName
— (String
)The name of the job definition that is 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.
-
(AWS.Response)
—
Returns:
batchUpdatePartition(params = {}, callback) ⇒ AWS.Request
Updates one or more partitions in a batch operation.
Service Reference:
Examples:
Calling the batchUpdatePartition operation
var params = { DatabaseName: 'STRING_VALUE', /* required */ Entries: [ /* 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: { AdditionalLocations: [ 'STRING_VALUE', /* more items */ ], BucketColumns: [ 'STRING_VALUE', /* more items */ ], Columns: [ { Name: 'STRING_VALUE', /* required */ Comment: 'STRING_VALUE', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, 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>': ... */ }, SchemaReference: { SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: 'NUMBER_VALUE' }, 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 */ ] }, /* more items */ ], TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.batchUpdatePartition(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 partition is to be updated. Currently, this should be the Amazon Web Services account ID.
DatabaseName
— (String
)The name of the metadata database in which the partition is to be updated.
TableName
— (String
)The name of the metadata table in which the partition is to be updated.
Entries
— (Array<map>
)A list of up to 100
BatchUpdatePartitionRequestEntry
objects to update.PartitionValueList
— required — (Array<String>
)A list of values defining the partitions.
PartitionInput
— required — (map
)The structure used to update a 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.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
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. Thedata
object has the following properties:Errors
— (Array<map>
)The errors encountered when trying to update the requested partitions. A list of
BatchUpdatePartitionFailureEntry
objects.PartitionValueList
— (Array<String>
)A list of values defining the partitions.
ErrorDetail
— (map
)The details about the batch update partition error.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
cancelDataQualityRuleRecommendationRun(params = {}, callback) ⇒ AWS.Request
Cancels the specified recommendation run that was being used to generate rules.
Service Reference:
Examples:
Calling the cancelDataQualityRuleRecommendationRun operation
var params = { RunId: 'STRING_VALUE' /* required */ }; glue.cancelDataQualityRuleRecommendationRun(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: {})
—
RunId
— (String
)The unique run identifier associated with this run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
cancelDataQualityRulesetEvaluationRun(params = {}, callback) ⇒ AWS.Request
Cancels a run where a ruleset is being evaluated against a data source.
Service Reference:
Examples:
Calling the cancelDataQualityRulesetEvaluationRun operation
var params = { RunId: 'STRING_VALUE' /* required */ }; glue.cancelDataQualityRulesetEvaluationRun(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: {})
—
RunId
— (String
)The unique run identifier associated with this run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
cancelMLTaskRun(params = {}, callback) ⇒ AWS.Request
Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling
CancelMLTaskRun
with a task run's parent transform'sTransformID
and the task run'sTaskRunId
.Service Reference:
Examples:
Calling the cancelMLTaskRun operation
var params = { TaskRunId: 'STRING_VALUE', /* required */ TransformId: 'STRING_VALUE' /* required */ }; glue.cancelMLTaskRun(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: {})
—
TransformId
— (String
)The unique identifier of the machine learning transform.
TaskRunId
— (String
)A unique identifier for the task run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:TransformId
— (String
)The unique identifier of the machine learning transform.
TaskRunId
— (String
)The unique identifier for the task run.
Status
— (String
)The status for this run.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
-
(AWS.Response)
—
Returns:
cancelStatement(params = {}, callback) ⇒ AWS.Request
Cancels the statement.
Service Reference:
Examples:
Calling the cancelStatement operation
var params = { Id: 'NUMBER_VALUE', /* required */ SessionId: 'STRING_VALUE', /* required */ RequestOrigin: 'STRING_VALUE' }; glue.cancelStatement(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: {})
—
SessionId
— (String
)The Session ID of the statement to be cancelled.
Id
— (Integer
)The ID of the statement to be cancelled.
RequestOrigin
— (String
)The origin of the request to cancel the statement.
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.
-
(AWS.Response)
—
Returns:
checkSchemaVersionValidity(params = {}, callback) ⇒ AWS.Request
Validates the supplied schema. This call has no side effects, it simply validates using the supplied schema using
DataFormat
as the format. Since it does not take a schema set name, no compatibility checks are performed.Service Reference:
Examples:
Calling the checkSchemaVersionValidity operation
var params = { DataFormat: AVRO | JSON | PROTOBUF, /* required */ SchemaDefinition: 'STRING_VALUE' /* required */ }; glue.checkSchemaVersionValidity(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: {})
—
DataFormat
— (String
)The data format of the schema definition. Currently
Possible values include:AVRO
,JSON
andPROTOBUF
are supported."AVRO"
"JSON"
"PROTOBUF"
SchemaDefinition
— (String
)The definition of the schema that has to be validated.
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. Thedata
object has the following properties:Valid
— (Boolean
)Return true, if the schema is valid and false otherwise.
Error
— (String
)A validation failure error message.
-
(AWS.Response)
—
Returns:
createBlueprint(params = {}, callback) ⇒ AWS.Request
Registers a blueprint with Glue.
Service Reference:
Examples:
Calling the createBlueprint operation
var params = { BlueprintLocation: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Description: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.createBlueprint(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 blueprint.
Description
— (String
)A description of the blueprint.
BlueprintLocation
— (String
)Specifies a path in Amazon S3 where the blueprint is published.
Tags
— (map<String>
)The tags to be applied to this blueprint.
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. Thedata
object has the following properties:Name
— (String
)Returns the name of the blueprint that was registered.
-
(AWS.Response)
—
Returns:
createClassifier(params = {}, callback) ⇒ AWS.Request
Creates a classifier in the user's account. This can be a
GrokClassifier
, anXMLClassifier
, aJsonClassifier
, or aCsvClassifier
, 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, CustomDatatypeConfigured: true || false, CustomDatatypes: [ 'STRING_VALUE', /* more items */ ], Delimiter: 'STRING_VALUE', DisableValueTrimming: true || false, Header: [ 'STRING_VALUE', /* more items */ ], QuoteSymbol: 'STRING_VALUE', Serde: OpenCSVSerDe | LazySimpleSerDe | None }, 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. This can't 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. 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.
CustomDatatypeConfigured
— (Boolean
)Enables the configuration of custom datatypes.
CustomDatatypes
— (Array<String>
)Creates a list of supported custom datatypes.
Serde
— (String
)Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are
Possible values include:OpenCSVSerDe
,LazySimpleSerDe
, andNone
. You can specify theNone
value when you want the crawler to do the detection."OpenCSVSerDe"
"LazySimpleSerDe"
"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.
-
(AWS.Response)
—
Returns:
createConnection(params = {}, callback) ⇒ AWS.Request
Creates a connection definition in the Data Catalog.
Connections used for creating federated resources require the IAM
glue:PassConnection
permission.Service Reference:
Examples:
Calling the createConnection operation
var params = { ConnectionInput: { /* required */ ConnectionProperties: { /* required */ '<ConnectionPropertyKey>': 'STRING_VALUE', /* '<ConnectionPropertyKey>': ... */ }, ConnectionType: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA, /* required */ Name: 'STRING_VALUE', /* required */ AuthenticationConfiguration: { AuthenticationType: BASIC | OAUTH2 | CUSTOM, OAuth2Properties: { AuthorizationCodeProperties: { AuthorizationCode: 'STRING_VALUE', RedirectUri: 'STRING_VALUE' }, OAuth2ClientApplication: { AWSManagedClientApplicationReference: 'STRING_VALUE', UserManagedClientApplicationClientId: 'STRING_VALUE' }, OAuth2GrantType: AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER, TokenUrl: 'STRING_VALUE', TokenUrlParametersMap: { '<TokenUrlParameterKey>': 'STRING_VALUE', /* '<TokenUrlParameterKey>': ... */ } }, SecretArn: 'STRING_VALUE' }, Description: 'STRING_VALUE', MatchCriteria: [ 'STRING_VALUE', /* more items */ ], PhysicalConnectionRequirements: { AvailabilityZone: 'STRING_VALUE', SecurityGroupIdList: [ 'STRING_VALUE', /* more items */ ], SubnetId: 'STRING_VALUE' }, ValidateCredentials: true || false }, CatalogId: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; 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 Amazon Web Services 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, these types are supported:
-
JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).JDBC
Connections use the following ConnectionParameters.-
Required: All of (
HOST
,PORT
,JDBC_ENGINE
) orJDBC_CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
. -
Optional:
JDBC_ENFORCE_SSL
,CUSTOM_JDBC_CERT
,CUSTOM_JDBC_CERT_STRING
,SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
-
-
KAFKA
- Designates a connection to an Apache Kafka streaming platform.KAFKA
Connections use the following ConnectionParameters.-
Required:
KAFKA_BOOTSTRAP_SERVERS
. -
Optional:
KAFKA_SSL_ENABLED
,KAFKA_CUSTOM_CERT
,KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL withKAFKA
. -
Optional:
KAFKA_CLIENT_KEYSTORE
,KAFKA_CLIENT_KEYSTORE_PASSWORD
,KAFKA_CLIENT_KEY_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL inKAFKA
. -
Optional:
KAFKA_SASL_MECHANISM
. Can be specified asSCRAM-SHA-512
,GSSAPI
, orAWS_MSK_IAM
. -
Optional:
KAFKA_SASL_SCRAM_USERNAME
,KAFKA_SASL_SCRAM_PASSWORD
,ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication withKAFKA
. -
Optional:
KAFKA_SASL_GSSAPI_KEYTAB
,KAFKA_SASL_GSSAPI_KRB5_CONF
,KAFKA_SASL_GSSAPI_SERVICE
,KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication withKAFKA
.
-
-
MONGODB
- Designates a connection to a MongoDB document database.MONGODB
Connections use the following ConnectionParameters.-
Required:
CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
SALESFORCE
- Designates a connection to Salesforce using OAuth authencation.-
Requires the
AuthenticationConfiguration
member to be configured.
-
-
VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift. -
VIEW_VALIDATION_ATHENA
- Designates a connection used for view validation by Amazon Athena. -
NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. -
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.MARKETPLACE
Connections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE
,CONNECTOR_URL
,CONNECTOR_CLASS_NAME
,CONNECTION_URL
. -
Required for
JDBC
CONNECTOR_TYPE
connections: All of (USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
SFTP
is not supported.For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
Possible values include:"JDBC"
"SFTP"
"MONGODB"
"KAFKA"
"NETWORK"
"MARKETPLACE"
"CUSTOM"
"SALESFORCE"
"VIEW_VALIDATION_REDSHIFT"
"VIEW_VALIDATION_ATHENA"
-
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
)The 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.
AuthenticationConfiguration
— (map
)The authentication properties of the connection. Used for a Salesforce connection.
AuthenticationType
— (String
)A structure containing the authentication configuration in the CreateConnection request.
Possible values include:"BASIC"
"OAUTH2"
"CUSTOM"
SecretArn
— (String
)The secret manager ARN to store credentials in the CreateConnection request.
OAuth2Properties
— (map
)The properties for OAuth2 authentication in the CreateConnection request.
OAuth2GrantType
— (String
)The OAuth2 grant type in the CreateConnection request. For example,
Possible values include:AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
."AUTHORIZATION_CODE"
"CLIENT_CREDENTIALS"
"JWT_BEARER"
OAuth2ClientApplication
— (map
)The client application type in the CreateConnection request. For example,
AWS_MANAGED
orUSER_MANAGED
.UserManagedClientApplicationClientId
— (String
)The client application clientID if the ClientAppType is
USER_MANAGED
.AWSManagedClientApplicationReference
— (String
)The reference to the SaaS-side client app that is Amazon Web Services managed.
TokenUrl
— (String
)The URL of the provider's authentication server, to exchange an authorization code for an access token.
TokenUrlParametersMap
— (map<String>
)A map of parameters that are added to the token
GET
request.AuthorizationCodeProperties
— (map
)The set of properties required for the the OAuth2
AUTHORIZATION_CODE
grant type.AuthorizationCode
— (String
)An authorization code to be used in the third leg of the
AUTHORIZATION_CODE
grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.RedirectUri
— (String
)The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.
ValidateCredentials
— (Boolean
)A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.
Tags
— (map<String>
)The tags you assign to the connection.
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. Thedata
object has the following properties:CreateConnectionStatus
— (String
)The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.
Possible values include:"READY"
"IN_PROGRESS"
"FAILED"
-
(AWS.Response)
—
Returns:
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, thejdbcTargets
field, or theDynamoDBTargets
field.Service Reference:
Examples:
Calling the createCrawler operation
var params = { Name: 'STRING_VALUE', /* required */ Role: 'STRING_VALUE', /* required */ Targets: { /* required */ CatalogTargets: [ { DatabaseName: 'STRING_VALUE', /* required */ Tables: [ /* required */ 'STRING_VALUE', /* more items */ ], ConnectionName: 'STRING_VALUE', DlqEventQueueArn: 'STRING_VALUE', EventQueueArn: 'STRING_VALUE' }, /* more items */ ], DeltaTargets: [ { ConnectionName: 'STRING_VALUE', CreateNativeDeltaTable: true || false, DeltaTables: [ 'STRING_VALUE', /* more items */ ], WriteManifest: true || false }, /* more items */ ], DynamoDBTargets: [ { Path: 'STRING_VALUE', scanAll: true || false, scanRate: 'NUMBER_VALUE' }, /* more items */ ], HudiTargets: [ { ConnectionName: 'STRING_VALUE', Exclusions: [ 'STRING_VALUE', /* more items */ ], MaximumTraversalDepth: 'NUMBER_VALUE', Paths: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], IcebergTargets: [ { ConnectionName: 'STRING_VALUE', Exclusions: [ 'STRING_VALUE', /* more items */ ], MaximumTraversalDepth: 'NUMBER_VALUE', Paths: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], JdbcTargets: [ { ConnectionName: 'STRING_VALUE', EnableAdditionalMetadata: [ COMMENTS | RAWTYPES, /* more items */ ], Exclusions: [ 'STRING_VALUE', /* more items */ ], Path: 'STRING_VALUE' }, /* more items */ ], MongoDBTargets: [ { ConnectionName: 'STRING_VALUE', Path: 'STRING_VALUE', ScanAll: true || false }, /* more items */ ], S3Targets: [ { ConnectionName: 'STRING_VALUE', DlqEventQueueArn: 'STRING_VALUE', EventQueueArn: 'STRING_VALUE', Exclusions: [ 'STRING_VALUE', /* more items */ ], Path: 'STRING_VALUE', SampleSize: 'NUMBER_VALUE' }, /* more items */ ] }, Classifiers: [ 'STRING_VALUE', /* more items */ ], Configuration: 'STRING_VALUE', CrawlerSecurityConfiguration: 'STRING_VALUE', DatabaseName: 'STRING_VALUE', Description: 'STRING_VALUE', LakeFormationConfiguration: { AccountId: 'STRING_VALUE', UseLakeFormationCredentials: true || false }, LineageConfiguration: { CrawlerLineageSettings: ENABLE | DISABLE }, RecrawlPolicy: { RecrawlBehavior: CRAWL_EVERYTHING | CRAWL_NEW_FOLDERS_ONLY | CRAWL_EVENT_MODE }, 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 Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
DatabaseName
— (String
)The 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 Simple Storage Service (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.
ConnectionName
— (String
)The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize
— (Integer
)Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
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.
EnableAdditionalMetadata
— (Array<String>
)Specify a value of
RAWTYPES
orCOMMENTS
to enable additional metadata in table responses.RAWTYPES
provides the native-level datatype.COMMENTS
provides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
MongoDBTargets
— (Array<map>
)Specifies Amazon DocumentDB or MongoDB targets.
ConnectionName
— (String
)The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path
— (String
)The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.
DynamoDBTargets
— (Array<map>
)Specifies Amazon DynamoDB targets.
Path
— (String
)The name of the DynamoDB table to crawl.
scanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.scanRate
— (Float
)The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets
— (Array<map>
)Specifies Glue Data Catalog targets.
DatabaseName
— required — (String
)The name of the database to be synchronized.
Tables
— required — (Array<String>
)A list of the tables to be synchronized.
ConnectionName
— (String
)The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a
Catalog
connection type paired with aNETWORK
Connection type.EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
DeltaTargets
— (Array<map>
)Specifies Delta data store targets.
DeltaTables
— (Array<String>
)A list of the Amazon S3 paths to the Delta tables.
ConnectionName
— (String
)The name of the connection to use to connect to the Delta table target.
WriteManifest
— (Boolean
)Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable
— (Boolean
)Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets
— (Array<map>
)Specifies Apache Iceberg data store targets.
Paths
— (Array<String>
)One or more Amazon S3 paths that contains Iceberg metadata folders as
s3://bucket/prefix
.ConnectionName
— (String
)The name of the connection to use to connect to the Iceberg target.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets
— (Array<map>
)Specifies Apache Hudi data store targets.
Paths
— (Array<String>
)An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
ConnectionName
— (String
)The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
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
)The 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"
RecrawlPolicy
— (map
)A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior
— (String
)Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of
CRAWL_EVERYTHING
specifies crawling the entire dataset again.A value of
CRAWL_NEW_FOLDERS_ONLY
specifies crawling only folders that were added since the last crawler run.A value of
Possible values include:CRAWL_EVENT_MODE
specifies crawling only the changes identified by Amazon S3 events."CRAWL_EVERYTHING"
"CRAWL_NEW_FOLDERS_ONLY"
"CRAWL_EVENT_MODE"
LineageConfiguration
— (map
)Specifies data lineage configuration settings for the crawler.
CrawlerLineageSettings
— (String
)Specifies whether data lineage is enabled for the crawler. Valid values are:
-
ENABLE: enables data lineage for the crawler
-
DISABLE: disables data lineage for the crawler
"ENABLE"
"DISABLE"
-
LakeFormationConfiguration
— (map
)Specifies Lake Formation configuration settings for the crawler.
UseLakeFormationCredentials
— (Boolean
)Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId
— (String
)Required for cross account crawls. For same account crawls as the target data, this can be left as null.
Configuration
— (String
)Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
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 Glue, see Amazon Web Services Tags in 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.
-
(AWS.Response)
—
Returns:
createCustomEntityType(params = {}, callback) ⇒ AWS.Request
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.
Service Reference:
Examples:
Calling the createCustomEntityType operation
var params = { Name: 'STRING_VALUE', /* required */ RegexString: 'STRING_VALUE', /* required */ ContextWords: [ 'STRING_VALUE', /* more items */ ], Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.createCustomEntityType(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
)A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
RegexString
— (String
)A regular expression string that is used for detecting sensitive data in a custom pattern.
ContextWords
— (Array<String>
)A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
Tags
— (map<String>
)A list of tags applied to the custom entity type.
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. Thedata
object has the following properties:Name
— (String
)The name of the custom pattern you created.
-
(AWS.Response)
—
Returns:
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 */ CreateTableDefaultPermissions: [ { Permissions: [ ALL | SELECT | ALTER | DROP | DELETE | INSERT | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS, /* more items */ ], Principal: { DataLakePrincipalIdentifier: 'STRING_VALUE' } }, /* more items */ ], Description: 'STRING_VALUE', FederatedDatabase: { ConnectionName: 'STRING_VALUE', Identifier: 'STRING_VALUE' }, LocationUri: 'STRING_VALUE', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, TargetDatabase: { CatalogId: 'STRING_VALUE', DatabaseName: 'STRING_VALUE', Region: 'STRING_VALUE' } }, CatalogId: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; 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 provided, the Amazon Web Services account ID is used by default.
DatabaseInput
— (map
)The metadata for the database.
Name
— required — (String
)The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description
— (String
)A 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.
These key-value pairs define parameters and properties of the database.
CreateTableDefaultPermissions
— (Array<map>
)Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
Principal
— (map
)The principal who is granted permissions.
DataLakePrincipalIdentifier
— (String
)An identifier for the Lake Formation principal.
Permissions
— (Array<String>
)The permissions that are granted to the principal.
TargetDatabase
— (map
)A
DatabaseIdentifier
structure that describes a target database for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the database resides.
DatabaseName
— (String
)The name of the catalog database.
Region
— (String
)Region of the target database.
FederatedDatabase
— (map
)A
FederatedDatabase
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
Tags
— (map<String>
)The tags you assign to 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.
-
(AWS.Response)
—
Returns:
createDataQualityRuleset(params = {}, callback) ⇒ AWS.Request
Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
You create the ruleset using the Data Quality Definition Language (DQDL). For more information, see the Glue developer guide.
Service Reference:
Examples:
Calling the createDataQualityRuleset operation
var params = { Name: 'STRING_VALUE', /* required */ Ruleset: 'STRING_VALUE', /* required */ ClientToken: 'STRING_VALUE', DataQualitySecurityConfiguration: 'STRING_VALUE', Description: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ }, TargetTable: { DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' } }; glue.createDataQualityRuleset(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
)A unique name for the data quality ruleset.
Description
— (String
)A description of the data quality ruleset.
Ruleset
— (String
)A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
Tags
— (map<String>
)A list of tags applied to the data quality ruleset.
TargetTable
— (map
)A target table associated with the data quality ruleset.
TableName
— required — (String
)The name of the Glue table.
DatabaseName
— required — (String
)The name of the database where the Glue table exists.
CatalogId
— (String
)The catalog id where the Glue table exists.
DataQualitySecurityConfiguration
— (String
)The name of the security configuration created with the data quality encryption option.
ClientToken
— (String
)Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same 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. Thedata
object has the following properties:Name
— (String
)A unique name for the data quality ruleset.
-
(AWS.Response)
—
Returns:
createDevEndpoint(params = {}, callback) ⇒ AWS.Request
Creates a new development endpoint.
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', GlueVersion: 'STRING_VALUE', NumberOfNodes: 'NUMBER_VALUE', NumberOfWorkers: '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>': ... */ }, WorkerType: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2X }; 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 because the recommended attribute to use is public keys.PublicKeys
— (Array<String>
)A list of public keys to be used by the development endpoints 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 theUpdateDevEndpoint
API with the public key content in thedeletePublicKeys
attribute, and the list of new keys in theaddPublicKeys
attribute.NumberOfNodes
— (Integer
)The number of Glue Data Processing Units (DPUs) to allocate to this
DevEndpoint
.WorkerType
— (String
)The type of predefined worker that is allocated to the development endpoint. 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
Possible values include:G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk."Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
GlueVersion
— (String
)Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated to the development endpoint.The maximum number of workers you can define are 299 for
G.1X
, and 149 forG.2X
.ExtraPythonLibsS3Path
— (String
)The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
DevEndpoint
. Multiple values must be complete paths separated by a comma.Note: You can only use pure Python libraries with aDevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.ExtraJarsS3Path
— (String
)The path to one or more Java
.jar
files in an S3 bucket that should be loaded in yourDevEndpoint
.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with thisDevEndpoint
.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 Glue, see Amazon Web Services Tags in 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. Thedata
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 Amazon Resource Name (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 Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
WorkerType
— (String
)The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.
Possible values include:"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
GlueVersion
— (String
)Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated to the development endpoint.AvailabilityZone
— (String
)The Amazon Web Services Availability Zone where this
DevEndpoint
is located.VpcId
— (String
)The ID of the virtual private cloud (VPC) used by this
DevEndpoint
.ExtraPythonLibsS3Path
— (String
)The paths 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
.jar
files in an S3 bucket that will be loaded in yourDevEndpoint
.FailureReason
— (String
)The reason for a current failure in this
DevEndpoint
.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure being used with thisDevEndpoint
.CreatedTimestamp
— (Date
)The point in time at which this
DevEndpoint
was created.Arguments
— (map<String>
)The map of arguments used to configure this
DevEndpoint
.Valid arguments are:
-
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.-
-
(AWS.Response)
—
Returns:
createJob(params = {}, callback) ⇒ AWS.Request
Creates a new job definition.
Service Reference:
Examples:
Calling the createJob operation
var params = { Command: { /* required */ Name: 'STRING_VALUE', PythonVersion: 'STRING_VALUE', Runtime: 'STRING_VALUE', ScriptLocation: 'STRING_VALUE' }, Name: 'STRING_VALUE', /* required */ Role: 'STRING_VALUE', /* required */ AllocatedCapacity: 'NUMBER_VALUE', CodeGenConfigurationNodes: { '<NodeId>': { Aggregate: { Aggs: [ /* required */ { AggFunc: avg | countDistinct | count | first | last | kurtosis | max | min | skewness | stddev_samp | stddev_pop | sum | sumDistinct | var_samp | var_pop, /* required */ Column: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], Groups: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE' /* required */ }, AmazonRedshiftSource: { Data: { AccessType: 'STRING_VALUE', Action: 'STRING_VALUE', AdvancedOptions: [ { Key: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], CatalogDatabase: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, CatalogRedshiftSchema: 'STRING_VALUE', CatalogRedshiftTable: 'STRING_VALUE', CatalogTable: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, Connection: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, CrawlerConnection: 'STRING_VALUE', IamRole: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, MergeAction: 'STRING_VALUE', MergeClause: 'STRING_VALUE', MergeWhenMatched: 'STRING_VALUE', MergeWhenNotMatched: 'STRING_VALUE', PostAction: 'STRING_VALUE', PreAction: 'STRING_VALUE', SampleQuery: 'STRING_VALUE', Schema: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, SelectedColumns: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], SourceType: 'STRING_VALUE', StagingTable: 'STRING_VALUE', Table: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, TablePrefix: 'STRING_VALUE', TableSchema: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], TempDir: 'STRING_VALUE', Upsert: true || false }, Name: 'STRING_VALUE' }, AmazonRedshiftTarget: { Data: { AccessType: 'STRING_VALUE', Action: 'STRING_VALUE', AdvancedOptions: [ { Key: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], CatalogDatabase: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, CatalogRedshiftSchema: 'STRING_VALUE', CatalogRedshiftTable: 'STRING_VALUE', CatalogTable: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, Connection: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, CrawlerConnection: 'STRING_VALUE', IamRole: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, MergeAction: 'STRING_VALUE', MergeClause: 'STRING_VALUE', MergeWhenMatched: 'STRING_VALUE', MergeWhenNotMatched: 'STRING_VALUE', PostAction: 'STRING_VALUE', PreAction: 'STRING_VALUE', SampleQuery: 'STRING_VALUE', Schema: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, SelectedColumns: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], SourceType: 'STRING_VALUE', StagingTable: 'STRING_VALUE', Table: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, TablePrefix: 'STRING_VALUE', TableSchema: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], TempDir: 'STRING_VALUE', Upsert: true || false }, Inputs: [ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE' }, ApplyMapping: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Mapping: [ /* Mappings */ /* required */ { Children: /* recursive Mappings */, Dropped: true || false, FromPath: [ 'STRING_VALUE', /* more items */ ], FromType: 'STRING_VALUE', ToKey: 'STRING_VALUE', ToType: 'STRING_VALUE' }, /* more items */ ], Name: 'STRING_VALUE' /* required */ }, AthenaConnectorSource: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ SchemaName: 'STRING_VALUE', /* required */ ConnectionTable: 'STRING_VALUE', OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, CatalogDeltaSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalDeltaOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, CatalogHudiSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalHudiOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, CatalogKafkaSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ DataPreviewOptions: { PollingTime: 'NUMBER_VALUE', RecordPollingLimit: 'NUMBER_VALUE' }, DetectSchema: true || false, StreamingOptions: { AddRecordTimestamp: 'STRING_VALUE', Assign: 'STRING_VALUE', BootstrapServers: 'STRING_VALUE', Classification: 'STRING_VALUE', ConnectionName: 'STRING_VALUE', Delimiter: 'STRING_VALUE', EmitConsumerLagMetrics: 'STRING_VALUE', EndingOffsets: 'STRING_VALUE', IncludeHeaders: true || false, MaxOffsetsPerTrigger: 'NUMBER_VALUE', MinPartitions: 'NUMBER_VALUE', NumRetries: 'NUMBER_VALUE', PollTimeoutMs: 'NUMBER_VALUE', RetryIntervalMs: 'NUMBER_VALUE', SecurityProtocol: 'STRING_VALUE', StartingOffsets: 'STRING_VALUE', StartingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, SubscribePattern: 'STRING_VALUE', TopicName: 'STRING_VALUE' }, WindowSize: 'NUMBER_VALUE' }, CatalogKinesisSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ DataPreviewOptions: { PollingTime: 'NUMBER_VALUE', RecordPollingLimit: 'NUMBER_VALUE' }, DetectSchema: true || false, StreamingOptions: { AddIdleTimeBetweenReads: true || false, AddRecordTimestamp: 'STRING_VALUE', AvoidEmptyBatches: true || false, Classification: 'STRING_VALUE', Delimiter: 'STRING_VALUE', DescribeShardInterval: 'NUMBER_VALUE', EmitConsumerLagMetrics: 'STRING_VALUE', EndpointUrl: 'STRING_VALUE', IdleTimeBetweenReadsInMs: 'NUMBER_VALUE', MaxFetchRecordsPerShard: 'NUMBER_VALUE', MaxFetchTimeInMs: 'NUMBER_VALUE', MaxRecordPerRead: 'NUMBER_VALUE', MaxRetryIntervalMs: 'NUMBER_VALUE', NumRetries: 'NUMBER_VALUE', RetryIntervalMs: 'NUMBER_VALUE', RoleArn: 'STRING_VALUE', RoleSessionName: 'STRING_VALUE', StartingPosition: latest | trim_horizon | earliest | timestamp, StartingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, StreamArn: 'STRING_VALUE', StreamName: 'STRING_VALUE' }, WindowSize: 'NUMBER_VALUE' }, CatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, CatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, ConnectorDataSource: { ConnectionType: 'STRING_VALUE', /* required */ Data: { /* required */ '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, Name: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, ConnectorDataTarget: { ConnectionType: 'STRING_VALUE', /* required */ Data: { /* required */ '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, Name: 'STRING_VALUE', /* required */ Inputs: [ 'STRING_VALUE', /* more items */ ] }, CustomCode: { ClassName: 'STRING_VALUE', /* required */ Code: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, DirectJDBCSource: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: sqlserver | mysql | oracle | postgresql | redshift, /* required */ Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ RedshiftTmpDir: 'STRING_VALUE' }, DirectKafkaSource: { Name: 'STRING_VALUE', /* required */ DataPreviewOptions: { PollingTime: 'NUMBER_VALUE', RecordPollingLimit: 'NUMBER_VALUE' }, DetectSchema: true || false, StreamingOptions: { AddRecordTimestamp: 'STRING_VALUE', Assign: 'STRING_VALUE', BootstrapServers: 'STRING_VALUE', Classification: 'STRING_VALUE', ConnectionName: 'STRING_VALUE', Delimiter: 'STRING_VALUE', EmitConsumerLagMetrics: 'STRING_VALUE', EndingOffsets: 'STRING_VALUE', IncludeHeaders: true || false, MaxOffsetsPerTrigger: 'NUMBER_VALUE', MinPartitions: 'NUMBER_VALUE', NumRetries: 'NUMBER_VALUE', PollTimeoutMs: 'NUMBER_VALUE', RetryIntervalMs: 'NUMBER_VALUE', SecurityProtocol: 'STRING_VALUE', StartingOffsets: 'STRING_VALUE', StartingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, SubscribePattern: 'STRING_VALUE', TopicName: 'STRING_VALUE' }, WindowSize: 'NUMBER_VALUE' }, DirectKinesisSource: { Name: 'STRING_VALUE', /* required */ DataPreviewOptions: { PollingTime: 'NUMBER_VALUE', RecordPollingLimit: 'NUMBER_VALUE' }, DetectSchema: true || false, StreamingOptions: { AddIdleTimeBetweenReads: true || false, AddRecordTimestamp: 'STRING_VALUE', AvoidEmptyBatches: true || false, Classification: 'STRING_VALUE', Delimiter: 'STRING_VALUE', DescribeShardInterval: 'NUMBER_VALUE', EmitConsumerLagMetrics: 'STRING_VALUE', EndpointUrl: 'STRING_VALUE', IdleTimeBetweenReadsInMs: 'NUMBER_VALUE', MaxFetchRecordsPerShard: 'NUMBER_VALUE', MaxFetchTimeInMs: 'NUMBER_VALUE', MaxRecordPerRead: 'NUMBER_VALUE', MaxRetryIntervalMs: 'NUMBER_VALUE', NumRetries: 'NUMBER_VALUE', RetryIntervalMs: 'NUMBER_VALUE', RoleArn: 'STRING_VALUE', RoleSessionName: 'STRING_VALUE', StartingPosition: latest | trim_horizon | earliest | timestamp, StartingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, StreamArn: 'STRING_VALUE', StreamName: 'STRING_VALUE' }, WindowSize: 'NUMBER_VALUE' }, DropDuplicates: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Columns: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, DropFields: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, DropNullFields: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ NullCheckBoxList: { IsEmpty: true || false, IsNegOne: true || false, IsNullString: true || false }, NullTextList: [ { Datatype: { /* required */ Id: 'STRING_VALUE', /* required */ Label: 'STRING_VALUE' /* required */ }, Value: 'STRING_VALUE' /* required */ }, /* more items */ ] }, DynamicTransform: { FunctionName: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ TransformName: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Parameters: [ { Name: 'STRING_VALUE', /* required */ Type: str | int | float | complex | bool | list | null, /* required */ IsOptional: true || false, ListType: str | int | float | complex | bool | list | null, ValidationMessage: 'STRING_VALUE', ValidationRule: 'STRING_VALUE', Value: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], Version: 'STRING_VALUE' }, DynamoDBCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, EvaluateDataQuality: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Ruleset: 'STRING_VALUE', /* required */ Output: PrimaryInput | EvaluationResults, PublishingOptions: { CloudWatchMetricsEnabled: true || false, EvaluationContext: 'STRING_VALUE', ResultsPublishingEnabled: true || false, ResultsS3Prefix: 'STRING_VALUE' }, StopJobOnFailureOptions: { StopJobOnFailureTiming: Immediate | AfterDataLoad } }, EvaluateDataQualityMultiFrame: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Ruleset: 'STRING_VALUE', /* required */ AdditionalDataSources: { '<NodeName>': 'STRING_VALUE', /* '<NodeName>': ... */ }, AdditionalOptions: { '<AdditionalOptionKeys>': 'STRING_VALUE', /* '<AdditionalOptionKeys>': ... */ }, PublishingOptions: { CloudWatchMetricsEnabled: true || false, EvaluationContext: 'STRING_VALUE', ResultsPublishingEnabled: true || false, ResultsS3Prefix: 'STRING_VALUE' }, StopJobOnFailureOptions: { StopJobOnFailureTiming: Immediate | AfterDataLoad } }, FillMissingValues: { ImputedPath: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ FilledPath: 'STRING_VALUE' }, Filter: { Filters: [ /* required */ { Operation: EQ | LT | GT | LTE | GTE | REGEX | ISNULL, /* required */ Values: [ /* required */ { Type: COLUMNEXTRACTED | CONSTANT, /* required */ Value: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], Negated: true || false }, /* more items */ ], Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], LogicalOperator: AND | OR, /* required */ Name: 'STRING_VALUE' /* required */ }, GovernedCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE' }, PartitionPredicate: 'STRING_VALUE' }, GovernedCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { EnableUpdateCatalog: true || false, UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, JDBCConnectorSource: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ AdditionalOptions: { DataTypeMapping: { '<JDBCDataType>': DATE | STRING | TIMESTAMP | INT | FLOAT | LONG | BIGDECIMAL | BYTE | SHORT | DOUBLE, /* '<JDBCDataType>': ... */ }, FilterPredicate: 'STRING_VALUE', JobBookmarkKeys: [ 'STRING_VALUE', /* more items */ ], JobBookmarkKeysSortOrder: 'STRING_VALUE', LowerBound: 'NUMBER_VALUE', NumPartitions: 'NUMBER_VALUE', PartitionColumn: 'STRING_VALUE', UpperBound: 'NUMBER_VALUE' }, ConnectionTable: 'STRING_VALUE', OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Query: 'STRING_VALUE' }, JDBCConnectorTarget: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionTable: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, Join: { Columns: [ /* required */ { From: 'STRING_VALUE', /* required */ Keys: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, /* more items */ ], Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], JoinType: equijoin | left | right | outer | leftsemi | leftanti, /* required */ Name: 'STRING_VALUE' /* required */ }, Merge: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ PrimaryKeys: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], Source: 'STRING_VALUE' /* required */ }, MicrosoftSQLServerCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, MicrosoftSQLServerCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, MySQLCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, MySQLCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, OracleSQLCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, OracleSQLCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, PIIDetection: { EntityTypesToDetect: [ /* required */ 'STRING_VALUE', /* more items */ ], Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ PiiType: RowAudit | RowMasking | ColumnAudit | ColumnMasking, /* required */ MaskValue: 'STRING_VALUE', OutputColumnName: 'STRING_VALUE', SampleFraction: 'NUMBER_VALUE', ThresholdFraction: 'NUMBER_VALUE' }, PostgreSQLCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, PostgreSQLCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, Recipe: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ RecipeReference: { RecipeArn: 'STRING_VALUE', /* required */ RecipeVersion: 'STRING_VALUE' /* required */ }, RecipeSteps: [ { Action: { /* required */ Operation: 'STRING_VALUE', /* required */ Parameters: { '<ParameterName>': 'STRING_VALUE', /* '<ParameterName>': ... */ } }, ConditionExpressions: [ { Condition: 'STRING_VALUE', /* required */ TargetColumn: 'STRING_VALUE', /* required */ Value: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, RedshiftSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ RedshiftTmpDir: 'STRING_VALUE', TmpDirIAMRole: 'STRING_VALUE' }, RedshiftTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ RedshiftTmpDir: 'STRING_VALUE', TmpDirIAMRole: 'STRING_VALUE', UpsertRedshiftOptions: { ConnectionName: 'STRING_VALUE', TableLocation: 'STRING_VALUE', UpsertKeys: [ 'STRING_VALUE', /* more items */ ] } }, RelationalCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, RenameField: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ SourcePath: [ /* required */ 'STRING_VALUE', /* more items */ ], TargetPath: [ /* required */ 'STRING_VALUE', /* more items */ ] }, S3CatalogDeltaSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalDeltaOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, S3CatalogHudiSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalHudiOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, S3CatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE' }, PartitionPredicate: 'STRING_VALUE' }, S3CatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { EnableUpdateCatalog: true || false, UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3CsvSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], QuoteChar: quote | quillemet | single_quote | disabled, /* required */ Separator: comma | ctrla | pipe | semicolon | tab, /* required */ AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, CompressionType: gzip | bzip2, Escaper: 'STRING_VALUE', Exclusions: [ 'STRING_VALUE', /* more items */ ], GroupFiles: 'STRING_VALUE', GroupSize: 'STRING_VALUE', MaxBand: 'NUMBER_VALUE', MaxFilesInBand: 'NUMBER_VALUE', Multiline: true || false, OptimizePerformance: true || false, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Recurse: true || false, SkipFirst: true || false, WithHeader: true || false, WriteHeader: true || false }, S3DeltaCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { EnableUpdateCatalog: true || false, UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3DeltaDirectTarget: { Compression: uncompressed | snappy, /* required */ Format: json | csv | avro | orc | parquet | hudi | delta, /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { Database: 'STRING_VALUE', EnableUpdateCatalog: true || false, Table: 'STRING_VALUE', UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3DeltaSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalDeltaOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, S3DirectTarget: { Format: json | csv | avro | orc | parquet | hudi | delta, /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ Compression: 'STRING_VALUE', PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { Database: 'STRING_VALUE', EnableUpdateCatalog: true || false, Table: 'STRING_VALUE', UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3GlueParquetTarget: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ Compression: snappy | lzo | gzip | uncompressed | none, PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { Database: 'STRING_VALUE', EnableUpdateCatalog: true || false, Table: 'STRING_VALUE', UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3HudiCatalogTarget: { AdditionalOptions: { /* required */ '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { EnableUpdateCatalog: true || false, UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3HudiDirectTarget: { AdditionalOptions: { /* required */ '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, Compression: gzip | lzo | uncompressed | snappy, /* required */ Format: json | csv | avro | orc | parquet | hudi | delta, /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { Database: 'STRING_VALUE', EnableUpdateCatalog: true || false, Table: 'STRING_VALUE', UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3HudiSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalHudiOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, S3JsonSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, CompressionType: gzip | bzip2, Exclusions: [ 'STRING_VALUE', /* more items */ ], GroupFiles: 'STRING_VALUE', GroupSize: 'STRING_VALUE', JsonPath: 'STRING_VALUE', MaxBand: 'NUMBER_VALUE', MaxFilesInBand: 'NUMBER_VALUE', Multiline: true || false, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Recurse: true || false }, S3ParquetSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, CompressionType: snappy | lzo | gzip | uncompressed | none, Exclusions: [ 'STRING_VALUE', /* more items */ ], GroupFiles: 'STRING_VALUE', GroupSize: 'STRING_VALUE', MaxBand: 'NUMBER_VALUE', MaxFilesInBand: 'NUMBER_VALUE', OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Recurse: true || false }, SelectFields: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, SelectFromCollection: { Index: 'NUMBER_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE' /* required */ }, SnowflakeSource: { Data: { /* required */ Action: 'STRING_VALUE', AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, AutoPushdown: true || false, Connection: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, Database: 'STRING_VALUE', IamRole: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, MergeAction: 'STRING_VALUE', MergeClause: 'STRING_VALUE', MergeWhenMatched: 'STRING_VALUE', MergeWhenNotMatched: 'STRING_VALUE', PostAction: 'STRING_VALUE', PreAction: 'STRING_VALUE', SampleQuery: 'STRING_VALUE', Schema: 'STRING_VALUE', SelectedColumns: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], SourceType: 'STRING_VALUE', StagingTable: 'STRING_VALUE', Table: 'STRING_VALUE', TableSchema: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], TempDir: 'STRING_VALUE', Upsert: true || false }, Name: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, SnowflakeTarget: { Data: { /* required */ Action: 'STRING_VALUE', AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, AutoPushdown: true || false, Connection: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, Database: 'STRING_VALUE', IamRole: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, MergeAction: 'STRING_VALUE', MergeClause: 'STRING_VALUE', MergeWhenMatched: 'STRING_VALUE', MergeWhenNotMatched: 'STRING_VALUE', PostAction: 'STRING_VALUE', PreAction: 'STRING_VALUE', SampleQuery: 'STRING_VALUE', Schema: 'STRING_VALUE', SelectedColumns: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], SourceType: 'STRING_VALUE', StagingTable: 'STRING_VALUE', Table: 'STRING_VALUE', TableSchema: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], TempDir: 'STRING_VALUE', Upsert: true || false }, Name: 'STRING_VALUE', /* required */ Inputs: [ 'STRING_VALUE', /* more items */ ] }, SparkConnectorSource: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, SparkConnectorTarget: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, SparkSQL: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ SqlAliases: [ /* required */ { Alias: 'STRING_VALUE', /* required */ From: 'STRING_VALUE' /* required */ }, /* more items */ ], SqlQuery: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, Spigot: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ Prob: 'NUMBER_VALUE', Topk: 'NUMBER_VALUE' }, SplitFields: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, Union: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ UnionType: ALL | DISTINCT /* required */ } }, /* '<NodeId>': ... */ }, Connections: { Connections: [ 'STRING_VALUE', /* more items */ ] }, DefaultArguments: { '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, Description: 'STRING_VALUE', ExecutionClass: FLEX | STANDARD, ExecutionProperty: { MaxConcurrentRuns: 'NUMBER_VALUE' }, GlueVersion: 'STRING_VALUE', JobMode: SCRIPT | VISUAL | NOTEBOOK, JobRunQueuingEnabled: true || false, LogUri: 'STRING_VALUE', MaintenanceWindow: 'STRING_VALUE', MaxCapacity: 'NUMBER_VALUE', MaxRetries: 'NUMBER_VALUE', NonOverridableArguments: { '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, NotificationProperty: { NotifyDelayAfter: 'NUMBER_VALUE' }, NumberOfWorkers: 'NUMBER_VALUE', SecurityConfiguration: 'STRING_VALUE', SourceControlDetails: { AuthStrategy: PERSONAL_ACCESS_TOKEN | AWS_SECRETS_MANAGER, AuthToken: 'STRING_VALUE', Branch: 'STRING_VALUE', Folder: 'STRING_VALUE', LastCommitId: 'STRING_VALUE', Owner: 'STRING_VALUE', Provider: GITHUB | GITLAB | BITBUCKET | AWS_CODE_COMMIT, Repository: 'STRING_VALUE' }, Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ }, Timeout: 'NUMBER_VALUE', WorkerType: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Description
— (String
)Description of the job being defined.
LogUri
— (String
)This field is reserved for future use.
Role
— (String
)The name or Amazon Resource Name (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 runs this job.Name
— (String
)The name of the job command. For an Apache Spark ETL job, this must be
glueetl
. For a Python shell job, it must bepythonshell
. For an Apache Spark streaming ETL job, this must begluestreaming
. For a Ray job, this must beglueray
.ScriptLocation
— (String
)Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
PythonVersion
— (String
)The Python version being used to run a Python shell job. Allowed values are 2 or 3.
Runtime
— (String
)In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
DefaultArguments
— (map<String>
)The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
NonOverridableArguments
— (map<String>
)Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
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 Glue data processing units (DPUs) to allocate to this Job. You can allocate a minimum of 2 DPUs; 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 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) for batch jobs.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
-
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 Glue, see Amazon Web Services Tags in Glue in the developer guide.
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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.WorkerType
— (String
)The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
CodeGenConfigurationNodes
— (map<map>
)The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
AthenaConnectorSource
— (map
)Specifies a connector to an Amazon Athena data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
ConnectionTable
— (String
)The name of the table in the data source.
SchemaName
— required — (String
)The name of the Cloudwatch log group to read from. For example,
/aws-glue/jobs/output
.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom Athena source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
JDBCConnectorSource
— (map
)Specifies a connector to a JDBC data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
AdditionalOptions
— (map
)Additional connection options for the connector.
FilterPredicate
— (String
)Extra condition clause to filter data from source. For example:
BillingCity='Mountain View'
When using a query instead of a table name, you should validate that the query works with the specified
filterPredicate
.PartitionColumn
— (String
)The name of an integer column that is used for partitioning. This option works only when it's included with
lowerBound
,upperBound
, andnumPartitions
. This option works the same way as in the Spark SQL JDBC reader.LowerBound
— (Integer
)The minimum value of
partitionColumn
that is used to decide partition stride.UpperBound
— (Integer
)The maximum value of
partitionColumn
that is used to decide partition stride.NumPartitions
— (Integer
)The number of partitions. This value, along with
lowerBound
(inclusive) andupperBound
(exclusive), form partition strides for generatedWHERE
clause expressions that are used to split thepartitionColumn
.JobBookmarkKeys
— (Array<String>
)The name of the job bookmark keys on which to sort.
JobBookmarkKeysSortOrder
— (String
)Specifies an ascending or descending sort order.
DataTypeMapping
— (map<String>
)Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option
"dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC typeFLOAT
into the JavaString
type by calling theResultSet.getString()
method of the driver, and uses it to build the Glue record. TheResultSet
object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
ConnectionTable
— (String
)The name of the table in the data source.
Query
— (String
)The table or SQL query to get the data from. You can specify either
ConnectionTable
orquery
, but not both.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom JDBC source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorSource
— (map
)Specifies a connector to an Apache Spark data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies data schema for the custom spark source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogSource
— (map
)Specifies a data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
RedshiftSource
— (map
)Specifies an Amazon Redshift data store.
Name
— required — (String
)The name of the Amazon Redshift data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
S3CatalogSource
— (map
)Specifies an Amazon S3 data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
S3CsvSource
— (map
)Specifies a command-separated value (CSV) data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
Separator
— required — (String
)Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
Possible values include:"comma"
"ctrla"
"pipe"
"semicolon"
"tab"
Escaper
— (String
)Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is
none
. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n
,\r
,\t
, and\0
).QuoteChar
— required — (String
)Specifies the character to use for quoting. The default is a double quote:
Possible values include:'"'
. Set this to-1
to turn off quoting entirely."quote"
"quillemet"
"single_quote"
"disabled"
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.WithHeader
— (Boolean
)A Boolean value that specifies whether to treat the first line as a header. The default value is
False
.WriteHeader
— (Boolean
)A Boolean value that specifies whether to write the header to output. The default value is
True
.SkipFirst
— (Boolean
)A Boolean value that specifies whether to skip the first data line. The default value is
False
.OptimizePerformance
— (Boolean
)A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 CSV source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3JsonSource
— (map
)Specifies a JSON data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
JsonPath
— (String
)A JsonPath string defining the JSON data.
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 JSON source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3ParquetSource
— (map
)Specifies an Apache Parquet data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 Parquet source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
RelationalCatalogSource
— (map
)Specifies a relational catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
DynamoDBCatalogSource
— (map
)Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
JDBCConnectorTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectionTable
— required — (String
)The name of the table in the data target.
ConnectorName
— required — (String
)The name of a connector that will be used.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the JDBC target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorTarget
— (map
)Specifies a target that uses an Apache Spark connector.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of a connection for an Apache Spark connector.
ConnectorName
— required — (String
)The name of an Apache Spark connector.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom spark target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogTarget
— (map
)Specifies a target that uses a Glue Data Catalog table.
Name
— required — (String
)The name of your data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)The partition keys used to distribute data across multiple partitions or shards based on a specific key or set of key.
Database
— required — (String
)The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
Table
— required — (String
)The table that defines the schema of your output data. This table must already exist in the Data Catalog.
RedshiftTarget
— (map
)Specifies a target that uses Amazon Redshift.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
UpsertRedshiftOptions
— (map
)The set of options to configure an upsert operation when writing to a Redshift target.
TableLocation
— (String
)The physical location of the Redshift table.
ConnectionName
— (String
)The name of the connection to use to write to Redshift.
UpsertKeys
— (Array<String>
)The keys used to determine whether to perform an update or insert.
S3CatalogTarget
— (map
)Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3GlueParquetTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
S3DirectTarget
— (map
)Specifies a data target that writes to Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
"gzip"
and"bzip"
).Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
ApplyMapping
— (map
)Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Mapping
— required — (Array<map>
)Specifies the mapping of data property keys in the data source to data property keys in the data target.
ToKey
— (String
)After the apply mapping, what the name of the column should be. Can be the same as
FromPath
.FromPath
— (Array<String>
)The table or column to be modified.
FromType
— (String
)The type of the data to be modified.
ToType
— (String
)The data type that the data is to be modified to.
Dropped
— (Boolean
)If true, then the column is removed.
SelectFields
— (map
)Specifies a transform that chooses the data property keys that you want to keep.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
DropFields
— (map
)Specifies a transform that chooses the data property keys that you want to drop.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
RenameField
— (map
)Specifies a transform that renames a single data property key.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
SourcePath
— required — (Array<String>
)A JSON path to a variable in the data structure for the source data.
TargetPath
— required — (Array<String>
)A JSON path to a variable in the data structure for the target data.
Spigot
— (map
)Specifies a transform that writes samples of the data to an Amazon S3 bucket.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Path
— required — (String
)A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
Topk
— (Integer
)Specifies a number of records to write starting from the beginning of the dataset.
Prob
— (Float
)The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
Join
— (map
)Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
JoinType
— required — (String
)Specifies the type of join to be performed on the datasets.
Possible values include:"equijoin"
"left"
"right"
"outer"
"leftsemi"
"leftanti"
Columns
— required — (Array<map>
)A list of the two columns to be joined.
From
— required — (String
)The column to be joined.
Keys
— required — (Array<Array<String>>
)The key of the column to be joined.
SplitFields
— (map
)Specifies a transform that splits data property keys into two
DynamicFrames
. The output is a collection ofDynamicFrames
: one with selected data property keys, and one with the remaining data property keys.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
SelectFromCollection
— (map
)Specifies a transform that chooses one
DynamicFrame
from a collection ofDynamicFrames
. The output is the selectedDynamicFrame
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Index
— required — (Integer
)The index for the DynamicFrame to be selected.
FillMissingValues
— (map
)Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
ImputedPath
— required — (String
)A JSON path to a variable in the data structure for the dataset that is imputed.
FilledPath
— (String
)A JSON path to a variable in the data structure for the dataset that is filled.
Filter
— (map
)Specifies a transform that splits a dataset into two, based on a filter condition.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
LogicalOperator
— required — (String
)The operator used to filter rows by comparing the key value to a specified value.
Possible values include:"AND"
"OR"
Filters
— required — (Array<map>
)Specifies a filter expression.
Operation
— required — (String
)The type of operation to perform in the expression.
Possible values include:"EQ"
"LT"
"GT"
"LTE"
"GTE"
"REGEX"
"ISNULL"
Negated
— (Boolean
)Whether the expression is to be negated.
Values
— required — (Array<map>
)A list of filter values.
Type
— required — (String
)The type of filter value.
Possible values include:"COLUMNEXTRACTED"
"CONSTANT"
Value
— required — (Array<String>
)The value to be associated.
CustomCode
— (map
)Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Code
— required — (String
)The custom code that is used to perform the data transformation.
ClassName
— required — (String
)The name defined for the custom code node class.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom code transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkSQL
— (map
)Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single
DynamicFrame
.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
SqlQuery
— required — (String
)A SQL query that must use Spark SQL syntax and return a single data set.
SqlAliases
— required — (Array<map>
)A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify
From
as MyDataSource, andAlias
as SqlName, then in your SQL you can do:select * from SqlName
and that gets data from MyDataSource.
From
— required — (String
)A table, or a column in a table.
Alias
— required — (String
)A temporary name given to a table, or a column in a table.
OutputSchemas
— (Array<map>
)Specifies the data schema for the SparkSQL transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
DirectKinesisSource
— (map
)Specifies a direct Amazon Kinesis data source.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DirectKafkaSource
— (map
)Specifies an Apache Kafka data store.
Name
— required — (String
)The name of the data store.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKinesisSource
— (map
)Specifies a Kinesis data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKafkaSource
— (map
)Specifies an Apache Kafka data store in the Data Catalog.
Name
— required — (String
)The name of the data store.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DropNullFields
— (map
)Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
NullCheckBoxList
— (map
)A structure that represents whether certain values are recognized as null values for removal.
IsEmpty
— (Boolean
)Specifies that an empty string is considered as a null value.
IsNullString
— (Boolean
)Specifies that a value spelling out the word 'null' is considered as a null value.
IsNegOne
— (Boolean
)Specifies that an integer value of -1 is considered as a null value.
NullTextList
— (Array<map>
)A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The
DropNullFields
transform removes custom null values only if both the value of the null placeholder and the datatype match the data.Value
— required — (String
)The value of the null placeholder.
Datatype
— required — (map
)The datatype of the value.
Id
— required — (String
)The datatype of the value.
Label
— required — (String
)A label assigned to the datatype.
Merge
— (map
)Specifies a transform that merges a
DynamicFrame
with a stagingDynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Source
— required — (String
)The source
DynamicFrame
that will be merged with a stagingDynamicFrame
.PrimaryKeys
— required — (Array<Array<String>>
)The list of primary key fields to match records from the source and staging dynamic frames.
Union
— (map
)Specifies a transform that combines the rows from two or more datasets into a single result.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
UnionType
— required — (String
)Indicates the type of Union transform.
Specify
ALL
to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.Specify
Possible values include:DISTINCT
to remove duplicate rows in the resulting DynamicFrame."ALL"
"DISTINCT"
PIIDetection
— (map
)Specifies a transform that identifies, removes or masks PII data.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
PiiType
— required — (String
)Indicates the type of PIIDetection transform.
Possible values include:"RowAudit"
"RowMasking"
"ColumnAudit"
"ColumnMasking"
EntityTypesToDetect
— required — (Array<String>
)Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
OutputColumnName
— (String
)Indicates the output column name that will contain any entity type detected in that row.
SampleFraction
— (Float
)Indicates the fraction of the data to sample when scanning for PII entities.
ThresholdFraction
— (Float
)Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
MaskValue
— (String
)Indicates the value that will replace the detected entity.
Aggregate
— (map
)Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)Specifies the fields and rows to use as inputs for the aggregate transform.
Groups
— required — (Array<Array<String>>
)Specifies the fields to group by.
Aggs
— required — (Array<map>
)Specifies the aggregate functions to be performed on specified fields.
Column
— required — (Array<String>
)Specifies the column on the data set on which the aggregation function will be applied.
AggFunc
— required — (String
)Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
Possible values include:"avg"
"countDistinct"
"count"
"first"
"last"
"kurtosis"
"max"
"min"
"skewness"
"stddev_samp"
"stddev_pop"
"sum"
"sumDistinct"
"var_samp"
"var_pop"
DropDuplicates
— (map
)Specifies a transform that removes rows of repeating data from a data set.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Columns
— (Array<Array<String>>
)The name of the columns to be merged or removed if repeating.
GovernedCatalogTarget
— (map
)Specifies a data target that writes to a goverened catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the governed catalog.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
GovernedCatalogSource
— (map
)Specifies a data source in a goverened Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
MicrosoftSQLServerCatalogSource
— (map
)Specifies a Microsoft SQL server data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MySQLCatalogSource
— (map
)Specifies a MySQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
OracleSQLCatalogSource
— (map
)Specifies an Oracle data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
PostgreSQLCatalogSource
— (map
)Specifies a PostgresSQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MicrosoftSQLServerCatalogTarget
— (map
)Specifies a target that uses Microsoft SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
MySQLCatalogTarget
— (map
)Specifies a target that uses MySQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
OracleSQLCatalogTarget
— (map
)Specifies a target that uses Oracle SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
PostgreSQLCatalogTarget
— (map
)Specifies a target that uses Postgres SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
DynamicTransform
— (map
)Specifies a custom visual transform created by a user.
Name
— required — (String
)Specifies the name of the dynamic transform.
TransformName
— required — (String
)Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
Inputs
— required — (Array<String>
)Specifies the inputs for the dynamic transform that are required.
Parameters
— (Array<map>
)Specifies the parameters of the dynamic transform.
Name
— required — (String
)Specifies the name of the parameter in the config file of the dynamic transform.
Type
— required — (String
)Specifies the parameter type in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
ValidationRule
— (String
)Specifies the validation rule in the config file of the dynamic transform.
ValidationMessage
— (String
)Specifies the validation message in the config file of the dynamic transform.
Value
— (Array<String>
)Specifies the value of the parameter in the config file of the dynamic transform.
ListType
— (String
)Specifies the list type of the parameter in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
IsOptional
— (Boolean
)Specifies whether the parameter is optional or not in the config file of the dynamic transform.
FunctionName
— required — (String
)Specifies the name of the function of the dynamic transform.
Path
— required — (String
)Specifies the path of the dynamic transform source and config files.
Version
— (String
)This field is not used and will be deprecated in future release.
OutputSchemas
— (Array<map>
)Specifies the data schema for the dynamic transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
EvaluateDataQuality
— (map
)Specifies your data quality evaluation criteria.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
Output
— (String
)The output of your data quality evaluation.
Possible values include:"PrimaryInput"
"EvaluationResults"
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
S3CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiSource
— (map
)Specifies a Hudi data source stored in Amazon S3.
Name
— required — (String
)The name of the Hudi source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiCatalogTarget
— (map
)Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3HudiDirectTarget
— (map
)Specifies a target that writes to a Hudi data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Path
— required — (String
)The Amazon S3 path of your Hudi data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"lzo"
"uncompressed"
"snappy"
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
DirectJDBCSource
— (map
)Specifies the direct JDBC source connection.
Name
— required — (String
)The name of the JDBC source connection.
Database
— required — (String
)The database of the JDBC source connection.
Table
— required — (String
)The table of the JDBC source connection.
ConnectionName
— required — (String
)The connection name of the JDBC source.
ConnectionType
— required — (String
)The connection type of the JDBC source.
Possible values include:"sqlserver"
"mysql"
"oracle"
"postgresql"
"redshift"
RedshiftTmpDir
— (String
)The temp directory of the JDBC Redshift source.
S3CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaSource
— (map
)Specifies a Delta Lake data source stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaCatalogTarget
— (map
)Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3DeltaDirectTarget
— (map
)Specifies a target that writes to a Delta Lake data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)The Amazon S3 path of your Delta Lake data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."uncompressed"
"snappy"
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
AmazonRedshiftSource
— (map
)Specifies a target that writes to a data source in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift source.
Data
— (map
)Specifies the data of the Amazon Reshift source node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AmazonRedshiftTarget
— (map
)Specifies a target that writes to a data target in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift target.
Data
— (map
)Specifies the data of the Amazon Redshift target node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
EvaluateDataQualityMultiFrame
— (map
)Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation. The first input in this list is the primary data source.
AdditionalDataSources
— (map<String>
)The aliases of all data sources except primary.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
AdditionalOptions
— (map<String>
)Options to configure runtime behavior of the transform.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
Recipe
— (map
)Specifies a Glue DataBrew recipe node.
Name
— required — (String
)The name of the Glue Studio node.
Inputs
— required — (Array<String>
)The nodes that are inputs to the recipe node, identified by id.
RecipeReference
— (map
)A reference to the DataBrew recipe used by the node.
RecipeArn
— required — (String
)The ARN of the DataBrew recipe.
RecipeVersion
— required — (String
)The RecipeVersion of the DataBrew recipe.
RecipeSteps
— (Array<map>
)Transform steps used in the recipe node.
Action
— required — (map
)The transformation action of the recipe step.
Operation
— required — (String
)The operation of the recipe action.
Parameters
— (map<String>
)The parameters of the recipe action.
ConditionExpressions
— (Array<map>
)The condition expressions for the recipe step.
Condition
— required — (String
)The condition of the condition expression.
Value
— (String
)The value of the condition expression.
TargetColumn
— required — (String
)The target column of the condition expressions.
SnowflakeSource
— (map
)Specifies a Snowflake data source.
Name
— required — (String
)The name of the Snowflake data source.
Data
— required — (map
)Configuration for the Snowflake data source.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
OutputSchemas
— (Array<map>
)Specifies user-defined schemas for your output data.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SnowflakeTarget
— (map
)Specifies a target that writes to a Snowflake data source.
Name
— required — (String
)The name of the Snowflake target.
Data
— required — (map
)Specifies the data of the Snowflake target node.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ConnectorDataSource
— (map
)Specifies a source generated with standard connection options.
Name
— required — (String
)The name of this source node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
OutputSchemas
— (Array<map>
)Specifies the data schema for this source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
ConnectorDataTarget
— (map
)Specifies a target generated with standard connection options.
Name
— required — (String
)The name of this target node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
SourceControlDetails
— (map
)The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Provider
— (String
)The provider for the remote repository.
Possible values include:"GITHUB"
"GITLAB"
"BITBUCKET"
"AWS_CODE_COMMIT"
Repository
— (String
)The name of the remote repository that contains the job artifacts.
Owner
— (String
)The owner of the remote repository that contains the job artifacts.
Branch
— (String
)An optional branch in the remote repository.
Folder
— (String
)An optional folder in the remote repository.
LastCommitId
— (String
)The last commit ID for a commit in the remote repository.
AuthStrategy
— (String
)The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
Possible values include:"PERSONAL_ACCESS_TOKEN"
"AWS_SECRETS_MANAGER"
AuthToken
— (String
)The value of an authorization token.
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
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. Thedata
object has the following properties:Name
— (String
)The unique name that was provided for this job definition.
-
(AWS.Response)
—
Returns:
createMLTransform(params = {}, callback) ⇒ AWS.Request
Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.
Call this operation as the first step in the process of using a machine learning transform (such as the
FindMatches
transform) for deduplicating data. You can provide an optionalDescription
, in addition to the parameters that you want to use for your algorithm.You must also specify certain parameters for the tasks that Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include
Role
, and optionally,AllocatedCapacity
,Timeout
, andMaxRetries
. For more information, see Jobs.Service Reference:
Examples:
Calling the createMLTransform operation
var params = { InputRecordTables: [ /* required */ { DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ AdditionalOptions: { '<NameString>': 'STRING_VALUE', /* '<NameString>': ... */ }, CatalogId: 'STRING_VALUE', ConnectionName: 'STRING_VALUE' }, /* more items */ ], Name: 'STRING_VALUE', /* required */ Parameters: { /* required */ TransformType: FIND_MATCHES, /* required */ FindMatchesParameters: { AccuracyCostTradeoff: 'NUMBER_VALUE', EnforceProvidedLabels: true || false, PrecisionRecallTradeoff: 'NUMBER_VALUE', PrimaryKeyColumnName: 'STRING_VALUE' } }, Role: 'STRING_VALUE', /* required */ Description: 'STRING_VALUE', GlueVersion: 'STRING_VALUE', MaxCapacity: 'NUMBER_VALUE', MaxRetries: 'NUMBER_VALUE', NumberOfWorkers: 'NUMBER_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ }, Timeout: 'NUMBER_VALUE', TransformEncryption: { MlUserDataEncryption: { MlUserDataEncryptionMode: DISABLED | SSE-KMS, /* required */ KmsKeyId: 'STRING_VALUE' }, TaskRunSecurityConfigurationName: 'STRING_VALUE' }, WorkerType: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2X }; glue.createMLTransform(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 unique name that you give the transform when you create it.
Description
— (String
)A description of the machine learning transform that is being defined. The default is an empty string.
InputRecordTables
— (Array<map>
)A list of Glue table definitions used by the transform.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
Parameters
— (map
)The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
TransformType
— required — (String
)The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
Possible values include:"FIND_MATCHES"
FindMatchesParameters
— (map
)The parameters for the find matches algorithm.
PrimaryKeyColumnName
— (String
)The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
PrecisionRecallTradeoff
— (Float
)The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
AccuracyCostTradeoff
— (Float
)The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate
FindMatches
transform, sometimes with unacceptable accuracy.Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
EnforceProvidedLabels
— (Boolean
)The value to switch on or off to force the output to match the provided labels from users. If the value is
True
, thefind matches
transform forces the output to match the provided labels. The results override the normal conflation results. If the value isFalse
, thefind matches
transform does not ensure all the labels provided are respected, and the results rely on the trained model.Note that setting this value to true may increase the conflation execution time.
Role
— (String
)The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
-
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
-
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
-
GlueVersion
— (String
)This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
MaxCapacity
— (Float
)The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; 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 Glue pricing page.
MaxCapacity
is a mutually exclusive option withNumberOfWorkers
andWorkerType
.-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.-
WorkerType
— (String
)The type of predefined worker that is allocated when this task 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.
MaxCapacity
is a mutually exclusive option withNumberOfWorkers
andWorkerType
.-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when this task runs.If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa).Timeout
— (Integer
)The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).MaxRetries
— (Integer
)The maximum number of times to retry a task for this transform after a task run fails.
Tags
— (map<String>
)The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
TransformEncryption
— (map
)The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
MlUserDataEncryption
— (map
)An
MLUserDataEncryption
object containing the encryption mode and customer-provided KMS key ID.MlUserDataEncryptionMode
— required — (String
)The encryption mode applied to user data. Valid values are:
-
DISABLED: encryption is disabled
-
SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
"DISABLED"
"SSE-KMS"
-
KmsKeyId
— (String
)The ID for the customer-provided KMS key.
TaskRunSecurityConfigurationName
— (String
)The name of the security configuration.
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. Thedata
object has the following properties:TransformId
— (String
)A unique identifier that is generated for the transform.
-
(AWS.Response)
—
Returns:
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: { AdditionalLocations: [ 'STRING_VALUE', /* more items */ ], BucketColumns: [ 'STRING_VALUE', /* more items */ ], Columns: [ { Name: 'STRING_VALUE', /* required */ Comment: 'STRING_VALUE', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, 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>': ... */ }, SchemaReference: { SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: 'NUMBER_VALUE' }, 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 Amazon Web Services account ID of the catalog in which the partition is to be created.
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.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
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.
-
(AWS.Response)
—
Returns:
createPartitionIndex(params = {}, callback) ⇒ AWS.Request
Creates a specified partition index in an existing table.
Service Reference:
Examples:
Calling the createPartitionIndex operation
var params = { DatabaseName: 'STRING_VALUE', /* required */ PartitionIndex: { /* required */ IndexName: 'STRING_VALUE', /* required */ Keys: [ /* required */ 'STRING_VALUE', /* more items */ ] }, TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.createPartitionIndex(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 catalog ID where the table resides.
DatabaseName
— (String
)Specifies the name of a database in which you want to create a partition index.
TableName
— (String
)Specifies the name of a table in which you want to create a partition index.
PartitionIndex
— (map
)Specifies a
PartitionIndex
structure to create a partition index in an existing table.Keys
— required — (Array<String>
)The keys for the partition index.
IndexName
— required — (String
)The name of the partition index.
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.
-
(AWS.Response)
—
Returns:
createRegistry(params = {}, callback) ⇒ AWS.Request
Creates a new registry which may be used to hold a collection of schemas.
Service Reference:
Examples:
Calling the createRegistry operation
var params = { RegistryName: 'STRING_VALUE', /* required */ Description: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.createRegistry(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: {})
—
RegistryName
— (String
)Name of the registry to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
Description
— (String
)A description of the registry. If description is not provided, there will not be any default value for this.
Tags
— (map<String>
)Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API.
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. Thedata
object has the following properties:RegistryArn
— (String
)The Amazon Resource Name (ARN) of the newly created registry.
RegistryName
— (String
)The name of the registry.
Description
— (String
)A description of the registry.
Tags
— (map<String>
)The tags for the registry.
-
(AWS.Response)
—
Returns:
createSchema(params = {}, callback) ⇒ AWS.Request
Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.
When the schema set is created, a version checkpoint will be set to the first version. Compatibility mode "DISABLED" restricts any additional schema versions from being added after the first schema version. For all other compatibility modes, validation of compatibility settings will be applied only from the second version onwards when the
RegisterSchemaVersion
API is used.When this API is called without a
RegistryId
, this will create an entry for a "default-registry" in the registry database tables, if it is not already present.Service Reference:
Examples:
Calling the createSchema operation
var params = { DataFormat: AVRO | JSON | PROTOBUF, /* required */ SchemaName: 'STRING_VALUE', /* required */ Compatibility: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL, Description: 'STRING_VALUE', RegistryId: { RegistryArn: 'STRING_VALUE', RegistryName: 'STRING_VALUE' }, SchemaDefinition: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.createSchema(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: {})
—
RegistryId
— (map
)This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be:
arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id
.RegistryName
— (String
)Name of the registry. Used only for lookup. One of
RegistryArn
orRegistryName
has to be provided.RegistryArn
— (String
)Arn of the registry to be updated. One of
RegistryArn
orRegistryName
has to be provided.
SchemaName
— (String
)Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.
DataFormat
— (String
)The data format of the schema definition. Currently
Possible values include:AVRO
,JSON
andPROTOBUF
are supported."AVRO"
"JSON"
"PROTOBUF"
Compatibility
— (String
)The compatibility mode of the schema. The possible values are:
-
NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.
-
DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.
-
BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.
-
BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.
-
FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.
-
FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.
-
FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.
-
FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.
"NONE"
"DISABLED"
"BACKWARD"
"BACKWARD_ALL"
"FORWARD"
"FORWARD_ALL"
"FULL"
"FULL_ALL"
-
Description
— (String
)An optional description of the schema. If description is not provided, there will not be any automatic default value for this.
Tags
— (map<String>
)Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.
SchemaDefinition
— (String
)The schema definition using the
DataFormat
setting forSchemaName
.
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. Thedata
object has the following properties:RegistryName
— (String
)The name of the registry.
RegistryArn
— (String
)The Amazon Resource Name (ARN) of the registry.
SchemaName
— (String
)The name of the schema.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema.
Description
— (String
)A description of the schema if specified when created.
DataFormat
— (String
)The data format of the schema definition. Currently
Possible values include:AVRO
,JSON
andPROTOBUF
are supported."AVRO"
"JSON"
"PROTOBUF"
Compatibility
— (String
)The schema compatibility mode.
Possible values include:"NONE"
"DISABLED"
"BACKWARD"
"BACKWARD_ALL"
"FORWARD"
"FORWARD_ALL"
"FULL"
"FULL_ALL"
SchemaCheckpoint
— (Integer
)The version number of the checkpoint (the last time the compatibility mode was changed).
LatestSchemaVersion
— (Integer
)The latest version of the schema associated with the returned schema definition.
NextSchemaVersion
— (Integer
)The next version of the schema associated with the returned schema definition.
SchemaStatus
— (String
)The status of the schema.
Possible values include:"AVAILABLE"
"PENDING"
"DELETING"
Tags
— (map<String>
)The tags for the schema.
SchemaVersionId
— (String
)The unique identifier of the first schema version.
SchemaVersionStatus
— (String
)The status of the first schema version created.
Possible values include:"AVAILABLE"
"PENDING"
"FAILURE"
"DELETING"
-
(AWS.Response)
—
Returns:
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 that 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. Thedata
object has the following properties:PythonScript
— (String
)The Python script generated from the DAG.
ScalaCode
— (String
)The Scala code generated from the DAG.
-
(AWS.Response)
—
Returns:
createSecurityConfiguration(params = {}, callback) ⇒ AWS.Request
Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.
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 Amazon Simple Storage Service (Amazon S3) data.
S3EncryptionMode
— (String
)The encryption mode to use for Amazon S3 data.
Possible values include:"DISABLED"
"SSE-KMS"
"SSE-S3"
KmsKeyArn
— (String
)The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
CloudWatchEncryption
— (map
)The encryption configuration for Amazon CloudWatch.
CloudWatchEncryptionMode
— (String
)The encryption mode to use for CloudWatch data.
Possible values include:"DISABLED"
"SSE-KMS"
KmsKeyArn
— (String
)The Amazon Resource Name (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 Amazon Resource Name (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. Thedata
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.
-
(AWS.Response)
—
Returns:
createSession(params = {}, callback) ⇒ AWS.Request
Creates a new session.
Service Reference:
Examples:
Calling the createSession operation
var params = { Command: { /* required */ Name: 'STRING_VALUE', PythonVersion: 'STRING_VALUE' }, Id: 'STRING_VALUE', /* required */ Role: 'STRING_VALUE', /* required */ Connections: { Connections: [ 'STRING_VALUE', /* more items */ ] }, DefaultArguments: { '<OrchestrationNameString>': 'STRING_VALUE', /* '<OrchestrationNameString>': ... */ }, Description: 'STRING_VALUE', GlueVersion: 'STRING_VALUE', IdleTimeout: 'NUMBER_VALUE', MaxCapacity: 'NUMBER_VALUE', NumberOfWorkers: 'NUMBER_VALUE', RequestOrigin: 'STRING_VALUE', SecurityConfiguration: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ }, Timeout: 'NUMBER_VALUE', WorkerType: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2X }; glue.createSession(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: {})
—
Id
— (String
)The ID of the session request.
Description
— (String
)The description of the session.
Role
— (String
)The IAM Role ARN
Command
— (map
)The
SessionCommand
that runs the job.Name
— (String
)Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
PythonVersion
— (String
)Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
Timeout
— (Integer
)The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation for other job types.
IdleTimeout
— (Integer
)The number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types.
DefaultArguments
— (map<String>
)A map array of key-value pairs. Max is 75 pairs.
Connections
— (map
)The number of connections to use for the session.
Connections
— (Array<String>
)A list of connections used by the job.
MaxCapacity
— (Float
)The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
NumberOfWorkers
— (Integer
)The number of workers of a defined
WorkerType
to use for the session.WorkerType
— (String
)The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark jobs. Accepts the value Z.2X for Ray notebooks.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
SecurityConfiguration
— (String
)The name of the SecurityConfiguration structure to be used with the session
GlueVersion
— (String
)The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
Tags
— (map<String>
)The map of key value pairs (tags) belonging to the session.
RequestOrigin
— (String
)The origin of the 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. Thedata
object has the following properties:Session
— (map
)Returns the session object in the response.
Id
— (String
)The ID of the session.
CreatedOn
— (Date
)The time and date when the session was created.
Status
— (String
)The session status.
Possible values include:"PROVISIONING"
"READY"
"FAILED"
"TIMEOUT"
"STOPPING"
"STOPPED"
ErrorMessage
— (String
)The error message displayed during the session.
Description
— (String
)The description of the session.
Role
— (String
)The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
Command
— (map
)The command object.See SessionCommand.
Name
— (String
)Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
PythonVersion
— (String
)Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
DefaultArguments
— (map<String>
)A map array of key-value pairs. Max is 75 pairs.
Connections
— (map
)The number of connections used for the session.
Connections
— (Array<String>
)A list of connections used by the job.
Progress
— (Float
)The code execution progress of the session.
MaxCapacity
— (Float
)The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
SecurityConfiguration
— (String
)The name of the SecurityConfiguration structure to be used with the session.
GlueVersion
— (String
)The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
NumberOfWorkers
— (Integer
)The number of workers of a defined
WorkerType
to use for the session.WorkerType
— (String
)The type of predefined worker that is allocated when a session runs. Accepts a value of
Possible values include:G.1X
,G.2X
,G.4X
, orG.8X
for Spark sessions. Accepts the valueZ.2X
for Ray sessions."Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
CompletedOn
— (Date
)The date and time that this session is completed.
ExecutionTime
— (Float
)The total time the session ran for.
DPUSeconds
— (Float
)The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
IdleTimeout
— (Integer
)The number of minutes when idle before the session times out.
ProfileName
— (String
)The name of an Glue usage profile associated with the session.
-
(AWS.Response)
—
Returns:
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', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, Type: 'STRING_VALUE' }, /* more items */ ], Retention: 'NUMBER_VALUE', StorageDescriptor: { AdditionalLocations: [ 'STRING_VALUE', /* more items */ ], BucketColumns: [ 'STRING_VALUE', /* more items */ ], Columns: [ { Name: 'STRING_VALUE', /* required */ Comment: 'STRING_VALUE', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, 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>': ... */ }, SchemaReference: { SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: 'NUMBER_VALUE' }, 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', TargetTable: { CatalogId: 'STRING_VALUE', DatabaseName: 'STRING_VALUE', Name: 'STRING_VALUE', Region: 'STRING_VALUE' }, ViewDefinition: { Definer: 'STRING_VALUE', IsProtected: true || false, Representations: [ { Dialect: REDSHIFT | ATHENA | SPARK, DialectVersion: 'STRING_VALUE', ValidationConnection: 'STRING_VALUE', ViewExpandedText: 'STRING_VALUE', ViewOriginalText: 'STRING_VALUE' }, /* more items */ ], SubObjects: [ 'STRING_VALUE', /* more items */ ] }, ViewExpandedText: 'STRING_VALUE', ViewOriginalText: 'STRING_VALUE' }, CatalogId: 'STRING_VALUE', OpenTableFormatInput: { IcebergInput: { MetadataOperation: CREATE, /* required */ Version: 'STRING_VALUE' } }, PartitionIndexes: [ { IndexName: 'STRING_VALUE', /* required */ Keys: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], TransactionId: '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 Amazon Web Services 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
)The table name. For Hive compatibility, this is folded to lowercase when it is stored.
Description
— (String
)A description of the table.
Owner
— (String
)The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
LastAccessTime
— (Date
)The last time that the table was accessed.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
Representations
— (Array<map>
)A list of structures that contains the dialect of the view, and the query that defines the view.
Dialect
— (String
)A parameter that specifies the engine type of a specific representation.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)A parameter that specifies the version of the engine of a specific representation.
ViewOriginalText
— (String
)A string that represents the original SQL query that describes the view.
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
ViewExpandedText
— (String
)A string that represents the SQL query that describes the view with expanded resource ARNs
SubObjects
— (Array<String>
)A list of base table ARNs that make up the view.
PartitionIndexes
— (Array<map>
)A list of partition indexes,
PartitionIndex
structures, to create in the table.Keys
— required — (Array<String>
)The keys for the partition index.
IndexName
— required — (String
)The name of the partition index.
TransactionId
— (String
)The ID of the transaction.
OpenTableFormatInput
— (map
)Specifies an
OpenTableFormatInput
structure when creating an open format table.IcebergInput
— (map
)Specifies an
IcebergInput
structure that defines an Apache Iceberg metadata table.MetadataOperation
— required — (String
)A required metadata operation. Can only be set to
Possible values include:CREATE
."CREATE"
Version
— (String
)The table version for the Iceberg table. Defaults to 2.
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.
-
(AWS.Response)
—
Returns:
createTableOptimizer(params = {}, callback) ⇒ AWS.Request
Creates a new table optimizer for a specific function.
compaction
is the only currently supported optimizer type.Service Reference:
Examples:
Calling the createTableOptimizer operation
var params = { CatalogId: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ TableOptimizerConfiguration: { /* required */ enabled: true || false, roleArn: 'STRING_VALUE' }, Type: compaction /* required */ }; glue.createTableOptimizer(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 Catalog ID of the table.
DatabaseName
— (String
)The name of the database in the catalog in which the table resides.
TableName
— (String
)The name of the table.
Type
— (String
)The type of table optimizer. Currently, the only valid value is
Possible values include:compaction
."compaction"
TableOptimizerConfiguration
— (map
)A
TableOptimizerConfiguration
object representing the configuration of a table optimizer.roleArn
— (String
)A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.
enabled
— (Boolean
)Whether table optimization is enabled.
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.
-
(AWS.Response)
—
Returns:
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>': ... */ }, CrawlerName: 'STRING_VALUE', JobName: 'STRING_VALUE', NotificationProperty: { NotifyDelayAfter: 'NUMBER_VALUE' }, SecurityConfiguration: 'STRING_VALUE', Timeout: 'NUMBER_VALUE' }, /* more items */ ], Name: 'STRING_VALUE', /* required */ Type: SCHEDULED | CONDITIONAL | ON_DEMAND | EVENT, /* required */ Description: 'STRING_VALUE', EventBatchingCondition: { BatchSize: 'NUMBER_VALUE', /* required */ BatchWindow: 'NUMBER_VALUE' }, Predicate: { Conditions: [ { CrawlState: RUNNING | CANCELLING | CANCELLED | SUCCEEDED | FAILED | ERROR, CrawlerName: 'STRING_VALUE', JobName: 'STRING_VALUE', LogicalOperator: EQUALS, State: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT | ERROR | WAITING | EXPIRED }, /* more items */ ], Logical: AND | ANY }, Schedule: 'STRING_VALUE', StartOnCreation: true || false, Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ }, WorkflowName: 'STRING_VALUE' }; 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.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Type
— (String
)The type of the new trigger.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
Actions
— (Array<map>
)The actions initiated by this trigger when it fires.
JobName
— (String
)The name of a job to be run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Description
— (String
)A description of the new trigger.
StartOnCreation
— (Boolean
)Set to
true
to startSCHEDULED
andCONDITIONAL
triggers when created. True is not supported forON_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 Glue, see Amazon Web Services Tags in Glue in the developer guide.
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
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. Thedata
object has the following properties:Name
— (String
)The name of the trigger.
-
(AWS.Response)
—
Returns:
createUsageProfile(params = {}, callback) ⇒ AWS.Request
Creates an Glue usage profile.
Service Reference:
Examples:
Calling the createUsageProfile operation
var params = { Configuration: { /* required */ JobConfiguration: { '<NameString>': { AllowedValues: [ 'STRING_VALUE', /* more items */ ], DefaultValue: 'STRING_VALUE', MaxValue: 'STRING_VALUE', MinValue: 'STRING_VALUE' }, /* '<NameString>': ... */ }, SessionConfiguration: { '<NameString>': { AllowedValues: [ 'STRING_VALUE', /* more items */ ], DefaultValue: 'STRING_VALUE', MaxValue: 'STRING_VALUE', MinValue: 'STRING_VALUE' }, /* '<NameString>': ... */ } }, Name: 'STRING_VALUE', /* required */ Description: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.createUsageProfile(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 usage profile.
Description
— (String
)A description of the usage profile.
Configuration
— (map
)A
ProfileConfiguration
object specifying the job and session values for the profile.SessionConfiguration
— (map<map>
)A key-value map of configuration parameters for Glue sessions.
DefaultValue
— (String
)A default value for the parameter.
AllowedValues
— (Array<String>
)A list of allowed values for the parameter.
MinValue
— (String
)A minimum allowed value for the parameter.
MaxValue
— (String
)A maximum allowed value for the parameter.
JobConfiguration
— (map<map>
)A key-value map of configuration parameters for Glue jobs.
DefaultValue
— (String
)A default value for the parameter.
AllowedValues
— (Array<String>
)A list of allowed values for the parameter.
MinValue
— (String
)A minimum allowed value for the parameter.
MaxValue
— (String
)A maximum allowed value for the parameter.
Tags
— (map<String>
)A list of tags applied to the usage profile.
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. Thedata
object has the following properties:Name
— (String
)The name of the usage profile that was created.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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.
-
(AWS.Response)
—
Returns:
createWorkflow(params = {}, callback) ⇒ AWS.Request
Creates a new workflow.
Service Reference:
Examples:
Calling the createWorkflow operation
var params = { Name: 'STRING_VALUE', /* required */ DefaultRunProperties: { '<IdString>': 'STRING_VALUE', /* '<IdString>': ... */ }, Description: 'STRING_VALUE', MaxConcurrentRuns: 'NUMBER_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.createWorkflow(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 to be assigned to the workflow. It should be unique within your account.
Description
— (String
)A description of the workflow.
DefaultRunProperties
— (map<String>
)A collection of properties to be used as part of each execution of the workflow.
Tags
— (map<String>
)The tags to be used with this workflow.
MaxConcurrentRuns
— (Integer
)You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
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. Thedata
object has the following properties:Name
— (String
)The name of the workflow which was provided as part of the request.
-
(AWS.Response)
—
Returns:
deleteBlueprint(params = {}, callback) ⇒ AWS.Request
Deletes an existing blueprint.
Service Reference:
Examples:
Calling the deleteBlueprint operation
var params = { Name: 'STRING_VALUE' /* required */ }; glue.deleteBlueprint(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 blueprint 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. Thedata
object has the following properties:Name
— (String
)Returns the name of the blueprint that was deleted.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
deleteColumnStatisticsForPartition(params = {}, callback) ⇒ AWS.Request
Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is
DeletePartition
.Service Reference:
Examples:
Calling the deleteColumnStatisticsForPartition operation
var params = { ColumnName: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ PartitionValues: [ /* required */ 'STRING_VALUE', /* more items */ ], TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.deleteColumnStatisticsForPartition(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 Amazon Web Services 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.
PartitionValues
— (Array<String>
)A list of partition values identifying the partition.
ColumnName
— (String
)Name of the 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.
-
(AWS.Response)
—
Returns:
deleteColumnStatisticsForTable(params = {}, callback) ⇒ AWS.Request
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
DeleteTable
.Service Reference:
Examples:
Calling the deleteColumnStatisticsForTable operation
var params = { ColumnName: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.deleteColumnStatisticsForTable(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 Amazon Web Services 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.
ColumnName
— (String
)The name of the 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.
-
(AWS.Response)
—
Returns:
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 Amazon Web Services 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.
-
(AWS.Response)
—
Returns:
deleteCrawler(params = {}, callback) ⇒ AWS.Request
Removes a specified crawler from the Glue 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
)The 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.
-
(AWS.Response)
—
Returns:
deleteCustomEntityType(params = {}, callback) ⇒ AWS.Request
Deletes a custom pattern by specifying its name.
Service Reference:
Examples:
Calling the deleteCustomEntityType operation
var params = { Name: 'STRING_VALUE' /* required */ }; glue.deleteCustomEntityType(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 custom pattern that you want 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. Thedata
object has the following properties:Name
— (String
)The name of the custom pattern you deleted.
-
(AWS.Response)
—
Returns:
deleteDatabase(params = {}, callback) ⇒ AWS.Request
Removes a specified database from a Data Catalog.
Note: After completing this operation, you 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. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure the immediate deletion of all related resources, before callingDeleteDatabase
, useDeleteTableVersion
orBatchDeleteTableVersion
,DeletePartition
orBatchDeletePartition
,DeleteUserDefinedFunction
, andDeleteTable
orBatchDeleteTable
, 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 provided, the Amazon Web Services 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.
-
(AWS.Response)
—
Returns:
deleteDataQualityRuleset(params = {}, callback) ⇒ AWS.Request
Deletes a data quality ruleset.
Service Reference:
Examples:
Calling the deleteDataQualityRuleset operation
var params = { Name: 'STRING_VALUE' /* required */ }; glue.deleteDataQualityRuleset(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
)A name for the data quality ruleset.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteDevEndpoint(params = {}, callback) ⇒ AWS.Request
Deletes a specified development endpoint.
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.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:JobName
— (String
)The name of the job definition that was deleted.
-
(AWS.Response)
—
Returns:
deleteMLTransform(params = {}, callback) ⇒ AWS.Request
Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling
DeleteMLTransforms
. However, any Glue jobs that still reference the deleted transform will no longer succeed.Service Reference:
Examples:
Calling the deleteMLTransform operation
var params = { TransformId: 'STRING_VALUE' /* required */ }; glue.deleteMLTransform(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: {})
—
TransformId
— (String
)The unique identifier of the transform 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. Thedata
object has the following properties:TransformId
— (String
)The unique identifier of the transform that was deleted.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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 that contains the partition to be deleted.
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.
-
(AWS.Response)
—
Returns:
deletePartitionIndex(params = {}, callback) ⇒ AWS.Request
Deletes a specified partition index from an existing table.
Service Reference:
Examples:
Calling the deletePartitionIndex operation
var params = { DatabaseName: 'STRING_VALUE', /* required */ IndexName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.deletePartitionIndex(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 catalog ID where the table resides.
DatabaseName
— (String
)Specifies the name of a database from which you want to delete a partition index.
TableName
— (String
)Specifies the name of a table from which you want to delete a partition index.
IndexName
— (String
)The name of the partition index 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.
-
(AWS.Response)
—
Returns:
deleteRegistry(params = {}, callback) ⇒ AWS.Request
Delete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the
GetRegistry
API after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as theUpdateRegistry
,CreateSchema
,UpdateSchema
, andRegisterSchemaVersion
APIs.Service Reference:
Examples:
Calling the deleteRegistry operation
var params = { RegistryId: { /* required */ RegistryArn: 'STRING_VALUE', RegistryName: 'STRING_VALUE' } }; glue.deleteRegistry(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: {})
—
RegistryId
— (map
)This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
RegistryName
— (String
)Name of the registry. Used only for lookup. One of
RegistryArn
orRegistryName
has to be provided.RegistryArn
— (String
)Arn of the registry to be updated. One of
RegistryArn
orRegistryName
has to be provided.
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. Thedata
object has the following properties:RegistryName
— (String
)The name of the registry being deleted.
RegistryArn
— (String
)The Amazon Resource Name (ARN) of the registry being deleted.
Status
— (String
)The status of the registry. A successful operation will return the
Possible values include:Deleting
status."AVAILABLE"
"DELETING"
-
(AWS.Response)
—
Returns:
deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request
Deletes a specified policy.
Service Reference:
Examples:
Calling the deleteResourcePolicy operation
var params = { PolicyHashCondition: 'STRING_VALUE', ResourceArn: '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.
ResourceArn
— (String
)The ARN of the Glue resource for the resource policy 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.
-
(AWS.Response)
—
Returns:
deleteSchema(params = {}, callback) ⇒ AWS.Request
Deletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call
GetSchema
API after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as theGetSchemaByDefinition
, andRegisterSchemaVersion
APIs.Service Reference:
Examples:
Calling the deleteSchema operation
var params = { SchemaId: { /* required */ RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' } }; glue.deleteSchema(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: {})
—
SchemaId
— (map
)This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
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. Thedata
object has the following properties:SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema being deleted.
SchemaName
— (String
)The name of the schema being deleted.
Status
— (String
)The status of the schema.
Possible values include:"AVAILABLE"
"PENDING"
"DELETING"
-
(AWS.Response)
—
Returns:
deleteSchemaVersions(params = {}, callback) ⇒ AWS.Request
Remove versions from the specified schema. A version number or range may be supplied. If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned. Calling the
GetSchemaVersions
API after this call will list the status of the deleted versions.When the range of version numbers contain check pointed version, the API will return a 409 conflict and will not proceed with the deletion. You have to remove the checkpoint first using the
DeleteSchemaCheckpoint
API before using this API.You cannot use the
DeleteSchemaVersions
API to delete the first schema version in the schema set. The first schema version can only be deleted by theDeleteSchema
API. This operation will also delete the attachedSchemaVersionMetadata
under the schema versions. Hard deletes will be enforced on the database.If the compatibility mode forbids deleting of a version that is necessary, such as BACKWARDS_FULL, an error is returned.
Service Reference:
Examples:
Calling the deleteSchemaVersions operation
var params = { SchemaId: { /* required */ RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, Versions: 'STRING_VALUE' /* required */ }; glue.deleteSchemaVersions(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: {})
—
SchemaId
— (map
)This is a wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
Versions
— (String
)A version range may be supplied which may be of the format:
-
a single version number, 5
-
a range, 5-8 : deletes versions 5, 6, 7, 8
-
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. Thedata
object has the following properties:SchemaVersionErrors
— (Array<map>
)A list of
SchemaVersionErrorItem
objects, each containing an error and schema version.VersionNumber
— (Integer
)The version number of the schema.
ErrorDetails
— (map
)The details of the error for the schema version.
ErrorCode
— (String
)The error code for an error.
ErrorMessage
— (String
)The error message for an error.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
deleteSession(params = {}, callback) ⇒ AWS.Request
Deletes the session.
Service Reference:
Examples:
Calling the deleteSession operation
var params = { Id: 'STRING_VALUE', /* required */ RequestOrigin: 'STRING_VALUE' }; glue.deleteSession(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: {})
—
Id
— (String
)The ID of the session to be deleted.
RequestOrigin
— (String
)The name of the origin of the delete session 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. Thedata
object has the following properties:Id
— (String
)Returns the ID of the deleted session.
-
(AWS.Response)
—
Returns:
deleteTable(params = {}, callback) ⇒ AWS.Request
Removes a table definition from the Data Catalog.
Note: After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. Glue deletes these "orphaned" resources asynchronously in a timely manner, at the discretion of the service. To ensure the immediate deletion of all related resources, before callingDeleteTable
, useDeleteTableVersion
orBatchDeleteTableVersion
, andDeletePartition
orBatchDeletePartition
, 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', TransactionId: '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 provided, the Amazon Web Services 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.
TransactionId
— (String
)The transaction ID at which to delete the table contents.
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.
-
(AWS.Response)
—
Returns:
deleteTableOptimizer(params = {}, callback) ⇒ AWS.Request
Deletes an optimizer and all associated metadata for a table. The optimization will no longer be performed on the table.
Service Reference:
Examples:
Calling the deleteTableOptimizer operation
var params = { CatalogId: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ Type: compaction /* required */ }; glue.deleteTableOptimizer(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 Catalog ID of the table.
DatabaseName
— (String
)The name of the database in the catalog in which the table resides.
TableName
— (String
)The name of the table.
Type
— (String
)The type of table optimizer.
Possible values include:"compaction"
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.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Name
— (String
)The name of the trigger that was deleted.
-
(AWS.Response)
—
Returns:
deleteUsageProfile(params = {}, callback) ⇒ AWS.Request
Deletes the Glue specified usage profile.
Service Reference:
Examples:
Calling the deleteUsageProfile operation
var params = { Name: 'STRING_VALUE' /* required */ }; glue.deleteUsageProfile(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 usage profile 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.
-
(AWS.Response)
—
Returns:
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 Amazon Web Services 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.
-
(AWS.Response)
—
Returns:
deleteWorkflow(params = {}, callback) ⇒ AWS.Request
Deletes a workflow.
Service Reference:
Examples:
Calling the deleteWorkflow operation
var params = { Name: 'STRING_VALUE' /* required */ }; glue.deleteWorkflow(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 workflow 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. Thedata
object has the following properties:Name
— (String
)Name of the workflow specified in input.
-
(AWS.Response)
—
Returns:
getBlueprint(params = {}, callback) ⇒ AWS.Request
Retrieves the details of a blueprint.
Service Reference:
Examples:
Calling the getBlueprint operation
var params = { Name: 'STRING_VALUE', /* required */ IncludeBlueprint: true || false, IncludeParameterSpec: true || false }; glue.getBlueprint(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 blueprint.
IncludeBlueprint
— (Boolean
)Specifies whether or not to include the blueprint in the response.
IncludeParameterSpec
— (Boolean
)Specifies whether or not to include the parameter specification.
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. Thedata
object has the following properties:Blueprint
— (map
)Returns a
Blueprint
object.Name
— (String
)The name of the blueprint.
Description
— (String
)The description of the blueprint.
CreatedOn
— (Date
)The date and time the blueprint was registered.
LastModifiedOn
— (Date
)The date and time the blueprint was last modified.
ParameterSpec
— (String
)A JSON string that indicates the list of parameter specifications for the blueprint.
BlueprintLocation
— (String
)Specifies the path in Amazon S3 where the blueprint is published.
BlueprintServiceLocation
— (String
)Specifies a path in Amazon S3 where the blueprint is copied when you call
CreateBlueprint/UpdateBlueprint
to register the blueprint in Glue.Status
— (String
)The status of the blueprint registration.
-
Creating — The blueprint registration is in progress.
-
Active — The blueprint has been successfully registered.
-
Updating — An update to the blueprint registration is in progress.
-
Failed — The blueprint registration failed.
"CREATING"
"ACTIVE"
"UPDATING"
"FAILED"
-
ErrorMessage
— (String
)An error message.
LastActiveDefinition
— (map
)When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.
Description
— (String
)The description of the blueprint.
LastModifiedOn
— (Date
)The date and time the blueprint was last modified.
ParameterSpec
— (String
)A JSON string specifying the parameters for the blueprint.
BlueprintLocation
— (String
)Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.
BlueprintServiceLocation
— (String
)Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.
-
(AWS.Response)
—
Returns:
getBlueprintRun(params = {}, callback) ⇒ AWS.Request
Retrieves the details of a blueprint run.
Service Reference:
Examples:
Calling the getBlueprintRun operation
var params = { BlueprintName: 'STRING_VALUE', /* required */ RunId: 'STRING_VALUE' /* required */ }; glue.getBlueprintRun(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: {})
—
BlueprintName
— (String
)The name of the blueprint.
RunId
— (String
)The run ID for the blueprint run you want 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. Thedata
object has the following properties:BlueprintRun
— (map
)Returns a
BlueprintRun
object.BlueprintName
— (String
)The name of the blueprint.
RunId
— (String
)The run ID for this blueprint run.
WorkflowName
— (String
)The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
State
— (String
)The state of the blueprint run. Possible values are:
-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
"RUNNING"
"SUCCEEDED"
"FAILED"
"ROLLING_BACK"
-
StartedOn
— (Date
)The date and time that the blueprint run started.
CompletedOn
— (Date
)The date and time that the blueprint run completed.
ErrorMessage
— (String
)Indicates any errors that are seen while running the blueprint.
RollbackErrorMessage
— (String
)If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
Parameters
— (String
)The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the
Blueprint$ParameterSpec
.RoleArn
— (String
)The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
-
(AWS.Response)
—
Returns:
getBlueprintRuns(params = {}, callback) ⇒ AWS.Request
Retrieves the details of blueprint runs for a specified blueprint.
Service Reference:
Examples:
Calling the getBlueprintRuns operation
var params = { BlueprintName: 'STRING_VALUE', /* required */ MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.getBlueprintRuns(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: {})
—
BlueprintName
— (String
)The name of the blueprint.
NextToken
— (String
)A continuation token, if this is a continuation request.
MaxResults
— (Integer
)The maximum size of a list to return.
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. Thedata
object has the following properties:BlueprintRuns
— (Array<map>
)Returns a list of
BlueprintRun
objects.BlueprintName
— (String
)The name of the blueprint.
RunId
— (String
)The run ID for this blueprint run.
WorkflowName
— (String
)The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.
State
— (String
)The state of the blueprint run. Possible values are:
-
Running — The blueprint run is in progress.
-
Succeeded — The blueprint run completed successfully.
-
Failed — The blueprint run failed and rollback is complete.
-
Rolling Back — The blueprint run failed and rollback is in progress.
"RUNNING"
"SUCCEEDED"
"FAILED"
"ROLLING_BACK"
-
StartedOn
— (Date
)The date and time that the blueprint run started.
CompletedOn
— (Date
)The date and time that the blueprint run completed.
ErrorMessage
— (String
)Indicates any errors that are seen while running the blueprint.
RollbackErrorMessage
— (String
)If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.
Parameters
— (String
)The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the
Blueprint$ParameterSpec
.RoleArn
— (String
)The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.
NextToken
— (String
)A continuation token, if not all blueprint runs have been returned.
-
(AWS.Response)
—
Returns:
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 Amazon Web Services 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. Thedata
object has the following properties:ImportStatus
— (map
)The status of the specified catalog migration.
ImportCompleted
— (Boolean
)True
if the migration has completed, orFalse
otherwise.ImportTime
— (Date
)The time that the migration was started.
ImportedBy
— (String
)The name of the person who initiated the migration.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Classifier
— (map
)The requested classifier.
GrokClassifier
— (map
)A classifier that uses
grok
.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 that this classifier was registered.
LastUpdated
— (Date
)The time that 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 Classifiers.
CustomPatterns
— (String
)Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
XMLClassifier
— (map
)A classifier for XML content.
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 that this classifier was registered.
LastUpdated
— (Date
)The time that 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. This can't 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 classifier for JSON content.
Name
— required — (String
)The name of the classifier.
CreationTime
— (Date
)The time that this classifier was registered.
LastUpdated
— (Date
)The time that 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. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
CsvClassifier
— (map
)A classifier for comma-separated values (CSV).
Name
— required — (String
)The name of the classifier.
CreationTime
— (Date
)The time that this classifier was registered.
LastUpdated
— (Date
)The time that 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. It 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.
CustomDatatypeConfigured
— (Boolean
)Enables the custom datatype to be configured.
CustomDatatypes
— (Array<String>
)A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
Serde
— (String
)Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are
Possible values include:OpenCSVSerDe
,LazySimpleSerDe
, andNone
. You can specify theNone
value when you want the crawler to do the detection."OpenCSVSerDe"
"LazySimpleSerDe"
"None"
-
(AWS.Response)
—
Returns:
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
)The 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. Thedata
object has the following properties:Classifiers
— (Array<map>
)The requested list of classifier objects.
GrokClassifier
— (map
)A classifier that uses
grok
.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 that this classifier was registered.
LastUpdated
— (Date
)The time that 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 Classifiers.
CustomPatterns
— (String
)Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
XMLClassifier
— (map
)A classifier for XML content.
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 that this classifier was registered.
LastUpdated
— (Date
)The time that 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. This can't 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 classifier for JSON content.
Name
— required — (String
)The name of the classifier.
CreationTime
— (Date
)The time that this classifier was registered.
LastUpdated
— (Date
)The time that 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. Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.
CsvClassifier
— (map
)A classifier for comma-separated values (CSV).
Name
— required — (String
)The name of the classifier.
CreationTime
— (Date
)The time that this classifier was registered.
LastUpdated
— (Date
)The time that 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. It 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.
CustomDatatypeConfigured
— (Boolean
)Enables the custom datatype to be configured.
CustomDatatypes
— (Array<String>
)A list of custom datatypes including "BINARY", "BOOLEAN", "DATE", "DECIMAL", "DOUBLE", "FLOAT", "INT", "LONG", "SHORT", "STRING", "TIMESTAMP".
Serde
— (String
)Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are
Possible values include:OpenCSVSerDe
,LazySimpleSerDe
, andNone
. You can specify theNone
value when you want the crawler to do the detection."OpenCSVSerDe"
"LazySimpleSerDe"
"None"
NextToken
— (String
)A continuation token.
-
(AWS.Response)
—
Returns:
getColumnStatisticsForPartition(params = {}, callback) ⇒ AWS.Request
Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
GetPartition
.Service Reference:
Examples:
Calling the getColumnStatisticsForPartition operation
var params = { ColumnNames: [ /* required */ 'STRING_VALUE', /* more items */ ], DatabaseName: 'STRING_VALUE', /* required */ PartitionValues: [ /* required */ 'STRING_VALUE', /* more items */ ], TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.getColumnStatisticsForPartition(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 Amazon Web Services 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.
PartitionValues
— (Array<String>
)A list of partition values identifying the partition.
ColumnNames
— (Array<String>
)A list of the column names.
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. Thedata
object has the following properties:ColumnStatisticsList
— (Array<map>
)List of ColumnStatistics that failed to be retrieved.
ColumnName
— required — (String
)Name of column which statistics belong to.
ColumnType
— required — (String
)The data type of the column.
AnalyzedTime
— required — (Date
)The timestamp of when column statistics were generated.
StatisticsData
— required — (map
)A
ColumnStatisticData
object that contains the statistics data values.Type
— required — (String
)The type of column statistics data.
Possible values include:"BOOLEAN"
"DATE"
"DECIMAL"
"DOUBLE"
"LONG"
"STRING"
"BINARY"
BooleanColumnStatisticsData
— (map
)Boolean column statistics data.
NumberOfTrues
— required — (Integer
)The number of true values in the column.
NumberOfFalses
— required — (Integer
)The number of false values in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
DateColumnStatisticsData
— (map
)Date column statistics data.
MinimumValue
— (Date
)The lowest value in the column.
MaximumValue
— (Date
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DecimalColumnStatisticsData
— (map
)Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two's complement representations of the decimal's unscaled value.
MinimumValue
— (map
)The lowest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
MaximumValue
— (map
)The highest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DoubleColumnStatisticsData
— (map
)Double column statistics data.
MinimumValue
— (Float
)The lowest value in the column.
MaximumValue
— (Float
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
LongColumnStatisticsData
— (map
)Long column statistics data.
MinimumValue
— (Integer
)The lowest value in the column.
MaximumValue
— (Integer
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
StringColumnStatisticsData
— (map
)String column statistics data.
MaximumLength
— required — (Integer
)The size of the longest string in the column.
AverageLength
— required — (Float
)The average string length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
BinaryColumnStatisticsData
— (map
)Binary column statistics data.
MaximumLength
— required — (Integer
)The size of the longest bit sequence in the column.
AverageLength
— required — (Float
)The average bit sequence length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
Errors
— (Array<map>
)Error occurred during retrieving column statistics data.
ColumnName
— (String
)The name of the column that failed.
Error
— (map
)An error message with the reason for the failure of an operation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
getColumnStatisticsForTable(params = {}, callback) ⇒ AWS.Request
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
GetTable
.Service Reference:
Examples:
Calling the getColumnStatisticsForTable operation
var params = { ColumnNames: [ /* required */ 'STRING_VALUE', /* more items */ ], DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.getColumnStatisticsForTable(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 Amazon Web Services 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.
ColumnNames
— (Array<String>
)A list of the column names.
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. Thedata
object has the following properties:ColumnStatisticsList
— (Array<map>
)List of ColumnStatistics.
ColumnName
— required — (String
)Name of column which statistics belong to.
ColumnType
— required — (String
)The data type of the column.
AnalyzedTime
— required — (Date
)The timestamp of when column statistics were generated.
StatisticsData
— required — (map
)A
ColumnStatisticData
object that contains the statistics data values.Type
— required — (String
)The type of column statistics data.
Possible values include:"BOOLEAN"
"DATE"
"DECIMAL"
"DOUBLE"
"LONG"
"STRING"
"BINARY"
BooleanColumnStatisticsData
— (map
)Boolean column statistics data.
NumberOfTrues
— required — (Integer
)The number of true values in the column.
NumberOfFalses
— required — (Integer
)The number of false values in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
DateColumnStatisticsData
— (map
)Date column statistics data.
MinimumValue
— (Date
)The lowest value in the column.
MaximumValue
— (Date
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DecimalColumnStatisticsData
— (map
)Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two's complement representations of the decimal's unscaled value.
MinimumValue
— (map
)The lowest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
MaximumValue
— (map
)The highest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DoubleColumnStatisticsData
— (map
)Double column statistics data.
MinimumValue
— (Float
)The lowest value in the column.
MaximumValue
— (Float
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
LongColumnStatisticsData
— (map
)Long column statistics data.
MinimumValue
— (Integer
)The lowest value in the column.
MaximumValue
— (Integer
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
StringColumnStatisticsData
— (map
)String column statistics data.
MaximumLength
— required — (Integer
)The size of the longest string in the column.
AverageLength
— required — (Float
)The average string length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
BinaryColumnStatisticsData
— (map
)Binary column statistics data.
MaximumLength
— required — (Integer
)The size of the longest bit sequence in the column.
AverageLength
— required — (Float
)The average bit sequence length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
Errors
— (Array<map>
)List of ColumnStatistics that failed to be retrieved.
ColumnName
— (String
)The name of the column that failed.
Error
— (map
)An error message with the reason for the failure of an operation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
getColumnStatisticsTaskRun(params = {}, callback) ⇒ AWS.Request
Get the associated metadata/information for a task run, given a task run ID.
Service Reference:
Examples:
Calling the getColumnStatisticsTaskRun operation
var params = { ColumnStatisticsTaskRunId: 'STRING_VALUE' /* required */ }; glue.getColumnStatisticsTaskRun(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: {})
—
ColumnStatisticsTaskRunId
— (String
)The identifier for the particular column statistics task run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ColumnStatisticsTaskRun
— (map
)A
ColumnStatisticsTaskRun
object representing the details of the column stats run.CustomerId
— (String
)The Amazon Web Services account ID.
ColumnStatisticsTaskRunId
— (String
)The identifier for the particular column statistics task run.
DatabaseName
— (String
)The database where the table resides.
TableName
— (String
)The name of the table for which column statistics is generated.
ColumnNameList
— (Array<String>
)A list of the column names. If none is supplied, all column names for the table will be used by default.
CatalogID
— (String
)The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
Role
— (String
)The IAM role that the service assumes to generate statistics.
SampleSize
— (Float
)The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
SecurityConfiguration
— (String
)Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
NumberOfWorkers
— (Integer
)The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
WorkerType
— (String
)The type of workers being used for generating stats. The default is
g.1x
.Status
— (String
)The status of the task run.
Possible values include:"STARTING"
"RUNNING"
"SUCCEEDED"
"FAILED"
"STOPPED"
CreationTime
— (Date
)The time that this task was created.
LastUpdated
— (Date
)The last point in time when this task was modified.
StartTime
— (Date
)The start time of the task.
EndTime
— (Date
)The end time of the task.
ErrorMessage
— (String
)The error message for the job.
DPUSeconds
— (Float
)The calculated DPU usage in seconds for all autoscaled workers.
-
(AWS.Response)
—
Returns:
getColumnStatisticsTaskRuns(params = {}, callback) ⇒ AWS.Request
Retrieves information about all runs associated with the specified table.
Service Reference:
Examples:
Calling the getColumnStatisticsTaskRuns operation
var params = { DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.getColumnStatisticsTaskRuns(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: {})
—
DatabaseName
— (String
)The name of the database where the table resides.
TableName
— (String
)The name of the table.
MaxResults
— (Integer
)The maximum size of the response.
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. Thedata
object has the following properties:ColumnStatisticsTaskRuns
— (Array<map>
)A list of column statistics task runs.
CustomerId
— (String
)The Amazon Web Services account ID.
ColumnStatisticsTaskRunId
— (String
)The identifier for the particular column statistics task run.
DatabaseName
— (String
)The database where the table resides.
TableName
— (String
)The name of the table for which column statistics is generated.
ColumnNameList
— (Array<String>
)A list of the column names. If none is supplied, all column names for the table will be used by default.
CatalogID
— (String
)The ID of the Data Catalog where the table resides. If none is supplied, the Amazon Web Services account ID is used by default.
Role
— (String
)The IAM role that the service assumes to generate statistics.
SampleSize
— (Float
)The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
SecurityConfiguration
— (String
)Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
NumberOfWorkers
— (Integer
)The number of workers used to generate column statistics. The job is preconfigured to autoscale up to 25 instances.
WorkerType
— (String
)The type of workers being used for generating stats. The default is
g.1x
.Status
— (String
)The status of the task run.
Possible values include:"STARTING"
"RUNNING"
"SUCCEEDED"
"FAILED"
"STOPPED"
CreationTime
— (Date
)The time that this task was created.
LastUpdated
— (Date
)The last point in time when this task was modified.
StartTime
— (Date
)The start time of the task.
EndTime
— (Date
)The end time of the task.
ErrorMessage
— (String
)The error message for the job.
DPUSeconds
— (Float
)The calculated DPU usage in seconds for all autoscaled workers.
NextToken
— (String
)A continuation token, if not all task runs have yet been returned.
-
(AWS.Response)
—
Returns:
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 Amazon Web Services 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 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 KMS key to decrypt the password, but it 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. Thedata
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, SFTP is not supported.
Possible values include:"JDBC"
"SFTP"
"MONGODB"
"KAFKA"
"NETWORK"
"MARKETPLACE"
"CUSTOM"
"SALESFORCE"
"VIEW_VALIDATION_REDSHIFT"
"VIEW_VALIDATION_ATHENA"
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 forUSER_NAME
is "USERNAME
". -
PASSWORD
- A password, if one is used, for the user name. -
ENCRYPTED_PASSWORD
- When you enable connection password protection by settingConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password. -
JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (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 connecting to a JDBC data source. -
JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false. -
CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format. -
SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this isfalse
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property totrue
to skip Glue’s validation of the customer certificate. -
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as theSSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as thehostNameInCertificate
. -
CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source. -
SECRET_ID
- The secret ID used for the secret manager of credentials. -
CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection. -
CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection. -
CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection. -
KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself. -
KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true". -
KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string. -
KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false". -
KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional). -
KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional). -
KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional). -
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected). -
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected). -
KAFKA_SASL_MECHANISM
-"SCRAM-SHA-512"
,"GSSAPI"
,"AWS_MSK_IAM"
, or"PLAIN"
. These are the supported SASL Mechanisms. -
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism. -
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism. -
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected). -
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism. -
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism. -
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected). -
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager. -
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberoskeytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab. -
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberoskrb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf. -
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set withsasl.kerberos.service.name
in your Kafka Configuration. -
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers. -
ROLE_ARN
- The role to be used for running queries. -
REGION
- The Amazon Web Services Region where queries will be run. -
WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run. -
CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run. -
DATABASE
- The Amazon Redshift database that you are connecting to.
-
PhysicalConnectionRequirements
— (map
)The 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.
CreationTime
— (Date
)The timestamp of the time that this connection definition was created.
LastUpdatedTime
— (Date
)The timestamp of the last time the connection definition was updated.
LastUpdatedBy
— (String
)The user, group, or role that last updated this connection definition.
Status
— (String
)The status of the connection. Can be one of:
Possible values include:READY
,IN_PROGRESS
, orFAILED
."READY"
"IN_PROGRESS"
"FAILED"
StatusReason
— (String
)The reason for the connection status.
LastConnectionValidationTime
— (Date
)A timestamp of the time this connection was last validated.
AuthenticationConfiguration
— (map
)The authentication properties of the connection.
AuthenticationType
— (String
)A structure containing the authentication configuration.
Possible values include:"BASIC"
"OAUTH2"
"CUSTOM"
SecretArn
— (String
)The secret manager ARN to store credentials.
OAuth2Properties
— (map
)The properties for OAuth2 authentication.
OAuth2GrantType
— (String
)The OAuth2 grant type. For example,
Possible values include:AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
."AUTHORIZATION_CODE"
"CLIENT_CREDENTIALS"
"JWT_BEARER"
OAuth2ClientApplication
— (map
)The client application type. For example, AWS_MANAGED or USER_MANAGED.
UserManagedClientApplicationClientId
— (String
)The client application clientID if the ClientAppType is
USER_MANAGED
.AWSManagedClientApplicationReference
— (String
)The reference to the SaaS-side client app that is Amazon Web Services managed.
TokenUrl
— (String
)The URL of the provider's authentication server, to exchange an authorization code for an access token.
TokenUrlParametersMap
— (map<String>
)A map of parameters that are added to the token
GET
request.
-
(AWS.Response)
—
Returns:
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 | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA, 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 Amazon Web Services account ID is used by default.
Filter
— (map
)A filter that controls which connections are 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, SFTP is not supported.
Possible values include:"JDBC"
"SFTP"
"MONGODB"
"KAFKA"
"NETWORK"
"MARKETPLACE"
"CUSTOM"
"SALESFORCE"
"VIEW_VALIDATION_REDSHIFT"
"VIEW_VALIDATION_ATHENA"
HidePassword
— (Boolean
)Allows you to retrieve the connection metadata without returning the password. For instance, the 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 KMS key to decrypt the password, but it 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. Thedata
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, SFTP is not supported.
Possible values include:"JDBC"
"SFTP"
"MONGODB"
"KAFKA"
"NETWORK"
"MARKETPLACE"
"CUSTOM"
"SALESFORCE"
"VIEW_VALIDATION_REDSHIFT"
"VIEW_VALIDATION_ATHENA"
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 forUSER_NAME
is "USERNAME
". -
PASSWORD
- A password, if one is used, for the user name. -
ENCRYPTED_PASSWORD
- When you enable connection password protection by settingConnectionPasswordEncryption
in the Data Catalog encryption settings, this field stores the encrypted password. -
JDBC_DRIVER_JAR_URI
- The Amazon Simple Storage Service (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 connecting to a JDBC data source. -
JDBC_ENFORCE_SSL
- A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false. -
CUSTOM_JDBC_CERT
- An Amazon S3 location specifying the customer's root certificate. Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format. -
SKIP_CUSTOM_JDBC_CERT_VALIDATION
- By default, this isfalse
. Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property totrue
to skip Glue’s validation of the customer certificate. -
CUSTOM_JDBC_CERT_STRING
- A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as theSSL_SERVER_CERT_DN
; in Microsoft SQL Server, this is used as thehostNameInCertificate
. -
CONNECTION_URL
- The URL for connecting to a general (non-JDBC) data source. -
SECRET_ID
- The secret ID used for the secret manager of credentials. -
CONNECTOR_URL
- The connector URL for a MARKETPLACE or CUSTOM connection. -
CONNECTOR_TYPE
- The connector type for a MARKETPLACE or CUSTOM connection. -
CONNECTOR_CLASS_NAME
- The connector class name for a MARKETPLACE or CUSTOM connection. -
KAFKA_BOOTSTRAP_SERVERS
- A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself. -
KAFKA_SSL_ENABLED
- Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true". -
KAFKA_CUSTOM_CERT
- The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string. -
KAFKA_SKIP_CUSTOM_CERT_VALIDATION
- Whether to skip the validation of the CA cert file or not. Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false". -
KAFKA_CLIENT_KEYSTORE
- The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional). -
KAFKA_CLIENT_KEYSTORE_PASSWORD
- The password to access the provided keystore (Optional). -
KAFKA_CLIENT_KEY_PASSWORD
- A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional). -
ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
- The encrypted version of the Kafka client keystore password (if the user has the Glue encrypt passwords setting selected). -
ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
- The encrypted version of the Kafka client key password (if the user has the Glue encrypt passwords setting selected). -
KAFKA_SASL_MECHANISM
-"SCRAM-SHA-512"
,"GSSAPI"
,"AWS_MSK_IAM"
, or"PLAIN"
. These are the supported SASL Mechanisms. -
KAFKA_SASL_PLAIN_USERNAME
- A plaintext username used to authenticate with the "PLAIN" mechanism. -
KAFKA_SASL_PLAIN_PASSWORD
- A plaintext password used to authenticate with the "PLAIN" mechanism. -
ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
- The encrypted version of the Kafka SASL PLAIN password (if the user has the Glue encrypt passwords setting selected). -
KAFKA_SASL_SCRAM_USERNAME
- A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism. -
KAFKA_SASL_SCRAM_PASSWORD
- A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism. -
ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
- The encrypted version of the Kafka SASL SCRAM password (if the user has the Glue encrypt passwords setting selected). -
KAFKA_SASL_SCRAM_SECRETS_ARN
- The Amazon Resource Name of a secret in Amazon Web Services Secrets Manager. -
KAFKA_SASL_GSSAPI_KEYTAB
- The S3 location of a Kerberoskeytab
file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab. -
KAFKA_SASL_GSSAPI_KRB5_CONF
- The S3 location of a Kerberoskrb5.conf
file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf. -
KAFKA_SASL_GSSAPI_SERVICE
- The Kerberos service name, as set withsasl.kerberos.service.name
in your Kafka Configuration. -
KAFKA_SASL_GSSAPI_PRINCIPAL
- The name of the Kerberos princial used by Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers. -
ROLE_ARN
- The role to be used for running queries. -
REGION
- The Amazon Web Services Region where queries will be run. -
WORKGROUP_NAME
- The name of an Amazon Redshift serverless workgroup or Amazon Athena workgroup in which queries will run. -
CLUSTER_IDENTIFIER
- The cluster identifier of an Amazon Redshift cluster in which queries will run. -
DATABASE
- The Amazon Redshift database that you are connecting to.
-
PhysicalConnectionRequirements
— (map
)The 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.
CreationTime
— (Date
)The timestamp of the time that this connection definition was created.
LastUpdatedTime
— (Date
)The timestamp of the last time the connection definition was updated.
LastUpdatedBy
— (String
)The user, group, or role that last updated this connection definition.
Status
— (String
)The status of the connection. Can be one of:
Possible values include:READY
,IN_PROGRESS
, orFAILED
."READY"
"IN_PROGRESS"
"FAILED"
StatusReason
— (String
)The reason for the connection status.
LastConnectionValidationTime
— (Date
)A timestamp of the time this connection was last validated.
AuthenticationConfiguration
— (map
)The authentication properties of the connection.
AuthenticationType
— (String
)A structure containing the authentication configuration.
Possible values include:"BASIC"
"OAUTH2"
"CUSTOM"
SecretArn
— (String
)The secret manager ARN to store credentials.
OAuth2Properties
— (map
)The properties for OAuth2 authentication.
OAuth2GrantType
— (String
)The OAuth2 grant type. For example,
Possible values include:AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
."AUTHORIZATION_CODE"
"CLIENT_CREDENTIALS"
"JWT_BEARER"
OAuth2ClientApplication
— (map
)The client application type. For example, AWS_MANAGED or USER_MANAGED.
UserManagedClientApplicationClientId
— (String
)The client application clientID if the ClientAppType is
USER_MANAGED
.AWSManagedClientApplicationReference
— (String
)The reference to the SaaS-side client app that is Amazon Web Services managed.
TokenUrl
— (String
)The URL of the provider's authentication server, to exchange an authorization code for an access token.
TokenUrlParametersMap
— (map<String>
)A map of parameters that are added to the token
GET
request.
NextToken
— (String
)A continuation token, if the list of connections returned does not include the last of the filtered connections.
-
(AWS.Response)
—
Returns:
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
)The 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. Thedata
object has the following properties:Crawler
— (map
)The metadata for the specified crawler.
Name
— (String
)The name of the crawler.
Role
— (String
)The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
Targets
— (map
)A collection of targets to crawl.
S3Targets
— (Array<map>
)Specifies Amazon Simple Storage Service (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.
ConnectionName
— (String
)The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize
— (Integer
)Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
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.
EnableAdditionalMetadata
— (Array<String>
)Specify a value of
RAWTYPES
orCOMMENTS
to enable additional metadata in table responses.RAWTYPES
provides the native-level datatype.COMMENTS
provides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
MongoDBTargets
— (Array<map>
)Specifies Amazon DocumentDB or MongoDB targets.
ConnectionName
— (String
)The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path
— (String
)The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.
DynamoDBTargets
— (Array<map>
)Specifies Amazon DynamoDB targets.
Path
— (String
)The name of the DynamoDB table to crawl.
scanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.scanRate
— (Float
)The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets
— (Array<map>
)Specifies Glue Data Catalog targets.
DatabaseName
— required — (String
)The name of the database to be synchronized.
Tables
— required — (Array<String>
)A list of the tables to be synchronized.
ConnectionName
— (String
)The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a
Catalog
connection type paired with aNETWORK
Connection type.EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
DeltaTargets
— (Array<map>
)Specifies Delta data store targets.
DeltaTables
— (Array<String>
)A list of the Amazon S3 paths to the Delta tables.
ConnectionName
— (String
)The name of the connection to use to connect to the Delta table target.
WriteManifest
— (Boolean
)Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable
— (Boolean
)Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets
— (Array<map>
)Specifies Apache Iceberg data store targets.
Paths
— (Array<String>
)One or more Amazon S3 paths that contains Iceberg metadata folders as
s3://bucket/prefix
.ConnectionName
— (String
)The name of the connection to use to connect to the Iceberg target.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets
— (Array<map>
)Specifies Apache Hudi data store targets.
Paths
— (Array<String>
)An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
ConnectionName
— (String
)The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
DatabaseName
— (String
)The name of the database in which the crawler's output is stored.
Description
— (String
)A description of the crawler.
Classifiers
— (Array<String>
)A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
RecrawlPolicy
— (map
)A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior
— (String
)Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of
CRAWL_EVERYTHING
specifies crawling the entire dataset again.A value of
CRAWL_NEW_FOLDERS_ONLY
specifies crawling only folders that were added since the last crawler run.A value of
Possible values include:CRAWL_EVENT_MODE
specifies crawling only the changes identified by Amazon S3 events."CRAWL_EVERYTHING"
"CRAWL_NEW_FOLDERS_ONLY"
"CRAWL_EVENT_MODE"
SchemaChangePolicy
— (map
)The policy that specifies update and delete behaviors for the crawler.
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"
LineageConfiguration
— (map
)A configuration that specifies whether data lineage is enabled for the crawler.
CrawlerLineageSettings
— (String
)Specifies whether data lineage is enabled for the crawler. Valid values are:
-
ENABLE: enables data lineage for the crawler
-
DISABLE: disables data lineage for the crawler
"ENABLE"
"DISABLE"
-
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 that the crawler was created.
LastUpdated
— (Date
)The time that 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 Setting crawler configuration options.
CrawlerSecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used by this crawler.LakeFormationConfiguration
— (map
)Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
UseLakeFormationCredentials
— (Boolean
)Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId
— (String
)Required for cross account crawls. For same account crawls as the target data, this can be left as null.
-
(AWS.Response)
—
Returns:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Crawlers
— (Array<map>
)A list of crawler metadata.
Name
— (String
)The name of the crawler.
Role
— (String
)The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
Targets
— (map
)A collection of targets to crawl.
S3Targets
— (Array<map>
)Specifies Amazon Simple Storage Service (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.
ConnectionName
— (String
)The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize
— (Integer
)Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
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.
EnableAdditionalMetadata
— (Array<String>
)Specify a value of
RAWTYPES
orCOMMENTS
to enable additional metadata in table responses.RAWTYPES
provides the native-level datatype.COMMENTS
provides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
MongoDBTargets
— (Array<map>
)Specifies Amazon DocumentDB or MongoDB targets.
ConnectionName
— (String
)The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path
— (String
)The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.
DynamoDBTargets
— (Array<map>
)Specifies Amazon DynamoDB targets.
Path
— (String
)The name of the DynamoDB table to crawl.
scanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.scanRate
— (Float
)The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets
— (Array<map>
)Specifies Glue Data Catalog targets.
DatabaseName
— required — (String
)The name of the database to be synchronized.
Tables
— required — (Array<String>
)A list of the tables to be synchronized.
ConnectionName
— (String
)The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a
Catalog
connection type paired with aNETWORK
Connection type.EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
DeltaTargets
— (Array<map>
)Specifies Delta data store targets.
DeltaTables
— (Array<String>
)A list of the Amazon S3 paths to the Delta tables.
ConnectionName
— (String
)The name of the connection to use to connect to the Delta table target.
WriteManifest
— (Boolean
)Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable
— (Boolean
)Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets
— (Array<map>
)Specifies Apache Iceberg data store targets.
Paths
— (Array<String>
)One or more Amazon S3 paths that contains Iceberg metadata folders as
s3://bucket/prefix
.ConnectionName
— (String
)The name of the connection to use to connect to the Iceberg target.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets
— (Array<map>
)Specifies Apache Hudi data store targets.
Paths
— (Array<String>
)An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
ConnectionName
— (String
)The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
DatabaseName
— (String
)The name of the database in which the crawler's output is stored.
Description
— (String
)A description of the crawler.
Classifiers
— (Array<String>
)A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
RecrawlPolicy
— (map
)A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior
— (String
)Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of
CRAWL_EVERYTHING
specifies crawling the entire dataset again.A value of
CRAWL_NEW_FOLDERS_ONLY
specifies crawling only folders that were added since the last crawler run.A value of
Possible values include:CRAWL_EVENT_MODE
specifies crawling only the changes identified by Amazon S3 events."CRAWL_EVERYTHING"
"CRAWL_NEW_FOLDERS_ONLY"
"CRAWL_EVENT_MODE"
SchemaChangePolicy
— (map
)The policy that specifies update and delete behaviors for the crawler.
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"
LineageConfiguration
— (map
)A configuration that specifies whether data lineage is enabled for the crawler.
CrawlerLineageSettings
— (String
)Specifies whether data lineage is enabled for the crawler. Valid values are:
-
ENABLE: enables data lineage for the crawler
-
DISABLE: disables data lineage for the crawler
"ENABLE"
"DISABLE"
-
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 that the crawler was created.
LastUpdated
— (Date
)The time that 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 Setting crawler configuration options.
CrawlerSecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used by this crawler.LakeFormationConfiguration
— (map
)Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
UseLakeFormationCredentials
— (Boolean
)Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId
— (String
)Required for cross account crawls. For same account crawls as the target data, this can be left as null.
NextToken
— (String
)A continuation token, if the returned list has not reached the end of those defined in this customer account.
-
(AWS.Response)
—
Returns:
getCustomEntityType(params = {}, callback) ⇒ AWS.Request
Retrieves the details of a custom pattern by specifying its name.
Service Reference:
Examples:
Calling the getCustomEntityType operation
var params = { Name: 'STRING_VALUE' /* required */ }; glue.getCustomEntityType(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 custom pattern that you want 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. Thedata
object has the following properties:Name
— (String
)The name of the custom pattern that you retrieved.
RegexString
— (String
)A regular expression string that is used for detecting sensitive data in a custom pattern.
ContextWords
— (Array<String>
)A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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. Thedata
object has the following properties:Database
— (map
)The definition of the specified database in the Data Catalog.
Name
— required — (String
)The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description
— (String
)A 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.
CreateTableDefaultPermissions
— (Array<map>
)Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
Principal
— (map
)The principal who is granted permissions.
DataLakePrincipalIdentifier
— (String
)An identifier for the Lake Formation principal.
Permissions
— (Array<String>
)The permissions that are granted to the principal.
TargetDatabase
— (map
)A
DatabaseIdentifier
structure that describes a target database for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the database resides.
DatabaseName
— (String
)The name of the catalog database.
Region
— (String
)Region of the target database.
CatalogId
— (String
)The ID of the Data Catalog in which the database resides.
FederatedDatabase
— (map
)A
FederatedDatabase
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
-
(AWS.Response)
—
Returns:
getDatabases(params = {}, callback) ⇒ AWS.Request
Retrieves all databases defined in a given Data Catalog.
Service Reference:
Examples:
Calling the getDatabases operation
var params = { AttributesToGet: [ NAME, /* more items */ ], CatalogId: 'STRING_VALUE', MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', ResourceShareType: FOREIGN | ALL | FEDERATED }; 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 provided, the Amazon Web Services 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.
ResourceShareType
— (String
)Allows you to specify that you want to list the databases shared with your account. The allowable values are
FEDERATED
,FOREIGN
orALL
.-
If set to
FEDERATED
, will list the federated databases (referencing an external entity) shared with your account. -
If set to
FOREIGN
, will list the databases shared with your account. -
If set to
ALL
, will list the databases shared with your account, as well as the databases in yor local account.
"FOREIGN"
"ALL"
"FEDERATED"
-
AttributesToGet
— (Array<String>
)Specifies the database fields returned by the
GetDatabases
call. This parameter doesn’t accept an empty list. The request must include theNAME
.
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. Thedata
object has the following properties:DatabaseList
— (Array<map>
)A list of
Database
objects from the specified catalog.Name
— required — (String
)The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description
— (String
)A 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.
CreateTableDefaultPermissions
— (Array<map>
)Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
Principal
— (map
)The principal who is granted permissions.
DataLakePrincipalIdentifier
— (String
)An identifier for the Lake Formation principal.
Permissions
— (Array<String>
)The permissions that are granted to the principal.
TargetDatabase
— (map
)A
DatabaseIdentifier
structure that describes a target database for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the database resides.
DatabaseName
— (String
)The name of the catalog database.
Region
— (String
)Region of the target database.
CatalogId
— (String
)The ID of the Data Catalog in which the database resides.
FederatedDatabase
— (map
)A
FederatedDatabase
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
NextToken
— (String
)A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
-
(AWS.Response)
—
Returns:
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 to retrieve the security configuration for. If none is provided, the Amazon Web Services 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. Thedata
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"
"SSE-KMS-WITH-SERVICE-ROLE"
SseAwsKmsKeyId
— (String
)The ID of the KMS key to use for encryption at rest.
CatalogEncryptionServiceRole
— (String
)The role that Glue assumes to encrypt and decrypt the Data Catalog objects on the caller's behalf.
ConnectionPasswordEncryption
— (map
)When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of
CreateConnection
orUpdateConnection
and store it in theENCRYPTED_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 ofGetConnection
andGetConnections
. This encryption takes effect independently from catalog encryption.AwsKmsKeyId
— (String
)An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of
CreateConnection
andUpdateConnection
needs at leastkms:Encrypt
permission on the specified 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.
-
(AWS.Response)
—
Returns:
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. Thedata
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 that 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.
-
(AWS.Response)
—
Returns:
getDataQualityModel(params = {}, callback) ⇒ AWS.Request
Retrieve the training status of the model along with more information (CompletedOn, StartedOn, FailureReason).
Service Reference:
Examples:
Calling the getDataQualityModel operation
var params = { ProfileId: 'STRING_VALUE', /* required */ StatisticId: 'STRING_VALUE' }; glue.getDataQualityModel(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: {})
—
StatisticId
— (String
)The Statistic ID.
ProfileId
— (String
)The Profile 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. Thedata
object has the following properties:Status
— (String
)The training status of the data quality model.
Possible values include:"RUNNING"
"SUCCEEDED"
"FAILED"
StartedOn
— (Date
)The timestamp when the data quality model training started.
CompletedOn
— (Date
)The timestamp when the data quality model training completed.
FailureReason
— (String
)The training failure reason.
-
(AWS.Response)
—
Returns:
getDataQualityModelResult(params = {}, callback) ⇒ AWS.Request
Retrieve a statistic's predictions for a given Profile ID.
Service Reference:
Examples:
Calling the getDataQualityModelResult operation
var params = { ProfileId: 'STRING_VALUE', /* required */ StatisticId: 'STRING_VALUE' /* required */ }; glue.getDataQualityModelResult(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: {})
—
StatisticId
— (String
)The Statistic ID.
ProfileId
— (String
)The Profile 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. Thedata
object has the following properties:CompletedOn
— (Date
)The timestamp when the data quality model training completed.
Model
— (Array<map>
)A list of
StatisticModelResult
LowerBound
— (Float
)The lower bound.
UpperBound
— (Float
)The upper bound.
PredictedValue
— (Float
)The predicted value.
ActualValue
— (Float
)The actual value.
Date
— (Date
)The date.
InclusionAnnotation
— (String
)The inclusion annotation.
Possible values include:"INCLUDE"
"EXCLUDE"
-
(AWS.Response)
—
Returns:
getDataQualityResult(params = {}, callback) ⇒ AWS.Request
Retrieves the result of a data quality rule evaluation.
Service Reference:
Examples:
Calling the getDataQualityResult operation
var params = { ResultId: 'STRING_VALUE' /* required */ }; glue.getDataQualityResult(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: {})
—
ResultId
— (String
)A unique result ID for the data quality result.
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. Thedata
object has the following properties:ResultId
— (String
)A unique result ID for the data quality result.
ProfileId
— (String
)The Profile ID for the data quality result.
Score
— (Float
)An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.
DataSource
— (map
)The table associated with the data quality result, if any.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
RulesetName
— (String
)The name of the ruleset associated with the data quality result.
EvaluationContext
— (String
)In the context of a job in Glue Studio, each node in the canvas is typically assigned some sort of name and data quality nodes will have names. In the case of multiple nodes, the
evaluationContext
can differentiate the nodes.StartedOn
— (Date
)The date and time when the run for this data quality result started.
CompletedOn
— (Date
)The date and time when the run for this data quality result was completed.
JobName
— (String
)The job name associated with the data quality result, if any.
JobRunId
— (String
)The job run ID associated with the data quality result, if any.
RulesetEvaluationRunId
— (String
)The unique run ID associated with the ruleset evaluation.
RuleResults
— (Array<map>
)A list of
DataQualityRuleResult
objects representing the results for each rule.Name
— (String
)The name of the data quality rule.
Description
— (String
)A description of the data quality rule.
EvaluationMessage
— (String
)An evaluation message.
Result
— (String
)A pass or fail status for the rule.
Possible values include:"PASS"
"FAIL"
"ERROR"
EvaluatedMetrics
— (map<Float>
)A map of metrics associated with the evaluation of the rule.
EvaluatedRule
— (String
)The evaluated rule.
AnalyzerResults
— (Array<map>
)A list of
DataQualityAnalyzerResult
objects representing the results for each analyzer.Name
— (String
)The name of the data quality analyzer.
Description
— (String
)A description of the data quality analyzer.
EvaluationMessage
— (String
)An evaluation message.
EvaluatedMetrics
— (map<Float>
)A map of metrics associated with the evaluation of the analyzer.
Observations
— (Array<map>
)A list of
DataQualityObservation
objects representing the observations generated after evaluating the rules and analyzers.Description
— (String
)A description of the data quality observation.
MetricBasedObservation
— (map
)An object of type
MetricBasedObservation
representing the observation that is based on evaluated data quality metrics.MetricName
— (String
)The name of the data quality metric used for generating the observation.
StatisticId
— (String
)The Statistic ID.
MetricValues
— (map
)An object of type
DataQualityMetricValues
representing the analysis of the data quality metric value.ActualValue
— (Float
)The actual value of the data quality metric.
ExpectedValue
— (Float
)The expected value of the data quality metric according to the analysis of historical data.
LowerLimit
— (Float
)The lower limit of the data quality metric value according to the analysis of historical data.
UpperLimit
— (Float
)The upper limit of the data quality metric value according to the analysis of historical data.
NewRules
— (Array<String>
)A list of new data quality rules generated as part of the observation based on the data quality metric value.
-
(AWS.Response)
—
Returns:
getDataQualityRuleRecommendationRun(params = {}, callback) ⇒ AWS.Request
Gets the specified recommendation run that was used to generate rules.
Service Reference:
Examples:
Calling the getDataQualityRuleRecommendationRun operation
var params = { RunId: 'STRING_VALUE' /* required */ }; glue.getDataQualityRuleRecommendationRun(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: {})
—
RunId
— (String
)The unique run identifier associated with this run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:RunId
— (String
)The unique run identifier associated with this run.
DataSource
— (map
)The data source (an Glue table) associated with this run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
Role
— (String
)An IAM role supplied to encrypt the results of the run.
NumberOfWorkers
— (Integer
)The number of
G.1X
workers to be used in the run. The default is 5.Timeout
— (Integer
)The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).Status
— (String
)The status for this run.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
ErrorString
— (String
)The error strings that are associated with the run.
StartedOn
— (Date
)The date and time when this run started.
LastModifiedOn
— (Date
)A timestamp. The last point in time when this data quality rule recommendation run was modified.
CompletedOn
— (Date
)The date and time when this run was completed.
ExecutionTime
— (Integer
)The amount of time (in seconds) that the run consumed resources.
RecommendedRuleset
— (String
)When a start rule recommendation run completes, it creates a recommended ruleset (a set of rules). This member has those rules in Data Quality Definition Language (DQDL) format.
CreatedRulesetName
— (String
)The name of the ruleset that was created by the run.
DataQualitySecurityConfiguration
— (String
)The name of the security configuration created with the data quality encryption option.
-
(AWS.Response)
—
Returns:
getDataQualityRuleset(params = {}, callback) ⇒ AWS.Request
Returns an existing ruleset by identifier or name.
Service Reference:
Examples:
Calling the getDataQualityRuleset operation
var params = { Name: 'STRING_VALUE' /* required */ }; glue.getDataQualityRuleset(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
Name
— (String
)The name of the ruleset.
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. Thedata
object has the following properties:Name
— (String
)The name of the ruleset.
Description
— (String
)A description of the ruleset.
Ruleset
— (String
)A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
TargetTable
— (map
)The name and database name of the target table.
TableName
— required — (String
)The name of the Glue table.
DatabaseName
— required — (String
)The name of the database where the Glue table exists.
CatalogId
— (String
)The catalog id where the Glue table exists.
CreatedOn
— (Date
)A timestamp. The time and date that this data quality ruleset was created.
LastModifiedOn
— (Date
)A timestamp. The last point in time when this data quality ruleset was modified.
RecommendationRunId
— (String
)When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
DataQualitySecurityConfiguration
— (String
)The name of the security configuration created with the data quality encryption option.
-
(AWS.Response)
—
Returns:
getDataQualityRulesetEvaluationRun(params = {}, callback) ⇒ AWS.Request
Retrieves a specific run where a ruleset is evaluated against a data source.
Service Reference:
Examples:
Calling the getDataQualityRulesetEvaluationRun operation
var params = { RunId: 'STRING_VALUE' /* required */ }; glue.getDataQualityRulesetEvaluationRun(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: {})
—
RunId
— (String
)The unique run identifier associated with this run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:RunId
— (String
)The unique run identifier associated with this run.
DataSource
— (map
)The data source (an Glue table) associated with this evaluation run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
Role
— (String
)An IAM role supplied to encrypt the results of the run.
NumberOfWorkers
— (Integer
)The number of
G.1X
workers to be used in the run. The default is 5.Timeout
— (Integer
)The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).AdditionalRunOptions
— (map
)Additional run options you can specify for an evaluation run.
CloudWatchMetricsEnabled
— (Boolean
)Whether or not to enable CloudWatch metrics.
ResultsS3Prefix
— (String
)Prefix for Amazon S3 to store results.
CompositeRuleEvaluationMethod
— (String
)Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
Possible values include:"COLUMN"
"ROW"
Status
— (String
)The status for this run.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
ErrorString
— (String
)The error strings that are associated with the run.
StartedOn
— (Date
)The date and time when this run started.
LastModifiedOn
— (Date
)A timestamp. The last point in time when this data quality rule recommendation run was modified.
CompletedOn
— (Date
)The date and time when this run was completed.
ExecutionTime
— (Integer
)The amount of time (in seconds) that the run consumed resources.
RulesetNames
— (Array<String>
)A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.
ResultIds
— (Array<String>
)A list of result IDs for the data quality results for the run.
AdditionalDataSources
— (map<map>
)A map of reference strings to additional data sources you can specify for an evaluation run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
-
(AWS.Response)
—
Returns:
getDevEndpoint(params = {}, callback) ⇒ AWS.Request
Retrieves information about a specified development endpoint.
Note: When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, 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
to retrieve information 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. Thedata
object has the following properties:DevEndpoint
— (map
)A
DevEndpoint
definition.EndpointName
— (String
)The name of the
DevEndpoint
.RoleArn
— (String
)The Amazon Resource Name (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 theDevEndpoint
is created within one. ThePrivateAddress
field is present only when you create theDevEndpoint
within your VPC.ZeppelinRemoteSparkInterpreterPort
— (Integer
)The Apache Zeppelin port for the remote Apache Spark interpreter.
PublicAddress
— (String
)The public IP address used by this
DevEndpoint
. ThePublicAddress
field is present only when you create a non-virtual private cloud (VPC)DevEndpoint
.Status
— (String
)The current status of this
DevEndpoint
.WorkerType
— (String
)The type of predefined worker that is allocated to the development endpoint. 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
Possible values include:G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk."Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
GlueVersion
— (String
)Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated to the development endpoint.The maximum number of workers you can define are 299 for
G.1X
, and 149 forG.2X
.NumberOfNodes
— (Integer
)The number of Glue Data Processing Units (DPUs) allocated to this
DevEndpoint
.AvailabilityZone
— (String
)The Amazon Web Services Availability Zone where this
DevEndpoint
is located.VpcId
— (String
)The ID of the virtual private cloud (VPC) used by this
DevEndpoint
.ExtraPythonLibsS3Path
— (String
)The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
DevEndpoint
. Multiple values must be complete paths separated by a comma.Note: You can only use pure Python libraries with aDevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.ExtraJarsS3Path
— (String
)The path to one or more Java
.jar
files in an S3 bucket that should be loaded in yourDevEndpoint
.Note: You can only use pure Java/Scala libraries with aDevEndpoint
.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 because the recommended attribute to use is public keys.PublicKeys
— (Array<String>
)A list of public keys to be used by the
DevEndpoints
for authentication. Using 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 theUpdateDevEndpoint
API operation with the public key content in thedeletePublicKeys
attribute, and the list of new keys in theaddPublicKeys
attribute.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with thisDevEndpoint
.Arguments
— (map<String>
)A map of arguments used to configure the
DevEndpoint
.Valid arguments are:
-
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.-
-
(AWS.Response)
—
Returns:
getDevEndpoints(params = {}, callback) ⇒ AWS.Request
Retrieves all the development endpoints in this Amazon Web Services account.
Note: When you create a development endpoint in a virtual private cloud (VPC), Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, 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. Thedata
object has the following properties:DevEndpoints
— (Array<map>
)A list of
DevEndpoint
definitions.EndpointName
— (String
)The name of the
DevEndpoint
.RoleArn
— (String
)The Amazon Resource Name (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 theDevEndpoint
is created within one. ThePrivateAddress
field is present only when you create theDevEndpoint
within your VPC.ZeppelinRemoteSparkInterpreterPort
— (Integer
)The Apache Zeppelin port for the remote Apache Spark interpreter.
PublicAddress
— (String
)The public IP address used by this
DevEndpoint
. ThePublicAddress
field is present only when you create a non-virtual private cloud (VPC)DevEndpoint
.Status
— (String
)The current status of this
DevEndpoint
.WorkerType
— (String
)The type of predefined worker that is allocated to the development endpoint. 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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Known issue: when a development endpoint is created with the
Possible values include:G.2X
WorkerType
configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk."Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
GlueVersion
— (String
)Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Development endpoints that are created without specifying a Glue version default to Glue 0.9.
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated to the development endpoint.The maximum number of workers you can define are 299 for
G.1X
, and 149 forG.2X
.NumberOfNodes
— (Integer
)The number of Glue Data Processing Units (DPUs) allocated to this
DevEndpoint
.AvailabilityZone
— (String
)The Amazon Web Services Availability Zone where this
DevEndpoint
is located.VpcId
— (String
)The ID of the virtual private cloud (VPC) used by this
DevEndpoint
.ExtraPythonLibsS3Path
— (String
)The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
DevEndpoint
. Multiple values must be complete paths separated by a comma.Note: You can only use pure Python libraries with aDevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.ExtraJarsS3Path
— (String
)The path to one or more Java
.jar
files in an S3 bucket that should be loaded in yourDevEndpoint
.Note: You can only use pure Java/Scala libraries with aDevEndpoint
.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 because the recommended attribute to use is public keys.PublicKeys
— (Array<String>
)A list of public keys to be used by the
DevEndpoints
for authentication. Using 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 theUpdateDevEndpoint
API operation with the public key content in thedeletePublicKeys
attribute, and the list of new keys in theaddPublicKeys
attribute.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with thisDevEndpoint
.Arguments
— (map<String>
)A map of arguments used to configure the
DevEndpoint
.Valid arguments are:
-
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.-
NextToken
— (String
)A continuation token, if not all
DevEndpoint
definitions have yet been returned.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Job
— (map
)The requested job definition.
Name
— (String
)The name you assign to this job definition.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Description
— (String
)A description of the job.
LogUri
— (String
)This field is reserved for future use.
Role
— (String
)The name or Amazon Resource Name (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 runs this job.Name
— (String
)The name of the job command. For an Apache Spark ETL job, this must be
glueetl
. For a Python shell job, it must bepythonshell
. For an Apache Spark streaming ETL job, this must begluestreaming
. For a Ray job, this must beglueray
.ScriptLocation
— (String
)Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
PythonVersion
— (String
)The Python version being used to run a Python shell job. Allowed values are 2 or 3.
Runtime
— (String
)In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
DefaultArguments
— (map<String>
)The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
NonOverridableArguments
— (map<String>
)Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
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 Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; 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 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) for batch jobs.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CodeGenConfigurationNodes
— (map<map>
)The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
AthenaConnectorSource
— (map
)Specifies a connector to an Amazon Athena data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
ConnectionTable
— (String
)The name of the table in the data source.
SchemaName
— required — (String
)The name of the Cloudwatch log group to read from. For example,
/aws-glue/jobs/output
.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom Athena source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
JDBCConnectorSource
— (map
)Specifies a connector to a JDBC data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
AdditionalOptions
— (map
)Additional connection options for the connector.
FilterPredicate
— (String
)Extra condition clause to filter data from source. For example:
BillingCity='Mountain View'
When using a query instead of a table name, you should validate that the query works with the specified
filterPredicate
.PartitionColumn
— (String
)The name of an integer column that is used for partitioning. This option works only when it's included with
lowerBound
,upperBound
, andnumPartitions
. This option works the same way as in the Spark SQL JDBC reader.LowerBound
— (Integer
)The minimum value of
partitionColumn
that is used to decide partition stride.UpperBound
— (Integer
)The maximum value of
partitionColumn
that is used to decide partition stride.NumPartitions
— (Integer
)The number of partitions. This value, along with
lowerBound
(inclusive) andupperBound
(exclusive), form partition strides for generatedWHERE
clause expressions that are used to split thepartitionColumn
.JobBookmarkKeys
— (Array<String>
)The name of the job bookmark keys on which to sort.
JobBookmarkKeysSortOrder
— (String
)Specifies an ascending or descending sort order.
DataTypeMapping
— (map<String>
)Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option
"dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC typeFLOAT
into the JavaString
type by calling theResultSet.getString()
method of the driver, and uses it to build the Glue record. TheResultSet
object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
ConnectionTable
— (String
)The name of the table in the data source.
Query
— (String
)The table or SQL query to get the data from. You can specify either
ConnectionTable
orquery
, but not both.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom JDBC source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorSource
— (map
)Specifies a connector to an Apache Spark data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies data schema for the custom spark source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogSource
— (map
)Specifies a data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
RedshiftSource
— (map
)Specifies an Amazon Redshift data store.
Name
— required — (String
)The name of the Amazon Redshift data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
S3CatalogSource
— (map
)Specifies an Amazon S3 data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
S3CsvSource
— (map
)Specifies a command-separated value (CSV) data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
Separator
— required — (String
)Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
Possible values include:"comma"
"ctrla"
"pipe"
"semicolon"
"tab"
Escaper
— (String
)Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is
none
. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n
,\r
,\t
, and\0
).QuoteChar
— required — (String
)Specifies the character to use for quoting. The default is a double quote:
Possible values include:'"'
. Set this to-1
to turn off quoting entirely."quote"
"quillemet"
"single_quote"
"disabled"
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.WithHeader
— (Boolean
)A Boolean value that specifies whether to treat the first line as a header. The default value is
False
.WriteHeader
— (Boolean
)A Boolean value that specifies whether to write the header to output. The default value is
True
.SkipFirst
— (Boolean
)A Boolean value that specifies whether to skip the first data line. The default value is
False
.OptimizePerformance
— (Boolean
)A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 CSV source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3JsonSource
— (map
)Specifies a JSON data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
JsonPath
— (String
)A JsonPath string defining the JSON data.
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 JSON source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3ParquetSource
— (map
)Specifies an Apache Parquet data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 Parquet source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
RelationalCatalogSource
— (map
)Specifies a relational catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
DynamoDBCatalogSource
— (map
)Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
JDBCConnectorTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectionTable
— required — (String
)The name of the table in the data target.
ConnectorName
— required — (String
)The name of a connector that will be used.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the JDBC target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorTarget
— (map
)Specifies a target that uses an Apache Spark connector.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of a connection for an Apache Spark connector.
ConnectorName
— required — (String
)The name of an Apache Spark connector.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom spark target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogTarget
— (map
)Specifies a target that uses a Glue Data Catalog table.
Name
— required — (String
)The name of your data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)The partition keys used to distribute data across multiple partitions or shards based on a specific key or set of key.
Database
— required — (String
)The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
Table
— required — (String
)The table that defines the schema of your output data. This table must already exist in the Data Catalog.
RedshiftTarget
— (map
)Specifies a target that uses Amazon Redshift.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
UpsertRedshiftOptions
— (map
)The set of options to configure an upsert operation when writing to a Redshift target.
TableLocation
— (String
)The physical location of the Redshift table.
ConnectionName
— (String
)The name of the connection to use to write to Redshift.
UpsertKeys
— (Array<String>
)The keys used to determine whether to perform an update or insert.
S3CatalogTarget
— (map
)Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3GlueParquetTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
S3DirectTarget
— (map
)Specifies a data target that writes to Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
"gzip"
and"bzip"
).Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
ApplyMapping
— (map
)Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Mapping
— required — (Array<map>
)Specifies the mapping of data property keys in the data source to data property keys in the data target.
ToKey
— (String
)After the apply mapping, what the name of the column should be. Can be the same as
FromPath
.FromPath
— (Array<String>
)The table or column to be modified.
FromType
— (String
)The type of the data to be modified.
ToType
— (String
)The data type that the data is to be modified to.
Dropped
— (Boolean
)If true, then the column is removed.
SelectFields
— (map
)Specifies a transform that chooses the data property keys that you want to keep.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
DropFields
— (map
)Specifies a transform that chooses the data property keys that you want to drop.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
RenameField
— (map
)Specifies a transform that renames a single data property key.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
SourcePath
— required — (Array<String>
)A JSON path to a variable in the data structure for the source data.
TargetPath
— required — (Array<String>
)A JSON path to a variable in the data structure for the target data.
Spigot
— (map
)Specifies a transform that writes samples of the data to an Amazon S3 bucket.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Path
— required — (String
)A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
Topk
— (Integer
)Specifies a number of records to write starting from the beginning of the dataset.
Prob
— (Float
)The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
Join
— (map
)Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
JoinType
— required — (String
)Specifies the type of join to be performed on the datasets.
Possible values include:"equijoin"
"left"
"right"
"outer"
"leftsemi"
"leftanti"
Columns
— required — (Array<map>
)A list of the two columns to be joined.
From
— required — (String
)The column to be joined.
Keys
— required — (Array<Array<String>>
)The key of the column to be joined.
SplitFields
— (map
)Specifies a transform that splits data property keys into two
DynamicFrames
. The output is a collection ofDynamicFrames
: one with selected data property keys, and one with the remaining data property keys.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
SelectFromCollection
— (map
)Specifies a transform that chooses one
DynamicFrame
from a collection ofDynamicFrames
. The output is the selectedDynamicFrame
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Index
— required — (Integer
)The index for the DynamicFrame to be selected.
FillMissingValues
— (map
)Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
ImputedPath
— required — (String
)A JSON path to a variable in the data structure for the dataset that is imputed.
FilledPath
— (String
)A JSON path to a variable in the data structure for the dataset that is filled.
Filter
— (map
)Specifies a transform that splits a dataset into two, based on a filter condition.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
LogicalOperator
— required — (String
)The operator used to filter rows by comparing the key value to a specified value.
Possible values include:"AND"
"OR"
Filters
— required — (Array<map>
)Specifies a filter expression.
Operation
— required — (String
)The type of operation to perform in the expression.
Possible values include:"EQ"
"LT"
"GT"
"LTE"
"GTE"
"REGEX"
"ISNULL"
Negated
— (Boolean
)Whether the expression is to be negated.
Values
— required — (Array<map>
)A list of filter values.
Type
— required — (String
)The type of filter value.
Possible values include:"COLUMNEXTRACTED"
"CONSTANT"
Value
— required — (Array<String>
)The value to be associated.
CustomCode
— (map
)Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Code
— required — (String
)The custom code that is used to perform the data transformation.
ClassName
— required — (String
)The name defined for the custom code node class.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom code transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkSQL
— (map
)Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single
DynamicFrame
.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
SqlQuery
— required — (String
)A SQL query that must use Spark SQL syntax and return a single data set.
SqlAliases
— required — (Array<map>
)A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify
From
as MyDataSource, andAlias
as SqlName, then in your SQL you can do:select * from SqlName
and that gets data from MyDataSource.
From
— required — (String
)A table, or a column in a table.
Alias
— required — (String
)A temporary name given to a table, or a column in a table.
OutputSchemas
— (Array<map>
)Specifies the data schema for the SparkSQL transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
DirectKinesisSource
— (map
)Specifies a direct Amazon Kinesis data source.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DirectKafkaSource
— (map
)Specifies an Apache Kafka data store.
Name
— required — (String
)The name of the data store.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKinesisSource
— (map
)Specifies a Kinesis data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKafkaSource
— (map
)Specifies an Apache Kafka data store in the Data Catalog.
Name
— required — (String
)The name of the data store.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DropNullFields
— (map
)Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
NullCheckBoxList
— (map
)A structure that represents whether certain values are recognized as null values for removal.
IsEmpty
— (Boolean
)Specifies that an empty string is considered as a null value.
IsNullString
— (Boolean
)Specifies that a value spelling out the word 'null' is considered as a null value.
IsNegOne
— (Boolean
)Specifies that an integer value of -1 is considered as a null value.
NullTextList
— (Array<map>
)A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The
DropNullFields
transform removes custom null values only if both the value of the null placeholder and the datatype match the data.Value
— required — (String
)The value of the null placeholder.
Datatype
— required — (map
)The datatype of the value.
Id
— required — (String
)The datatype of the value.
Label
— required — (String
)A label assigned to the datatype.
Merge
— (map
)Specifies a transform that merges a
DynamicFrame
with a stagingDynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Source
— required — (String
)The source
DynamicFrame
that will be merged with a stagingDynamicFrame
.PrimaryKeys
— required — (Array<Array<String>>
)The list of primary key fields to match records from the source and staging dynamic frames.
Union
— (map
)Specifies a transform that combines the rows from two or more datasets into a single result.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
UnionType
— required — (String
)Indicates the type of Union transform.
Specify
ALL
to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.Specify
Possible values include:DISTINCT
to remove duplicate rows in the resulting DynamicFrame."ALL"
"DISTINCT"
PIIDetection
— (map
)Specifies a transform that identifies, removes or masks PII data.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
PiiType
— required — (String
)Indicates the type of PIIDetection transform.
Possible values include:"RowAudit"
"RowMasking"
"ColumnAudit"
"ColumnMasking"
EntityTypesToDetect
— required — (Array<String>
)Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
OutputColumnName
— (String
)Indicates the output column name that will contain any entity type detected in that row.
SampleFraction
— (Float
)Indicates the fraction of the data to sample when scanning for PII entities.
ThresholdFraction
— (Float
)Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
MaskValue
— (String
)Indicates the value that will replace the detected entity.
Aggregate
— (map
)Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)Specifies the fields and rows to use as inputs for the aggregate transform.
Groups
— required — (Array<Array<String>>
)Specifies the fields to group by.
Aggs
— required — (Array<map>
)Specifies the aggregate functions to be performed on specified fields.
Column
— required — (Array<String>
)Specifies the column on the data set on which the aggregation function will be applied.
AggFunc
— required — (String
)Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
Possible values include:"avg"
"countDistinct"
"count"
"first"
"last"
"kurtosis"
"max"
"min"
"skewness"
"stddev_samp"
"stddev_pop"
"sum"
"sumDistinct"
"var_samp"
"var_pop"
DropDuplicates
— (map
)Specifies a transform that removes rows of repeating data from a data set.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Columns
— (Array<Array<String>>
)The name of the columns to be merged or removed if repeating.
GovernedCatalogTarget
— (map
)Specifies a data target that writes to a goverened catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the governed catalog.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
GovernedCatalogSource
— (map
)Specifies a data source in a goverened Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
MicrosoftSQLServerCatalogSource
— (map
)Specifies a Microsoft SQL server data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MySQLCatalogSource
— (map
)Specifies a MySQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
OracleSQLCatalogSource
— (map
)Specifies an Oracle data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
PostgreSQLCatalogSource
— (map
)Specifies a PostgresSQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MicrosoftSQLServerCatalogTarget
— (map
)Specifies a target that uses Microsoft SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
MySQLCatalogTarget
— (map
)Specifies a target that uses MySQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
OracleSQLCatalogTarget
— (map
)Specifies a target that uses Oracle SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
PostgreSQLCatalogTarget
— (map
)Specifies a target that uses Postgres SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
DynamicTransform
— (map
)Specifies a custom visual transform created by a user.
Name
— required — (String
)Specifies the name of the dynamic transform.
TransformName
— required — (String
)Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
Inputs
— required — (Array<String>
)Specifies the inputs for the dynamic transform that are required.
Parameters
— (Array<map>
)Specifies the parameters of the dynamic transform.
Name
— required — (String
)Specifies the name of the parameter in the config file of the dynamic transform.
Type
— required — (String
)Specifies the parameter type in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
ValidationRule
— (String
)Specifies the validation rule in the config file of the dynamic transform.
ValidationMessage
— (String
)Specifies the validation message in the config file of the dynamic transform.
Value
— (Array<String>
)Specifies the value of the parameter in the config file of the dynamic transform.
ListType
— (String
)Specifies the list type of the parameter in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
IsOptional
— (Boolean
)Specifies whether the parameter is optional or not in the config file of the dynamic transform.
FunctionName
— required — (String
)Specifies the name of the function of the dynamic transform.
Path
— required — (String
)Specifies the path of the dynamic transform source and config files.
Version
— (String
)This field is not used and will be deprecated in future release.
OutputSchemas
— (Array<map>
)Specifies the data schema for the dynamic transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
EvaluateDataQuality
— (map
)Specifies your data quality evaluation criteria.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
Output
— (String
)The output of your data quality evaluation.
Possible values include:"PrimaryInput"
"EvaluationResults"
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
S3CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiSource
— (map
)Specifies a Hudi data source stored in Amazon S3.
Name
— required — (String
)The name of the Hudi source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiCatalogTarget
— (map
)Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3HudiDirectTarget
— (map
)Specifies a target that writes to a Hudi data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Path
— required — (String
)The Amazon S3 path of your Hudi data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"lzo"
"uncompressed"
"snappy"
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
DirectJDBCSource
— (map
)Specifies the direct JDBC source connection.
Name
— required — (String
)The name of the JDBC source connection.
Database
— required — (String
)The database of the JDBC source connection.
Table
— required — (String
)The table of the JDBC source connection.
ConnectionName
— required — (String
)The connection name of the JDBC source.
ConnectionType
— required — (String
)The connection type of the JDBC source.
Possible values include:"sqlserver"
"mysql"
"oracle"
"postgresql"
"redshift"
RedshiftTmpDir
— (String
)The temp directory of the JDBC Redshift source.
S3CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaSource
— (map
)Specifies a Delta Lake data source stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaCatalogTarget
— (map
)Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3DeltaDirectTarget
— (map
)Specifies a target that writes to a Delta Lake data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)The Amazon S3 path of your Delta Lake data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."uncompressed"
"snappy"
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
AmazonRedshiftSource
— (map
)Specifies a target that writes to a data source in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift source.
Data
— (map
)Specifies the data of the Amazon Reshift source node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AmazonRedshiftTarget
— (map
)Specifies a target that writes to a data target in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift target.
Data
— (map
)Specifies the data of the Amazon Redshift target node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
EvaluateDataQualityMultiFrame
— (map
)Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation. The first input in this list is the primary data source.
AdditionalDataSources
— (map<String>
)The aliases of all data sources except primary.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
AdditionalOptions
— (map<String>
)Options to configure runtime behavior of the transform.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
Recipe
— (map
)Specifies a Glue DataBrew recipe node.
Name
— required — (String
)The name of the Glue Studio node.
Inputs
— required — (Array<String>
)The nodes that are inputs to the recipe node, identified by id.
RecipeReference
— (map
)A reference to the DataBrew recipe used by the node.
RecipeArn
— required — (String
)The ARN of the DataBrew recipe.
RecipeVersion
— required — (String
)The RecipeVersion of the DataBrew recipe.
RecipeSteps
— (Array<map>
)Transform steps used in the recipe node.
Action
— required — (map
)The transformation action of the recipe step.
Operation
— required — (String
)The operation of the recipe action.
Parameters
— (map<String>
)The parameters of the recipe action.
ConditionExpressions
— (Array<map>
)The condition expressions for the recipe step.
Condition
— required — (String
)The condition of the condition expression.
Value
— (String
)The value of the condition expression.
TargetColumn
— required — (String
)The target column of the condition expressions.
SnowflakeSource
— (map
)Specifies a Snowflake data source.
Name
— required — (String
)The name of the Snowflake data source.
Data
— required — (map
)Configuration for the Snowflake data source.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
OutputSchemas
— (Array<map>
)Specifies user-defined schemas for your output data.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SnowflakeTarget
— (map
)Specifies a target that writes to a Snowflake data source.
Name
— required — (String
)The name of the Snowflake target.
Data
— required — (map
)Specifies the data of the Snowflake target node.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ConnectorDataSource
— (map
)Specifies a source generated with standard connection options.
Name
— required — (String
)The name of this source node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
OutputSchemas
— (Array<map>
)Specifies the data schema for this source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
ConnectorDataTarget
— (map
)Specifies a target generated with standard connection options.
Name
— required — (String
)The name of this target node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
SourceControlDetails
— (map
)The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Provider
— (String
)The provider for the remote repository.
Possible values include:"GITHUB"
"GITLAB"
"BITBUCKET"
"AWS_CODE_COMMIT"
Repository
— (String
)The name of the remote repository that contains the job artifacts.
Owner
— (String
)The owner of the remote repository that contains the job artifacts.
Branch
— (String
)An optional branch in the remote repository.
Folder
— (String
)An optional folder in the remote repository.
LastCommitId
— (String
)The last commit ID for a commit in the remote repository.
AuthStrategy
— (String
)The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
Possible values include:"PERSONAL_ACCESS_TOKEN"
"AWS_SECRETS_MANAGER"
AuthToken
— (String
)The value of an authorization token.
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job.
-
(AWS.Response)
—
Returns:
getJobBookmark(params = {}, callback) ⇒ AWS.Request
Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
Service Reference:
Examples:
Calling the getJobBookmark operation
var params = { JobName: 'STRING_VALUE', /* required */ RunId: 'STRING_VALUE' }; glue.getJobBookmark(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.
RunId
— (String
)The unique run identifier associated with this job run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:JobBookmarkEntry
— (map
)A structure that defines a point that a job can resume processing.
JobName
— (String
)The name of the job in question.
Version
— (Integer
)The version of the job.
Run
— (Integer
)The run ID number.
Attempt
— (Integer
)The attempt ID number.
PreviousRunId
— (String
)The unique run identifier associated with the previous job run.
RunId
— (String
)The run ID number.
JobBookmark
— (String
)The bookmark itself.
-
(AWS.Response)
—
Returns:
getJobRun(params = {}, callback) ⇒ AWS.Request
Retrieves the metadata for a given job run. Job run history is accessible for 90 days for your workflow and 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. Thedata
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 theStartJobRun
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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
StartedOn
— (Date
)The date and time at which this job run was started.
LastModifiedOn
— (Date
)The last time that this job run was modified.
CompletedOn
— (Date
)The date and time that this job run completed.
JobRunState
— (String
)The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs 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 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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 Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption isNONE
. If you add a role name andSecurityConfiguration
name (in other words,/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds
— (Float
)This field can be set for either job runs with execution class
FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X
, 2 forG.2X
, or 0.25 forG.025X
workers). This value may be different than theexecutionEngineRuntime
*MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than theMaxCapacity
. Therefore, it is possible that the value ofDPUSeconds
is less thanexecutionEngineRuntime
*MaxCapacity
.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job run.
StateDetail
— (String
)This field holds details that pertain to the state of a job run. The field is nullable.
For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:JobRuns
— (Array<map>
)A list of job-run metadata 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 theStartJobRun
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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
StartedOn
— (Date
)The date and time at which this job run was started.
LastModifiedOn
— (Date
)The last time that this job run was modified.
CompletedOn
— (Date
)The date and time that this job run completed.
JobRunState
— (String
)The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs 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 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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 Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption isNONE
. If you add a role name andSecurityConfiguration
name (in other words,/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds
— (Float
)This field can be set for either job runs with execution class
FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X
, 2 forG.2X
, or 0.25 forG.025X
workers). This value may be different than theexecutionEngineRuntime
*MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than theMaxCapacity
. Therefore, it is possible that the value ofDPUSeconds
is less thanexecutionEngineRuntime
*MaxCapacity
.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job run.
StateDetail
— (String
)This field holds details that pertain to the state of a job run. The field is nullable.
For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.
NextToken
— (String
)A continuation token, if not all requested job runs have been returned.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Jobs
— (Array<map>
)A list of job definitions.
Name
— (String
)The name you assign to this job definition.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Description
— (String
)A description of the job.
LogUri
— (String
)This field is reserved for future use.
Role
— (String
)The name or Amazon Resource Name (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 runs this job.Name
— (String
)The name of the job command. For an Apache Spark ETL job, this must be
glueetl
. For a Python shell job, it must bepythonshell
. For an Apache Spark streaming ETL job, this must begluestreaming
. For a Ray job, this must beglueray
.ScriptLocation
— (String
)Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
PythonVersion
— (String
)The Python version being used to run a Python shell job. Allowed values are 2 or 3.
Runtime
— (String
)In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
DefaultArguments
— (map<String>
)The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
NonOverridableArguments
— (map<String>
)Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
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 Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; 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 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) for batch jobs.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CodeGenConfigurationNodes
— (map<map>
)The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
AthenaConnectorSource
— (map
)Specifies a connector to an Amazon Athena data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
ConnectionTable
— (String
)The name of the table in the data source.
SchemaName
— required — (String
)The name of the Cloudwatch log group to read from. For example,
/aws-glue/jobs/output
.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom Athena source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
JDBCConnectorSource
— (map
)Specifies a connector to a JDBC data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
AdditionalOptions
— (map
)Additional connection options for the connector.
FilterPredicate
— (String
)Extra condition clause to filter data from source. For example:
BillingCity='Mountain View'
When using a query instead of a table name, you should validate that the query works with the specified
filterPredicate
.PartitionColumn
— (String
)The name of an integer column that is used for partitioning. This option works only when it's included with
lowerBound
,upperBound
, andnumPartitions
. This option works the same way as in the Spark SQL JDBC reader.LowerBound
— (Integer
)The minimum value of
partitionColumn
that is used to decide partition stride.UpperBound
— (Integer
)The maximum value of
partitionColumn
that is used to decide partition stride.NumPartitions
— (Integer
)The number of partitions. This value, along with
lowerBound
(inclusive) andupperBound
(exclusive), form partition strides for generatedWHERE
clause expressions that are used to split thepartitionColumn
.JobBookmarkKeys
— (Array<String>
)The name of the job bookmark keys on which to sort.
JobBookmarkKeysSortOrder
— (String
)Specifies an ascending or descending sort order.
DataTypeMapping
— (map<String>
)Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option
"dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC typeFLOAT
into the JavaString
type by calling theResultSet.getString()
method of the driver, and uses it to build the Glue record. TheResultSet
object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
ConnectionTable
— (String
)The name of the table in the data source.
Query
— (String
)The table or SQL query to get the data from. You can specify either
ConnectionTable
orquery
, but not both.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom JDBC source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorSource
— (map
)Specifies a connector to an Apache Spark data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies data schema for the custom spark source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogSource
— (map
)Specifies a data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
RedshiftSource
— (map
)Specifies an Amazon Redshift data store.
Name
— required — (String
)The name of the Amazon Redshift data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
S3CatalogSource
— (map
)Specifies an Amazon S3 data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
S3CsvSource
— (map
)Specifies a command-separated value (CSV) data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
Separator
— required — (String
)Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
Possible values include:"comma"
"ctrla"
"pipe"
"semicolon"
"tab"
Escaper
— (String
)Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is
none
. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n
,\r
,\t
, and\0
).QuoteChar
— required — (String
)Specifies the character to use for quoting. The default is a double quote:
Possible values include:'"'
. Set this to-1
to turn off quoting entirely."quote"
"quillemet"
"single_quote"
"disabled"
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.WithHeader
— (Boolean
)A Boolean value that specifies whether to treat the first line as a header. The default value is
False
.WriteHeader
— (Boolean
)A Boolean value that specifies whether to write the header to output. The default value is
True
.SkipFirst
— (Boolean
)A Boolean value that specifies whether to skip the first data line. The default value is
False
.OptimizePerformance
— (Boolean
)A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 CSV source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3JsonSource
— (map
)Specifies a JSON data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
JsonPath
— (String
)A JsonPath string defining the JSON data.
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 JSON source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3ParquetSource
— (map
)Specifies an Apache Parquet data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 Parquet source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
RelationalCatalogSource
— (map
)Specifies a relational catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
DynamoDBCatalogSource
— (map
)Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
JDBCConnectorTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectionTable
— required — (String
)The name of the table in the data target.
ConnectorName
— required — (String
)The name of a connector that will be used.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the JDBC target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorTarget
— (map
)Specifies a target that uses an Apache Spark connector.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of a connection for an Apache Spark connector.
ConnectorName
— required — (String
)The name of an Apache Spark connector.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom spark target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogTarget
— (map
)Specifies a target that uses a Glue Data Catalog table.
Name
— required — (String
)The name of your data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)The partition keys used to distribute data across multiple partitions or shards based on a specific key or set of key.
Database
— required — (String
)The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
Table
— required — (String
)The table that defines the schema of your output data. This table must already exist in the Data Catalog.
RedshiftTarget
— (map
)Specifies a target that uses Amazon Redshift.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
UpsertRedshiftOptions
— (map
)The set of options to configure an upsert operation when writing to a Redshift target.
TableLocation
— (String
)The physical location of the Redshift table.
ConnectionName
— (String
)The name of the connection to use to write to Redshift.
UpsertKeys
— (Array<String>
)The keys used to determine whether to perform an update or insert.
S3CatalogTarget
— (map
)Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3GlueParquetTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
S3DirectTarget
— (map
)Specifies a data target that writes to Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
"gzip"
and"bzip"
).Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
ApplyMapping
— (map
)Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Mapping
— required — (Array<map>
)Specifies the mapping of data property keys in the data source to data property keys in the data target.
ToKey
— (String
)After the apply mapping, what the name of the column should be. Can be the same as
FromPath
.FromPath
— (Array<String>
)The table or column to be modified.
FromType
— (String
)The type of the data to be modified.
ToType
— (String
)The data type that the data is to be modified to.
Dropped
— (Boolean
)If true, then the column is removed.
SelectFields
— (map
)Specifies a transform that chooses the data property keys that you want to keep.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
DropFields
— (map
)Specifies a transform that chooses the data property keys that you want to drop.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
RenameField
— (map
)Specifies a transform that renames a single data property key.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
SourcePath
— required — (Array<String>
)A JSON path to a variable in the data structure for the source data.
TargetPath
— required — (Array<String>
)A JSON path to a variable in the data structure for the target data.
Spigot
— (map
)Specifies a transform that writes samples of the data to an Amazon S3 bucket.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Path
— required — (String
)A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
Topk
— (Integer
)Specifies a number of records to write starting from the beginning of the dataset.
Prob
— (Float
)The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
Join
— (map
)Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
JoinType
— required — (String
)Specifies the type of join to be performed on the datasets.
Possible values include:"equijoin"
"left"
"right"
"outer"
"leftsemi"
"leftanti"
Columns
— required — (Array<map>
)A list of the two columns to be joined.
From
— required — (String
)The column to be joined.
Keys
— required — (Array<Array<String>>
)The key of the column to be joined.
SplitFields
— (map
)Specifies a transform that splits data property keys into two
DynamicFrames
. The output is a collection ofDynamicFrames
: one with selected data property keys, and one with the remaining data property keys.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
SelectFromCollection
— (map
)Specifies a transform that chooses one
DynamicFrame
from a collection ofDynamicFrames
. The output is the selectedDynamicFrame
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Index
— required — (Integer
)The index for the DynamicFrame to be selected.
FillMissingValues
— (map
)Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
ImputedPath
— required — (String
)A JSON path to a variable in the data structure for the dataset that is imputed.
FilledPath
— (String
)A JSON path to a variable in the data structure for the dataset that is filled.
Filter
— (map
)Specifies a transform that splits a dataset into two, based on a filter condition.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
LogicalOperator
— required — (String
)The operator used to filter rows by comparing the key value to a specified value.
Possible values include:"AND"
"OR"
Filters
— required — (Array<map>
)Specifies a filter expression.
Operation
— required — (String
)The type of operation to perform in the expression.
Possible values include:"EQ"
"LT"
"GT"
"LTE"
"GTE"
"REGEX"
"ISNULL"
Negated
— (Boolean
)Whether the expression is to be negated.
Values
— required — (Array<map>
)A list of filter values.
Type
— required — (String
)The type of filter value.
Possible values include:"COLUMNEXTRACTED"
"CONSTANT"
Value
— required — (Array<String>
)The value to be associated.
CustomCode
— (map
)Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Code
— required — (String
)The custom code that is used to perform the data transformation.
ClassName
— required — (String
)The name defined for the custom code node class.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom code transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkSQL
— (map
)Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single
DynamicFrame
.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
SqlQuery
— required — (String
)A SQL query that must use Spark SQL syntax and return a single data set.
SqlAliases
— required — (Array<map>
)A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify
From
as MyDataSource, andAlias
as SqlName, then in your SQL you can do:select * from SqlName
and that gets data from MyDataSource.
From
— required — (String
)A table, or a column in a table.
Alias
— required — (String
)A temporary name given to a table, or a column in a table.
OutputSchemas
— (Array<map>
)Specifies the data schema for the SparkSQL transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
DirectKinesisSource
— (map
)Specifies a direct Amazon Kinesis data source.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DirectKafkaSource
— (map
)Specifies an Apache Kafka data store.
Name
— required — (String
)The name of the data store.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKinesisSource
— (map
)Specifies a Kinesis data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKafkaSource
— (map
)Specifies an Apache Kafka data store in the Data Catalog.
Name
— required — (String
)The name of the data store.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DropNullFields
— (map
)Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
NullCheckBoxList
— (map
)A structure that represents whether certain values are recognized as null values for removal.
IsEmpty
— (Boolean
)Specifies that an empty string is considered as a null value.
IsNullString
— (Boolean
)Specifies that a value spelling out the word 'null' is considered as a null value.
IsNegOne
— (Boolean
)Specifies that an integer value of -1 is considered as a null value.
NullTextList
— (Array<map>
)A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The
DropNullFields
transform removes custom null values only if both the value of the null placeholder and the datatype match the data.Value
— required — (String
)The value of the null placeholder.
Datatype
— required — (map
)The datatype of the value.
Id
— required — (String
)The datatype of the value.
Label
— required — (String
)A label assigned to the datatype.
Merge
— (map
)Specifies a transform that merges a
DynamicFrame
with a stagingDynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Source
— required — (String
)The source
DynamicFrame
that will be merged with a stagingDynamicFrame
.PrimaryKeys
— required — (Array<Array<String>>
)The list of primary key fields to match records from the source and staging dynamic frames.
Union
— (map
)Specifies a transform that combines the rows from two or more datasets into a single result.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
UnionType
— required — (String
)Indicates the type of Union transform.
Specify
ALL
to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.Specify
Possible values include:DISTINCT
to remove duplicate rows in the resulting DynamicFrame."ALL"
"DISTINCT"
PIIDetection
— (map
)Specifies a transform that identifies, removes or masks PII data.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
PiiType
— required — (String
)Indicates the type of PIIDetection transform.
Possible values include:"RowAudit"
"RowMasking"
"ColumnAudit"
"ColumnMasking"
EntityTypesToDetect
— required — (Array<String>
)Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
OutputColumnName
— (String
)Indicates the output column name that will contain any entity type detected in that row.
SampleFraction
— (Float
)Indicates the fraction of the data to sample when scanning for PII entities.
ThresholdFraction
— (Float
)Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
MaskValue
— (String
)Indicates the value that will replace the detected entity.
Aggregate
— (map
)Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)Specifies the fields and rows to use as inputs for the aggregate transform.
Groups
— required — (Array<Array<String>>
)Specifies the fields to group by.
Aggs
— required — (Array<map>
)Specifies the aggregate functions to be performed on specified fields.
Column
— required — (Array<String>
)Specifies the column on the data set on which the aggregation function will be applied.
AggFunc
— required — (String
)Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
Possible values include:"avg"
"countDistinct"
"count"
"first"
"last"
"kurtosis"
"max"
"min"
"skewness"
"stddev_samp"
"stddev_pop"
"sum"
"sumDistinct"
"var_samp"
"var_pop"
DropDuplicates
— (map
)Specifies a transform that removes rows of repeating data from a data set.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Columns
— (Array<Array<String>>
)The name of the columns to be merged or removed if repeating.
GovernedCatalogTarget
— (map
)Specifies a data target that writes to a goverened catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the governed catalog.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
GovernedCatalogSource
— (map
)Specifies a data source in a goverened Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
MicrosoftSQLServerCatalogSource
— (map
)Specifies a Microsoft SQL server data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MySQLCatalogSource
— (map
)Specifies a MySQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
OracleSQLCatalogSource
— (map
)Specifies an Oracle data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
PostgreSQLCatalogSource
— (map
)Specifies a PostgresSQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MicrosoftSQLServerCatalogTarget
— (map
)Specifies a target that uses Microsoft SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
MySQLCatalogTarget
— (map
)Specifies a target that uses MySQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
OracleSQLCatalogTarget
— (map
)Specifies a target that uses Oracle SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
PostgreSQLCatalogTarget
— (map
)Specifies a target that uses Postgres SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
DynamicTransform
— (map
)Specifies a custom visual transform created by a user.
Name
— required — (String
)Specifies the name of the dynamic transform.
TransformName
— required — (String
)Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
Inputs
— required — (Array<String>
)Specifies the inputs for the dynamic transform that are required.
Parameters
— (Array<map>
)Specifies the parameters of the dynamic transform.
Name
— required — (String
)Specifies the name of the parameter in the config file of the dynamic transform.
Type
— required — (String
)Specifies the parameter type in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
ValidationRule
— (String
)Specifies the validation rule in the config file of the dynamic transform.
ValidationMessage
— (String
)Specifies the validation message in the config file of the dynamic transform.
Value
— (Array<String>
)Specifies the value of the parameter in the config file of the dynamic transform.
ListType
— (String
)Specifies the list type of the parameter in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
IsOptional
— (Boolean
)Specifies whether the parameter is optional or not in the config file of the dynamic transform.
FunctionName
— required — (String
)Specifies the name of the function of the dynamic transform.
Path
— required — (String
)Specifies the path of the dynamic transform source and config files.
Version
— (String
)This field is not used and will be deprecated in future release.
OutputSchemas
— (Array<map>
)Specifies the data schema for the dynamic transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
EvaluateDataQuality
— (map
)Specifies your data quality evaluation criteria.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
Output
— (String
)The output of your data quality evaluation.
Possible values include:"PrimaryInput"
"EvaluationResults"
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
S3CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiSource
— (map
)Specifies a Hudi data source stored in Amazon S3.
Name
— required — (String
)The name of the Hudi source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiCatalogTarget
— (map
)Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3HudiDirectTarget
— (map
)Specifies a target that writes to a Hudi data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Path
— required — (String
)The Amazon S3 path of your Hudi data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"lzo"
"uncompressed"
"snappy"
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
DirectJDBCSource
— (map
)Specifies the direct JDBC source connection.
Name
— required — (String
)The name of the JDBC source connection.
Database
— required — (String
)The database of the JDBC source connection.
Table
— required — (String
)The table of the JDBC source connection.
ConnectionName
— required — (String
)The connection name of the JDBC source.
ConnectionType
— required — (String
)The connection type of the JDBC source.
Possible values include:"sqlserver"
"mysql"
"oracle"
"postgresql"
"redshift"
RedshiftTmpDir
— (String
)The temp directory of the JDBC Redshift source.
S3CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaSource
— (map
)Specifies a Delta Lake data source stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaCatalogTarget
— (map
)Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3DeltaDirectTarget
— (map
)Specifies a target that writes to a Delta Lake data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)The Amazon S3 path of your Delta Lake data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."uncompressed"
"snappy"
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
AmazonRedshiftSource
— (map
)Specifies a target that writes to a data source in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift source.
Data
— (map
)Specifies the data of the Amazon Reshift source node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AmazonRedshiftTarget
— (map
)Specifies a target that writes to a data target in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift target.
Data
— (map
)Specifies the data of the Amazon Redshift target node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
EvaluateDataQualityMultiFrame
— (map
)Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation. The first input in this list is the primary data source.
AdditionalDataSources
— (map<String>
)The aliases of all data sources except primary.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
AdditionalOptions
— (map<String>
)Options to configure runtime behavior of the transform.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
Recipe
— (map
)Specifies a Glue DataBrew recipe node.
Name
— required — (String
)The name of the Glue Studio node.
Inputs
— required — (Array<String>
)The nodes that are inputs to the recipe node, identified by id.
RecipeReference
— (map
)A reference to the DataBrew recipe used by the node.
RecipeArn
— required — (String
)The ARN of the DataBrew recipe.
RecipeVersion
— required — (String
)The RecipeVersion of the DataBrew recipe.
RecipeSteps
— (Array<map>
)Transform steps used in the recipe node.
Action
— required — (map
)The transformation action of the recipe step.
Operation
— required — (String
)The operation of the recipe action.
Parameters
— (map<String>
)The parameters of the recipe action.
ConditionExpressions
— (Array<map>
)The condition expressions for the recipe step.
Condition
— required — (String
)The condition of the condition expression.
Value
— (String
)The value of the condition expression.
TargetColumn
— required — (String
)The target column of the condition expressions.
SnowflakeSource
— (map
)Specifies a Snowflake data source.
Name
— required — (String
)The name of the Snowflake data source.
Data
— required — (map
)Configuration for the Snowflake data source.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
OutputSchemas
— (Array<map>
)Specifies user-defined schemas for your output data.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SnowflakeTarget
— (map
)Specifies a target that writes to a Snowflake data source.
Name
— required — (String
)The name of the Snowflake target.
Data
— required — (map
)Specifies the data of the Snowflake target node.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ConnectorDataSource
— (map
)Specifies a source generated with standard connection options.
Name
— required — (String
)The name of this source node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
OutputSchemas
— (Array<map>
)Specifies the data schema for this source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
ConnectorDataTarget
— (map
)Specifies a target generated with standard connection options.
Name
— required — (String
)The name of this target node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
SourceControlDetails
— (map
)The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Provider
— (String
)The provider for the remote repository.
Possible values include:"GITHUB"
"GITLAB"
"BITBUCKET"
"AWS_CODE_COMMIT"
Repository
— (String
)The name of the remote repository that contains the job artifacts.
Owner
— (String
)The owner of the remote repository that contains the job artifacts.
Branch
— (String
)An optional branch in the remote repository.
Folder
— (String
)An optional folder in the remote repository.
LastCommitId
— (String
)The last commit ID for a commit in the remote repository.
AuthStrategy
— (String
)The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
Possible values include:"PERSONAL_ACCESS_TOKEN"
"AWS_SECRETS_MANAGER"
AuthToken
— (String
)The value of an authorization token.
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job.
NextToken
— (String
)A continuation token, if not all job definitions have yet been returned.
-
(AWS.Response)
—
Returns:
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 Simple Storage Service (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>
)An Amazon 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. Thedata
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.
-
(AWS.Response)
—
Returns:
getMLTaskRun(params = {}, callback) ⇒ AWS.Request
Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling
GetMLTaskRun
with theTaskRunID
and its parent transform'sTransformID
.Service Reference:
Examples:
Calling the getMLTaskRun operation
var params = { TaskRunId: 'STRING_VALUE', /* required */ TransformId: 'STRING_VALUE' /* required */ }; glue.getMLTaskRun(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: {})
—
TransformId
— (String
)The unique identifier of the machine learning transform.
TaskRunId
— (String
)The unique identifier of the task run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:TransformId
— (String
)The unique identifier of the task run.
TaskRunId
— (String
)The unique run identifier associated with this run.
Status
— (String
)The status for this task run.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
LogGroupName
— (String
)The names of the log groups that are associated with the task run.
Properties
— (map
)The list of properties that are associated with the task run.
TaskType
— (String
)The type of task run.
Possible values include:"EVALUATION"
"LABELING_SET_GENERATION"
"IMPORT_LABELS"
"EXPORT_LABELS"
"FIND_MATCHES"
ImportLabelsTaskRunProperties
— (map
)The configuration properties for an importing labels task run.
InputS3Path
— (String
)The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
Replace
— (Boolean
)Indicates whether to overwrite your existing labels.
ExportLabelsTaskRunProperties
— (map
)The configuration properties for an exporting labels task run.
OutputS3Path
— (String
)The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
LabelingSetGenerationTaskRunProperties
— (map
)The configuration properties for a labeling set generation task run.
OutputS3Path
— (String
)The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
FindMatchesTaskRunProperties
— (map
)The configuration properties for a find matches task run.
JobId
— (String
)The job ID for the Find Matches task run.
JobName
— (String
)The name assigned to the job for the Find Matches task run.
JobRunId
— (String
)The job run ID for the Find Matches task run.
ErrorString
— (String
)The error strings that are associated with the task run.
StartedOn
— (Date
)The date and time when this task run started.
LastModifiedOn
— (Date
)The date and time when this task run was last modified.
CompletedOn
— (Date
)The date and time when this task run was completed.
ExecutionTime
— (Integer
)The amount of time (in seconds) that the task run consumed resources.
-
(AWS.Response)
—
Returns:
getMLTaskRuns(params = {}, callback) ⇒ AWS.Request
Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling
GetMLTaskRuns
with their parent transform'sTransformID
and other optional parameters as documented in this section.This operation returns a list of historic runs and must be paginated.
Service Reference:
Examples:
Calling the getMLTaskRuns operation
var params = { TransformId: 'STRING_VALUE', /* required */ Filter: { StartedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, StartedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, Status: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT, TaskRunType: EVALUATION | LABELING_SET_GENERATION | IMPORT_LABELS | EXPORT_LABELS | FIND_MATCHES }, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', Sort: { Column: TASK_RUN_TYPE | STATUS | STARTED, /* required */ SortDirection: DESCENDING | ASCENDING /* required */ } }; glue.getMLTaskRuns(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: {})
—
TransformId
— (String
)The unique identifier of the machine learning transform.
NextToken
— (String
)A token for pagination of the results. The default is empty.
MaxResults
— (Integer
)The maximum number of results to return.
Filter
— (map
)The filter criteria, in the
TaskRunFilterCriteria
structure, for the task run.TaskRunType
— (String
)The type of task run.
Possible values include:"EVALUATION"
"LABELING_SET_GENERATION"
"IMPORT_LABELS"
"EXPORT_LABELS"
"FIND_MATCHES"
Status
— (String
)The current status of the task run.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
StartedBefore
— (Date
)Filter on task runs started before this date.
StartedAfter
— (Date
)Filter on task runs started after this date.
Sort
— (map
)The sorting criteria, in the
TaskRunSortCriteria
structure, for the task run.Column
— required — (String
)The column to be used to sort the list of task runs for the machine learning transform.
Possible values include:"TASK_RUN_TYPE"
"STATUS"
"STARTED"
SortDirection
— required — (String
)The sort direction to be used to sort the list of task runs for the machine learning transform.
Possible values include:"DESCENDING"
"ASCENDING"
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. Thedata
object has the following properties:TaskRuns
— (Array<map>
)A list of task runs that are associated with the transform.
TransformId
— (String
)The unique identifier for the transform.
TaskRunId
— (String
)The unique identifier for this task run.
Status
— (String
)The current status of the requested task run.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
LogGroupName
— (String
)The names of the log group for secure logging, associated with this task run.
Properties
— (map
)Specifies configuration properties associated with this task run.
TaskType
— (String
)The type of task run.
Possible values include:"EVALUATION"
"LABELING_SET_GENERATION"
"IMPORT_LABELS"
"EXPORT_LABELS"
"FIND_MATCHES"
ImportLabelsTaskRunProperties
— (map
)The configuration properties for an importing labels task run.
InputS3Path
— (String
)The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
Replace
— (Boolean
)Indicates whether to overwrite your existing labels.
ExportLabelsTaskRunProperties
— (map
)The configuration properties for an exporting labels task run.
OutputS3Path
— (String
)The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
LabelingSetGenerationTaskRunProperties
— (map
)The configuration properties for a labeling set generation task run.
OutputS3Path
— (String
)The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
FindMatchesTaskRunProperties
— (map
)The configuration properties for a find matches task run.
JobId
— (String
)The job ID for the Find Matches task run.
JobName
— (String
)The name assigned to the job for the Find Matches task run.
JobRunId
— (String
)The job run ID for the Find Matches task run.
ErrorString
— (String
)The list of error strings associated with this task run.
StartedOn
— (Date
)The date and time that this task run started.
LastModifiedOn
— (Date
)The last point in time that the requested task run was updated.
CompletedOn
— (Date
)The last point in time that the requested task run was completed.
ExecutionTime
— (Integer
)The amount of time (in seconds) that the task run consumed resources.
NextToken
— (String
)A pagination token, if more results are available.
-
(AWS.Response)
—
Returns:
getMLTransform(params = {}, callback) ⇒ AWS.Request
Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling
GetMLTransform
.Service Reference:
Examples:
Calling the getMLTransform operation
var params = { TransformId: 'STRING_VALUE' /* required */ }; glue.getMLTransform(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: {})
—
TransformId
— (String
)The unique identifier of the transform, generated at the time that the transform was created.
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. Thedata
object has the following properties:TransformId
— (String
)The unique identifier of the transform, generated at the time that the transform was created.
Name
— (String
)The unique name given to the transform when it was created.
Description
— (String
)A description of the transform.
Status
— (String
)The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
Possible values include:"NOT_READY"
"READY"
"DELETING"
CreatedOn
— (Date
)The date and time when the transform was created.
LastModifiedOn
— (Date
)The date and time when the transform was last modified.
InputRecordTables
— (Array<map>
)A list of Glue table definitions used by the transform.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
Parameters
— (map
)The configuration parameters that are specific to the algorithm used.
TransformType
— required — (String
)The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
Possible values include:"FIND_MATCHES"
FindMatchesParameters
— (map
)The parameters for the find matches algorithm.
PrimaryKeyColumnName
— (String
)The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
PrecisionRecallTradeoff
— (Float
)The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
AccuracyCostTradeoff
— (Float
)The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate
FindMatches
transform, sometimes with unacceptable accuracy.Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
EnforceProvidedLabels
— (Boolean
)The value to switch on or off to force the output to match the provided labels from users. If the value is
True
, thefind matches
transform forces the output to match the provided labels. The results override the normal conflation results. If the value isFalse
, thefind matches
transform does not ensure all the labels provided are respected, and the results rely on the trained model.Note that setting this value to true may increase the conflation execution time.
EvaluationMetrics
— (map
)The latest evaluation metrics.
TransformType
— required — (String
)The type of machine learning transform.
Possible values include:"FIND_MATCHES"
FindMatchesMetrics
— (map
)The evaluation metrics for the find matches algorithm.
AreaUnderPRCurve
— (Float
)The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
Precision
— (Float
)The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
Recall
— (Float
)The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
F1
— (Float
)The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
ConfusionMatrix
— (map
)The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
NumTruePositives
— (Integer
)The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
NumFalsePositives
— (Integer
)The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
NumTrueNegatives
— (Integer
)The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
NumFalseNegatives
— (Integer
)The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.
ColumnImportances
— (Array<map>
)A list of
ColumnImportance
structures containing column importance metrics, sorted in order of descending importance.ColumnName
— (String
)The name of a column.
Importance
— (Float
)The column importance score for the column, as a decimal.
LabelCount
— (Integer
)The number of labels available for this transform.
Schema
— (Array<map>
)The
Map<Column, Type>
object that represents the schema that this transform accepts. Has an upper bound of 100 columns.Name
— (String
)The name of the column.
DataType
— (String
)The type of data in the column.
Role
— (String
)The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
GlueVersion
— (String
)This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
MaxCapacity
— (Float
)The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; 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 Glue pricing page.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.WorkerType
— (String
)The type of predefined worker that is allocated when this task 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.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when this task runs.Timeout
— (Integer
)The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).MaxRetries
— (Integer
)The maximum number of times to retry a task for this transform after a task run fails.
TransformEncryption
— (map
)The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
MlUserDataEncryption
— (map
)An
MLUserDataEncryption
object containing the encryption mode and customer-provided KMS key ID.MlUserDataEncryptionMode
— required — (String
)The encryption mode applied to user data. Valid values are:
-
DISABLED: encryption is disabled
-
SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
"DISABLED"
"SSE-KMS"
-
KmsKeyId
— (String
)The ID for the customer-provided KMS key.
TaskRunSecurityConfigurationName
— (String
)The name of the security configuration.
-
(AWS.Response)
—
Returns:
getMLTransforms(params = {}, callback) ⇒ AWS.Request
Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling
GetMLTransforms
.Service Reference:
Examples:
Calling the getMLTransforms operation
var params = { Filter: { CreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, CreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, GlueVersion: 'STRING_VALUE', LastModifiedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, LastModifiedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, Name: 'STRING_VALUE', Schema: [ { DataType: 'STRING_VALUE', Name: 'STRING_VALUE' }, /* more items */ ], Status: NOT_READY | READY | DELETING, TransformType: FIND_MATCHES }, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', Sort: { Column: NAME | TRANSFORM_TYPE | STATUS | CREATED | LAST_MODIFIED, /* required */ SortDirection: DESCENDING | ASCENDING /* required */ } }; glue.getMLTransforms(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 paginated token to offset the results.
MaxResults
— (Integer
)The maximum number of results to return.
Filter
— (map
)The filter transformation criteria.
Name
— (String
)A unique transform name that is used to filter the machine learning transforms.
TransformType
— (String
)The type of machine learning transform that is used to filter the machine learning transforms.
Possible values include:"FIND_MATCHES"
Status
— (String
)Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
Possible values include:"NOT_READY"
"READY"
"DELETING"
GlueVersion
— (String
)This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
CreatedBefore
— (Date
)The time and date before which the transforms were created.
CreatedAfter
— (Date
)The time and date after which the transforms were created.
LastModifiedBefore
— (Date
)Filter on transforms last modified before this date.
LastModifiedAfter
— (Date
)Filter on transforms last modified after this date.
Schema
— (Array<map>
)Filters on datasets with a specific schema. The
Map<Column, Type>
object is an array of key-value pairs representing the schema this transform accepts, whereColumn
is the name of a column, andType
is the type of the data such as an integer or string. Has an upper bound of 100 columns.Name
— (String
)The name of the column.
DataType
— (String
)The type of data in the column.
Sort
— (map
)The sorting criteria.
Column
— required — (String
)The column to be used in the sorting criteria that are associated with the machine learning transform.
Possible values include:"NAME"
"TRANSFORM_TYPE"
"STATUS"
"CREATED"
"LAST_MODIFIED"
SortDirection
— required — (String
)The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
Possible values include:"DESCENDING"
"ASCENDING"
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. Thedata
object has the following properties:Transforms
— (Array<map>
)A list of machine learning transforms.
TransformId
— (String
)The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
Name
— (String
)A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
Description
— (String
)A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
Status
— (String
)The current status of the machine learning transform.
Possible values include:"NOT_READY"
"READY"
"DELETING"
CreatedOn
— (Date
)A timestamp. The time and date that this machine learning transform was created.
LastModifiedOn
— (Date
)A timestamp. The last point in time when this machine learning transform was modified.
InputRecordTables
— (Array<map>
)A list of Glue table definitions used by the transform.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
Parameters
— (map
)A
TransformParameters
object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).TransformType
— required — (String
)The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
Possible values include:"FIND_MATCHES"
FindMatchesParameters
— (map
)The parameters for the find matches algorithm.
PrimaryKeyColumnName
— (String
)The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
PrecisionRecallTradeoff
— (Float
)The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
AccuracyCostTradeoff
— (Float
)The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate
FindMatches
transform, sometimes with unacceptable accuracy.Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
EnforceProvidedLabels
— (Boolean
)The value to switch on or off to force the output to match the provided labels from users. If the value is
True
, thefind matches
transform forces the output to match the provided labels. The results override the normal conflation results. If the value isFalse
, thefind matches
transform does not ensure all the labels provided are respected, and the results rely on the trained model.Note that setting this value to true may increase the conflation execution time.
EvaluationMetrics
— (map
)An
EvaluationMetrics
object. Evaluation metrics provide an estimate of the quality of your machine learning transform.TransformType
— required — (String
)The type of machine learning transform.
Possible values include:"FIND_MATCHES"
FindMatchesMetrics
— (map
)The evaluation metrics for the find matches algorithm.
AreaUnderPRCurve
— (Float
)The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.
For more information, see Precision and recall in Wikipedia.
Precision
— (Float
)The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.
For more information, see Precision and recall in Wikipedia.
Recall
— (Float
)The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.
For more information, see Precision and recall in Wikipedia.
F1
— (Float
)The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.
For more information, see F1 score in Wikipedia.
ConfusionMatrix
— (map
)The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
NumTruePositives
— (Integer
)The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
NumFalsePositives
— (Integer
)The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.
NumTrueNegatives
— (Integer
)The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.
NumFalseNegatives
— (Integer
)The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.
ColumnImportances
— (Array<map>
)A list of
ColumnImportance
structures containing column importance metrics, sorted in order of descending importance.ColumnName
— (String
)The name of a column.
Importance
— (Float
)The column importance score for the column, as a decimal.
LabelCount
— (Integer
)A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
Schema
— (Array<map>
)A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
Name
— (String
)The name of the column.
DataType
— (String
)The type of data in the column.
Role
— (String
)The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.
-
This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.
-
This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.
-
GlueVersion
— (String
)This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
MaxCapacity
— (Float
)The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; 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 Glue pricing page.
MaxCapacity
is a mutually exclusive option withNumberOfWorkers
andWorkerType
.-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.-
WorkerType
— (String
)The type of predefined worker that is allocated when a task of this transform 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.
MaxCapacity
is a mutually exclusive option withNumberOfWorkers
andWorkerType
.-
If either
NumberOfWorkers
orWorkerType
is set, thenMaxCapacity
cannot be set. -
If
MaxCapacity
is set then neitherNumberOfWorkers
orWorkerType
can be set. -
If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa). -
MaxCapacity
andNumberOfWorkers
must both be at least 1.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a task of the transform runs.If
WorkerType
is set, thenNumberOfWorkers
is required (and vice versa).Timeout
— (Integer
)The timeout in minutes of the machine learning transform.
MaxRetries
— (Integer
)The maximum number of times to retry after an
MLTaskRun
of the machine learning transform fails.TransformEncryption
— (map
)The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
MlUserDataEncryption
— (map
)An
MLUserDataEncryption
object containing the encryption mode and customer-provided KMS key ID.MlUserDataEncryptionMode
— required — (String
)The encryption mode applied to user data. Valid values are:
-
DISABLED: encryption is disabled
-
SSEKMS: use of server-side encryption with Key Management Service (SSE-KMS) for user data stored in Amazon S3.
"DISABLED"
"SSE-KMS"
-
KmsKeyId
— (String
)The ID for the customer-provided KMS key.
TaskRunSecurityConfigurationName
— (String
)The name of the security configuration.
NextToken
— (String
)A pagination token, if more results are available.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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. Thedata
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 in which to create the partition.
TableName
— (String
)The name of the database table in which to create the partition.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
Parameters
— (map<String>
)These key-value pairs define partition parameters.
LastAnalyzedTime
— (Date
)The last time at which column statistics were computed for this partition.
CatalogId
— (String
)The ID of the Data Catalog in which the partition resides.
-
(AWS.Response)
—
Returns:
getPartitionIndexes(params = {}, callback) ⇒ AWS.Request
Retrieves the partition indexes associated with a table.
Service Reference:
Examples:
Calling the getPartitionIndexes operation
var params = { DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE', NextToken: 'STRING_VALUE' }; glue.getPartitionIndexes(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 catalog ID where the table resides.
DatabaseName
— (String
)Specifies the name of a database from which you want to retrieve partition indexes.
TableName
— (String
)Specifies the name of a table for which you want to retrieve the partition indexes.
NextToken
— (String
)A continuation token, included 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. Thedata
object has the following properties:PartitionIndexDescriptorList
— (Array<map>
)A list of index descriptors.
IndexName
— required — (String
)The name of the partition index.
Keys
— required — (Array<map>
)A list of one or more keys, as
KeySchemaElement
structures, for the partition index.Name
— required — (String
)The name of a partition key.
Type
— required — (String
)The type of a partition key.
IndexStatus
— required — (String
)The status of the partition index.
The possible statuses are:
-
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
-
ACTIVE: The index creation succeeds.
-
FAILED: The index creation fails.
-
DELETING: The index is deleted from the list of indexes.
"CREATING"
"ACTIVE"
"DELETING"
"FAILED"
-
BackfillErrors
— (Array<map>
)A list of errors that can occur when registering partition indexes for an existing table.
Code
— (String
)The error code for an error that occurred when registering partition indexes for an existing table.
Possible values include:"ENCRYPTED_PARTITION_ERROR"
"INTERNAL_ERROR"
"INVALID_PARTITION_TYPE_DATA_ERROR"
"MISSING_PARTITION_VALUE_ERROR"
"UNSUPPORTED_PARTITION_CHARACTER_ERROR"
Partitions
— (Array<map>
)A list of a limited number of partitions in the response.
Values
— required — (Array<String>
)The list of values.
NextToken
— (String
)A continuation token, present if the current list segment is not the last.
-
(AWS.Response)
—
Returns:
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', ExcludeColumnSchema: true || false, Expression: 'STRING_VALUE', MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', QueryAsOfTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, Segment: { SegmentNumber: 'NUMBER_VALUE', /* required */ TotalSegments: 'NUMBER_VALUE' /* required */ }, TransactionId: 'STRING_VALUE' }; 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 provided, the Amazon Web Services 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 that filters 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 whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
- < >
-
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
- >
-
Checks whether 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 whether 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 whether 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 whether 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 supported partition keys.
-
string
-
date
-
timestamp
-
int
-
bigint
-
long
-
tinyint
-
smallint
-
decimal
If an type is encountered that is not valid, 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 aSTRING
, 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 segment. For example, if the total number of segments is 4,
SegmentNumber
values range from 0 through 3.TotalSegments
— required — (Integer
)The total number of segments.
MaxResults
— (Integer
)The maximum number of partitions to return in a single response.
ExcludeColumnSchema
— (Boolean
)When true, specifies not returning the partition column schema. Useful when you are interested only in other partition attributes such as partition values or location. This approach avoids the problem of a large response by not returning duplicate data.
TransactionId
— (String
)The transaction ID at which to read the partition contents.
QueryAsOfTime
— (Date
)The time as of when to read the partition contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with
TransactionId
.
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. Thedata
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 in which to create the partition.
TableName
— (String
)The name of the database table in which to create the partition.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
Parameters
— (map<String>
)These key-value pairs define partition parameters.
LastAnalyzedTime
— (Date
)The last time at which column statistics were computed for this partition.
CatalogId
— (String
)The ID of the Data Catalog in which the partition resides.
NextToken
— (String
)A continuation token, if the returned list of partitions does not include the last one.
-
(AWS.Response)
—
Returns:
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 */ }, AdditionalPlanOptionsMap: { '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, 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
)The 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 Simple Storage Service (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>
)An Amazon 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"
AdditionalPlanOptionsMap
— (map<String>
)A map to hold additional optional key-value parameters.
Currently, these key-value pairs are supported:
-
inferSchema
— Specifies whether to setinferSchema
to true or false for the default script generated by an Glue job. For example, to setinferSchema
to true, pass the following key value pair:--additional-plan-options-map '{"inferSchema":"true"}'
-
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. Thedata
object has the following properties:PythonScript
— (String
)A Python script to perform the mapping.
ScalaCode
— (String
)The Scala code to perform the mapping.
-
(AWS.Response)
—
Returns:
getRegistry(params = {}, callback) ⇒ AWS.Request
Describes the specified registry in detail.
Service Reference:
Examples:
Calling the getRegistry operation
var params = { RegistryId: { /* required */ RegistryArn: 'STRING_VALUE', RegistryName: 'STRING_VALUE' } }; glue.getRegistry(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: {})
—
RegistryId
— (map
)This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
RegistryName
— (String
)Name of the registry. Used only for lookup. One of
RegistryArn
orRegistryName
has to be provided.RegistryArn
— (String
)Arn of the registry to be updated. One of
RegistryArn
orRegistryName
has to be provided.
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. Thedata
object has the following properties:RegistryName
— (String
)The name of the registry.
RegistryArn
— (String
)The Amazon Resource Name (ARN) of the registry.
Description
— (String
)A description of the registry.
Status
— (String
)The status of the registry.
Possible values include:"AVAILABLE"
"DELETING"
CreatedTime
— (String
)The date and time the registry was created.
UpdatedTime
— (String
)The date and time the registry was updated.
-
(AWS.Response)
—
Returns:
getResourcePolicies(params = {}, callback) ⇒ AWS.Request
Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.
If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can't return the Data Catalog resource policy.
Service Reference:
Examples:
Calling the getResourcePolicies operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.getResourcePolicies(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.
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. Thedata
object has the following properties:GetResourcePoliciesResponseList
— (Array<map>
)A list of the individual resource policies and the account-level resource policy.
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.
NextToken
— (String
)A continuation token, if the returned list does not contain the last resource policy available.
-
(AWS.Response)
—
Returns:
getResourcePolicy(params = {}, callback) ⇒ AWS.Request
Retrieves a specified resource policy.
Service Reference:
Examples:
Calling the getResourcePolicy operation
var params = { ResourceArn: 'STRING_VALUE' }; 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: {})
—
ResourceArn
— (String
)The ARN of the Glue resource for which to retrieve the resource policy. If not supplied, the Data Catalog resource policy is returned. Use
GetResourcePolicies
to view all existing resource policies. For more information see Specifying Glue Resource ARNs.
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. Thedata
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.
-
(AWS.Response)
—
Returns:
getSchema(params = {}, callback) ⇒ AWS.Request
Describes the specified schema in detail.
Service Reference:
Examples:
Calling the getSchema operation
var params = { SchemaId: { /* required */ RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' } }; glue.getSchema(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: {})
—
SchemaId
— (map
)This is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided. -
SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
-
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. Thedata
object has the following properties:RegistryName
— (String
)The name of the registry.
RegistryArn
— (String
)The Amazon Resource Name (ARN) of the registry.
SchemaName
— (String
)The name of the schema.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema.
Description
— (String
)A description of schema if specified when created
DataFormat
— (String
)The data format of the schema definition. Currently
Possible values include:AVRO
,JSON
andPROTOBUF
are supported."AVRO"
"JSON"
"PROTOBUF"
Compatibility
— (String
)The compatibility mode of the schema.
Possible values include:"NONE"
"DISABLED"
"BACKWARD"
"BACKWARD_ALL"
"FORWARD"
"FORWARD_ALL"
"FULL"
"FULL_ALL"
SchemaCheckpoint
— (Integer
)The version number of the checkpoint (the last time the compatibility mode was changed).
LatestSchemaVersion
— (Integer
)The latest version of the schema associated with the returned schema definition.
NextSchemaVersion
— (Integer
)The next version of the schema associated with the returned schema definition.
SchemaStatus
— (String
)The status of the schema.
Possible values include:"AVAILABLE"
"PENDING"
"DELETING"
CreatedTime
— (String
)The date and time the schema was created.
UpdatedTime
— (String
)The date and time the schema was updated.
-
(AWS.Response)
—
Returns:
getSchemaByDefinition(params = {}, callback) ⇒ AWS.Request
Retrieves a schema by the
SchemaDefinition
. The schema definition is sent to the Schema Registry, canonicalized, and hashed. If the hash is matched within the scope of theSchemaName
or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFound error is returned. Schema versions inDeleted
statuses will not be included in the results.Service Reference:
Examples:
Calling the getSchemaByDefinition operation
var params = { SchemaDefinition: 'STRING_VALUE', /* required */ SchemaId: { /* required */ RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' } }; glue.getSchemaByDefinition(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: {})
—
SchemaId
— (map
)This is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided. -
SchemaId$SchemaName: The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
-
SchemaDefinition
— (String
)The definition of the schema for which schema details are required.
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. Thedata
object has the following properties:SchemaVersionId
— (String
)The schema ID of the schema version.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema.
DataFormat
— (String
)The data format of the schema definition. Currently
Possible values include:AVRO
,JSON
andPROTOBUF
are supported."AVRO"
"JSON"
"PROTOBUF"
Status
— (String
)The status of the schema version.
Possible values include:"AVAILABLE"
"PENDING"
"FAILURE"
"DELETING"
CreatedTime
— (String
)The date and time the schema was created.
-
(AWS.Response)
—
Returns:
getSchemaVersion(params = {}, callback) ⇒ AWS.Request
Get the specified schema by its unique ID assigned when a version of the schema is created or registered. Schema versions in Deleted status will not be included in the results.
Service Reference:
Examples:
Calling the getSchemaVersion operation
var params = { SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: { LatestVersion: true || false, VersionNumber: 'NUMBER_VALUE' } }; glue.getSchemaVersion(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: {})
—
SchemaId
— (map
)This is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided. -
SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
-
SchemaVersionId
— (String
)The
SchemaVersionId
of the schema version. This field is required for fetching by schema ID. Either this or theSchemaId
wrapper has to be provided.SchemaVersionNumber
— (map
)The version number of the schema.
LatestVersion
— (Boolean
)The latest version available for the schema.
VersionNumber
— (Integer
)The version number of the schema.
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. Thedata
object has the following properties:SchemaVersionId
— (String
)The
SchemaVersionId
of the schema version.SchemaDefinition
— (String
)The schema definition for the schema ID.
DataFormat
— (String
)The data format of the schema definition. Currently
Possible values include:AVRO
,JSON
andPROTOBUF
are supported."AVRO"
"JSON"
"PROTOBUF"
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema.
VersionNumber
— (Integer
)The version number of the schema.
Status
— (String
)The status of the schema version.
Possible values include:"AVAILABLE"
"PENDING"
"FAILURE"
"DELETING"
CreatedTime
— (String
)The date and time the schema version was created.
-
(AWS.Response)
—
Returns:
getSchemaVersionsDiff(params = {}, callback) ⇒ AWS.Request
Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
This API allows you to compare two schema versions between two schema definitions under the same schema.
Service Reference:
Examples:
Calling the getSchemaVersionsDiff operation
var params = { FirstSchemaVersionNumber: { /* required */ LatestVersion: true || false, VersionNumber: 'NUMBER_VALUE' }, SchemaDiffType: SYNTAX_DIFF, /* required */ SchemaId: { /* required */ RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SecondSchemaVersionNumber: { /* required */ LatestVersion: true || false, VersionNumber: 'NUMBER_VALUE' } }; glue.getSchemaVersionsDiff(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: {})
—
SchemaId
— (map
)This is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided. -
SchemaId$SchemaName: The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
-
FirstSchemaVersionNumber
— (map
)The first of the two schema versions to be compared.
LatestVersion
— (Boolean
)The latest version available for the schema.
VersionNumber
— (Integer
)The version number of the schema.
SecondSchemaVersionNumber
— (map
)The second of the two schema versions to be compared.
LatestVersion
— (Boolean
)The latest version available for the schema.
VersionNumber
— (Integer
)The version number of the schema.
SchemaDiffType
— (String
)Refers to
Possible values include:SYNTAX_DIFF
, which is the currently supported diff type."SYNTAX_DIFF"
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. Thedata
object has the following properties:Diff
— (String
)The difference between schemas as a string in JsonPatch format.
-
(AWS.Response)
—
Returns:
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. Thedata
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 Amazon Simple Storage Service (Amazon S3) data.
S3EncryptionMode
— (String
)The encryption mode to use for Amazon S3 data.
Possible values include:"DISABLED"
"SSE-KMS"
"SSE-S3"
KmsKeyArn
— (String
)The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
CloudWatchEncryption
— (map
)The encryption configuration for Amazon CloudWatch.
CloudWatchEncryptionMode
— (String
)The encryption mode to use for CloudWatch data.
Possible values include:"DISABLED"
"SSE-KMS"
KmsKeyArn
— (String
)The Amazon Resource Name (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 Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
-
(AWS.Response)
—
Returns:
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. Thedata
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 Amazon Simple Storage Service (Amazon S3) data.
S3EncryptionMode
— (String
)The encryption mode to use for Amazon S3 data.
Possible values include:"DISABLED"
"SSE-KMS"
"SSE-S3"
KmsKeyArn
— (String
)The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
CloudWatchEncryption
— (map
)The encryption configuration for Amazon CloudWatch.
CloudWatchEncryptionMode
— (String
)The encryption mode to use for CloudWatch data.
Possible values include:"DISABLED"
"SSE-KMS"
KmsKeyArn
— (String
)The Amazon Resource Name (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 Amazon Resource Name (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.
-
(AWS.Response)
—
Returns:
getSession(params = {}, callback) ⇒ AWS.Request
Retrieves the session.
Service Reference:
Examples:
Calling the getSession operation
var params = { Id: 'STRING_VALUE', /* required */ RequestOrigin: 'STRING_VALUE' }; glue.getSession(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: {})
—
Id
— (String
)The ID of the session.
RequestOrigin
— (String
)The origin of the 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. Thedata
object has the following properties:Session
— (map
)The session object is returned in the response.
Id
— (String
)The ID of the session.
CreatedOn
— (Date
)The time and date when the session was created.
Status
— (String
)The session status.
Possible values include:"PROVISIONING"
"READY"
"FAILED"
"TIMEOUT"
"STOPPING"
"STOPPED"
ErrorMessage
— (String
)The error message displayed during the session.
Description
— (String
)The description of the session.
Role
— (String
)The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
Command
— (map
)The command object.See SessionCommand.
Name
— (String
)Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
PythonVersion
— (String
)Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
DefaultArguments
— (map<String>
)A map array of key-value pairs. Max is 75 pairs.
Connections
— (map
)The number of connections used for the session.
Connections
— (Array<String>
)A list of connections used by the job.
Progress
— (Float
)The code execution progress of the session.
MaxCapacity
— (Float
)The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
SecurityConfiguration
— (String
)The name of the SecurityConfiguration structure to be used with the session.
GlueVersion
— (String
)The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
NumberOfWorkers
— (Integer
)The number of workers of a defined
WorkerType
to use for the session.WorkerType
— (String
)The type of predefined worker that is allocated when a session runs. Accepts a value of
Possible values include:G.1X
,G.2X
,G.4X
, orG.8X
for Spark sessions. Accepts the valueZ.2X
for Ray sessions."Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
CompletedOn
— (Date
)The date and time that this session is completed.
ExecutionTime
— (Float
)The total time the session ran for.
DPUSeconds
— (Float
)The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
IdleTimeout
— (Integer
)The number of minutes when idle before the session times out.
ProfileName
— (String
)The name of an Glue usage profile associated with the session.
-
(AWS.Response)
—
Returns:
getStatement(params = {}, callback) ⇒ AWS.Request
Retrieves the statement.
Service Reference:
Examples:
Calling the getStatement operation
var params = { Id: 'NUMBER_VALUE', /* required */ SessionId: 'STRING_VALUE', /* required */ RequestOrigin: 'STRING_VALUE' }; glue.getStatement(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: {})
—
SessionId
— (String
)The Session ID of the statement.
Id
— (Integer
)The Id of the statement.
RequestOrigin
— (String
)The origin of the 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. Thedata
object has the following properties:Statement
— (map
)Returns the statement.
Id
— (Integer
)The ID of the statement.
Code
— (String
)The execution code of the statement.
State
— (String
)The state while request is actioned.
Possible values include:"WAITING"
"RUNNING"
"AVAILABLE"
"CANCELLING"
"CANCELLED"
"ERROR"
Output
— (map
)The output in JSON.
Data
— (map
)The code execution output.
TextPlain
— (String
)The code execution output in text format.
ExecutionCount
— (Integer
)The execution count of the output.
Status
— (String
)The status of the code execution output.
Possible values include:"WAITING"
"RUNNING"
"AVAILABLE"
"CANCELLING"
"CANCELLED"
"ERROR"
ErrorName
— (String
)The name of the error in the output.
ErrorValue
— (String
)The error value of the output.
Traceback
— (Array<String>
)The traceback of the output.
Progress
— (Float
)The code execution progress.
StartedOn
— (Integer
)The unix time and date that the job definition was started.
CompletedOn
— (Integer
)The unix time and date that the job definition was completed.
-
(AWS.Response)
—
Returns:
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', IncludeStatusDetails: true || false, QueryAsOfTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, TransactionId: '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 provided, the Amazon Web Services 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.
TransactionId
— (String
)The transaction ID at which to read the table contents.
QueryAsOfTime
— (Date
)The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with
TransactionId
.IncludeStatusDetails
— (Boolean
)Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
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. Thedata
object has the following properties:Table
— (map
)The
Table
object that defines the specified table.Name
— required — (String
)The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName
— (String
)The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description
— (String
)A description of the table.
Owner
— (String
)The owner of the table.
CreateTime
— (Date
)The time when the table definition was created in the Data Catalog.
UpdateTime
— (Date
)The last time that the table was updated.
LastAccessTime
— (Date
)The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
CreatedBy
— (String
)The person or entity who created the table.
IsRegisteredWithLakeFormation
— (Boolean
)Indicates whether the table has been registered with Lake Formation.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
VersionId
— (String
)The ID of the table version.
FederatedTable
— (map
)A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated table.
DatabaseIdentifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
SubObjects
— (Array<String>
)A list of table Amazon Resource Names (ARNs).
Representations
— (Array<map>
)A list of representations.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText
— (String
)The
SELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText
— (String
)The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:-
Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
-
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
IsStale
— (Boolean
)Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status
— (map
)A structure containing information about the state of an asynchronous change to a table.
RequestedBy
— (String
)The ARN of the user who requested the asynchronous change.
UpdatedBy
— (String
)The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime
— (Date
)An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime
— (Date
)An ISO 8601 formatted date string indicating the time that the state was last updated.
Action
— (String
)Indicates which action was called on the table, currently only
Possible values include:CREATE
orUPDATE
."UPDATE"
"CREATE"
State
— (String
)A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different
Error
s for each dialect.ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
Details
— (map
)A
StatusDetails
object with information about the requested change.RequestedChange
— (map
)A
Table
object representing the requested changes.Name
— required — (String
)The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName
— (String
)The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description
— (String
)A description of the table.
Owner
— (String
)The owner of the table.
CreateTime
— (Date
)The time when the table definition was created in the Data Catalog.
UpdateTime
— (Date
)The last time that the table was updated.
LastAccessTime
— (Date
)The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
CreatedBy
— (String
)The person or entity who created the table.
IsRegisteredWithLakeFormation
— (Boolean
)Indicates whether the table has been registered with Lake Formation.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
VersionId
— (String
)The ID of the table version.
FederatedTable
— (map
)A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated table.
DatabaseIdentifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
SubObjects
— (Array<String>
)A list of table Amazon Resource Names (ARNs).
Representations
— (Array<map>
)A list of representations.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText
— (String
)The
SELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText
— (String
)The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:-
Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
-
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
IsStale
— (Boolean
)Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
ViewValidations
— (Array<map>
)A list of
ViewValidation
objects that contain information for an analytical engine to validate a view.Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText
— (String
)The
SELECT
query that defines the view, as provided by the customer.UpdateTime
— (Date
)The time of the last update.
State
— (String
)The state of the validation.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error associated with the validation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
getTableOptimizer(params = {}, callback) ⇒ AWS.Request
Returns the configuration of all optimizers associated with a specified table.
Service Reference:
Examples:
Calling the getTableOptimizer operation
var params = { CatalogId: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ Type: compaction /* required */ }; glue.getTableOptimizer(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 Catalog ID of the table.
DatabaseName
— (String
)The name of the database in the catalog in which the table resides.
TableName
— (String
)The name of the table.
Type
— (String
)The type of table optimizer.
Possible values include:"compaction"
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. Thedata
object has the following properties:CatalogId
— (String
)The Catalog ID of the table.
DatabaseName
— (String
)The name of the database in the catalog in which the table resides.
TableName
— (String
)The name of the table.
TableOptimizer
— (map
)The optimizer associated with the specified table.
type
— (String
)The type of table optimizer. Currently, the only valid value is
Possible values include:compaction
."compaction"
configuration
— (map
)A
TableOptimizerConfiguration
object that was specified when creating or updating a table optimizer.roleArn
— (String
)A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.
enabled
— (Boolean
)Whether table optimization is enabled.
lastRun
— (map
)A
TableOptimizerRun
object representing the last run of the table optimizer.eventType
— (String
)An event type representing the status of the table optimizer run.
Possible values include:"starting"
"completed"
"failed"
"in_progress"
startTimestamp
— (Date
)Represents the epoch timestamp at which the compaction job was started within Lake Formation.
endTimestamp
— (Date
)Represents the epoch timestamp at which the compaction job ended.
metrics
— (map
)A
RunMetrics
object containing metrics for the optimizer run.NumberOfBytesCompacted
— (String
)The number of bytes removed by the compaction job run.
NumberOfFilesCompacted
— (String
)The number of files removed by the compaction job run.
NumberOfDpus
— (String
)The number of DPU hours consumed by the job.
JobDurationInHour
— (String
)The duration of the job in hours.
error
— (String
)An error that occured during the optimizer run.
-
(AWS.Response)
—
Returns:
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 */ AttributesToGet: [ NAME | TABLE_TYPE, /* more items */ ], CatalogId: 'STRING_VALUE', Expression: 'STRING_VALUE', IncludeStatusDetails: true || false, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', QueryAsOfTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, TransactionId: '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 provided, the Amazon Web Services 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.
TransactionId
— (String
)The transaction ID at which to read the table contents.
QueryAsOfTime
— (Date
)The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with
TransactionId
.IncludeStatusDetails
— (Boolean
)Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
AttributesToGet
— (Array<String>
)Specifies the table fields returned by the
GetTables
call. This parameter doesn’t accept an empty list. The request must includeNAME
.The following are the valid combinations of values:
-
NAME
- Names of all tables in the database. -
NAME
,TABLE_TYPE
- Names of all tables and the table types.
-
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. Thedata
object has the following properties:TableList
— (Array<map>
)A list of the requested
Table
objects.Name
— required — (String
)The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName
— (String
)The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description
— (String
)A description of the table.
Owner
— (String
)The owner of the table.
CreateTime
— (Date
)The time when the table definition was created in the Data Catalog.
UpdateTime
— (Date
)The last time that the table was updated.
LastAccessTime
— (Date
)The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
CreatedBy
— (String
)The person or entity who created the table.
IsRegisteredWithLakeFormation
— (Boolean
)Indicates whether the table has been registered with Lake Formation.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
VersionId
— (String
)The ID of the table version.
FederatedTable
— (map
)A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated table.
DatabaseIdentifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
SubObjects
— (Array<String>
)A list of table Amazon Resource Names (ARNs).
Representations
— (Array<map>
)A list of representations.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText
— (String
)The
SELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText
— (String
)The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:-
Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
-
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
IsStale
— (Boolean
)Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status
— (map
)A structure containing information about the state of an asynchronous change to a table.
RequestedBy
— (String
)The ARN of the user who requested the asynchronous change.
UpdatedBy
— (String
)The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime
— (Date
)An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime
— (Date
)An ISO 8601 formatted date string indicating the time that the state was last updated.
Action
— (String
)Indicates which action was called on the table, currently only
Possible values include:CREATE
orUPDATE
."UPDATE"
"CREATE"
State
— (String
)A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different
Error
s for each dialect.ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
Details
— (map
)A
StatusDetails
object with information about the requested change.ViewValidations
— (Array<map>
)A list of
ViewValidation
objects that contain information for an analytical engine to validate a view.Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText
— (String
)The
SELECT
query that defines the view, as provided by the customer.UpdateTime
— (Date
)The time of the last update.
State
— (String
)The state of the validation.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error associated with the validation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
NextToken
— (String
)A continuation token, present if the current list segment is not the last.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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. Thedata
object has the following properties:TableVersion
— (map
)The requested table version.
Table
— (map
)The table in question.
Name
— required — (String
)The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName
— (String
)The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description
— (String
)A description of the table.
Owner
— (String
)The owner of the table.
CreateTime
— (Date
)The time when the table definition was created in the Data Catalog.
UpdateTime
— (Date
)The last time that the table was updated.
LastAccessTime
— (Date
)The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
CreatedBy
— (String
)The person or entity who created the table.
IsRegisteredWithLakeFormation
— (Boolean
)Indicates whether the table has been registered with Lake Formation.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
VersionId
— (String
)The ID of the table version.
FederatedTable
— (map
)A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated table.
DatabaseIdentifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
SubObjects
— (Array<String>
)A list of table Amazon Resource Names (ARNs).
Representations
— (Array<map>
)A list of representations.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText
— (String
)The
SELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText
— (String
)The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:-
Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
-
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
IsStale
— (Boolean
)Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status
— (map
)A structure containing information about the state of an asynchronous change to a table.
RequestedBy
— (String
)The ARN of the user who requested the asynchronous change.
UpdatedBy
— (String
)The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime
— (Date
)An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime
— (Date
)An ISO 8601 formatted date string indicating the time that the state was last updated.
Action
— (String
)Indicates which action was called on the table, currently only
Possible values include:CREATE
orUPDATE
."UPDATE"
"CREATE"
State
— (String
)A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different
Error
s for each dialect.ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
Details
— (map
)A
StatusDetails
object with information about the requested change.ViewValidations
— (Array<map>
)A list of
ViewValidation
objects that contain information for an analytical engine to validate a view.Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText
— (String
)The
SELECT
query that defines the view, as provided by the customer.UpdateTime
— (Date
)The time of the last update.
State
— (String
)The state of the validation.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error associated with the validation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
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.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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. Thedata
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
)The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName
— (String
)The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description
— (String
)A description of the table.
Owner
— (String
)The owner of the table.
CreateTime
— (Date
)The time when the table definition was created in the Data Catalog.
UpdateTime
— (Date
)The last time that the table was updated.
LastAccessTime
— (Date
)The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
CreatedBy
— (String
)The person or entity who created the table.
IsRegisteredWithLakeFormation
— (Boolean
)Indicates whether the table has been registered with Lake Formation.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
VersionId
— (String
)The ID of the table version.
FederatedTable
— (map
)A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated table.
DatabaseIdentifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
SubObjects
— (Array<String>
)A list of table Amazon Resource Names (ARNs).
Representations
— (Array<map>
)A list of representations.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText
— (String
)The
SELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText
— (String
)The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:-
Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
-
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
IsStale
— (Boolean
)Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status
— (map
)A structure containing information about the state of an asynchronous change to a table.
RequestedBy
— (String
)The ARN of the user who requested the asynchronous change.
UpdatedBy
— (String
)The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime
— (Date
)An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime
— (Date
)An ISO 8601 formatted date string indicating the time that the state was last updated.
Action
— (String
)Indicates which action was called on the table, currently only
Possible values include:CREATE
orUPDATE
."UPDATE"
"CREATE"
State
— (String
)A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different
Error
s for each dialect.ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
Details
— (map
)A
StatusDetails
object with information about the requested change.ViewValidations
— (Array<map>
)A list of
ViewValidation
objects that contain information for an analytical engine to validate a view.Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText
— (String
)The
SELECT
query that defines the view, as provided by the customer.UpdateTime
— (Date
)The time of the last update.
State
— (String
)The state of the validation.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error associated with the validation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
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.
-
(AWS.Response)
—
Returns:
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 Resource Name (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. Thedata
object has the following properties:Tags
— (map<String>
)The requested tags.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Trigger
— (map
)The requested trigger definition.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
-
(AWS.Response)
—
Returns:
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 to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are 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. Thedata
object has the following properties:Triggers
— (Array<map>
)A list of triggers for the specified job.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
NextToken
— (String
)A continuation token, if not all the requested triggers have yet been returned.
-
(AWS.Response)
—
Returns:
getUnfilteredPartitionMetadata(params = {}, callback) ⇒ AWS.Request
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
glue:GetPartition
.Service Reference:
Examples:
Calling the getUnfilteredPartitionMetadata operation
var params = { CatalogId: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ PartitionValues: [ /* required */ 'STRING_VALUE', /* more items */ ], SupportedPermissionTypes: [ /* required */ COLUMN_PERMISSION | CELL_FILTER_PERMISSION | NESTED_PERMISSION | NESTED_CELL_PERMISSION, /* more items */ ], TableName: 'STRING_VALUE', /* required */ AuditContext: { AdditionalAuditContext: 'STRING_VALUE', AllColumnsRequested: true || false, RequestedColumns: [ 'STRING_VALUE', /* more items */ ] }, QuerySessionContext: { AdditionalContext: { '<ContextKey>': 'STRING_VALUE', /* '<ContextKey>': ... */ }, ClusterId: 'STRING_VALUE', QueryAuthorizationId: 'STRING_VALUE', QueryId: 'STRING_VALUE', QueryStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, Region: 'STRING_VALUE' }; glue.getUnfilteredPartitionMetadata(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: {})
—
Region
— (String
)Specified only if the base tables belong to a different Amazon Web Services Region.
CatalogId
— (String
)The catalog ID where the partition resides.
DatabaseName
— (String
)(Required) Specifies the name of a database that contains the partition.
TableName
— (String
)(Required) Specifies the name of a table that contains the partition.
PartitionValues
— (Array<String>
)(Required) A list of partition key values.
AuditContext
— (map
)A structure containing Lake Formation audit context information.
AdditionalAuditContext
— (String
)A string containing the additional audit context information.
RequestedColumns
— (Array<String>
)The requested columns for audit.
AllColumnsRequested
— (Boolean
)All columns request for audit.
SupportedPermissionTypes
— (Array<String>
)(Required) A list of supported permission types.
QuerySessionContext
— (map
)A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
QueryId
— (String
)A unique identifier generated by the query engine for the query.
QueryStartTime
— (Date
)A timestamp provided by the query engine for when the query started.
ClusterId
— (String
)An identifier string for the consumer cluster.
QueryAuthorizationId
— (String
)A cryptographically generated query identifier generated by Glue or Lake Formation.
AdditionalContext
— (map<String>
)An opaque string-string map passed by the query engine.
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. Thedata
object has the following properties:Partition
— (map
)A Partition object containing the partition metadata.
Values
— (Array<String>
)The values of the partition.
DatabaseName
— (String
)The name of the catalog database in which to create the partition.
TableName
— (String
)The name of the database table in which to create the partition.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
Parameters
— (map<String>
)These key-value pairs define partition parameters.
LastAnalyzedTime
— (Date
)The last time at which column statistics were computed for this partition.
CatalogId
— (String
)The ID of the Data Catalog in which the partition resides.
AuthorizedColumns
— (Array<String>
)A list of column names that the user has been granted access to.
IsRegisteredWithLakeFormation
— (Boolean
)A Boolean value that indicates whether the partition location is registered with Lake Formation.
-
(AWS.Response)
—
Returns:
getUnfilteredPartitionsMetadata(params = {}, callback) ⇒ AWS.Request
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
glue:GetPartitions
.Service Reference:
Examples:
Calling the getUnfilteredPartitionsMetadata operation
var params = { CatalogId: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ SupportedPermissionTypes: [ /* required */ COLUMN_PERMISSION | CELL_FILTER_PERMISSION | NESTED_PERMISSION | NESTED_CELL_PERMISSION, /* more items */ ], TableName: 'STRING_VALUE', /* required */ AuditContext: { AdditionalAuditContext: 'STRING_VALUE', AllColumnsRequested: true || false, RequestedColumns: [ 'STRING_VALUE', /* more items */ ] }, Expression: 'STRING_VALUE', MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', QuerySessionContext: { AdditionalContext: { '<ContextKey>': 'STRING_VALUE', /* '<ContextKey>': ... */ }, ClusterId: 'STRING_VALUE', QueryAuthorizationId: 'STRING_VALUE', QueryId: 'STRING_VALUE', QueryStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, Region: 'STRING_VALUE', Segment: { SegmentNumber: 'NUMBER_VALUE', /* required */ TotalSegments: 'NUMBER_VALUE' /* required */ } }; glue.getUnfilteredPartitionsMetadata(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: {})
—
Region
— (String
)Specified only if the base tables belong to a different Amazon Web Services Region.
CatalogId
— (String
)The ID of the Data Catalog where the partitions in question reside. If none is provided, 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 table that contains the partition.
Expression
— (String
)An expression that filters 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 whether the values of the two operands are equal; if yes, then the condition becomes true.
Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
(a = b) is not true.
- < >
-
Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.
Example: (a < > b) is true.
- >
-
Checks whether 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 whether 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 whether 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 whether 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 supported partition keys.
-
string
-
date
-
timestamp
-
int
-
bigint
-
long
-
tinyint
-
smallint
-
decimal
If an type is encountered that is not valid, an exception is thrown.
AuditContext
— (map
)A structure containing Lake Formation audit context information.
AdditionalAuditContext
— (String
)A string containing the additional audit context information.
RequestedColumns
— (Array<String>
)The requested columns for audit.
AllColumnsRequested
— (Boolean
)All columns request for audit.
SupportedPermissionTypes
— (Array<String>
)A list of supported permission types.
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 segment. For example, if the total number of segments is 4,
SegmentNumber
values range from 0 through 3.TotalSegments
— required — (Integer
)The total number of segments.
MaxResults
— (Integer
)The maximum number of partitions to return in a single response.
QuerySessionContext
— (map
)A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
QueryId
— (String
)A unique identifier generated by the query engine for the query.
QueryStartTime
— (Date
)A timestamp provided by the query engine for when the query started.
ClusterId
— (String
)An identifier string for the consumer cluster.
QueryAuthorizationId
— (String
)A cryptographically generated query identifier generated by Glue or Lake Formation.
AdditionalContext
— (map<String>
)An opaque string-string map passed by the query engine.
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. Thedata
object has the following properties:UnfilteredPartitions
— (Array<map>
)A list of requested partitions.
Partition
— (map
)The partition object.
Values
— (Array<String>
)The values of the partition.
DatabaseName
— (String
)The name of the catalog database in which to create the partition.
TableName
— (String
)The name of the database table in which to create the partition.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
Parameters
— (map<String>
)These key-value pairs define partition parameters.
LastAnalyzedTime
— (Date
)The last time at which column statistics were computed for this partition.
CatalogId
— (String
)The ID of the Data Catalog in which the partition resides.
AuthorizedColumns
— (Array<String>
)The list of columns the user has permissions to access.
IsRegisteredWithLakeFormation
— (Boolean
)A Boolean value indicating that the partition location is registered with Lake Formation.
NextToken
— (String
)A continuation token, if the returned list of partitions does not include the last one.
-
(AWS.Response)
—
Returns:
getUnfilteredTableMetadata(params = {}, callback) ⇒ AWS.Request
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
For IAM authorization, the public IAM action associated with this API is
glue:GetTable
.Service Reference:
Examples:
Calling the getUnfilteredTableMetadata operation
var params = { CatalogId: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ SupportedPermissionTypes: [ /* required */ COLUMN_PERMISSION | CELL_FILTER_PERMISSION | NESTED_PERMISSION | NESTED_CELL_PERMISSION, /* more items */ ], AuditContext: { AdditionalAuditContext: 'STRING_VALUE', AllColumnsRequested: true || false, RequestedColumns: [ 'STRING_VALUE', /* more items */ ] }, ParentResourceArn: 'STRING_VALUE', Permissions: [ ALL | SELECT | ALTER | DROP | DELETE | INSERT | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS, /* more items */ ], QuerySessionContext: { AdditionalContext: { '<ContextKey>': 'STRING_VALUE', /* '<ContextKey>': ... */ }, ClusterId: 'STRING_VALUE', QueryAuthorizationId: 'STRING_VALUE', QueryId: 'STRING_VALUE', QueryStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, Region: 'STRING_VALUE', RootResourceArn: 'STRING_VALUE', SupportedDialect: { Dialect: REDSHIFT | ATHENA | SPARK, DialectVersion: 'STRING_VALUE' } }; glue.getUnfilteredTableMetadata(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: {})
—
Region
— (String
)Specified only if the base tables belong to a different Amazon Web Services Region.
CatalogId
— (String
)The catalog ID where the table resides.
DatabaseName
— (String
)(Required) Specifies the name of a database that contains the table.
Name
— (String
)(Required) Specifies the name of a table for which you are requesting metadata.
AuditContext
— (map
)A structure containing Lake Formation audit context information.
AdditionalAuditContext
— (String
)A string containing the additional audit context information.
RequestedColumns
— (Array<String>
)The requested columns for audit.
AllColumnsRequested
— (Boolean
)All columns request for audit.
SupportedPermissionTypes
— (Array<String>
)Indicates the level of filtering a third-party analytical engine is capable of enforcing when calling the
GetUnfilteredTableMetadata
API operation. Accepted values are:-
COLUMN_PERMISSION
- Column permissions ensure that users can access only specific columns in the table. If there are particular columns contain sensitive data, data lake administrators can define column filters that exclude access to specific columns. -
CELL_FILTER_PERMISSION
- Cell-level filtering combines column filtering (include or exclude columns) and row filter expressions to restrict access to individual elements in the table. -
NESTED_PERMISSION
- Nested permissions combines cell-level filtering and nested column filtering to restrict access to columns and/or nested columns in specific rows based on row filter expressions. -
NESTED_CELL_PERMISSION
- Nested cell permissions combines nested permission with nested cell-level filtering. This allows different subsets of nested columns to be restricted based on an array of row filter expressions.
Note: Each of these permission types follows a hierarchical order where each subsequent permission type includes all permission of the previous type.
Important: If you provide a supported permission type that doesn't match the user's level of permissions on the table, then Lake Formation raises an exception. For example, if the third-party engine calling the
GetUnfilteredTableMetadata
operation can enforce only column-level filtering, and the user has nested cell filtering applied on the table, Lake Formation throws an exception, and will not return unfiltered table metadata and data access credentials.-
ParentResourceArn
— (String
)The resource ARN of the view.
RootResourceArn
— (String
)The resource ARN of the root view in a chain of nested views.
SupportedDialect
— (map
)A structure specifying the dialect and dialect version used by the query engine.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
Permissions
— (Array<String>
)The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
QuerySessionContext
— (map
)A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
QueryId
— (String
)A unique identifier generated by the query engine for the query.
QueryStartTime
— (Date
)A timestamp provided by the query engine for when the query started.
ClusterId
— (String
)An identifier string for the consumer cluster.
QueryAuthorizationId
— (String
)A cryptographically generated query identifier generated by Glue or Lake Formation.
AdditionalContext
— (map<String>
)An opaque string-string map passed by the query engine.
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. Thedata
object has the following properties:Table
— (map
)A Table object containing the table metadata.
Name
— required — (String
)The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName
— (String
)The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description
— (String
)A description of the table.
Owner
— (String
)The owner of the table.
CreateTime
— (Date
)The time when the table definition was created in the Data Catalog.
UpdateTime
— (Date
)The last time that the table was updated.
LastAccessTime
— (Date
)The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
CreatedBy
— (String
)The person or entity who created the table.
IsRegisteredWithLakeFormation
— (Boolean
)Indicates whether the table has been registered with Lake Formation.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
VersionId
— (String
)The ID of the table version.
FederatedTable
— (map
)A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated table.
DatabaseIdentifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
SubObjects
— (Array<String>
)A list of table Amazon Resource Names (ARNs).
Representations
— (Array<map>
)A list of representations.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText
— (String
)The
SELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText
— (String
)The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:-
Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
-
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
IsStale
— (Boolean
)Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status
— (map
)A structure containing information about the state of an asynchronous change to a table.
RequestedBy
— (String
)The ARN of the user who requested the asynchronous change.
UpdatedBy
— (String
)The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime
— (Date
)An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime
— (Date
)An ISO 8601 formatted date string indicating the time that the state was last updated.
Action
— (String
)Indicates which action was called on the table, currently only
Possible values include:CREATE
orUPDATE
."UPDATE"
"CREATE"
State
— (String
)A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different
Error
s for each dialect.ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
Details
— (map
)A
StatusDetails
object with information about the requested change.RequestedChange
— (map
)A
Table
object representing the requested changes.Name
— required — (String
)The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName
— (String
)The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description
— (String
)A description of the table.
Owner
— (String
)The owner of the table.
CreateTime
— (Date
)The time when the table definition was created in the Data Catalog.
UpdateTime
— (Date
)The last time that the table was updated.
LastAccessTime
— (Date
)The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
CreatedBy
— (String
)The person or entity who created the table.
IsRegisteredWithLakeFormation
— (Boolean
)Indicates whether the table has been registered with Lake Formation.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
VersionId
— (String
)The ID of the table version.
FederatedTable
— (map
)A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated table.
DatabaseIdentifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
SubObjects
— (Array<String>
)A list of table Amazon Resource Names (ARNs).
Representations
— (Array<map>
)A list of representations.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText
— (String
)The
SELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText
— (String
)The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:-
Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
-
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
IsStale
— (Boolean
)Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
ViewValidations
— (Array<map>
)A list of
ViewValidation
objects that contain information for an analytical engine to validate a view.Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText
— (String
)The
SELECT
query that defines the view, as provided by the customer.UpdateTime
— (Date
)The time of the last update.
State
— (String
)The state of the validation.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error associated with the validation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
AuthorizedColumns
— (Array<String>
)A list of column names that the user has been granted access to.
IsRegisteredWithLakeFormation
— (Boolean
)A Boolean value that indicates whether the partition location is registered with Lake Formation.
CellFilters
— (Array<map>
)A list of column row filters.
ColumnName
— (String
)A string containing the name of the column.
RowFilterExpression
— (String
)A string containing the row-level filter expression.
QueryAuthorizationId
— (String
)A cryptographically generated query identifier generated by Glue or Lake Formation.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
ResourceArn
— (String
)The resource ARN of the parent resource extracted from the request.
IsProtected
— (Boolean
)A flag that instructs the engine not to push user-provided operations into the logical plan of the view during query planning. However, if set this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Permissions
— (Array<String>
)The Lake Formation data permissions of the caller on the table. Used to authorize the call when no view context is found.
RowFilter
— (String
)The filter that applies to the table. For example when applying the filter in SQL, it would go in the
WHERE
clause and can be evaluated by using anAND
operator with any other predicates applied by the user querying the table.
-
(AWS.Response)
—
Returns:
getUsageProfile(params = {}, callback) ⇒ AWS.Request
Retrieves information about the specified Glue usage profile.
Service Reference:
Examples:
Calling the getUsageProfile operation
var params = { Name: 'STRING_VALUE' /* required */ }; glue.getUsageProfile(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 usage profile 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. Thedata
object has the following properties:Name
— (String
)The name of the usage profile.
Description
— (String
)A description of the usage profile.
Configuration
— (map
)A
ProfileConfiguration
object specifying the job and session values for the profile.SessionConfiguration
— (map<map>
)A key-value map of configuration parameters for Glue sessions.
DefaultValue
— (String
)A default value for the parameter.
AllowedValues
— (Array<String>
)A list of allowed values for the parameter.
MinValue
— (String
)A minimum allowed value for the parameter.
MaxValue
— (String
)A maximum allowed value for the parameter.
JobConfiguration
— (map<map>
)A key-value map of configuration parameters for Glue jobs.
DefaultValue
— (String
)A default value for the parameter.
AllowedValues
— (Array<String>
)A list of allowed values for the parameter.
MinValue
— (String
)A minimum allowed value for the parameter.
MaxValue
— (String
)A maximum allowed value for the parameter.
CreatedOn
— (Date
)The date and time when the usage profile was created.
LastModifiedOn
— (Date
)The date and time when the usage profile was last modified.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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. Thedata
object has the following properties:UserDefinedFunction
— (map
)The requested function definition.
FunctionName
— (String
)The name of the function.
DatabaseName
— (String
)The name of the catalog database that contains 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.
CatalogId
— (String
)The ID of the Data Catalog in which the function resides.
-
(AWS.Response)
—
Returns:
getUserDefinedFunctions(params = {}, callback) ⇒ AWS.Request
Retrieves multiple function definitions from the Data Catalog.
Service Reference:
Examples:
Calling the getUserDefinedFunctions operation
var params = { Pattern: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE', DatabaseName: '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 provided, the Amazon Web Services account ID is used by default.
DatabaseName
— (String
)The name of the catalog database where the functions are located. If none is provided, functions from all the databases across the catalog will be returned.
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. Thedata
object has the following properties:UserDefinedFunctions
— (Array<map>
)A list of requested function definitions.
FunctionName
— (String
)The name of the function.
DatabaseName
— (String
)The name of the catalog database that contains 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.
CatalogId
— (String
)The ID of the Data Catalog in which the function resides.
NextToken
— (String
)A continuation token, if the list of functions returned does not include the last requested function.
-
(AWS.Response)
—
Returns:
getWorkflow(params = {}, callback) ⇒ AWS.Request
Retrieves resource metadata for a workflow.
Service Reference:
Examples:
Calling the getWorkflow operation
var params = { Name: 'STRING_VALUE', /* required */ IncludeGraph: true || false }; glue.getWorkflow(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 workflow to retrieve.
IncludeGraph
— (Boolean
)Specifies whether to include a graph when returning the workflow resource metadata.
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. Thedata
object has the following properties:Workflow
— (map
)The resource metadata for the workflow.
Name
— (String
)The name of the workflow.
Description
— (String
)A description of the workflow.
DefaultRunProperties
— (map<String>
)A collection of properties to be used as part of each execution of the workflow. The run properties are made available to each job in the workflow. A job can modify the properties for the next jobs in the flow.
CreatedOn
— (Date
)The date and time when the workflow was created.
LastModifiedOn
— (Date
)The date and time when the workflow was last modified.
LastRun
— (map
)The information about the last execution of the workflow.
Name
— (String
)Name of the workflow that was run.
WorkflowRunId
— (String
)The ID of this workflow run.
PreviousRunId
— (String
)The ID of the previous workflow run.
WorkflowRunProperties
— (map<String>
)The workflow run properties which were set during the run.
StartedOn
— (Date
)The date and time when the workflow run was started.
CompletedOn
— (Date
)The date and time when the workflow run completed.
Status
— (String
)The status of the workflow run.
Possible values include:"RUNNING"
"COMPLETED"
"STOPPING"
"STOPPED"
"ERROR"
ErrorMessage
— (String
)This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow:
foo
."Statistics
— (map
)The statistics of the run.
TotalActions
— (Integer
)Total number of Actions in the workflow run.
TimeoutActions
— (Integer
)Total number of Actions that timed out.
FailedActions
— (Integer
)Total number of Actions that have failed.
StoppedActions
— (Integer
)Total number of Actions that have stopped.
SucceededActions
— (Integer
)Total number of Actions that have succeeded.
RunningActions
— (Integer
)Total number Actions in running state.
ErroredActions
— (Integer
)Indicates the count of job runs in the ERROR state in the workflow run.
WaitingActions
— (Integer
)Indicates the count of job runs in WAITING state in the workflow run.
Graph
— (map
)The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes
— (Array<map>
)A list of the the Glue components belong to the workflow represented as nodes.
Type
— (String
)The type of Glue component represented by the node.
Possible values include:"CRAWLER"
"JOB"
"TRIGGER"
Name
— (String
)The name of the Glue component represented by the node.
UniqueId
— (String
)The unique Id assigned to the node within the workflow.
TriggerDetails
— (map
)Details of the Trigger when the node represents a Trigger.
Trigger
— (map
)The information of the trigger represented by the trigger node.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails
— (map
)Details of the Job when the node represents a Job.
JobRuns
— (Array<map>
)The information for the job runs represented by the job node.
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 theStartJobRun
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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
StartedOn
— (Date
)The date and time at which this job run was started.
LastModifiedOn
— (Date
)The last time that this job run was modified.
CompletedOn
— (Date
)The date and time that this job run completed.
JobRunState
— (String
)The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs 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 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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 Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption isNONE
. If you add a role name andSecurityConfiguration
name (in other words,/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds
— (Float
)This field can be set for either job runs with execution class
FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X
, 2 forG.2X
, or 0.25 forG.025X
workers). This value may be different than theexecutionEngineRuntime
*MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than theMaxCapacity
. Therefore, it is possible that the value ofDPUSeconds
is less thanexecutionEngineRuntime
*MaxCapacity
.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job run.
StateDetail
— (String
)This field holds details that pertain to the state of a job run. The field is nullable.
For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.
CrawlerDetails
— (map
)Details of the crawler when the node represents a crawler.
Crawls
— (Array<map>
)A list of crawls represented by the crawl node.
State
— (String
)The state of the crawler.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
StartedOn
— (Date
)The date and time on which the crawl started.
CompletedOn
— (Date
)The date and time on which the crawl completed.
ErrorMessage
— (String
)The error message associated with the crawl.
LogGroup
— (String
)The log group associated with the crawl.
LogStream
— (String
)The log stream associated with the crawl.
Edges
— (Array<map>
)A list of all the directed connections between the nodes belonging to the workflow.
SourceId
— (String
)The unique of the node within the workflow where the edge starts.
DestinationId
— (String
)The unique of the node within the workflow where the edge ends.
StartingEventBatchCondition
— (map
)The batch condition that started the workflow run.
BatchSize
— (Integer
)Number of events in the batch.
BatchWindow
— (Integer
)Duration of the batch window in seconds.
Graph
— (map
)The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes
— (Array<map>
)A list of the the Glue components belong to the workflow represented as nodes.
Type
— (String
)The type of Glue component represented by the node.
Possible values include:"CRAWLER"
"JOB"
"TRIGGER"
Name
— (String
)The name of the Glue component represented by the node.
UniqueId
— (String
)The unique Id assigned to the node within the workflow.
TriggerDetails
— (map
)Details of the Trigger when the node represents a Trigger.
Trigger
— (map
)The information of the trigger represented by the trigger node.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails
— (map
)Details of the Job when the node represents a Job.
JobRuns
— (Array<map>
)The information for the job runs represented by the job node.
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 theStartJobRun
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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
StartedOn
— (Date
)The date and time at which this job run was started.
LastModifiedOn
— (Date
)The last time that this job run was modified.
CompletedOn
— (Date
)The date and time that this job run completed.
JobRunState
— (String
)The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs 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 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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 Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption isNONE
. If you add a role name andSecurityConfiguration
name (in other words,/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds
— (Float
)This field can be set for either job runs with execution class
FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X
, 2 forG.2X
, or 0.25 forG.025X
workers). This value may be different than theexecutionEngineRuntime
*MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than theMaxCapacity
. Therefore, it is possible that the value ofDPUSeconds
is less thanexecutionEngineRuntime
*MaxCapacity
.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job run.
StateDetail
— (String
)This field holds details that pertain to the state of a job run. The field is nullable.
For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.
CrawlerDetails
— (map
)Details of the crawler when the node represents a crawler.
Crawls
— (Array<map>
)A list of crawls represented by the crawl node.
State
— (String
)The state of the crawler.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
StartedOn
— (Date
)The date and time on which the crawl started.
CompletedOn
— (Date
)The date and time on which the crawl completed.
ErrorMessage
— (String
)The error message associated with the crawl.
LogGroup
— (String
)The log group associated with the crawl.
LogStream
— (String
)The log stream associated with the crawl.
Edges
— (Array<map>
)A list of all the directed connections between the nodes belonging to the workflow.
SourceId
— (String
)The unique of the node within the workflow where the edge starts.
DestinationId
— (String
)The unique of the node within the workflow where the edge ends.
MaxConcurrentRuns
— (Integer
)You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
BlueprintDetails
— (map
)This structure indicates the details of the blueprint that this particular workflow is created from.
BlueprintName
— (String
)The name of the blueprint.
RunId
— (String
)The run ID for this blueprint.
-
(AWS.Response)
—
Returns:
getWorkflowRun(params = {}, callback) ⇒ AWS.Request
Retrieves the metadata for a given workflow run. Job run history is accessible for 90 days for your workflow and job run.
Service Reference:
Examples:
Calling the getWorkflowRun operation
var params = { Name: 'STRING_VALUE', /* required */ RunId: 'STRING_VALUE', /* required */ IncludeGraph: true || false }; glue.getWorkflowRun(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 workflow being run.
RunId
— (String
)The ID of the workflow run.
IncludeGraph
— (Boolean
)Specifies whether to include the workflow graph in response or not.
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. Thedata
object has the following properties:Run
— (map
)The requested workflow run metadata.
Name
— (String
)Name of the workflow that was run.
WorkflowRunId
— (String
)The ID of this workflow run.
PreviousRunId
— (String
)The ID of the previous workflow run.
WorkflowRunProperties
— (map<String>
)The workflow run properties which were set during the run.
StartedOn
— (Date
)The date and time when the workflow run was started.
CompletedOn
— (Date
)The date and time when the workflow run completed.
Status
— (String
)The status of the workflow run.
Possible values include:"RUNNING"
"COMPLETED"
"STOPPING"
"STOPPED"
"ERROR"
ErrorMessage
— (String
)This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow:
foo
."Statistics
— (map
)The statistics of the run.
TotalActions
— (Integer
)Total number of Actions in the workflow run.
TimeoutActions
— (Integer
)Total number of Actions that timed out.
FailedActions
— (Integer
)Total number of Actions that have failed.
StoppedActions
— (Integer
)Total number of Actions that have stopped.
SucceededActions
— (Integer
)Total number of Actions that have succeeded.
RunningActions
— (Integer
)Total number Actions in running state.
ErroredActions
— (Integer
)Indicates the count of job runs in the ERROR state in the workflow run.
WaitingActions
— (Integer
)Indicates the count of job runs in WAITING state in the workflow run.
Graph
— (map
)The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes
— (Array<map>
)A list of the the Glue components belong to the workflow represented as nodes.
Type
— (String
)The type of Glue component represented by the node.
Possible values include:"CRAWLER"
"JOB"
"TRIGGER"
Name
— (String
)The name of the Glue component represented by the node.
UniqueId
— (String
)The unique Id assigned to the node within the workflow.
TriggerDetails
— (map
)Details of the Trigger when the node represents a Trigger.
Trigger
— (map
)The information of the trigger represented by the trigger node.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails
— (map
)Details of the Job when the node represents a Job.
JobRuns
— (Array<map>
)The information for the job runs represented by the job node.
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 theStartJobRun
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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
StartedOn
— (Date
)The date and time at which this job run was started.
LastModifiedOn
— (Date
)The last time that this job run was modified.
CompletedOn
— (Date
)The date and time that this job run completed.
JobRunState
— (String
)The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs 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 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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 Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption isNONE
. If you add a role name andSecurityConfiguration
name (in other words,/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds
— (Float
)This field can be set for either job runs with execution class
FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X
, 2 forG.2X
, or 0.25 forG.025X
workers). This value may be different than theexecutionEngineRuntime
*MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than theMaxCapacity
. Therefore, it is possible that the value ofDPUSeconds
is less thanexecutionEngineRuntime
*MaxCapacity
.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job run.
StateDetail
— (String
)This field holds details that pertain to the state of a job run. The field is nullable.
For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.
CrawlerDetails
— (map
)Details of the crawler when the node represents a crawler.
Crawls
— (Array<map>
)A list of crawls represented by the crawl node.
State
— (String
)The state of the crawler.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
StartedOn
— (Date
)The date and time on which the crawl started.
CompletedOn
— (Date
)The date and time on which the crawl completed.
ErrorMessage
— (String
)The error message associated with the crawl.
LogGroup
— (String
)The log group associated with the crawl.
LogStream
— (String
)The log stream associated with the crawl.
Edges
— (Array<map>
)A list of all the directed connections between the nodes belonging to the workflow.
SourceId
— (String
)The unique of the node within the workflow where the edge starts.
DestinationId
— (String
)The unique of the node within the workflow where the edge ends.
StartingEventBatchCondition
— (map
)The batch condition that started the workflow run.
BatchSize
— (Integer
)Number of events in the batch.
BatchWindow
— (Integer
)Duration of the batch window in seconds.
-
(AWS.Response)
—
Returns:
getWorkflowRunProperties(params = {}, callback) ⇒ AWS.Request
Retrieves the workflow run properties which were set during the run.
Service Reference:
Examples:
Calling the getWorkflowRunProperties operation
var params = { Name: 'STRING_VALUE', /* required */ RunId: 'STRING_VALUE' /* required */ }; glue.getWorkflowRunProperties(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 workflow which was run.
RunId
— (String
)The ID of the workflow run whose run properties 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. Thedata
object has the following properties:RunProperties
— (map<String>
)The workflow run properties which were set during the specified run.
-
(AWS.Response)
—
Returns:
getWorkflowRuns(params = {}, callback) ⇒ AWS.Request
Retrieves metadata for all runs of a given workflow.
Service Reference:
Examples:
Calling the getWorkflowRuns operation
var params = { Name: 'STRING_VALUE', /* required */ IncludeGraph: true || false, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.getWorkflowRuns(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 workflow whose metadata of runs should be returned.
IncludeGraph
— (Boolean
)Specifies whether to include the workflow graph in response or not.
NextToken
— (String
)The maximum size of the response.
MaxResults
— (Integer
)The maximum number of workflow runs to be included in 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. Thedata
object has the following properties:Runs
— (Array<map>
)A list of workflow run metadata objects.
Name
— (String
)Name of the workflow that was run.
WorkflowRunId
— (String
)The ID of this workflow run.
PreviousRunId
— (String
)The ID of the previous workflow run.
WorkflowRunProperties
— (map<String>
)The workflow run properties which were set during the run.
StartedOn
— (Date
)The date and time when the workflow run was started.
CompletedOn
— (Date
)The date and time when the workflow run completed.
Status
— (String
)The status of the workflow run.
Possible values include:"RUNNING"
"COMPLETED"
"STOPPING"
"STOPPED"
"ERROR"
ErrorMessage
— (String
)This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow:
foo
."Statistics
— (map
)The statistics of the run.
TotalActions
— (Integer
)Total number of Actions in the workflow run.
TimeoutActions
— (Integer
)Total number of Actions that timed out.
FailedActions
— (Integer
)Total number of Actions that have failed.
StoppedActions
— (Integer
)Total number of Actions that have stopped.
SucceededActions
— (Integer
)Total number of Actions that have succeeded.
RunningActions
— (Integer
)Total number Actions in running state.
ErroredActions
— (Integer
)Indicates the count of job runs in the ERROR state in the workflow run.
WaitingActions
— (Integer
)Indicates the count of job runs in WAITING state in the workflow run.
Graph
— (map
)The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
Nodes
— (Array<map>
)A list of the the Glue components belong to the workflow represented as nodes.
Type
— (String
)The type of Glue component represented by the node.
Possible values include:"CRAWLER"
"JOB"
"TRIGGER"
Name
— (String
)The name of the Glue component represented by the node.
UniqueId
— (String
)The unique Id assigned to the node within the workflow.
TriggerDetails
— (map
)Details of the Trigger when the node represents a Trigger.
Trigger
— (map
)The information of the trigger represented by the trigger node.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
JobDetails
— (map
)Details of the Job when the node represents a Job.
JobRuns
— (Array<map>
)The information for the job runs represented by the job node.
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 theStartJobRun
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.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
StartedOn
— (Date
)The date and time at which this job run was started.
LastModifiedOn
— (Date
)The last time that this job run was modified.
CompletedOn
— (Date
)The date and time that this job run completed.
JobRunState
— (String
)The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs 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 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.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 Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption isNONE
. If you add a role name andSecurityConfiguration
name (in other words,/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is used to encrypt the log group.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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
DPUSeconds
— (Float
)This field can be set for either job runs with execution class
FLEX
or when Auto Scaling is enabled, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 forG.1X
, 2 forG.2X
, or 0.25 forG.025X
workers). This value may be different than theexecutionEngineRuntime
*MaxCapacity
as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than theMaxCapacity
. Therefore, it is possible that the value ofDPUSeconds
is less thanexecutionEngineRuntime
*MaxCapacity
.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
ProfileName
— (String
)The name of an Glue usage profile associated with the job run.
StateDetail
— (String
)This field holds details that pertain to the state of a job run. The field is nullable.
For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.
CrawlerDetails
— (map
)Details of the crawler when the node represents a crawler.
Crawls
— (Array<map>
)A list of crawls represented by the crawl node.
State
— (String
)The state of the crawler.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
StartedOn
— (Date
)The date and time on which the crawl started.
CompletedOn
— (Date
)The date and time on which the crawl completed.
ErrorMessage
— (String
)The error message associated with the crawl.
LogGroup
— (String
)The log group associated with the crawl.
LogStream
— (String
)The log stream associated with the crawl.
Edges
— (Array<map>
)A list of all the directed connections between the nodes belonging to the workflow.
SourceId
— (String
)The unique of the node within the workflow where the edge starts.
DestinationId
— (String
)The unique of the node within the workflow where the edge ends.
StartingEventBatchCondition
— (map
)The batch condition that started the workflow run.
BatchSize
— (Integer
)Number of events in the batch.
BatchWindow
— (Integer
)Duration of the batch window in seconds.
NextToken
— (String
)A continuation token, if not all requested workflow runs have been returned.
-
(AWS.Response)
—
Returns:
importCatalogToGlue(params = {}, callback) ⇒ AWS.Request
Imports an existing Amazon Athena Data Catalog to 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 Amazon Web Services 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.
-
(AWS.Response)
—
Returns:
listBlueprints(params = {}, callback) ⇒ AWS.Request
Lists all the blueprint names in an account.
Service Reference:
Examples:
Calling the listBlueprints operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.listBlueprints(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>
)Filters the list by an Amazon Web Services resource tag.
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. Thedata
object has the following properties:Blueprints
— (Array<String>
)List of names of blueprints in the account.
NextToken
— (String
)A continuation token, if not all blueprint names have been returned.
-
(AWS.Response)
—
Returns:
listColumnStatisticsTaskRuns(params = {}, callback) ⇒ AWS.Request
List all task runs for a particular account.
Service Reference:
Examples:
Calling the listColumnStatisticsTaskRuns operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listColumnStatisticsTaskRuns(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 the response.
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. Thedata
object has the following properties:ColumnStatisticsTaskRunIds
— (Array<String>
)A list of column statistics task run IDs.
NextToken
— (String
)A continuation token, if not all task run IDs have yet been returned.
-
(AWS.Response)
—
Returns:
listCrawlers(params = {}, callback) ⇒ AWS.Request
Retrieves the names of all crawler resources in this Amazon Web Services 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 are 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. Thedata
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.
-
(AWS.Response)
—
Returns:
listCrawls(params = {}, callback) ⇒ AWS.Request
Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.
You may use this API to:
-
Retrive all the crawls of a specified crawler.
-
Retrieve all the crawls of a specified crawler within a limited count.
-
Retrieve all the crawls of a specified crawler in a specific time range.
-
Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.
Service Reference:
Examples:
Calling the listCrawls operation
var params = { CrawlerName: 'STRING_VALUE', /* required */ Filters: [ { FieldName: CRAWL_ID | STATE | START_TIME | END_TIME | DPU_HOUR, FieldValue: 'STRING_VALUE', FilterOperator: GT | GE | LT | LE | EQ | NE }, /* more items */ ], MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listCrawls(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
)The name of the crawler whose runs you want to retrieve.
MaxResults
— (Integer
)The maximum number of results to return. The default is 20, and maximum is 100.
Filters
— (Array<map>
)Filters the crawls by the criteria you specify in a list of
CrawlsFilter
objects.FieldName
— (String
)A key used to filter the crawler runs for a specified crawler. Valid values for each of the field names are:
-
CRAWL_ID
: A string representing the UUID identifier for a crawl. -
STATE
: A string representing the state of the crawl. -
START_TIME
andEND_TIME
: The epoch timestamp in milliseconds. -
DPU_HOUR
: The number of data processing unit (DPU) hours used for the crawl.
"CRAWL_ID"
"STATE"
"START_TIME"
"END_TIME"
"DPU_HOUR"
-
FilterOperator
— (String
)A defined comparator that operates on the value. The available operators are:
-
GT
: Greater than. -
GE
: Greater than or equal to. -
LT
: Less than. -
LE
: Less than or equal to. -
EQ
: Equal to. -
NE
: Not equal to.
"GT"
"GE"
"LT"
"LE"
"EQ"
"NE"
-
FieldValue
— (String
)The value provided for comparison on the crawl field.
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. Thedata
object has the following properties:Crawls
— (Array<map>
)A list of
CrawlerHistory
objects representing the crawl runs that meet your criteria.CrawlId
— (String
)A UUID identifier for each crawl.
State
— (String
)The state of the crawl.
Possible values include:"RUNNING"
"COMPLETED"
"FAILED"
"STOPPED"
StartTime
— (Date
)The date and time on which the crawl started.
EndTime
— (Date
)The date and time on which the crawl ended.
Summary
— (String
)A run summary for the specific crawl in JSON. Contains the catalog tables and partitions that were added, updated, or deleted.
ErrorMessage
— (String
)If an error occurred, the error message associated with the crawl.
LogGroup
— (String
)The log group associated with the crawl.
LogStream
— (String
)The log stream associated with the crawl.
MessagePrefix
— (String
)The prefix for a CloudWatch message about this crawl.
DPUHour
— (Float
)The number of data processing units (DPU) used in hours for the crawl.
NextToken
— (String
)A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
-
(AWS.Response)
—
Returns:
listCustomEntityTypes(params = {}, callback) ⇒ AWS.Request
Lists all the custom patterns that have been created.
Service Reference:
Examples:
Calling the listCustomEntityTypes operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.listCustomEntityTypes(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 paginated token to offset the results.
MaxResults
— (Integer
)The maximum number of results to return.
Tags
— (map<String>
)A list of key-value pair 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. Thedata
object has the following properties:CustomEntityTypes
— (Array<map>
)A list of
CustomEntityType
objects representing custom patterns.Name
— required — (String
)A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.
RegexString
— required — (String
)A regular expression string that is used for detecting sensitive data in a custom pattern.
ContextWords
— (Array<String>
)A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.
If no context words are passed only a regular expression is checked.
NextToken
— (String
)A pagination token, if more results are available.
-
(AWS.Response)
—
Returns:
listDataQualityResults(params = {}, callback) ⇒ AWS.Request
Returns all data quality execution results for your account.
Service Reference:
Examples:
Calling the listDataQualityResults operation
var params = { Filter: { DataSource: { GlueTable: { /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ AdditionalOptions: { '<NameString>': 'STRING_VALUE', /* '<NameString>': ... */ }, CatalogId: 'STRING_VALUE', ConnectionName: 'STRING_VALUE' } }, JobName: 'STRING_VALUE', JobRunId: 'STRING_VALUE', StartedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, StartedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listDataQualityResults(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: {})
—
Filter
— (map
)The filter criteria.
DataSource
— (map
)Filter results by the specified data source. For example, retrieving all results for an Glue table.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
JobName
— (String
)Filter results by the specified job name.
JobRunId
— (String
)Filter results by the specified job run ID.
StartedAfter
— (Date
)Filter results by runs that started after this time.
StartedBefore
— (Date
)Filter results by runs that started before this time.
NextToken
— (String
)A paginated token to offset the results.
MaxResults
— (Integer
)The maximum number of results to return.
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. Thedata
object has the following properties:Results
— (Array<map>
)A list of
DataQualityResultDescription
objects.ResultId
— (String
)The unique result ID for this data quality result.
DataSource
— (map
)The table name associated with the data quality result.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
JobName
— (String
)The job name associated with the data quality result.
JobRunId
— (String
)The job run ID associated with the data quality result.
StartedOn
— (Date
)The time that the run started for this data quality result.
NextToken
— (String
)A pagination token, if more results are available.
-
(AWS.Response)
—
Returns:
listDataQualityRuleRecommendationRuns(params = {}, callback) ⇒ AWS.Request
Lists the recommendation runs meeting the filter criteria.
Service Reference:
Examples:
Calling the listDataQualityRuleRecommendationRuns operation
var params = { Filter: { DataSource: { /* required */ GlueTable: { /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ AdditionalOptions: { '<NameString>': 'STRING_VALUE', /* '<NameString>': ... */ }, CatalogId: 'STRING_VALUE', ConnectionName: 'STRING_VALUE' } }, StartedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, StartedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listDataQualityRuleRecommendationRuns(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: {})
—
Filter
— (map
)The filter criteria.
DataSource
— required — (map
)Filter based on a specified data source (Glue table).
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
StartedBefore
— (Date
)Filter based on time for results started before provided time.
StartedAfter
— (Date
)Filter based on time for results started after provided time.
NextToken
— (String
)A paginated token to offset the results.
MaxResults
— (Integer
)The maximum number of results to return.
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. Thedata
object has the following properties:Runs
— (Array<map>
)A list of
DataQualityRuleRecommendationRunDescription
objects.RunId
— (String
)The unique run identifier associated with this run.
Status
— (String
)The status for this run.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
StartedOn
— (Date
)The date and time when this run started.
DataSource
— (map
)The data source (Glue table) associated with the recommendation run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
NextToken
— (String
)A pagination token, if more results are available.
-
(AWS.Response)
—
Returns:
listDataQualityRulesetEvaluationRuns(params = {}, callback) ⇒ AWS.Request
Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
Service Reference:
Examples:
Calling the listDataQualityRulesetEvaluationRuns operation
var params = { Filter: { DataSource: { /* required */ GlueTable: { /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ AdditionalOptions: { '<NameString>': 'STRING_VALUE', /* '<NameString>': ... */ }, CatalogId: 'STRING_VALUE', ConnectionName: 'STRING_VALUE' } }, StartedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, StartedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listDataQualityRulesetEvaluationRuns(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: {})
—
Filter
— (map
)The filter criteria.
DataSource
— required — (map
)Filter based on a data source (an Glue table) associated with the run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
StartedBefore
— (Date
)Filter results by runs that started before this time.
StartedAfter
— (Date
)Filter results by runs that started after this time.
NextToken
— (String
)A paginated token to offset the results.
MaxResults
— (Integer
)The maximum number of results to return.
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. Thedata
object has the following properties:Runs
— (Array<map>
)A list of
DataQualityRulesetEvaluationRunDescription
objects representing data quality ruleset runs.RunId
— (String
)The unique run identifier associated with this run.
Status
— (String
)The status for this run.
Possible values include:"STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
StartedOn
— (Date
)The date and time when the run started.
DataSource
— (map
)The data source (an Glue table) associated with the run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
NextToken
— (String
)A pagination token, if more results are available.
-
(AWS.Response)
—
Returns:
listDataQualityRulesets(params = {}, callback) ⇒ AWS.Request
Returns a paginated list of rulesets for the specified list of Glue tables.
Service Reference:
Examples:
Calling the listDataQualityRulesets operation
var params = { Filter: { CreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, CreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, Description: 'STRING_VALUE', LastModifiedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, LastModifiedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, Name: 'STRING_VALUE', TargetTable: { DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' } }, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.listDataQualityRulesets(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 paginated token to offset the results.
MaxResults
— (Integer
)The maximum number of results to return.
Filter
— (map
)The filter criteria.
Name
— (String
)The name of the ruleset filter criteria.
Description
— (String
)The description of the ruleset filter criteria.
CreatedBefore
— (Date
)Filter on rulesets created before this date.
CreatedAfter
— (Date
)Filter on rulesets created after this date.
LastModifiedBefore
— (Date
)Filter on rulesets last modified before this date.
LastModifiedAfter
— (Date
)Filter on rulesets last modified after this date.
TargetTable
— (map
)The name and database name of the target table.
TableName
— required — (String
)The name of the Glue table.
DatabaseName
— required — (String
)The name of the database where the Glue table exists.
CatalogId
— (String
)The catalog id where the Glue table exists.
Tags
— (map<String>
)A list of key-value pair 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. Thedata
object has the following properties:Rulesets
— (Array<map>
)A paginated list of rulesets for the specified list of Glue tables.
Name
— (String
)The name of the data quality ruleset.
Description
— (String
)A description of the data quality ruleset.
CreatedOn
— (Date
)The date and time the data quality ruleset was created.
LastModifiedOn
— (Date
)The date and time the data quality ruleset was last modified.
TargetTable
— (map
)An object representing an Glue table.
TableName
— required — (String
)The name of the Glue table.
DatabaseName
— required — (String
)The name of the database where the Glue table exists.
CatalogId
— (String
)The catalog id where the Glue table exists.
RecommendationRunId
— (String
)When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
RuleCount
— (Integer
)The number of rules in the ruleset.
NextToken
— (String
)A pagination token, if more results are available.
-
(AWS.Response)
—
Returns:
listDataQualityStatisticAnnotations(params = {}, callback) ⇒ AWS.Request
Retrieve annotations for a data quality statistic.
Service Reference:
Examples:
Calling the listDataQualityStatisticAnnotations operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', ProfileId: 'STRING_VALUE', StatisticId: 'STRING_VALUE', TimestampFilter: { RecordedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, RecordedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 } }; glue.listDataQualityStatisticAnnotations(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: {})
—
StatisticId
— (String
)The Statistic ID.
ProfileId
— (String
)The Profile ID.
TimestampFilter
— (map
)A timestamp filter.
RecordedBefore
— (Date
)The timestamp before which statistics should be included in the results.
RecordedAfter
— (Date
)The timestamp after which statistics should be included in the results.
MaxResults
— (Integer
)The maximum number of results to return in this request.
NextToken
— (String
)A pagination token to retrieve the next set of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Annotations
— (Array<map>
)A list of
StatisticAnnotation
applied to the StatisticProfileId
— (String
)The Profile ID.
StatisticId
— (String
)The Statistic ID.
StatisticRecordedOn
— (Date
)The timestamp when the annotated statistic was recorded.
InclusionAnnotation
— (map
)The inclusion annotation applied to the statistic.
Value
— (String
)The inclusion annotation value.
Possible values include:"INCLUDE"
"EXCLUDE"
LastModifiedOn
— (Date
)The timestamp when the inclusion annotation was last modified.
NextToken
— (String
)A pagination token to retrieve the next set of results.
-
(AWS.Response)
—
Returns:
listDataQualityStatistics(params = {}, callback) ⇒ AWS.Request
Retrieves a list of data quality statistics.
Service Reference:
Examples:
Calling the listDataQualityStatistics operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', ProfileId: 'STRING_VALUE', StatisticId: 'STRING_VALUE', TimestampFilter: { RecordedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, RecordedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 } }; glue.listDataQualityStatistics(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: {})
—
StatisticId
— (String
)The Statistic ID.
ProfileId
— (String
)The Profile ID.
TimestampFilter
— (map
)A timestamp filter.
RecordedBefore
— (Date
)The timestamp before which statistics should be included in the results.
RecordedAfter
— (Date
)The timestamp after which statistics should be included in the results.
MaxResults
— (Integer
)The maximum number of results to return in this request.
NextToken
— (String
)A pagination token to request the next page of results.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Statistics
— (Array<map>
)A
StatisticSummaryList
.StatisticId
— (String
)The Statistic ID.
ProfileId
— (String
)The Profile ID.
RunIdentifier
— (map
)The Run Identifier
RunId
— (String
)The Run ID.
JobRunId
— (String
)The Job Run ID.
StatisticName
— (String
)The name of the statistic.
DoubleValue
— (Float
)The value of the statistic.
EvaluationLevel
— (String
)The evaluation level of the statistic. Possible values:
Possible values include:Dataset
,Column
,Multicolumn
."Dataset"
"Column"
"Multicolumn"
ColumnsReferenced
— (Array<String>
)The list of columns referenced by the statistic.
ReferencedDatasets
— (Array<String>
)The list of datasets referenced by the statistic.
StatisticProperties
— (map<String>
)A
StatisticPropertiesMap
, which contains aNameString
andDescriptionString
RecordedOn
— (Date
)The timestamp when the statistic was recorded.
InclusionAnnotation
— (map
)The inclusion annotation for the statistic.
Value
— (String
)The inclusion annotation value.
Possible values include:"INCLUDE"
"EXCLUDE"
LastModifiedOn
— (Date
)The timestamp when the inclusion annotation was last modified.
NextToken
— (String
)A pagination token to request the next page of results.
-
(AWS.Response)
—
Returns:
listDevEndpoints(params = {}, callback) ⇒ AWS.Request
Retrieves the names of all
DevEndpoint
resources in this Amazon Web Services 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 are 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. Thedata
object has the following properties:DevEndpointNames
— (Array<String>
)The names of all the
DevEndpoint
s in the account, or theDevEndpoint
s with the specified tags.NextToken
— (String
)A continuation token, if the returned list does not contain the last metric available.
-
(AWS.Response)
—
Returns:
listJobs(params = {}, callback) ⇒ AWS.Request
Retrieves the names of all job resources in this Amazon Web Services 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 are 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. Thedata
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.
-
(AWS.Response)
—
Returns:
listMLTransforms(params = {}, callback) ⇒ AWS.Request
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional
Tags
field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.Service Reference:
Examples:
Calling the listMLTransforms operation
var params = { Filter: { CreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, CreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, GlueVersion: 'STRING_VALUE', LastModifiedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, LastModifiedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, Name: 'STRING_VALUE', Schema: [ { DataType: 'STRING_VALUE', Name: 'STRING_VALUE' }, /* more items */ ], Status: NOT_READY | READY | DELETING, TransformType: FIND_MATCHES }, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', Sort: { Column: NAME | TRANSFORM_TYPE | STATUS | CREATED | LAST_MODIFIED, /* required */ SortDirection: DESCENDING | ASCENDING /* required */ }, Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.listMLTransforms(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.
Filter
— (map
)A
TransformFilterCriteria
used to filter the machine learning transforms.Name
— (String
)A unique transform name that is used to filter the machine learning transforms.
TransformType
— (String
)The type of machine learning transform that is used to filter the machine learning transforms.
Possible values include:"FIND_MATCHES"
Status
— (String
)Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
Possible values include:"NOT_READY"
"READY"
"DELETING"
GlueVersion
— (String
)This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
CreatedBefore
— (Date
)The time and date before which the transforms were created.
CreatedAfter
— (Date
)The time and date after which the transforms were created.
LastModifiedBefore
— (Date
)Filter on transforms last modified before this date.
LastModifiedAfter
— (Date
)Filter on transforms last modified after this date.
Schema
— (Array<map>
)Filters on datasets with a specific schema. The
Map<Column, Type>
object is an array of key-value pairs representing the schema this transform accepts, whereColumn
is the name of a column, andType
is the type of the data such as an integer or string. Has an upper bound of 100 columns.Name
— (String
)The name of the column.
DataType
— (String
)The type of data in the column.
Sort
— (map
)A
TransformSortCriteria
used to sort the machine learning transforms.Column
— required — (String
)The column to be used in the sorting criteria that are associated with the machine learning transform.
Possible values include:"NAME"
"TRANSFORM_TYPE"
"STATUS"
"CREATED"
"LAST_MODIFIED"
SortDirection
— required — (String
)The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
Possible values include:"DESCENDING"
"ASCENDING"
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. Thedata
object has the following properties:TransformIds
— (Array<String>
)The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.
NextToken
— (String
)A continuation token, if the returned list does not contain the last metric available.
-
(AWS.Response)
—
Returns:
listRegistries(params = {}, callback) ⇒ AWS.Request
Returns a list of registries that you have created, with minimal registry information. Registries in the
Deleting
status will not be included in the results. Empty results will be returned if there are no registries available.Service Reference:
Examples:
Calling the listRegistries operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listRegistries(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
)Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
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. Thedata
object has the following properties:Registries
— (Array<map>
)An array of
RegistryDetailedListItem
objects containing minimal details of each registry.RegistryName
— (String
)The name of the registry.
RegistryArn
— (String
)The Amazon Resource Name (ARN) of the registry.
Description
— (String
)A description of the registry.
Status
— (String
)The status of the registry.
Possible values include:"AVAILABLE"
"DELETING"
CreatedTime
— (String
)The data the registry was created.
UpdatedTime
— (String
)The date the registry was updated.
NextToken
— (String
)A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
-
(AWS.Response)
—
Returns:
listSchemas(params = {}, callback) ⇒ AWS.Request
Returns a list of schemas with minimal details. Schemas in Deleting status will not be included in the results. Empty results will be returned if there are no schemas available.
When the
RegistryId
is not provided, all the schemas across registries will be part of the API response.Service Reference:
Examples:
Calling the listSchemas operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', RegistryId: { RegistryArn: 'STRING_VALUE', RegistryName: 'STRING_VALUE' } }; glue.listSchemas(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: {})
—
RegistryId
— (map
)A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
RegistryName
— (String
)Name of the registry. Used only for lookup. One of
RegistryArn
orRegistryName
has to be provided.RegistryArn
— (String
)Arn of the registry to be updated. One of
RegistryArn
orRegistryName
has to be provided.
MaxResults
— (Integer
)Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
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. Thedata
object has the following properties:Schemas
— (Array<map>
)An array of
SchemaListItem
objects containing details of each schema.RegistryName
— (String
)the name of the registry where the schema resides.
SchemaName
— (String
)The name of the schema.
SchemaArn
— (String
)The Amazon Resource Name (ARN) for the schema.
Description
— (String
)A description for the schema.
SchemaStatus
— (String
)The status of the schema.
Possible values include:"AVAILABLE"
"PENDING"
"DELETING"
CreatedTime
— (String
)The date and time that a schema was created.
UpdatedTime
— (String
)The date and time that a schema was updated.
NextToken
— (String
)A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
-
(AWS.Response)
—
Returns:
listSchemaVersions(params = {}, callback) ⇒ AWS.Request
Returns a list of schema versions that you have created, with minimal information. Schema versions in Deleted status will not be included in the results. Empty results will be returned if there are no schema versions available.
Service Reference:
Examples:
Calling the listSchemaVersions operation
var params = { SchemaId: { /* required */ RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listSchemaVersions(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: {})
—
SchemaId
— (map
)This is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided. -
SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
-
MaxResults
— (Integer
)Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
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. Thedata
object has the following properties:Schemas
— (Array<map>
)An array of
SchemaVersionList
objects containing details of each schema version.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema.
SchemaVersionId
— (String
)The unique identifier of the schema version.
VersionNumber
— (Integer
)The version number of the schema.
Status
— (String
)The status of the schema version.
Possible values include:"AVAILABLE"
"PENDING"
"FAILURE"
"DELETING"
CreatedTime
— (String
)The date and time the schema version was created.
NextToken
— (String
)A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
-
(AWS.Response)
—
Returns:
listSessions(params = {}, callback) ⇒ AWS.Request
Retrieve a list of sessions.
Service Reference:
Examples:
Calling the listSessions operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', RequestOrigin: 'STRING_VALUE', Tags: { '<TagKey>': 'STRING_VALUE', /* '<TagKey>': ... */ } }; glue.listSessions(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
NextToken
— (String
)The token for the next set of results, or null if there are no more result.
MaxResults
— (Integer
)The maximum number of results.
Tags
— (map<String>
)Tags belonging to the session.
RequestOrigin
— (String
)The origin of the 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. Thedata
object has the following properties:Ids
— (Array<String>
)Returns the ID of the session.
Sessions
— (Array<map>
)Returns the session object.
Id
— (String
)The ID of the session.
CreatedOn
— (Date
)The time and date when the session was created.
Status
— (String
)The session status.
Possible values include:"PROVISIONING"
"READY"
"FAILED"
"TIMEOUT"
"STOPPING"
"STOPPED"
ErrorMessage
— (String
)The error message displayed during the session.
Description
— (String
)The description of the session.
Role
— (String
)The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
Command
— (map
)The command object.See SessionCommand.
Name
— (String
)Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
PythonVersion
— (String
)Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
DefaultArguments
— (map<String>
)A map array of key-value pairs. Max is 75 pairs.
Connections
— (map
)The number of connections used for the session.
Connections
— (Array<String>
)A list of connections used by the job.
Progress
— (Float
)The code execution progress of the session.
MaxCapacity
— (Float
)The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
SecurityConfiguration
— (String
)The name of the SecurityConfiguration structure to be used with the session.
GlueVersion
— (String
)The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
NumberOfWorkers
— (Integer
)The number of workers of a defined
WorkerType
to use for the session.WorkerType
— (String
)The type of predefined worker that is allocated when a session runs. Accepts a value of
Possible values include:G.1X
,G.2X
,G.4X
, orG.8X
for Spark sessions. Accepts the valueZ.2X
for Ray sessions."Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
CompletedOn
— (Date
)The date and time that this session is completed.
ExecutionTime
— (Float
)The total time the session ran for.
DPUSeconds
— (Float
)The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
IdleTimeout
— (Integer
)The number of minutes when idle before the session times out.
ProfileName
— (String
)The name of an Glue usage profile associated with the session.
NextToken
— (String
)The token for the next set of results, or null if there are no more result.
-
(AWS.Response)
—
Returns:
listStatements(params = {}, callback) ⇒ AWS.Request
Lists statements for the session.
Service Reference:
Examples:
Calling the listStatements operation
var params = { SessionId: 'STRING_VALUE', /* required */ NextToken: 'STRING_VALUE', RequestOrigin: 'STRING_VALUE' }; glue.listStatements(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: {})
—
SessionId
— (String
)The Session ID of the statements.
RequestOrigin
— (String
)The origin of the request to list statements.
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. Thedata
object has the following properties:Statements
— (Array<map>
)Returns the list of statements.
Id
— (Integer
)The ID of the statement.
Code
— (String
)The execution code of the statement.
State
— (String
)The state while request is actioned.
Possible values include:"WAITING"
"RUNNING"
"AVAILABLE"
"CANCELLING"
"CANCELLED"
"ERROR"
Output
— (map
)The output in JSON.
Data
— (map
)The code execution output.
TextPlain
— (String
)The code execution output in text format.
ExecutionCount
— (Integer
)The execution count of the output.
Status
— (String
)The status of the code execution output.
Possible values include:"WAITING"
"RUNNING"
"AVAILABLE"
"CANCELLING"
"CANCELLED"
"ERROR"
ErrorName
— (String
)The name of the error in the output.
ErrorValue
— (String
)The error value of the output.
Traceback
— (Array<String>
)The traceback of the output.
Progress
— (Float
)The code execution progress.
StartedOn
— (Integer
)The unix time and date that the job definition was started.
CompletedOn
— (Integer
)The unix time and date that the job definition was completed.
NextToken
— (String
)A continuation token, if not all statements have yet been returned.
-
(AWS.Response)
—
Returns:
listTableOptimizerRuns(params = {}, callback) ⇒ AWS.Request
Lists the history of previous optimizer runs for a specific table.
Service Reference:
Examples:
Calling the listTableOptimizerRuns operation
var params = { CatalogId: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ Type: compaction, /* required */ MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listTableOptimizerRuns(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 Catalog ID of the table.
DatabaseName
— (String
)The name of the database in the catalog in which the table resides.
TableName
— (String
)The name of the table.
Type
— (String
)The type of table optimizer. Currently, the only valid value is
Possible values include:compaction
."compaction"
MaxResults
— (Integer
)The maximum number of optimizer runs to return on each call.
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. Thedata
object has the following properties:CatalogId
— (String
)The Catalog ID of the table.
DatabaseName
— (String
)The name of the database in the catalog in which the table resides.
TableName
— (String
)The name of the table.
NextToken
— (String
)A continuation token for paginating the returned list of optimizer runs, returned if the current segment of the list is not the last.
TableOptimizerRuns
— (Array<map>
)A list of the optimizer runs associated with a table.
eventType
— (String
)An event type representing the status of the table optimizer run.
Possible values include:"starting"
"completed"
"failed"
"in_progress"
startTimestamp
— (Date
)Represents the epoch timestamp at which the compaction job was started within Lake Formation.
endTimestamp
— (Date
)Represents the epoch timestamp at which the compaction job ended.
metrics
— (map
)A
RunMetrics
object containing metrics for the optimizer run.NumberOfBytesCompacted
— (String
)The number of bytes removed by the compaction job run.
NumberOfFilesCompacted
— (String
)The number of files removed by the compaction job run.
NumberOfDpus
— (String
)The number of DPU hours consumed by the job.
JobDurationInHour
— (String
)The duration of the job in hours.
error
— (String
)An error that occured during the optimizer run.
-
(AWS.Response)
—
Returns:
listTriggers(params = {}, callback) ⇒ AWS.Request
Retrieves the names of all trigger resources in this Amazon Web Services 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 are 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 is returned. If there is no such trigger, all triggers are 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. Thedata
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.
-
(AWS.Response)
—
Returns:
listUsageProfiles(params = {}, callback) ⇒ AWS.Request
List all the Glue usage profiles.
Service Reference:
Examples:
Calling the listUsageProfiles operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listUsageProfiles(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, included if this is a continuation call.
MaxResults
— (Integer
)The maximum number of usage profiles 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. Thedata
object has the following properties:Profiles
— (Array<map>
)A list of usage profile (
UsageProfileDefinition
) objects.Name
— (String
)The name of the usage profile.
Description
— (String
)A description of the usage profile.
CreatedOn
— (Date
)The date and time when the usage profile was created.
LastModifiedOn
— (Date
)The date and time when the usage profile was last modified.
NextToken
— (String
)A continuation token, present if the current list segment is not the last.
-
(AWS.Response)
—
Returns:
listWorkflows(params = {}, callback) ⇒ AWS.Request
Lists names of workflows created in the account.
Service Reference:
Examples:
Calling the listWorkflows operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; glue.listWorkflows(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.
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. Thedata
object has the following properties:Workflows
— (Array<String>
)List of names of workflows in the account.
NextToken
— (String
)A continuation token, if not all workflow names have been returned.
-
(AWS.Response)
—
Returns:
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 | SSE-KMS-WITH-SERVICE-ROLE, /* required */ CatalogEncryptionServiceRole: 'STRING_VALUE', 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 to set the security configuration for. If none is provided, the Amazon Web Services 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"
"SSE-KMS-WITH-SERVICE-ROLE"
SseAwsKmsKeyId
— (String
)The ID of the KMS key to use for encryption at rest.
CatalogEncryptionServiceRole
— (String
)The role that Glue assumes to encrypt and decrypt the Data Catalog objects on the caller's behalf.
ConnectionPasswordEncryption
— (map
)When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of
CreateConnection
orUpdateConnection
and store it in theENCRYPTED_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 ofGetConnection
andGetConnections
. This encryption takes effect independently from catalog encryption.AwsKmsKeyId
— (String
)An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of
CreateConnection
andUpdateConnection
needs at leastkms:Encrypt
permission on the specified 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.
-
(AWS.Response)
—
Returns:
putDataQualityProfileAnnotation(params = {}, callback) ⇒ AWS.Request
Annotate all datapoints for a Profile.
Service Reference:
Examples:
Calling the putDataQualityProfileAnnotation operation
var params = { InclusionAnnotation: INCLUDE | EXCLUDE, /* required */ ProfileId: 'STRING_VALUE' /* required */ }; glue.putDataQualityProfileAnnotation(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: {})
—
ProfileId
— (String
)The ID of the data quality monitoring profile to annotate.
InclusionAnnotation
— (String
)The inclusion annotation value to apply to the profile.
Possible values include:"INCLUDE"
"EXCLUDE"
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.
-
(AWS.Response)
—
Returns:
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 */ EnableHybrid: TRUE | FALSE, PolicyExistsCondition: MUST_EXIST | NOT_EXIST | NONE, PolicyHashCondition: 'STRING_VALUE', ResourceArn: '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.
ResourceArn
— (String
)Do not use. For internal use only.
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
Possible values include:MUST_EXIST
is used to update a policy. A value ofNOT_EXIST
is used to create a new policy. If a value ofNONE
or a null value is used, the call does not depend on the existence of a policy."MUST_EXIST"
"NOT_EXIST"
"NONE"
EnableHybrid
— (String
)If
'TRUE'
, indicates that you are using both methods to grant cross-account access to Data Catalog resources:-
By directly updating the resource policy with
PutResourePolicy
-
By using the Grant permissions command on the Amazon Web Services Management Console.
Must be set to
Possible values include:'TRUE'
if you have already used the Management Console to grant cross-account access, otherwise the call fails. Default is 'FALSE'."TRUE"
"FALSE"
-
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. Thedata
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.
-
(AWS.Response)
—
Returns:
putSchemaVersionMetadata(params = {}, callback) ⇒ AWS.Request
Puts the metadata key value pair for a specified schema version ID. A maximum of 10 key value pairs will be allowed per schema version. They can be added over one or more calls.
Service Reference:
Examples:
Calling the putSchemaVersionMetadata operation
var params = { MetadataKeyValue: { /* required */ MetadataKey: 'STRING_VALUE', MetadataValue: 'STRING_VALUE' }, SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: { LatestVersion: true || false, VersionNumber: 'NUMBER_VALUE' } }; glue.putSchemaVersionMetadata(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: {})
—
SchemaId
— (map
)The unique ID for the schema.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionNumber
— (map
)The version number of the schema.
LatestVersion
— (Boolean
)The latest version available for the schema.
VersionNumber
— (Integer
)The version number of the schema.
SchemaVersionId
— (String
)The unique version ID of the schema version.
MetadataKeyValue
— (map
)The metadata key's corresponding value.
MetadataKey
— (String
)A metadata key.
MetadataValue
— (String
)A metadata key’s corresponding value.
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. Thedata
object has the following properties:SchemaArn
— (String
)The Amazon Resource Name (ARN) for the schema.
SchemaName
— (String
)The name for the schema.
RegistryName
— (String
)The name for the registry.
LatestVersion
— (Boolean
)The latest version of the schema.
VersionNumber
— (Integer
)The version number of the schema.
SchemaVersionId
— (String
)The unique version ID of the schema version.
MetadataKey
— (String
)The metadata key.
MetadataValue
— (String
)The value of the metadata key.
-
(AWS.Response)
—
Returns:
putWorkflowRunProperties(params = {}, callback) ⇒ AWS.Request
Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.
Service Reference:
Examples:
Calling the putWorkflowRunProperties operation
var params = { Name: 'STRING_VALUE', /* required */ RunId: 'STRING_VALUE', /* required */ RunProperties: { /* required */ '<IdString>': 'STRING_VALUE', /* '<IdString>': ... */ } }; glue.putWorkflowRunProperties(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 workflow which was run.
RunId
— (String
)The ID of the workflow run for which the run properties should be updated.
RunProperties
— (map<String>
)The properties to put for the specified run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
querySchemaVersionMetadata(params = {}, callback) ⇒ AWS.Request
Queries for the schema version metadata information.
Service Reference:
Examples:
Calling the querySchemaVersionMetadata operation
var params = { MaxResults: 'NUMBER_VALUE', MetadataList: [ { MetadataKey: 'STRING_VALUE', MetadataValue: 'STRING_VALUE' }, /* more items */ ], NextToken: 'STRING_VALUE', SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: { LatestVersion: true || false, VersionNumber: 'NUMBER_VALUE' } }; glue.querySchemaVersionMetadata(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: {})
—
SchemaId
— (map
)A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionNumber
— (map
)The version number of the schema.
LatestVersion
— (Boolean
)The latest version available for the schema.
VersionNumber
— (Integer
)The version number of the schema.
SchemaVersionId
— (String
)The unique version ID of the schema version.
MetadataList
— (Array<map>
)Search key-value pairs for metadata, if they are not provided all the metadata information will be fetched.
MetadataKey
— (String
)A metadata key.
MetadataValue
— (String
)A metadata key’s corresponding value.
MaxResults
— (Integer
)Maximum number of results required per page. If the value is not supplied, this will be defaulted to 25 per page.
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. Thedata
object has the following properties:MetadataInfoMap
— (map<map>
)A map of a metadata key and associated values.
MetadataValue
— (String
)The metadata key’s corresponding value.
CreatedTime
— (String
)The time at which the entry was created.
OtherMetadataValueList
— (Array<map>
)Other metadata belonging to the same metadata key.
MetadataValue
— (String
)The metadata key’s corresponding value for the other metadata belonging to the same metadata key.
CreatedTime
— (String
)The time at which the entry was created.
SchemaVersionId
— (String
)The unique version ID of the schema version.
NextToken
— (String
)A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
-
(AWS.Response)
—
Returns:
registerSchemaVersion(params = {}, callback) ⇒ AWS.Request
Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.
If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the
GetSchemaVersion
API with theSchemaVersionId
to check compatibility modes.If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.
Service Reference:
Examples:
Calling the registerSchemaVersion operation
var params = { SchemaDefinition: 'STRING_VALUE', /* required */ SchemaId: { /* required */ RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' } }; glue.registerSchemaVersion(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: {})
—
SchemaId
— (map
)This is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided. -
SchemaId$SchemaName: The name of the schema. Either
SchemaArn
orSchemaName
andRegistryName
has to be provided.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
-
SchemaDefinition
— (String
)The schema definition using the
DataFormat
setting for theSchemaName
.
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. Thedata
object has the following properties:SchemaVersionId
— (String
)The unique ID that represents the version of this schema.
VersionNumber
— (Integer
)The version of this schema (for sync flow only, in case this is the first version).
Status
— (String
)The status of the schema version.
Possible values include:"AVAILABLE"
"PENDING"
"FAILURE"
"DELETING"
-
(AWS.Response)
—
Returns:
removeSchemaVersionMetadata(params = {}, callback) ⇒ AWS.Request
Removes a key value pair from the schema version metadata for the specified schema version ID.
Service Reference:
Examples:
Calling the removeSchemaVersionMetadata operation
var params = { MetadataKeyValue: { /* required */ MetadataKey: 'STRING_VALUE', MetadataValue: 'STRING_VALUE' }, SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: { LatestVersion: true || false, VersionNumber: 'NUMBER_VALUE' } }; glue.removeSchemaVersionMetadata(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: {})
—
SchemaId
— (map
)A wrapper structure that may contain the schema name and Amazon Resource Name (ARN).
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionNumber
— (map
)The version number of the schema.
LatestVersion
— (Boolean
)The latest version available for the schema.
VersionNumber
— (Integer
)The version number of the schema.
SchemaVersionId
— (String
)The unique version ID of the schema version.
MetadataKeyValue
— (map
)The value of the metadata key.
MetadataKey
— (String
)A metadata key.
MetadataValue
— (String
)A metadata key’s corresponding value.
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. Thedata
object has the following properties:SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema.
SchemaName
— (String
)The name of the schema.
RegistryName
— (String
)The name of the registry.
LatestVersion
— (Boolean
)The latest version of the schema.
VersionNumber
— (Integer
)The version number of the schema.
SchemaVersionId
— (String
)The version ID for the schema version.
MetadataKey
— (String
)The metadata key.
MetadataValue
— (String
)The value of the metadata key.
-
(AWS.Response)
—
Returns:
resetJobBookmark(params = {}, callback) ⇒ AWS.Request
Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
Service Reference:
Examples:
Calling the resetJobBookmark operation
var params = { JobName: 'STRING_VALUE', /* required */ RunId: 'STRING_VALUE' }; 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.
RunId
— (String
)The unique run identifier associated with this job run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:JobBookmarkEntry
— (map
)The reset bookmark entry.
JobName
— (String
)The name of the job in question.
Version
— (Integer
)The version of the job.
Run
— (Integer
)The run ID number.
Attempt
— (Integer
)The attempt ID number.
PreviousRunId
— (String
)The unique run identifier associated with the previous job run.
RunId
— (String
)The run ID number.
JobBookmark
— (String
)The bookmark itself.
-
(AWS.Response)
—
Returns:
resumeWorkflowRun(params = {}, callback) ⇒ AWS.Request
Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run. The selected nodes and all nodes that are downstream from the selected nodes are run.
Service Reference:
Examples:
Calling the resumeWorkflowRun operation
var params = { Name: 'STRING_VALUE', /* required */ NodeIds: [ /* required */ 'STRING_VALUE', /* more items */ ], RunId: 'STRING_VALUE' /* required */ }; glue.resumeWorkflowRun(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 workflow to resume.
RunId
— (String
)The ID of the workflow run to resume.
NodeIds
— (Array<String>
)A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:RunId
— (String
)The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
NodeIds
— (Array<String>
)A list of the node IDs for the nodes that were actually restarted.
-
(AWS.Response)
—
Returns:
runStatement(params = {}, callback) ⇒ AWS.Request
Executes the statement.
Service Reference:
Examples:
Calling the runStatement operation
var params = { Code: 'STRING_VALUE', /* required */ SessionId: 'STRING_VALUE', /* required */ RequestOrigin: 'STRING_VALUE' }; glue.runStatement(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: {})
—
SessionId
— (String
)The Session Id of the statement to be run.
Code
— (String
)The statement code to be run.
RequestOrigin
— (String
)The origin of the 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. Thedata
object has the following properties:Id
— (Integer
)Returns the Id of the statement that was run.
-
(AWS.Response)
—
Returns:
searchTables(params = {}, callback) ⇒ AWS.Request
Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
Service Reference:
Examples:
Calling the searchTables operation
var params = { CatalogId: 'STRING_VALUE', Filters: [ { Comparator: EQUALS | GREATER_THAN | LESS_THAN | GREATER_THAN_EQUALS | LESS_THAN_EQUALS, Key: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], IncludeStatusDetails: true || false, MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', ResourceShareType: FOREIGN | ALL | FEDERATED, SearchText: 'STRING_VALUE', SortCriteria: [ { FieldName: 'STRING_VALUE', Sort: ASC | DESC }, /* more items */ ] }; glue.searchTables(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
)A unique identifier, consisting of
account_id
.NextToken
— (String
)A continuation token, included if this is a continuation call.
Filters
— (Array<map>
)A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The
Comparator
member of thePropertyPredicate
struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as whenKey=Name
, a fuzzy match algorithm is used. TheKey
field (for example, the value of theName
field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with theValue
member ofPropertyPredicate
. For example, ifKey=Name
andValue=link
, tables namedcustomer-link
andxx-link-yy
are returned, butxxlinkyy
is not returned.Key
— (String
)The key of the property.
Value
— (String
)The value of the property.
Comparator
— (String
)The comparator used to compare this property to others.
Possible values include:"EQUALS"
"GREATER_THAN"
"LESS_THAN"
"GREATER_THAN_EQUALS"
"LESS_THAN_EQUALS"
SearchText
— (String
)A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
SortCriteria
— (Array<map>
)A list of criteria for sorting the results by a field name, in an ascending or descending order.
FieldName
— (String
)The name of the field on which to sort.
Sort
— (String
)An ascending or descending sort.
Possible values include:"ASC"
"DESC"
MaxResults
— (Integer
)The maximum number of tables to return in a single response.
ResourceShareType
— (String
)Allows you to specify that you want to search the tables shared with your account. The allowable values are
FOREIGN
orALL
.-
If set to
FOREIGN
, will search the tables shared with your account. -
If set to
ALL
, will search the tables shared with your account, as well as the tables in yor local account.
"FOREIGN"
"ALL"
"FEDERATED"
-
IncludeStatusDetails
— (Boolean
)Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.
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. Thedata
object has the following properties:NextToken
— (String
)A continuation token, present if the current list segment is not the last.
TableList
— (Array<map>
)A list of the requested
Table
objects. TheSearchTables
response returns only the tables that you have access to.Name
— required — (String
)The table name. For Hive compatibility, this must be entirely lowercase.
DatabaseName
— (String
)The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
Description
— (String
)A description of the table.
Owner
— (String
)The owner of the table.
CreateTime
— (Date
)The time when the table definition was created in the Data Catalog.
UpdateTime
— (Date
)The last time that the table was updated.
LastAccessTime
— (Date
)The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
CreatedBy
— (String
)The person or entity who created the table.
IsRegisteredWithLakeFormation
— (Boolean
)Indicates whether the table has been registered with Lake Formation.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
VersionId
— (String
)The ID of the table version.
FederatedTable
— (map
)A
FederatedTable
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated table.
DatabaseIdentifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
SubObjects
— (Array<String>
)A list of table Amazon Resource Names (ARNs).
Representations
— (Array<map>
)A list of representations.
Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewOriginalText
— (String
)The
SELECT
query provided by the customer duringCREATE VIEW DDL
. This SQL is not used during a query on a view (ViewExpandedText
is used instead).ViewOriginalText
is used for cases likeSHOW CREATE VIEW
where users want to see the original DDL command that created the view.ViewExpandedText
— (String
)The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform
ViewOriginalText
toViewExpandedText
. For example:-
Fully qualified identifiers:
SELECT * from table1 -> SELECT * from db1.table1
-
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
IsStale
— (Boolean
)Dialects marked as stale are no longer valid and must be updated before they can be queried in their respective query engines.
IsMultiDialectView
— (Boolean
)Specifies whether the view supports the SQL dialects of one or more different query engines and can therefore be read by those engines.
Status
— (map
)A structure containing information about the state of an asynchronous change to a table.
RequestedBy
— (String
)The ARN of the user who requested the asynchronous change.
UpdatedBy
— (String
)The ARN of the user to last manually alter the asynchronous change (requesting cancellation, etc).
RequestTime
— (Date
)An ISO 8601 formatted date string indicating the time that the change was initiated.
UpdateTime
— (Date
)An ISO 8601 formatted date string indicating the time that the state was last updated.
Action
— (String
)Indicates which action was called on the table, currently only
Possible values include:CREATE
orUPDATE
."UPDATE"
"CREATE"
State
— (String
)A generic status for the change in progress, such as QUEUED, IN_PROGRESS, SUCCESS, or FAILED.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error that will only appear when the state is "FAILED". This is a parent level exception message, there may be different
Error
s for each dialect.ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
Details
— (map
)A
StatusDetails
object with information about the requested change.ViewValidations
— (Array<map>
)A list of
ViewValidation
objects that contain information for an analytical engine to validate a view.Dialect
— (String
)The dialect of the query engine.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)The version of the dialect of the query engine. For example, 3.0.0.
ViewValidationText
— (String
)The
SELECT
query that defines the view, as provided by the customer.UpdateTime
— (Date
)The time of the last update.
State
— (String
)The state of the validation.
Possible values include:"QUEUED"
"IN_PROGRESS"
"SUCCESS"
"STOPPED"
"FAILED"
Error
— (map
)An error associated with the validation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
startBlueprintRun(params = {}, callback) ⇒ AWS.Request
Starts a new run of the specified blueprint.
Service Reference:
Examples:
Calling the startBlueprintRun operation
var params = { BlueprintName: 'STRING_VALUE', /* required */ RoleArn: 'STRING_VALUE', /* required */ Parameters: 'STRING_VALUE' }; glue.startBlueprintRun(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: {})
—
BlueprintName
— (String
)The name of the blueprint.
Parameters
— (String
)Specifies the parameters as a
BlueprintParameters
object.RoleArn
— (String
)Specifies the IAM role used to create the workflow.
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. Thedata
object has the following properties:RunId
— (String
)The run ID for this blueprint run.
-
(AWS.Response)
—
Returns:
startColumnStatisticsTaskRun(params = {}, callback) ⇒ AWS.Request
Starts a column statistics task run, for a specified table and columns.
Service Reference:
Examples:
Calling the startColumnStatisticsTaskRun operation
var params = { DatabaseName: 'STRING_VALUE', /* required */ Role: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ CatalogID: 'STRING_VALUE', ColumnNameList: [ 'STRING_VALUE', /* more items */ ], SampleSize: 'NUMBER_VALUE', SecurityConfiguration: 'STRING_VALUE' }; glue.startColumnStatisticsTaskRun(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: {})
—
DatabaseName
— (String
)The name of the database where the table resides.
TableName
— (String
)The name of the table to generate statistics.
ColumnNameList
— (Array<String>
)A list of the column names to generate statistics. If none is supplied, all column names for the table will be used by default.
Role
— (String
)The IAM role that the service assumes to generate statistics.
SampleSize
— (Float
)The percentage of rows used to generate statistics. If none is supplied, the entire table will be used to generate stats.
CatalogID
— (String
)The ID of the Data Catalog where the table reside. If none is supplied, the Amazon Web Services account ID is used by default.
SecurityConfiguration
— (String
)Name of the security configuration that is used to encrypt CloudWatch logs for the column stats task run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ColumnStatisticsTaskRunId
— (String
)The identifier for the column statistics task run.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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 alreadySCHEDULED
.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.
-
(AWS.Response)
—
Returns:
startDataQualityRuleRecommendationRun(params = {}, callback) ⇒ AWS.Request
Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
Recommendation runs are automatically deleted after 90 days.
Service Reference:
Examples:
Calling the startDataQualityRuleRecommendationRun operation
var params = { DataSource: { /* required */ GlueTable: { /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ AdditionalOptions: { '<NameString>': 'STRING_VALUE', /* '<NameString>': ... */ }, CatalogId: 'STRING_VALUE', ConnectionName: 'STRING_VALUE' } }, Role: 'STRING_VALUE', /* required */ ClientToken: 'STRING_VALUE', CreatedRulesetName: 'STRING_VALUE', DataQualitySecurityConfiguration: 'STRING_VALUE', NumberOfWorkers: 'NUMBER_VALUE', Timeout: 'NUMBER_VALUE' }; glue.startDataQualityRuleRecommendationRun(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: {})
—
DataSource
— (map
)The data source (Glue table) associated with this run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
Role
— (String
)An IAM role supplied to encrypt the results of the run.
NumberOfWorkers
— (Integer
)The number of
G.1X
workers to be used in the run. The default is 5.Timeout
— (Integer
)The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).CreatedRulesetName
— (String
)A name for the ruleset.
DataQualitySecurityConfiguration
— (String
)The name of the security configuration created with the data quality encryption option.
ClientToken
— (String
)Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same 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. Thedata
object has the following properties:RunId
— (String
)The unique run identifier associated with this run.
-
(AWS.Response)
—
Returns:
startDataQualityRulesetEvaluationRun(params = {}, callback) ⇒ AWS.Request
Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes results which you can retrieve with the
GetDataQualityResult
API.Service Reference:
Examples:
Calling the startDataQualityRulesetEvaluationRun operation
var params = { DataSource: { /* required */ GlueTable: { /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ AdditionalOptions: { '<NameString>': 'STRING_VALUE', /* '<NameString>': ... */ }, CatalogId: 'STRING_VALUE', ConnectionName: 'STRING_VALUE' } }, Role: 'STRING_VALUE', /* required */ RulesetNames: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalDataSources: { '<NameString>': { GlueTable: { /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ AdditionalOptions: { '<NameString>': 'STRING_VALUE', /* '<NameString>': ... */ }, CatalogId: 'STRING_VALUE', ConnectionName: 'STRING_VALUE' } }, /* '<NameString>': ... */ }, AdditionalRunOptions: { CloudWatchMetricsEnabled: true || false, CompositeRuleEvaluationMethod: COLUMN | ROW, ResultsS3Prefix: 'STRING_VALUE' }, ClientToken: 'STRING_VALUE', NumberOfWorkers: 'NUMBER_VALUE', Timeout: 'NUMBER_VALUE' }; glue.startDataQualityRulesetEvaluationRun(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: {})
—
DataSource
— (map
)The data source (Glue table) associated with this run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
Role
— (String
)An IAM role supplied to encrypt the results of the run.
NumberOfWorkers
— (Integer
)The number of
G.1X
workers to be used in the run. The default is 5.Timeout
— (Integer
)The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).ClientToken
— (String
)Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.
AdditionalRunOptions
— (map
)Additional run options you can specify for an evaluation run.
CloudWatchMetricsEnabled
— (Boolean
)Whether or not to enable CloudWatch metrics.
ResultsS3Prefix
— (String
)Prefix for Amazon S3 to store results.
CompositeRuleEvaluationMethod
— (String
)Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
Possible values include:"COLUMN"
"ROW"
RulesetNames
— (Array<String>
)A list of ruleset names.
AdditionalDataSources
— (map<map>
)A map of reference strings to additional data sources you can specify for an evaluation run.
GlueTable
— required — (map
)An Glue table.
DatabaseName
— required — (String
)A database name in the Glue Data Catalog.
TableName
— required — (String
)A table name in the Glue Data Catalog.
CatalogId
— (String
)A unique identifier for the Glue Data Catalog.
ConnectionName
— (String
)The name of the connection to the Glue Data Catalog.
AdditionalOptions
— (map<String>
)Additional options for the table. Currently there are two keys supported:
-
pushDownPredicate
: to filter on partitions without having to list and read all the files in your dataset. -
catalogPartitionPredicate
: to use server-side partition pruning using partition indexes in the Glue Data Catalog.
-
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. Thedata
object has the following properties:RunId
— (String
)The unique run identifier associated with this run.
-
(AWS.Response)
—
Returns:
startExportLabelsTaskRun(params = {}, callback) ⇒ AWS.Request
Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use
StartExportLabelsTaskRun
when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts theTransformId
whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns aTaskRunId
. You can check on the status of your task run by calling theGetMLTaskRun
API.Service Reference:
Examples:
Calling the startExportLabelsTaskRun operation
var params = { OutputS3Path: 'STRING_VALUE', /* required */ TransformId: 'STRING_VALUE' /* required */ }; glue.startExportLabelsTaskRun(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: {})
—
TransformId
— (String
)The unique identifier of the machine learning transform.
OutputS3Path
— (String
)The Amazon S3 path where you export the labels.
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. Thedata
object has the following properties:TaskRunId
— (String
)The unique identifier for the task run.
-
(AWS.Response)
—
Returns:
startImportLabelsTaskRun(params = {}, callback) ⇒ AWS.Request
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the
StartMLLabelingSetGenerationTaskRun
call and that ultimately results in improving the quality of your machine learning transform.After the
StartMLLabelingSetGenerationTaskRun
finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called 'labeling' in the machine learning workflows). In the case of theFindMatches
transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call toStartImportLabelsTaskRun
. AfterStartImportLabelsTaskRun
finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.By default,
StartMLLabelingSetGenerationTaskRun
continually learns from and combines all labels that you upload unless you setReplace
to true. If you setReplace
to true,StartImportLabelsTaskRun
deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.You can check on the status of your task run by calling the
GetMLTaskRun
operation.Service Reference:
Examples:
Calling the startImportLabelsTaskRun operation
var params = { InputS3Path: 'STRING_VALUE', /* required */ TransformId: 'STRING_VALUE', /* required */ ReplaceAllLabels: true || false }; glue.startImportLabelsTaskRun(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: {})
—
TransformId
— (String
)The unique identifier of the machine learning transform.
InputS3Path
— (String
)The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
ReplaceAllLabels
— (Boolean
)Indicates whether to overwrite your existing labels.
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. Thedata
object has the following properties:TaskRunId
— (String
)The unique identifier for the task run.
-
(AWS.Response)
—
Returns:
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>': ... */ }, ExecutionClass: FLEX | STANDARD, JobRunId: 'STRING_VALUE', JobRunQueuingEnabled: true || false, MaxCapacity: 'NUMBER_VALUE', NotificationProperty: { NotifyDelayAfter: 'NUMBER_VALUE' }, NumberOfWorkers: 'NUMBER_VALUE', SecurityConfiguration: 'STRING_VALUE', Timeout: 'NUMBER_VALUE', WorkerType: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.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.
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job run.
A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
JobRunId
— (String
)The ID of a previous
JobRun
to retry.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 Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
AllocatedCapacity
— (Integer
)This field is deprecated. Use
MaxCapacity
instead.The number of Glue data processing units (DPUs) to allocate to this JobRun. You can allocate a minimum of 2 DPUs; 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 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 entersTIMEOUT
status. This value overrides the timeout value set in the parent job.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
-
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.
WorkerType
— (String
)The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
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. Thedata
object has the following properties:JobRunId
— (String
)The ID assigned to this job run.
-
(AWS.Response)
—
Returns:
startMLEvaluationTaskRun(params = {}, callback) ⇒ AWS.Request
Starts a task to estimate the quality of the transform.
When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.
Returns a unique identifier for the run. You can call
GetMLTaskRun
to get more information about the stats of theEvaluationTaskRun
.Service Reference:
Examples:
Calling the startMLEvaluationTaskRun operation
var params = { TransformId: 'STRING_VALUE' /* required */ }; glue.startMLEvaluationTaskRun(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: {})
—
TransformId
— (String
)The unique identifier of the machine learning 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. Thedata
object has the following properties:TaskRunId
— (String
)The unique identifier associated with this run.
-
(AWS.Response)
—
Returns:
startMLLabelingSetGenerationTaskRun(params = {}, callback) ⇒ AWS.Request
Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.
When the
StartMLLabelingSetGenerationTaskRun
finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.In the case of the
FindMatches
transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”After the labeling process is finished, you can upload your labels with a call to
StartImportLabelsTaskRun
. AfterStartImportLabelsTaskRun
finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.Service Reference:
Examples:
Calling the startMLLabelingSetGenerationTaskRun operation
var params = { OutputS3Path: 'STRING_VALUE', /* required */ TransformId: 'STRING_VALUE' /* required */ }; glue.startMLLabelingSetGenerationTaskRun(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: {})
—
TransformId
— (String
)The unique identifier of the machine learning transform.
OutputS3Path
— (String
)The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling 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. Thedata
object has the following properties:TaskRunId
— (String
)The unique run identifier that is associated with this task run.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Name
— (String
)The name of the trigger that was started.
-
(AWS.Response)
—
Returns:
startWorkflowRun(params = {}, callback) ⇒ AWS.Request
Starts a new run of the specified workflow.
Service Reference:
Examples:
Calling the startWorkflowRun operation
var params = { Name: 'STRING_VALUE', /* required */ RunProperties: { '<IdString>': 'STRING_VALUE', /* '<IdString>': ... */ } }; glue.startWorkflowRun(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 workflow to start.
RunProperties
— (map<String>
)The workflow run properties for the new workflow run.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:RunId
— (String
)An Id for the new run.
-
(AWS.Response)
—
Returns:
stopColumnStatisticsTaskRun(params = {}, callback) ⇒ AWS.Request
Stops a task run for the specified table.
Service Reference:
Examples:
Calling the stopColumnStatisticsTaskRun operation
var params = { DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE' /* required */ }; glue.stopColumnStatisticsTaskRun(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: {})
—
DatabaseName
— (String
)The name of the database where the table resides.
TableName
— (String
)The name of 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.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
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.
-
(AWS.Response)
—
Returns:
stopSession(params = {}, callback) ⇒ AWS.Request
Stops the session.
Service Reference:
Examples:
Calling the stopSession operation
var params = { Id: 'STRING_VALUE', /* required */ RequestOrigin: 'STRING_VALUE' }; glue.stopSession(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: {})
—
Id
— (String
)The ID of the session to be stopped.
RequestOrigin
— (String
)The origin of the 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. Thedata
object has the following properties:Id
— (String
)Returns the Id of the stopped session.
-
(AWS.Response)
—
Returns:
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. Thedata
object has the following properties:Name
— (String
)The name of the trigger that was stopped.
-
(AWS.Response)
—
Returns:
stopWorkflowRun(params = {}, callback) ⇒ AWS.Request
Stops the execution of the specified workflow run.
Service Reference:
Examples:
Calling the stopWorkflowRun operation
var params = { Name: 'STRING_VALUE', /* required */ RunId: 'STRING_VALUE' /* required */ }; glue.stopWorkflowRun(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 workflow to stop.
RunId
— (String
)The ID of the workflow run 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.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
Adds tags to a resource. A tag is a label you can assign to an Amazon Web Services resource. In Glue, you can tag only certain resources. For information about what resources you can tag, see Amazon Web Services Tags in 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 Glue resource to which to add the tags. For more information about Glue resource ARNs, see the 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.
-
(AWS.Response)
—
Returns:
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 Amazon Resource Name (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.
-
(AWS.Response)
—
Returns:
updateBlueprint(params = {}, callback) ⇒ AWS.Request
Updates a registered blueprint.
Service Reference:
Examples:
Calling the updateBlueprint operation
var params = { BlueprintLocation: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Description: 'STRING_VALUE' }; glue.updateBlueprint(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 blueprint.
Description
— (String
)A description of the blueprint.
BlueprintLocation
— (String
)Specifies a path in Amazon S3 where the blueprint is published.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Name
— (String
)Returns the name of the blueprint that was updated.
-
(AWS.Response)
—
Returns:
updateClassifier(params = {}, callback) ⇒ AWS.Request
Modifies an existing classifier (a
GrokClassifier
, anXMLClassifier
, aJsonClassifier
, or aCsvClassifier
, 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, CustomDatatypeConfigured: true || false, CustomDatatypes: [ 'STRING_VALUE', /* more items */ ], Delimiter: 'STRING_VALUE', DisableValueTrimming: true || false, Header: [ 'STRING_VALUE', /* more items */ ], QuoteSymbol: 'STRING_VALUE', Serde: OpenCSVSerDe | LazySimpleSerDe | None }, 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. 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. 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. It 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.
CustomDatatypeConfigured
— (Boolean
)Specifies the configuration of custom datatypes.
CustomDatatypes
— (Array<String>
)Specifies a list of supported custom datatypes.
Serde
— (String
)Sets the SerDe for processing CSV in the classifier, which will be applied in the Data Catalog. Valid values are
Possible values include:OpenCSVSerDe
,LazySimpleSerDe
, andNone
. You can specify theNone
value when you want the crawler to do the detection."OpenCSVSerDe"
"LazySimpleSerDe"
"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.
-
(AWS.Response)
—
Returns:
updateColumnStatisticsForPartition(params = {}, callback) ⇒ AWS.Request
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
UpdatePartition
.Service Reference:
Examples:
Calling the updateColumnStatisticsForPartition operation
var params = { ColumnStatisticsList: [ /* required */ { AnalyzedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ ColumnName: 'STRING_VALUE', /* required */ ColumnType: 'STRING_VALUE', /* required */ StatisticsData: { /* required */ Type: BOOLEAN | DATE | DECIMAL | DOUBLE | LONG | STRING | BINARY, /* required */ BinaryColumnStatisticsData: { AverageLength: 'NUMBER_VALUE', /* required */ MaximumLength: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE' /* required */ }, BooleanColumnStatisticsData: { NumberOfFalses: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ NumberOfTrues: 'NUMBER_VALUE' /* required */ }, DateColumnStatisticsData: { NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ MaximumValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, MinimumValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, DecimalColumnStatisticsData: { NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ MaximumValue: { Scale: 'NUMBER_VALUE', /* required */ UnscaledValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */ }, MinimumValue: { Scale: 'NUMBER_VALUE', /* required */ UnscaledValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */ } }, DoubleColumnStatisticsData: { NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ MaximumValue: 'NUMBER_VALUE', MinimumValue: 'NUMBER_VALUE' }, LongColumnStatisticsData: { NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ MaximumValue: 'NUMBER_VALUE', MinimumValue: 'NUMBER_VALUE' }, StringColumnStatisticsData: { AverageLength: 'NUMBER_VALUE', /* required */ MaximumLength: 'NUMBER_VALUE', /* required */ NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE' /* required */ } } }, /* more items */ ], DatabaseName: 'STRING_VALUE', /* required */ PartitionValues: [ /* required */ 'STRING_VALUE', /* more items */ ], TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.updateColumnStatisticsForPartition(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 Amazon Web Services 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.
PartitionValues
— (Array<String>
)A list of partition values identifying the partition.
ColumnStatisticsList
— (Array<map>
)A list of the column statistics.
ColumnName
— required — (String
)Name of column which statistics belong to.
ColumnType
— required — (String
)The data type of the column.
AnalyzedTime
— required — (Date
)The timestamp of when column statistics were generated.
StatisticsData
— required — (map
)A
ColumnStatisticData
object that contains the statistics data values.Type
— required — (String
)The type of column statistics data.
Possible values include:"BOOLEAN"
"DATE"
"DECIMAL"
"DOUBLE"
"LONG"
"STRING"
"BINARY"
BooleanColumnStatisticsData
— (map
)Boolean column statistics data.
NumberOfTrues
— required — (Integer
)The number of true values in the column.
NumberOfFalses
— required — (Integer
)The number of false values in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
DateColumnStatisticsData
— (map
)Date column statistics data.
MinimumValue
— (Date
)The lowest value in the column.
MaximumValue
— (Date
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DecimalColumnStatisticsData
— (map
)Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two's complement representations of the decimal's unscaled value.
MinimumValue
— (map
)The lowest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
MaximumValue
— (map
)The highest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DoubleColumnStatisticsData
— (map
)Double column statistics data.
MinimumValue
— (Float
)The lowest value in the column.
MaximumValue
— (Float
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
LongColumnStatisticsData
— (map
)Long column statistics data.
MinimumValue
— (Integer
)The lowest value in the column.
MaximumValue
— (Integer
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
StringColumnStatisticsData
— (map
)String column statistics data.
MaximumLength
— required — (Integer
)The size of the longest string in the column.
AverageLength
— required — (Float
)The average string length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
BinaryColumnStatisticsData
— (map
)Binary column statistics data.
MaximumLength
— required — (Integer
)The size of the longest bit sequence in the column.
AverageLength
— required — (Float
)The average bit sequence length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the 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. Thedata
object has the following properties:Errors
— (Array<map>
)Error occurred during updating column statistics data.
ColumnStatistics
— (map
)The
ColumnStatistics
of the column.ColumnName
— required — (String
)Name of column which statistics belong to.
ColumnType
— required — (String
)The data type of the column.
AnalyzedTime
— required — (Date
)The timestamp of when column statistics were generated.
StatisticsData
— required — (map
)A
ColumnStatisticData
object that contains the statistics data values.Type
— required — (String
)The type of column statistics data.
Possible values include:"BOOLEAN"
"DATE"
"DECIMAL"
"DOUBLE"
"LONG"
"STRING"
"BINARY"
BooleanColumnStatisticsData
— (map
)Boolean column statistics data.
NumberOfTrues
— required — (Integer
)The number of true values in the column.
NumberOfFalses
— required — (Integer
)The number of false values in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
DateColumnStatisticsData
— (map
)Date column statistics data.
MinimumValue
— (Date
)The lowest value in the column.
MaximumValue
— (Date
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DecimalColumnStatisticsData
— (map
)Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two's complement representations of the decimal's unscaled value.
MinimumValue
— (map
)The lowest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
MaximumValue
— (map
)The highest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DoubleColumnStatisticsData
— (map
)Double column statistics data.
MinimumValue
— (Float
)The lowest value in the column.
MaximumValue
— (Float
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
LongColumnStatisticsData
— (map
)Long column statistics data.
MinimumValue
— (Integer
)The lowest value in the column.
MaximumValue
— (Integer
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
StringColumnStatisticsData
— (map
)String column statistics data.
MaximumLength
— required — (Integer
)The size of the longest string in the column.
AverageLength
— required — (Float
)The average string length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
BinaryColumnStatisticsData
— (map
)Binary column statistics data.
MaximumLength
— required — (Integer
)The size of the longest bit sequence in the column.
AverageLength
— required — (Float
)The average bit sequence length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
Error
— (map
)An error message with the reason for the failure of an operation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
updateColumnStatisticsForTable(params = {}, callback) ⇒ AWS.Request
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
UpdateTable
.Service Reference:
Examples:
Calling the updateColumnStatisticsForTable operation
var params = { ColumnStatisticsList: [ /* required */ { AnalyzedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ ColumnName: 'STRING_VALUE', /* required */ ColumnType: 'STRING_VALUE', /* required */ StatisticsData: { /* required */ Type: BOOLEAN | DATE | DECIMAL | DOUBLE | LONG | STRING | BINARY, /* required */ BinaryColumnStatisticsData: { AverageLength: 'NUMBER_VALUE', /* required */ MaximumLength: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE' /* required */ }, BooleanColumnStatisticsData: { NumberOfFalses: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ NumberOfTrues: 'NUMBER_VALUE' /* required */ }, DateColumnStatisticsData: { NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ MaximumValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, MinimumValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, DecimalColumnStatisticsData: { NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ MaximumValue: { Scale: 'NUMBER_VALUE', /* required */ UnscaledValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */ }, MinimumValue: { Scale: 'NUMBER_VALUE', /* required */ UnscaledValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */ } }, DoubleColumnStatisticsData: { NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ MaximumValue: 'NUMBER_VALUE', MinimumValue: 'NUMBER_VALUE' }, LongColumnStatisticsData: { NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE', /* required */ MaximumValue: 'NUMBER_VALUE', MinimumValue: 'NUMBER_VALUE' }, StringColumnStatisticsData: { AverageLength: 'NUMBER_VALUE', /* required */ MaximumLength: 'NUMBER_VALUE', /* required */ NumberOfDistinctValues: 'NUMBER_VALUE', /* required */ NumberOfNulls: 'NUMBER_VALUE' /* required */ } } }, /* more items */ ], DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ CatalogId: 'STRING_VALUE' }; glue.updateColumnStatisticsForTable(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 Amazon Web Services 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.
ColumnStatisticsList
— (Array<map>
)A list of the column statistics.
ColumnName
— required — (String
)Name of column which statistics belong to.
ColumnType
— required — (String
)The data type of the column.
AnalyzedTime
— required — (Date
)The timestamp of when column statistics were generated.
StatisticsData
— required — (map
)A
ColumnStatisticData
object that contains the statistics data values.Type
— required — (String
)The type of column statistics data.
Possible values include:"BOOLEAN"
"DATE"
"DECIMAL"
"DOUBLE"
"LONG"
"STRING"
"BINARY"
BooleanColumnStatisticsData
— (map
)Boolean column statistics data.
NumberOfTrues
— required — (Integer
)The number of true values in the column.
NumberOfFalses
— required — (Integer
)The number of false values in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
DateColumnStatisticsData
— (map
)Date column statistics data.
MinimumValue
— (Date
)The lowest value in the column.
MaximumValue
— (Date
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DecimalColumnStatisticsData
— (map
)Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two's complement representations of the decimal's unscaled value.
MinimumValue
— (map
)The lowest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
MaximumValue
— (map
)The highest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DoubleColumnStatisticsData
— (map
)Double column statistics data.
MinimumValue
— (Float
)The lowest value in the column.
MaximumValue
— (Float
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
LongColumnStatisticsData
— (map
)Long column statistics data.
MinimumValue
— (Integer
)The lowest value in the column.
MaximumValue
— (Integer
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
StringColumnStatisticsData
— (map
)String column statistics data.
MaximumLength
— required — (Integer
)The size of the longest string in the column.
AverageLength
— required — (Float
)The average string length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
BinaryColumnStatisticsData
— (map
)Binary column statistics data.
MaximumLength
— required — (Integer
)The size of the longest bit sequence in the column.
AverageLength
— required — (Float
)The average bit sequence length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the 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. Thedata
object has the following properties:Errors
— (Array<map>
)List of ColumnStatisticsErrors.
ColumnStatistics
— (map
)The
ColumnStatistics
of the column.ColumnName
— required — (String
)Name of column which statistics belong to.
ColumnType
— required — (String
)The data type of the column.
AnalyzedTime
— required — (Date
)The timestamp of when column statistics were generated.
StatisticsData
— required — (map
)A
ColumnStatisticData
object that contains the statistics data values.Type
— required — (String
)The type of column statistics data.
Possible values include:"BOOLEAN"
"DATE"
"DECIMAL"
"DOUBLE"
"LONG"
"STRING"
"BINARY"
BooleanColumnStatisticsData
— (map
)Boolean column statistics data.
NumberOfTrues
— required — (Integer
)The number of true values in the column.
NumberOfFalses
— required — (Integer
)The number of false values in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
DateColumnStatisticsData
— (map
)Date column statistics data.
MinimumValue
— (Date
)The lowest value in the column.
MaximumValue
— (Date
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DecimalColumnStatisticsData
— (map
)Decimal column statistics data. UnscaledValues within are Base64-encoded binary objects storing big-endian, two's complement representations of the decimal's unscaled value.
MinimumValue
— (map
)The lowest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
MaximumValue
— (map
)The highest value in the column.
UnscaledValue
— required — (Buffer, Typed Array, Blob, String
)The unscaled numeric value.
Scale
— required — (Integer
)The scale that determines where the decimal point falls in the unscaled value.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
DoubleColumnStatisticsData
— (map
)Double column statistics data.
MinimumValue
— (Float
)The lowest value in the column.
MaximumValue
— (Float
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
LongColumnStatisticsData
— (map
)Long column statistics data.
MinimumValue
— (Integer
)The lowest value in the column.
MaximumValue
— (Integer
)The highest value in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
StringColumnStatisticsData
— (map
)String column statistics data.
MaximumLength
— required — (Integer
)The size of the longest string in the column.
AverageLength
— required — (Float
)The average string length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
NumberOfDistinctValues
— required — (Integer
)The number of distinct values in a column.
BinaryColumnStatisticsData
— (map
)Binary column statistics data.
MaximumLength
— required — (Integer
)The size of the longest bit sequence in the column.
AverageLength
— required — (Float
)The average bit sequence length in the column.
NumberOfNulls
— required — (Integer
)The number of null values in the column.
Error
— (map
)An error message with the reason for the failure of an operation.
ErrorCode
— (String
)The code associated with this error.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
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 | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA, /* required */ Name: 'STRING_VALUE', /* required */ AuthenticationConfiguration: { AuthenticationType: BASIC | OAUTH2 | CUSTOM, OAuth2Properties: { AuthorizationCodeProperties: { AuthorizationCode: 'STRING_VALUE', RedirectUri: 'STRING_VALUE' }, OAuth2ClientApplication: { AWSManagedClientApplicationReference: 'STRING_VALUE', UserManagedClientApplicationClientId: 'STRING_VALUE' }, OAuth2GrantType: AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER, TokenUrl: 'STRING_VALUE', TokenUrlParametersMap: { '<TokenUrlParameterKey>': 'STRING_VALUE', /* '<TokenUrlParameterKey>': ... */ } }, SecretArn: 'STRING_VALUE' }, Description: 'STRING_VALUE', MatchCriteria: [ 'STRING_VALUE', /* more items */ ], PhysicalConnectionRequirements: { AvailabilityZone: 'STRING_VALUE', SecurityGroupIdList: [ 'STRING_VALUE', /* more items */ ], SubnetId: 'STRING_VALUE' }, ValidateCredentials: true || false }, 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 Amazon Web Services 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, these types are supported:
-
JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).JDBC
Connections use the following ConnectionParameters.-
Required: All of (
HOST
,PORT
,JDBC_ENGINE
) orJDBC_CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
. -
Optional:
JDBC_ENFORCE_SSL
,CUSTOM_JDBC_CERT
,CUSTOM_JDBC_CERT_STRING
,SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
-
-
KAFKA
- Designates a connection to an Apache Kafka streaming platform.KAFKA
Connections use the following ConnectionParameters.-
Required:
KAFKA_BOOTSTRAP_SERVERS
. -
Optional:
KAFKA_SSL_ENABLED
,KAFKA_CUSTOM_CERT
,KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL withKAFKA
. -
Optional:
KAFKA_CLIENT_KEYSTORE
,KAFKA_CLIENT_KEYSTORE_PASSWORD
,KAFKA_CLIENT_KEY_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
,ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL inKAFKA
. -
Optional:
KAFKA_SASL_MECHANISM
. Can be specified asSCRAM-SHA-512
,GSSAPI
, orAWS_MSK_IAM
. -
Optional:
KAFKA_SASL_SCRAM_USERNAME
,KAFKA_SASL_SCRAM_PASSWORD
,ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication withKAFKA
. -
Optional:
KAFKA_SASL_GSSAPI_KEYTAB
,KAFKA_SASL_GSSAPI_KRB5_CONF
,KAFKA_SASL_GSSAPI_SERVICE
,KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication withKAFKA
.
-
-
MONGODB
- Designates a connection to a MongoDB document database.MONGODB
Connections use the following ConnectionParameters.-
Required:
CONNECTION_URL
. -
Required: All of (
USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
SALESFORCE
- Designates a connection to Salesforce using OAuth authencation.-
Requires the
AuthenticationConfiguration
member to be configured.
-
-
VIEW_VALIDATION_REDSHIFT
- Designates a connection used for view validation by Amazon Redshift. -
VIEW_VALIDATION_ATHENA
- Designates a connection used for view validation by Amazon Athena. -
NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. -
MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.MARKETPLACE
Connections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE
,CONNECTOR_URL
,CONNECTOR_CLASS_NAME
,CONNECTION_URL
. -
Required for
JDBC
CONNECTOR_TYPE
connections: All of (USERNAME
,PASSWORD
) orSECRET_ID
.
-
-
CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
SFTP
is not supported.For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
Possible values include:"JDBC"
"SFTP"
"MONGODB"
"KAFKA"
"NETWORK"
"MARKETPLACE"
"CUSTOM"
"SALESFORCE"
"VIEW_VALIDATION_REDSHIFT"
"VIEW_VALIDATION_ATHENA"
-
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
)The 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.
AuthenticationConfiguration
— (map
)The authentication properties of the connection. Used for a Salesforce connection.
AuthenticationType
— (String
)A structure containing the authentication configuration in the CreateConnection request.
Possible values include:"BASIC"
"OAUTH2"
"CUSTOM"
SecretArn
— (String
)The secret manager ARN to store credentials in the CreateConnection request.
OAuth2Properties
— (map
)The properties for OAuth2 authentication in the CreateConnection request.
OAuth2GrantType
— (String
)The OAuth2 grant type in the CreateConnection request. For example,
Possible values include:AUTHORIZATION_CODE
,JWT_BEARER
, orCLIENT_CREDENTIALS
."AUTHORIZATION_CODE"
"CLIENT_CREDENTIALS"
"JWT_BEARER"
OAuth2ClientApplication
— (map
)The client application type in the CreateConnection request. For example,
AWS_MANAGED
orUSER_MANAGED
.UserManagedClientApplicationClientId
— (String
)The client application clientID if the ClientAppType is
USER_MANAGED
.AWSManagedClientApplicationReference
— (String
)The reference to the SaaS-side client app that is Amazon Web Services managed.
TokenUrl
— (String
)The URL of the provider's authentication server, to exchange an authorization code for an access token.
TokenUrlParametersMap
— (map<String>
)A map of parameters that are added to the token
GET
request.AuthorizationCodeProperties
— (map
)The set of properties required for the the OAuth2
AUTHORIZATION_CODE
grant type.AuthorizationCode
— (String
)An authorization code to be used in the third leg of the
AUTHORIZATION_CODE
grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.RedirectUri
— (String
)The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.
ValidateCredentials
— (Boolean
)A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.
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.
-
(AWS.Response)
—
Returns:
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', LakeFormationConfiguration: { AccountId: 'STRING_VALUE', UseLakeFormationCredentials: true || false }, LineageConfiguration: { CrawlerLineageSettings: ENABLE | DISABLE }, RecrawlPolicy: { RecrawlBehavior: CRAWL_EVERYTHING | CRAWL_NEW_FOLDERS_ONLY | CRAWL_EVENT_MODE }, Role: 'STRING_VALUE', Schedule: 'STRING_VALUE', SchemaChangePolicy: { DeleteBehavior: LOG | DELETE_FROM_DATABASE | DEPRECATE_IN_DATABASE, UpdateBehavior: LOG | UPDATE_IN_DATABASE }, TablePrefix: 'STRING_VALUE', Targets: { CatalogTargets: [ { DatabaseName: 'STRING_VALUE', /* required */ Tables: [ /* required */ 'STRING_VALUE', /* more items */ ], ConnectionName: 'STRING_VALUE', DlqEventQueueArn: 'STRING_VALUE', EventQueueArn: 'STRING_VALUE' }, /* more items */ ], DeltaTargets: [ { ConnectionName: 'STRING_VALUE', CreateNativeDeltaTable: true || false, DeltaTables: [ 'STRING_VALUE', /* more items */ ], WriteManifest: true || false }, /* more items */ ], DynamoDBTargets: [ { Path: 'STRING_VALUE', scanAll: true || false, scanRate: 'NUMBER_VALUE' }, /* more items */ ], HudiTargets: [ { ConnectionName: 'STRING_VALUE', Exclusions: [ 'STRING_VALUE', /* more items */ ], MaximumTraversalDepth: 'NUMBER_VALUE', Paths: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], IcebergTargets: [ { ConnectionName: 'STRING_VALUE', Exclusions: [ 'STRING_VALUE', /* more items */ ], MaximumTraversalDepth: 'NUMBER_VALUE', Paths: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], JdbcTargets: [ { ConnectionName: 'STRING_VALUE', EnableAdditionalMetadata: [ COMMENTS | RAWTYPES, /* more items */ ], Exclusions: [ 'STRING_VALUE', /* more items */ ], Path: 'STRING_VALUE' }, /* more items */ ], MongoDBTargets: [ { ConnectionName: 'STRING_VALUE', Path: 'STRING_VALUE', ScanAll: true || false }, /* more items */ ], S3Targets: [ { ConnectionName: 'STRING_VALUE', DlqEventQueueArn: 'STRING_VALUE', EventQueueArn: 'STRING_VALUE', Exclusions: [ 'STRING_VALUE', /* more items */ ], Path: 'STRING_VALUE', SampleSize: 'NUMBER_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 Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
DatabaseName
— (String
)The 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 Simple Storage Service (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.
ConnectionName
— (String
)The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).
SampleSize
— (Integer
)Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
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.
EnableAdditionalMetadata
— (Array<String>
)Specify a value of
RAWTYPES
orCOMMENTS
to enable additional metadata in table responses.RAWTYPES
provides the native-level datatype.COMMENTS
provides comments associated with a column or table in the database.If you do not need additional metadata, keep the field empty.
MongoDBTargets
— (Array<map>
)Specifies Amazon DocumentDB or MongoDB targets.
ConnectionName
— (String
)The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.
Path
— (String
)The path of the Amazon DocumentDB or MongoDB target (database/collection).
ScanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.
DynamoDBTargets
— (Array<map>
)Specifies Amazon DynamoDB targets.
Path
— (String
)The name of the DynamoDB table to crawl.
scanAll
— (Boolean
)Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.
A value of
true
means to scan all records, while a value offalse
means to sample the records. If no value is specified, the value defaults totrue
.scanRate
— (Float
)The percentage of the configured read capacity units to use by the Glue crawler. Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.
The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).
CatalogTargets
— (Array<map>
)Specifies Glue Data Catalog targets.
DatabaseName
— required — (String
)The name of the database to be synchronized.
Tables
— required — (Array<String>
)A list of the tables to be synchronized.
ConnectionName
— (String
)The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a
Catalog
connection type paired with aNETWORK
Connection type.EventQueueArn
— (String
)A valid Amazon SQS ARN. For example,
arn:aws:sqs:region:account:sqs
.DlqEventQueueArn
— (String
)A valid Amazon dead-letter SQS ARN. For example,
arn:aws:sqs:region:account:deadLetterQueue
.
DeltaTargets
— (Array<map>
)Specifies Delta data store targets.
DeltaTables
— (Array<String>
)A list of the Amazon S3 paths to the Delta tables.
ConnectionName
— (String
)The name of the connection to use to connect to the Delta table target.
WriteManifest
— (Boolean
)Specifies whether to write the manifest files to the Delta table path.
CreateNativeDeltaTable
— (Boolean
)Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly.
IcebergTargets
— (Array<map>
)Specifies Apache Iceberg data store targets.
Paths
— (Array<String>
)One or more Amazon S3 paths that contains Iceberg metadata folders as
s3://bucket/prefix
.ConnectionName
— (String
)The name of the connection to use to connect to the Iceberg target.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. Used to limit the crawler run time.
HudiTargets
— (Array<map>
)Specifies Apache Hudi data store targets.
Paths
— (Array<String>
)An array of Amazon S3 location strings for Hudi, each indicating the root folder with which the metadata files for a Hudi table resides. The Hudi folder may be located in a child folder of the root folder.
The crawler will scan all folders underneath a path for a Hudi folder.
ConnectionName
— (String
)The name of the connection to use to connect to the Hudi target. If your Hudi files are stored in buckets that require VPC authorization, you can set their connection properties here.
Exclusions
— (Array<String>
)A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
MaximumTraversalDepth
— (Integer
)The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Hudi metadata folder in your Amazon S3 path. Used to limit the crawler run time.
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
)The 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"
RecrawlPolicy
— (map
)A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
RecrawlBehavior
— (String
)Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
A value of
CRAWL_EVERYTHING
specifies crawling the entire dataset again.A value of
CRAWL_NEW_FOLDERS_ONLY
specifies crawling only folders that were added since the last crawler run.A value of
Possible values include:CRAWL_EVENT_MODE
specifies crawling only the changes identified by Amazon S3 events."CRAWL_EVERYTHING"
"CRAWL_NEW_FOLDERS_ONLY"
"CRAWL_EVENT_MODE"
LineageConfiguration
— (map
)Specifies data lineage configuration settings for the crawler.
CrawlerLineageSettings
— (String
)Specifies whether data lineage is enabled for the crawler. Valid values are:
-
ENABLE: enables data lineage for the crawler
-
DISABLE: disables data lineage for the crawler
"ENABLE"
"DISABLE"
-
LakeFormationConfiguration
— (map
)Specifies Lake Formation configuration settings for the crawler.
UseLakeFormationCredentials
— (Boolean
)Specifies whether to use Lake Formation credentials for the crawler instead of the IAM role credentials.
AccountId
— (String
)Required for cross account crawls. For same account crawls as the target data, this can be left as null.
Configuration
— (String
)Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.
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.
-
(AWS.Response)
—
Returns:
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
)The 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.
-
(AWS.Response)
—
Returns:
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 */ CreateTableDefaultPermissions: [ { Permissions: [ ALL | SELECT | ALTER | DROP | DELETE | INSERT | CREATE_DATABASE | CREATE_TABLE | DATA_LOCATION_ACCESS, /* more items */ ], Principal: { DataLakePrincipalIdentifier: 'STRING_VALUE' } }, /* more items */ ], Description: 'STRING_VALUE', FederatedDatabase: { ConnectionName: 'STRING_VALUE', Identifier: 'STRING_VALUE' }, LocationUri: 'STRING_VALUE', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, TargetDatabase: { CatalogId: 'STRING_VALUE', DatabaseName: 'STRING_VALUE', Region: 'STRING_VALUE' } }, 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 provided, the Amazon Web Services 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
)The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
Description
— (String
)A 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.
These key-value pairs define parameters and properties of the database.
CreateTableDefaultPermissions
— (Array<map>
)Creates a set of default permissions on the table for principals. Used by Lake Formation. Not used in the normal course of Glue operations.
Principal
— (map
)The principal who is granted permissions.
DataLakePrincipalIdentifier
— (String
)An identifier for the Lake Formation principal.
Permissions
— (Array<String>
)The permissions that are granted to the principal.
TargetDatabase
— (map
)A
DatabaseIdentifier
structure that describes a target database for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the database resides.
DatabaseName
— (String
)The name of the catalog database.
Region
— (String
)Region of the target database.
FederatedDatabase
— (map
)A
FederatedDatabase
structure that references an entity outside the Glue Data Catalog.Identifier
— (String
)A unique identifier for the federated database.
ConnectionName
— (String
)The name of the connection to the external metastore.
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.
-
(AWS.Response)
—
Returns:
updateDataQualityRuleset(params = {}, callback) ⇒ AWS.Request
Updates the specified data quality ruleset.
Service Reference:
Examples:
Calling the updateDataQualityRuleset operation
var params = { Name: 'STRING_VALUE', /* required */ Description: 'STRING_VALUE', Ruleset: 'STRING_VALUE' }; glue.updateDataQualityRuleset(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 data quality ruleset.
Description
— (String
)A description of the ruleset.
Ruleset
— (String
)A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue 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. Thedata
object has the following properties:Name
— (String
)The name of the data quality ruleset.
Description
— (String
)A description of the ruleset.
Ruleset
— (String
)A Data Quality Definition Language (DQDL) ruleset. For more information, see the Glue developer guide.
-
(AWS.Response)
—
Returns:
updateDevEndpoint(params = {}, callback) ⇒ AWS.Request
Updates a specified development endpoint.
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
)The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be loaded in your
DevEndpoint
. Multiple values must be complete paths separated by a comma.Note: You can only use pure Python libraries with aDevEndpoint
. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.ExtraJarsS3Path
— (String
)The path to one or more Java
.jar
files in an S3 bucket that should be loaded in yourDevEndpoint
.Note: You can only use pure Java/Scala libraries with aDevEndpoint
.
UpdateEtlLibraries
— (Boolean
)True
if the list of custom libraries to be loaded in the development endpoint needs to be updated, orFalse
if 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
.Valid arguments are:
-
"--enable-glue-datacatalog": ""
You can specify a version of Python support for development endpoints by using the
Arguments
parameter in theCreateDevEndpoint
orUpdateDevEndpoint
APIs. If no arguments are provided, the version defaults to Python 2.-
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.
-
(AWS.Response)
—
Returns:
updateJob(params = {}, callback) ⇒ AWS.Request
Updates an existing job definition. The previous job definition is completely overwritten by this information.
Service Reference:
Examples:
Calling the updateJob operation
var params = { JobName: 'STRING_VALUE', /* required */ JobUpdate: { /* required */ AllocatedCapacity: 'NUMBER_VALUE', CodeGenConfigurationNodes: { '<NodeId>': { Aggregate: { Aggs: [ /* required */ { AggFunc: avg | countDistinct | count | first | last | kurtosis | max | min | skewness | stddev_samp | stddev_pop | sum | sumDistinct | var_samp | var_pop, /* required */ Column: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], Groups: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE' /* required */ }, AmazonRedshiftSource: { Data: { AccessType: 'STRING_VALUE', Action: 'STRING_VALUE', AdvancedOptions: [ { Key: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], CatalogDatabase: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, CatalogRedshiftSchema: 'STRING_VALUE', CatalogRedshiftTable: 'STRING_VALUE', CatalogTable: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, Connection: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, CrawlerConnection: 'STRING_VALUE', IamRole: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, MergeAction: 'STRING_VALUE', MergeClause: 'STRING_VALUE', MergeWhenMatched: 'STRING_VALUE', MergeWhenNotMatched: 'STRING_VALUE', PostAction: 'STRING_VALUE', PreAction: 'STRING_VALUE', SampleQuery: 'STRING_VALUE', Schema: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, SelectedColumns: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], SourceType: 'STRING_VALUE', StagingTable: 'STRING_VALUE', Table: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, TablePrefix: 'STRING_VALUE', TableSchema: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], TempDir: 'STRING_VALUE', Upsert: true || false }, Name: 'STRING_VALUE' }, AmazonRedshiftTarget: { Data: { AccessType: 'STRING_VALUE', Action: 'STRING_VALUE', AdvancedOptions: [ { Key: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], CatalogDatabase: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, CatalogRedshiftSchema: 'STRING_VALUE', CatalogRedshiftTable: 'STRING_VALUE', CatalogTable: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, Connection: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, CrawlerConnection: 'STRING_VALUE', IamRole: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, MergeAction: 'STRING_VALUE', MergeClause: 'STRING_VALUE', MergeWhenMatched: 'STRING_VALUE', MergeWhenNotMatched: 'STRING_VALUE', PostAction: 'STRING_VALUE', PreAction: 'STRING_VALUE', SampleQuery: 'STRING_VALUE', Schema: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, SelectedColumns: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], SourceType: 'STRING_VALUE', StagingTable: 'STRING_VALUE', Table: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, TablePrefix: 'STRING_VALUE', TableSchema: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], TempDir: 'STRING_VALUE', Upsert: true || false }, Inputs: [ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE' }, ApplyMapping: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Mapping: [ /* Mappings */ /* required */ { Children: /* recursive Mappings */, Dropped: true || false, FromPath: [ 'STRING_VALUE', /* more items */ ], FromType: 'STRING_VALUE', ToKey: 'STRING_VALUE', ToType: 'STRING_VALUE' }, /* more items */ ], Name: 'STRING_VALUE' /* required */ }, AthenaConnectorSource: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ SchemaName: 'STRING_VALUE', /* required */ ConnectionTable: 'STRING_VALUE', OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, CatalogDeltaSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalDeltaOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, CatalogHudiSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalHudiOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, CatalogKafkaSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ DataPreviewOptions: { PollingTime: 'NUMBER_VALUE', RecordPollingLimit: 'NUMBER_VALUE' }, DetectSchema: true || false, StreamingOptions: { AddRecordTimestamp: 'STRING_VALUE', Assign: 'STRING_VALUE', BootstrapServers: 'STRING_VALUE', Classification: 'STRING_VALUE', ConnectionName: 'STRING_VALUE', Delimiter: 'STRING_VALUE', EmitConsumerLagMetrics: 'STRING_VALUE', EndingOffsets: 'STRING_VALUE', IncludeHeaders: true || false, MaxOffsetsPerTrigger: 'NUMBER_VALUE', MinPartitions: 'NUMBER_VALUE', NumRetries: 'NUMBER_VALUE', PollTimeoutMs: 'NUMBER_VALUE', RetryIntervalMs: 'NUMBER_VALUE', SecurityProtocol: 'STRING_VALUE', StartingOffsets: 'STRING_VALUE', StartingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, SubscribePattern: 'STRING_VALUE', TopicName: 'STRING_VALUE' }, WindowSize: 'NUMBER_VALUE' }, CatalogKinesisSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ DataPreviewOptions: { PollingTime: 'NUMBER_VALUE', RecordPollingLimit: 'NUMBER_VALUE' }, DetectSchema: true || false, StreamingOptions: { AddIdleTimeBetweenReads: true || false, AddRecordTimestamp: 'STRING_VALUE', AvoidEmptyBatches: true || false, Classification: 'STRING_VALUE', Delimiter: 'STRING_VALUE', DescribeShardInterval: 'NUMBER_VALUE', EmitConsumerLagMetrics: 'STRING_VALUE', EndpointUrl: 'STRING_VALUE', IdleTimeBetweenReadsInMs: 'NUMBER_VALUE', MaxFetchRecordsPerShard: 'NUMBER_VALUE', MaxFetchTimeInMs: 'NUMBER_VALUE', MaxRecordPerRead: 'NUMBER_VALUE', MaxRetryIntervalMs: 'NUMBER_VALUE', NumRetries: 'NUMBER_VALUE', RetryIntervalMs: 'NUMBER_VALUE', RoleArn: 'STRING_VALUE', RoleSessionName: 'STRING_VALUE', StartingPosition: latest | trim_horizon | earliest | timestamp, StartingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, StreamArn: 'STRING_VALUE', StreamName: 'STRING_VALUE' }, WindowSize: 'NUMBER_VALUE' }, CatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, CatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, ConnectorDataSource: { ConnectionType: 'STRING_VALUE', /* required */ Data: { /* required */ '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, Name: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, ConnectorDataTarget: { ConnectionType: 'STRING_VALUE', /* required */ Data: { /* required */ '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, Name: 'STRING_VALUE', /* required */ Inputs: [ 'STRING_VALUE', /* more items */ ] }, CustomCode: { ClassName: 'STRING_VALUE', /* required */ Code: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, DirectJDBCSource: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: sqlserver | mysql | oracle | postgresql | redshift, /* required */ Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ RedshiftTmpDir: 'STRING_VALUE' }, DirectKafkaSource: { Name: 'STRING_VALUE', /* required */ DataPreviewOptions: { PollingTime: 'NUMBER_VALUE', RecordPollingLimit: 'NUMBER_VALUE' }, DetectSchema: true || false, StreamingOptions: { AddRecordTimestamp: 'STRING_VALUE', Assign: 'STRING_VALUE', BootstrapServers: 'STRING_VALUE', Classification: 'STRING_VALUE', ConnectionName: 'STRING_VALUE', Delimiter: 'STRING_VALUE', EmitConsumerLagMetrics: 'STRING_VALUE', EndingOffsets: 'STRING_VALUE', IncludeHeaders: true || false, MaxOffsetsPerTrigger: 'NUMBER_VALUE', MinPartitions: 'NUMBER_VALUE', NumRetries: 'NUMBER_VALUE', PollTimeoutMs: 'NUMBER_VALUE', RetryIntervalMs: 'NUMBER_VALUE', SecurityProtocol: 'STRING_VALUE', StartingOffsets: 'STRING_VALUE', StartingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, SubscribePattern: 'STRING_VALUE', TopicName: 'STRING_VALUE' }, WindowSize: 'NUMBER_VALUE' }, DirectKinesisSource: { Name: 'STRING_VALUE', /* required */ DataPreviewOptions: { PollingTime: 'NUMBER_VALUE', RecordPollingLimit: 'NUMBER_VALUE' }, DetectSchema: true || false, StreamingOptions: { AddIdleTimeBetweenReads: true || false, AddRecordTimestamp: 'STRING_VALUE', AvoidEmptyBatches: true || false, Classification: 'STRING_VALUE', Delimiter: 'STRING_VALUE', DescribeShardInterval: 'NUMBER_VALUE', EmitConsumerLagMetrics: 'STRING_VALUE', EndpointUrl: 'STRING_VALUE', IdleTimeBetweenReadsInMs: 'NUMBER_VALUE', MaxFetchRecordsPerShard: 'NUMBER_VALUE', MaxFetchTimeInMs: 'NUMBER_VALUE', MaxRecordPerRead: 'NUMBER_VALUE', MaxRetryIntervalMs: 'NUMBER_VALUE', NumRetries: 'NUMBER_VALUE', RetryIntervalMs: 'NUMBER_VALUE', RoleArn: 'STRING_VALUE', RoleSessionName: 'STRING_VALUE', StartingPosition: latest | trim_horizon | earliest | timestamp, StartingTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, StreamArn: 'STRING_VALUE', StreamName: 'STRING_VALUE' }, WindowSize: 'NUMBER_VALUE' }, DropDuplicates: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Columns: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, DropFields: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, DropNullFields: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ NullCheckBoxList: { IsEmpty: true || false, IsNegOne: true || false, IsNullString: true || false }, NullTextList: [ { Datatype: { /* required */ Id: 'STRING_VALUE', /* required */ Label: 'STRING_VALUE' /* required */ }, Value: 'STRING_VALUE' /* required */ }, /* more items */ ] }, DynamicTransform: { FunctionName: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ TransformName: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Parameters: [ { Name: 'STRING_VALUE', /* required */ Type: str | int | float | complex | bool | list | null, /* required */ IsOptional: true || false, ListType: str | int | float | complex | bool | list | null, ValidationMessage: 'STRING_VALUE', ValidationRule: 'STRING_VALUE', Value: [ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], Version: 'STRING_VALUE' }, DynamoDBCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, EvaluateDataQuality: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Ruleset: 'STRING_VALUE', /* required */ Output: PrimaryInput | EvaluationResults, PublishingOptions: { CloudWatchMetricsEnabled: true || false, EvaluationContext: 'STRING_VALUE', ResultsPublishingEnabled: true || false, ResultsS3Prefix: 'STRING_VALUE' }, StopJobOnFailureOptions: { StopJobOnFailureTiming: Immediate | AfterDataLoad } }, EvaluateDataQualityMultiFrame: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Ruleset: 'STRING_VALUE', /* required */ AdditionalDataSources: { '<NodeName>': 'STRING_VALUE', /* '<NodeName>': ... */ }, AdditionalOptions: { '<AdditionalOptionKeys>': 'STRING_VALUE', /* '<AdditionalOptionKeys>': ... */ }, PublishingOptions: { CloudWatchMetricsEnabled: true || false, EvaluationContext: 'STRING_VALUE', ResultsPublishingEnabled: true || false, ResultsS3Prefix: 'STRING_VALUE' }, StopJobOnFailureOptions: { StopJobOnFailureTiming: Immediate | AfterDataLoad } }, FillMissingValues: { ImputedPath: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ FilledPath: 'STRING_VALUE' }, Filter: { Filters: [ /* required */ { Operation: EQ | LT | GT | LTE | GTE | REGEX | ISNULL, /* required */ Values: [ /* required */ { Type: COLUMNEXTRACTED | CONSTANT, /* required */ Value: [ /* required */ 'STRING_VALUE', /* more items */ ] }, /* more items */ ], Negated: true || false }, /* more items */ ], Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], LogicalOperator: AND | OR, /* required */ Name: 'STRING_VALUE' /* required */ }, GovernedCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE' }, PartitionPredicate: 'STRING_VALUE' }, GovernedCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { EnableUpdateCatalog: true || false, UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, JDBCConnectorSource: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ AdditionalOptions: { DataTypeMapping: { '<JDBCDataType>': DATE | STRING | TIMESTAMP | INT | FLOAT | LONG | BIGDECIMAL | BYTE | SHORT | DOUBLE, /* '<JDBCDataType>': ... */ }, FilterPredicate: 'STRING_VALUE', JobBookmarkKeys: [ 'STRING_VALUE', /* more items */ ], JobBookmarkKeysSortOrder: 'STRING_VALUE', LowerBound: 'NUMBER_VALUE', NumPartitions: 'NUMBER_VALUE', PartitionColumn: 'STRING_VALUE', UpperBound: 'NUMBER_VALUE' }, ConnectionTable: 'STRING_VALUE', OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Query: 'STRING_VALUE' }, JDBCConnectorTarget: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionTable: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, Join: { Columns: [ /* required */ { From: 'STRING_VALUE', /* required */ Keys: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, /* more items */ ], Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], JoinType: equijoin | left | right | outer | leftsemi | leftanti, /* required */ Name: 'STRING_VALUE' /* required */ }, Merge: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ PrimaryKeys: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], Source: 'STRING_VALUE' /* required */ }, MicrosoftSQLServerCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, MicrosoftSQLServerCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, MySQLCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, MySQLCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, OracleSQLCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, OracleSQLCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, PIIDetection: { EntityTypesToDetect: [ /* required */ 'STRING_VALUE', /* more items */ ], Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ PiiType: RowAudit | RowMasking | ColumnAudit | ColumnMasking, /* required */ MaskValue: 'STRING_VALUE', OutputColumnName: 'STRING_VALUE', SampleFraction: 'NUMBER_VALUE', ThresholdFraction: 'NUMBER_VALUE' }, PostgreSQLCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, PostgreSQLCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, Recipe: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ RecipeReference: { RecipeArn: 'STRING_VALUE', /* required */ RecipeVersion: 'STRING_VALUE' /* required */ }, RecipeSteps: [ { Action: { /* required */ Operation: 'STRING_VALUE', /* required */ Parameters: { '<ParameterName>': 'STRING_VALUE', /* '<ParameterName>': ... */ } }, ConditionExpressions: [ { Condition: 'STRING_VALUE', /* required */ TargetColumn: 'STRING_VALUE', /* required */ Value: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, RedshiftSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ RedshiftTmpDir: 'STRING_VALUE', TmpDirIAMRole: 'STRING_VALUE' }, RedshiftTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ RedshiftTmpDir: 'STRING_VALUE', TmpDirIAMRole: 'STRING_VALUE', UpsertRedshiftOptions: { ConnectionName: 'STRING_VALUE', TableLocation: 'STRING_VALUE', UpsertKeys: [ 'STRING_VALUE', /* more items */ ] } }, RelationalCatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE' /* required */ }, RenameField: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ SourcePath: [ /* required */ 'STRING_VALUE', /* more items */ ], TargetPath: [ /* required */ 'STRING_VALUE', /* more items */ ] }, S3CatalogDeltaSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalDeltaOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, S3CatalogHudiSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalHudiOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, S3CatalogSource: { Database: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE' }, PartitionPredicate: 'STRING_VALUE' }, S3CatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { EnableUpdateCatalog: true || false, UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3CsvSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], QuoteChar: quote | quillemet | single_quote | disabled, /* required */ Separator: comma | ctrla | pipe | semicolon | tab, /* required */ AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, CompressionType: gzip | bzip2, Escaper: 'STRING_VALUE', Exclusions: [ 'STRING_VALUE', /* more items */ ], GroupFiles: 'STRING_VALUE', GroupSize: 'STRING_VALUE', MaxBand: 'NUMBER_VALUE', MaxFilesInBand: 'NUMBER_VALUE', Multiline: true || false, OptimizePerformance: true || false, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Recurse: true || false, SkipFirst: true || false, WithHeader: true || false, WriteHeader: true || false }, S3DeltaCatalogTarget: { Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { EnableUpdateCatalog: true || false, UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3DeltaDirectTarget: { Compression: uncompressed | snappy, /* required */ Format: json | csv | avro | orc | parquet | hudi | delta, /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { Database: 'STRING_VALUE', EnableUpdateCatalog: true || false, Table: 'STRING_VALUE', UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3DeltaSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalDeltaOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, S3DirectTarget: { Format: json | csv | avro | orc | parquet | hudi | delta, /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ Compression: 'STRING_VALUE', PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { Database: 'STRING_VALUE', EnableUpdateCatalog: true || false, Table: 'STRING_VALUE', UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3GlueParquetTarget: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ Compression: snappy | lzo | gzip | uncompressed | none, PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { Database: 'STRING_VALUE', EnableUpdateCatalog: true || false, Table: 'STRING_VALUE', UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3HudiCatalogTarget: { AdditionalOptions: { /* required */ '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, Database: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Table: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { EnableUpdateCatalog: true || false, UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3HudiDirectTarget: { AdditionalOptions: { /* required */ '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, Compression: gzip | lzo | uncompressed | snappy, /* required */ Format: json | csv | avro | orc | parquet | hudi | delta, /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ PartitionKeys: [ [ 'STRING_VALUE', /* more items */ ], /* more items */ ], SchemaChangePolicy: { Database: 'STRING_VALUE', EnableUpdateCatalog: true || false, Table: 'STRING_VALUE', UpdateBehavior: UPDATE_IN_DATABASE | LOG } }, S3HudiSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalHudiOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, S3JsonSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, CompressionType: gzip | bzip2, Exclusions: [ 'STRING_VALUE', /* more items */ ], GroupFiles: 'STRING_VALUE', GroupSize: 'STRING_VALUE', JsonPath: 'STRING_VALUE', MaxBand: 'NUMBER_VALUE', MaxFilesInBand: 'NUMBER_VALUE', Multiline: true || false, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Recurse: true || false }, S3ParquetSource: { Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ 'STRING_VALUE', /* more items */ ], AdditionalOptions: { BoundedFiles: 'NUMBER_VALUE', BoundedSize: 'NUMBER_VALUE', EnableSamplePath: true || false, SamplePath: 'STRING_VALUE' }, CompressionType: snappy | lzo | gzip | uncompressed | none, Exclusions: [ 'STRING_VALUE', /* more items */ ], GroupFiles: 'STRING_VALUE', GroupSize: 'STRING_VALUE', MaxBand: 'NUMBER_VALUE', MaxFilesInBand: 'NUMBER_VALUE', OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ], Recurse: true || false }, SelectFields: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, SelectFromCollection: { Index: 'NUMBER_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE' /* required */ }, SnowflakeSource: { Data: { /* required */ Action: 'STRING_VALUE', AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, AutoPushdown: true || false, Connection: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, Database: 'STRING_VALUE', IamRole: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, MergeAction: 'STRING_VALUE', MergeClause: 'STRING_VALUE', MergeWhenMatched: 'STRING_VALUE', MergeWhenNotMatched: 'STRING_VALUE', PostAction: 'STRING_VALUE', PreAction: 'STRING_VALUE', SampleQuery: 'STRING_VALUE', Schema: 'STRING_VALUE', SelectedColumns: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], SourceType: 'STRING_VALUE', StagingTable: 'STRING_VALUE', Table: 'STRING_VALUE', TableSchema: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], TempDir: 'STRING_VALUE', Upsert: true || false }, Name: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, SnowflakeTarget: { Data: { /* required */ Action: 'STRING_VALUE', AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, AutoPushdown: true || false, Connection: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, Database: 'STRING_VALUE', IamRole: { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, MergeAction: 'STRING_VALUE', MergeClause: 'STRING_VALUE', MergeWhenMatched: 'STRING_VALUE', MergeWhenNotMatched: 'STRING_VALUE', PostAction: 'STRING_VALUE', PreAction: 'STRING_VALUE', SampleQuery: 'STRING_VALUE', Schema: 'STRING_VALUE', SelectedColumns: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], SourceType: 'STRING_VALUE', StagingTable: 'STRING_VALUE', Table: 'STRING_VALUE', TableSchema: [ { Description: 'STRING_VALUE', Label: 'STRING_VALUE', Value: 'STRING_VALUE' }, /* more items */ ], TempDir: 'STRING_VALUE', Upsert: true || false }, Name: 'STRING_VALUE', /* required */ Inputs: [ 'STRING_VALUE', /* more items */ ] }, SparkConnectorSource: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Name: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, SparkConnectorTarget: { ConnectionName: 'STRING_VALUE', /* required */ ConnectionType: 'STRING_VALUE', /* required */ ConnectorName: 'STRING_VALUE', /* required */ Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ AdditionalOptions: { '<EnclosedInStringProperty>': 'STRING_VALUE', /* '<EnclosedInStringProperty>': ... */ }, OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, SparkSQL: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ SqlAliases: [ /* required */ { Alias: 'STRING_VALUE', /* required */ From: 'STRING_VALUE' /* required */ }, /* more items */ ], SqlQuery: 'STRING_VALUE', /* required */ OutputSchemas: [ { Columns: [ { Name: 'STRING_VALUE', /* required */ Type: 'STRING_VALUE' }, /* more items */ ] }, /* more items */ ] }, Spigot: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Path: 'STRING_VALUE', /* required */ Prob: 'NUMBER_VALUE', Topk: 'NUMBER_VALUE' }, SplitFields: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ Paths: [ /* required */ [ 'STRING_VALUE', /* more items */ ], /* more items */ ] }, Union: { Inputs: [ /* required */ 'STRING_VALUE', /* more items */ ], Name: 'STRING_VALUE', /* required */ UnionType: ALL | DISTINCT /* required */ } }, /* '<NodeId>': ... */ }, Command: { Name: 'STRING_VALUE', PythonVersion: 'STRING_VALUE', Runtime: 'STRING_VALUE', ScriptLocation: 'STRING_VALUE' }, Connections: { Connections: [ 'STRING_VALUE', /* more items */ ] }, DefaultArguments: { '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, Description: 'STRING_VALUE', ExecutionClass: FLEX | STANDARD, ExecutionProperty: { MaxConcurrentRuns: 'NUMBER_VALUE' }, GlueVersion: 'STRING_VALUE', JobMode: SCRIPT | VISUAL | NOTEBOOK, JobRunQueuingEnabled: true || false, LogUri: 'STRING_VALUE', MaintenanceWindow: 'STRING_VALUE', MaxCapacity: 'NUMBER_VALUE', MaxRetries: 'NUMBER_VALUE', NonOverridableArguments: { '<GenericString>': 'STRING_VALUE', /* '<GenericString>': ... */ }, NotificationProperty: { NotifyDelayAfter: 'NUMBER_VALUE' }, NumberOfWorkers: 'NUMBER_VALUE', Role: 'STRING_VALUE', SecurityConfiguration: 'STRING_VALUE', SourceControlDetails: { AuthStrategy: PERSONAL_ACCESS_TOKEN | AWS_SECRETS_MANAGER, AuthToken: 'STRING_VALUE', Branch: 'STRING_VALUE', Folder: 'STRING_VALUE', LastCommitId: 'STRING_VALUE', Owner: 'STRING_VALUE', Provider: GITHUB | GITLAB | BITBUCKET | AWS_CODE_COMMIT, Repository: 'STRING_VALUE' }, Timeout: 'NUMBER_VALUE', WorkerType: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.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
)The name of the job definition to update.
JobUpdate
— (map
)Specifies the values with which to update the job definition. Unspecified configuration is removed or reset to default values.
JobMode
— (String
)A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
Possible values include:JobMode
field is missing or null,SCRIPT
is assigned as the default value."SCRIPT"
"VISUAL"
"NOTEBOOK"
-
JobRunQueuingEnabled
— (Boolean
)Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Description
— (String
)Description of the job being defined.
LogUri
— (String
)This field is reserved for future use.
Role
— (String
)The name or Amazon Resource Name (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 runs this job (required).Name
— (String
)The name of the job command. For an Apache Spark ETL job, this must be
glueetl
. For a Python shell job, it must bepythonshell
. For an Apache Spark streaming ETL job, this must begluestreaming
. For a Ray job, this must beglueray
.ScriptLocation
— (String
)Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that runs a job.
PythonVersion
— (String
)The Python version being used to run a Python shell job. Allowed values are 2 or 3.
Runtime
— (String
)In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
DefaultArguments
— (map<String>
)The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
NonOverridableArguments
— (map<String>
)Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
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 Glue data processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 DPUs; 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 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) for batch jobs.Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
MaxCapacity
— (Float
)For Glue version 1.0 or earlier jobs, using the standard worker type, the number of 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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity
. Instead, you should specify aWorker type
and theNumber of workers
.Do not set
MaxCapacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming 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") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), 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 G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
-
For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. -
For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). -
For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for theG.4X
worker type. -
For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs. -
For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when a job runs.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this job.NotificationProperty
— (map
)Specifies the 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.
GlueVersion
— (String
)In Spark jobs,
GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.Ray jobs should set
GlueVersion
to4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntime
parameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
CodeGenConfigurationNodes
— (map<map>
)The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
AthenaConnectorSource
— (map
)Specifies a connector to an Amazon Athena data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
ConnectionTable
— (String
)The name of the table in the data source.
SchemaName
— required — (String
)The name of the Cloudwatch log group to read from. For example,
/aws-glue/jobs/output
.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom Athena source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
JDBCConnectorSource
— (map
)Specifies a connector to a JDBC data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
AdditionalOptions
— (map
)Additional connection options for the connector.
FilterPredicate
— (String
)Extra condition clause to filter data from source. For example:
BillingCity='Mountain View'
When using a query instead of a table name, you should validate that the query works with the specified
filterPredicate
.PartitionColumn
— (String
)The name of an integer column that is used for partitioning. This option works only when it's included with
lowerBound
,upperBound
, andnumPartitions
. This option works the same way as in the Spark SQL JDBC reader.LowerBound
— (Integer
)The minimum value of
partitionColumn
that is used to decide partition stride.UpperBound
— (Integer
)The maximum value of
partitionColumn
that is used to decide partition stride.NumPartitions
— (Integer
)The number of partitions. This value, along with
lowerBound
(inclusive) andupperBound
(exclusive), form partition strides for generatedWHERE
clause expressions that are used to split thepartitionColumn
.JobBookmarkKeys
— (Array<String>
)The name of the job bookmark keys on which to sort.
JobBookmarkKeysSortOrder
— (String
)Specifies an ascending or descending sort order.
DataTypeMapping
— (map<String>
)Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option
"dataTypeMapping":{"FLOAT":"STRING"}
maps data fields of JDBC typeFLOAT
into the JavaString
type by calling theResultSet.getString()
method of the driver, and uses it to build the Glue record. TheResultSet
object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
ConnectionTable
— (String
)The name of the table in the data source.
Query
— (String
)The table or SQL query to get the data from. You can specify either
ConnectionTable
orquery
, but not both.OutputSchemas
— (Array<map>
)Specifies the data schema for the custom JDBC source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorSource
— (map
)Specifies a connector to an Apache Spark data source.
Name
— required — (String
)The name of the data source.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectorName
— required — (String
)The name of a connector that assists with accessing the data store in Glue Studio.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies data schema for the custom spark source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogSource
— (map
)Specifies a data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
RedshiftSource
— (map
)Specifies an Amazon Redshift data store.
Name
— required — (String
)The name of the Amazon Redshift data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
S3CatalogSource
— (map
)Specifies an Amazon S3 data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
S3CsvSource
— (map
)Specifies a command-separated value (CSV) data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
Separator
— required — (String
)Specifies the delimiter character. The default is a comma: ",", but any other character can be specified.
Possible values include:"comma"
"ctrla"
"pipe"
"semicolon"
"tab"
Escaper
— (String
)Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is
none
. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\n
,\r
,\t
, and\0
).QuoteChar
— required — (String
)Specifies the character to use for quoting. The default is a double quote:
Possible values include:'"'
. Set this to-1
to turn off quoting entirely."quote"
"quillemet"
"single_quote"
"disabled"
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.WithHeader
— (Boolean
)A Boolean value that specifies whether to treat the first line as a header. The default value is
False
.WriteHeader
— (Boolean
)A Boolean value that specifies whether to write the header to output. The default value is
True
.SkipFirst
— (Boolean
)A Boolean value that specifies whether to skip the first data line. The default value is
False
.OptimizePerformance
— (Boolean
)A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 CSV source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3JsonSource
— (map
)Specifies a JSON data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"bzip2"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
JsonPath
— (String
)A JsonPath string defining the JSON data.
Multiline
— (Boolean
)A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 JSON source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3ParquetSource
— (map
)Specifies an Apache Parquet data store stored in Amazon S3.
Name
— required — (String
)The name of the data store.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
CompressionType
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
Exclusions
— (Array<String>
)A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
GroupSize
— (String
)The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.GroupFiles
— (String
)Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.Recurse
— (Boolean
)If set to true, recursively reads files in all subdirectories under the specified paths.
MaxBand
— (Integer
)This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
MaxFilesInBand
— (Integer
)This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the S3 Parquet source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
RelationalCatalogSource
— (map
)Specifies a relational catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
DynamoDBCatalogSource
— (map
)Specifies a DynamoDBC Catalog data store in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
JDBCConnectorTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of the connection that is associated with the connector.
ConnectionTable
— required — (String
)The name of the table in the data target.
ConnectorName
— required — (String
)The name of a connector that will be used.
ConnectionType
— required — (String
)The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the JDBC target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkConnectorTarget
— (map
)Specifies a target that uses an Apache Spark connector.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
ConnectionName
— required — (String
)The name of a connection for an Apache Spark connector.
ConnectorName
— required — (String
)The name of an Apache Spark connector.
ConnectionType
— required — (String
)The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
AdditionalOptions
— (map<String>
)Additional connection options for the connector.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom spark target.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogTarget
— (map
)Specifies a target that uses a Glue Data Catalog table.
Name
— required — (String
)The name of your data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)The partition keys used to distribute data across multiple partitions or shards based on a specific key or set of key.
Database
— required — (String
)The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
Table
— required — (String
)The table that defines the schema of your output data. This table must already exist in the Data Catalog.
RedshiftTarget
— (map
)Specifies a target that uses Amazon Redshift.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
RedshiftTmpDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
TmpDirIAMRole
— (String
)The IAM role with permissions.
UpsertRedshiftOptions
— (map
)The set of options to configure an upsert operation when writing to a Redshift target.
TableLocation
— (String
)The physical location of the Redshift table.
ConnectionName
— (String
)The name of the connection to use to write to Redshift.
UpsertKeys
— (Array<String>
)The keys used to determine whether to perform an update or insert.
S3CatalogTarget
— (map
)Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3GlueParquetTarget
— (map
)Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."snappy"
"lzo"
"gzip"
"uncompressed"
"none"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
S3DirectTarget
— (map
)Specifies a data target that writes to Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)A single Amazon S3 path to write to.
Compression
— (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
"gzip"
and"bzip"
).Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
ApplyMapping
— (map
)Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Mapping
— required — (Array<map>
)Specifies the mapping of data property keys in the data source to data property keys in the data target.
ToKey
— (String
)After the apply mapping, what the name of the column should be. Can be the same as
FromPath
.FromPath
— (Array<String>
)The table or column to be modified.
FromType
— (String
)The type of the data to be modified.
ToType
— (String
)The data type that the data is to be modified to.
Dropped
— (Boolean
)If true, then the column is removed.
SelectFields
— (map
)Specifies a transform that chooses the data property keys that you want to keep.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
DropFields
— (map
)Specifies a transform that chooses the data property keys that you want to drop.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
RenameField
— (map
)Specifies a transform that renames a single data property key.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
SourcePath
— required — (Array<String>
)A JSON path to a variable in the data structure for the source data.
TargetPath
— required — (Array<String>
)A JSON path to a variable in the data structure for the target data.
Spigot
— (map
)Specifies a transform that writes samples of the data to an Amazon S3 bucket.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Path
— required — (String
)A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
Topk
— (Integer
)Specifies a number of records to write starting from the beginning of the dataset.
Prob
— (Float
)The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
Join
— (map
)Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
JoinType
— required — (String
)Specifies the type of join to be performed on the datasets.
Possible values include:"equijoin"
"left"
"right"
"outer"
"leftsemi"
"leftanti"
Columns
— required — (Array<map>
)A list of the two columns to be joined.
From
— required — (String
)The column to be joined.
Keys
— required — (Array<Array<String>>
)The key of the column to be joined.
SplitFields
— (map
)Specifies a transform that splits data property keys into two
DynamicFrames
. The output is a collection ofDynamicFrames
: one with selected data property keys, and one with the remaining data property keys.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Paths
— required — (Array<Array<String>>
)A JSON path to a variable in the data structure.
SelectFromCollection
— (map
)Specifies a transform that chooses one
DynamicFrame
from a collection ofDynamicFrames
. The output is the selectedDynamicFrame
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Index
— required — (Integer
)The index for the DynamicFrame to be selected.
FillMissingValues
— (map
)Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
ImputedPath
— required — (String
)A JSON path to a variable in the data structure for the dataset that is imputed.
FilledPath
— (String
)A JSON path to a variable in the data structure for the dataset that is filled.
Filter
— (map
)Specifies a transform that splits a dataset into two, based on a filter condition.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
LogicalOperator
— required — (String
)The operator used to filter rows by comparing the key value to a specified value.
Possible values include:"AND"
"OR"
Filters
— required — (Array<map>
)Specifies a filter expression.
Operation
— required — (String
)The type of operation to perform in the expression.
Possible values include:"EQ"
"LT"
"GT"
"LTE"
"GTE"
"REGEX"
"ISNULL"
Negated
— (Boolean
)Whether the expression is to be negated.
Values
— required — (Array<map>
)A list of filter values.
Type
— required — (String
)The type of filter value.
Possible values include:"COLUMNEXTRACTED"
"CONSTANT"
Value
— required — (Array<String>
)The value to be associated.
CustomCode
— (map
)Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Code
— required — (String
)The custom code that is used to perform the data transformation.
ClassName
— required — (String
)The name defined for the custom code node class.
OutputSchemas
— (Array<map>
)Specifies the data schema for the custom code transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SparkSQL
— (map
)Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single
DynamicFrame
.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
SqlQuery
— required — (String
)A SQL query that must use Spark SQL syntax and return a single data set.
SqlAliases
— required — (Array<map>
)A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify
From
as MyDataSource, andAlias
as SqlName, then in your SQL you can do:select * from SqlName
and that gets data from MyDataSource.
From
— required — (String
)A table, or a column in a table.
Alias
— required — (String
)A temporary name given to a table, or a column in a table.
OutputSchemas
— (Array<map>
)Specifies the data schema for the SparkSQL transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
DirectKinesisSource
— (map
)Specifies a direct Amazon Kinesis data source.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DirectKafkaSource
— (map
)Specifies an Apache Kafka data store.
Name
— required — (String
)The name of the data store.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKinesisSource
— (map
)Specifies a Kinesis data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Additional options for the Kinesis streaming data source.
EndpointUrl
— (String
)The URL of the Kinesis endpoint.
StreamName
— (String
)The name of the Kinesis data stream.
Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingPosition
— (String
)The starting position in the Kinesis data stream to read data from. The possible values are
"latest"
,"trim_horizon"
,"earliest"
, or a timestamp string in UTC format in the patternyyyy-mm-ddTHH:MM:SSZ
(whereZ
represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00-04:00"). The default value is"latest"
.Note: Using a value that is a timestamp string in UTC format for "startingPosition" is supported only for Glue version 4.0 or later.
Possible values include:"latest"
"trim_horizon"
"earliest"
"timestamp"
MaxFetchTimeInMs
— (Integer
)The maximum time spent for the job executor to read records for the current batch from the Kinesis data stream, specified in milliseconds (ms). Multiple
GetRecords
API calls may be made within this time. The default value is1000
.MaxFetchRecordsPerShard
— (Integer
)The maximum number of records to fetch per shard in the Kinesis data stream per microbatch. Note: The client can exceed this limit if the streaming job has already read extra records from Kinesis (in the same get-records call). If
MaxFetchRecordsPerShard
needs to be strict then it needs to be a multiple ofMaxRecordPerRead
. The default value is100000
.MaxRecordPerRead
— (Integer
)The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is
10000
.AddIdleTimeBetweenReads
— (Boolean
)Adds a time delay between two consecutive getRecords operations. The default value is
"False"
. This option is only configurable for Glue version 2.0 and above.IdleTimeBetweenReadsInMs
— (Integer
)The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is
1000
. This option is only configurable for Glue version 2.0 and above.DescribeShardInterval
— (Integer
)The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is
1s
.NumRetries
— (Integer
)The maximum number of retries for Kinesis Data Streams API requests. The default value is
3
.RetryIntervalMs
— (Integer
)The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is
1000
.MaxRetryIntervalMs
— (Integer
)The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is
10000
.AvoidEmptyBatches
— (Boolean
)Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is
"False"
.StreamArn
— (String
)The Amazon Resource Name (ARN) of the Kinesis data stream.
RoleArn
— (String
)The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSSessionName"
.RoleSessionName
— (String
)An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with
"awsSTSRoleARN"
.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the stream. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the stream and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").
DataPreviewOptions
— (map
)Additional options for data preview.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
CatalogKafkaSource
— (map
)Specifies an Apache Kafka data store in the Data Catalog.
Name
— required — (String
)The name of the data store.
WindowSize
— (Integer
)The amount of time to spend processing each micro batch.
DetectSchema
— (Boolean
)Whether to automatically determine the schema from the incoming data.
Table
— required — (String
)The name of the table in the database to read from.
Database
— required — (String
)The name of the database to read from.
StreamingOptions
— (map
)Specifies the streaming options.
BootstrapServers
— (String
)A list of bootstrap server URLs, for example, as
b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.SecurityProtocol
— (String
)The protocol used to communicate with brokers. The possible values are
"SSL"
or"PLAINTEXT"
.ConnectionName
— (String
)The name of the connection.
TopicName
— (String
)The topic name as specified in Apache Kafka. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Assign
— (String
)The specific
TopicPartitions
to consume. You must specify at least one of"topicName"
,"assign"
or"subscribePattern"
.SubscribePattern
— (String
)A Java regex string that identifies the topic list to subscribe to. You must specify at least one of
"topicName"
,"assign"
or"subscribePattern"
.Classification
— (String
)An optional classification.
Delimiter
— (String
)Specifies the delimiter character.
StartingOffsets
— (String
)The starting position in the Kafka topic to read data from. The possible values are
"earliest"
or"latest"
. The default value is"latest"
.EndingOffsets
— (String
)The end point when a batch query is ended. Possible values are either
"latest"
or a JSON string that specifies an ending offset for eachTopicPartition
.PollTimeoutMs
— (Integer
)The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is
512
.NumRetries
— (Integer
)The number of times to retry before failing to fetch Kafka offsets. The default value is
3
.RetryIntervalMs
— (Integer
)The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is
10
.MaxOffsetsPerTrigger
— (Integer
)The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across
topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.MinPartitions
— (Integer
)The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
IncludeHeaders
— (Boolean
)Whether to include the Kafka headers. When the option is set to "true", the data output will contain an additional column named "glue_streaming_kafka_headers" with type
Array[Struct(key: String, value: String)]
. The default value is "false". This option is available in Glue version 3.0 or later only.AddRecordTimestamp
— (String
)When this option is set to 'true', the data output will contain an additional column named "__src_timestamp" that indicates the time when the corresponding record received by the topic. The default value is 'false'. This option is supported in Glue version 4.0 or later.
EmitConsumerLagMetrics
— (String
)When this option is set to 'true', for each batch, it will emit the metrics for the duration between the oldest record received by the topic and the time it arrives in Glue to CloudWatch. The metric's name is "glue.driver.streaming.maxConsumerLagInMs". The default value is 'false'. This option is supported in Glue version 4.0 or later.
StartingTimestamp
— (Date
)The timestamp of the record in the Kafka topic to start reading data from. The possible values are a timestamp string in UTC format of the pattern
yyyy-mm-ddTHH:MM:SSZ
(where Z represents a UTC timezone offset with a +/-. For example: "2023-04-04T08:00:00+08:00").Only one of
StartingTimestamp
orStartingOffsets
must be set.
DataPreviewOptions
— (map
)Specifies options related to data preview for viewing a sample of your data.
PollingTime
— (Integer
)The polling time in milliseconds.
RecordPollingLimit
— (Integer
)The limit to the number of records polled.
DropNullFields
— (map
)Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are "null", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
NullCheckBoxList
— (map
)A structure that represents whether certain values are recognized as null values for removal.
IsEmpty
— (Boolean
)Specifies that an empty string is considered as a null value.
IsNullString
— (Boolean
)Specifies that a value spelling out the word 'null' is considered as a null value.
IsNegOne
— (Boolean
)Specifies that an integer value of -1 is considered as a null value.
NullTextList
— (Array<map>
)A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
The
DropNullFields
transform removes custom null values only if both the value of the null placeholder and the datatype match the data.Value
— required — (String
)The value of the null placeholder.
Datatype
— required — (map
)The datatype of the value.
Id
— required — (String
)The datatype of the value.
Label
— required — (String
)A label assigned to the datatype.
Merge
— (map
)Specifies a transform that merges a
DynamicFrame
with a stagingDynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Source
— required — (String
)The source
DynamicFrame
that will be merged with a stagingDynamicFrame
.PrimaryKeys
— required — (Array<Array<String>>
)The list of primary key fields to match records from the source and staging dynamic frames.
Union
— (map
)Specifies a transform that combines the rows from two or more datasets into a single result.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
UnionType
— required — (String
)Indicates the type of Union transform.
Specify
ALL
to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.Specify
Possible values include:DISTINCT
to remove duplicate rows in the resulting DynamicFrame."ALL"
"DISTINCT"
PIIDetection
— (map
)Specifies a transform that identifies, removes or masks PII data.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The node ID inputs to the transform.
PiiType
— required — (String
)Indicates the type of PIIDetection transform.
Possible values include:"RowAudit"
"RowMasking"
"ColumnAudit"
"ColumnMasking"
EntityTypesToDetect
— required — (Array<String>
)Indicates the types of entities the PIIDetection transform will identify as PII data.
PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
OutputColumnName
— (String
)Indicates the output column name that will contain any entity type detected in that row.
SampleFraction
— (Float
)Indicates the fraction of the data to sample when scanning for PII entities.
ThresholdFraction
— (Float
)Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
MaskValue
— (String
)Indicates the value that will replace the detected entity.
Aggregate
— (map
)Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)Specifies the fields and rows to use as inputs for the aggregate transform.
Groups
— required — (Array<Array<String>>
)Specifies the fields to group by.
Aggs
— required — (Array<map>
)Specifies the aggregate functions to be performed on specified fields.
Column
— required — (Array<String>
)Specifies the column on the data set on which the aggregation function will be applied.
AggFunc
— required — (String
)Specifies the aggregation function to apply.
Possible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
Possible values include:"avg"
"countDistinct"
"count"
"first"
"last"
"kurtosis"
"max"
"min"
"skewness"
"stddev_samp"
"stddev_pop"
"sum"
"sumDistinct"
"var_samp"
"var_pop"
DropDuplicates
— (map
)Specifies a transform that removes rows of repeating data from a data set.
Name
— required — (String
)The name of the transform node.
Inputs
— required — (Array<String>
)The data inputs identified by their node names.
Columns
— (Array<Array<String>>
)The name of the columns to be merged or removed if repeating.
GovernedCatalogTarget
— (map
)Specifies a data target that writes to a goverened catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the governed catalog.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
GovernedCatalogSource
— (map
)Specifies a data source in a goverened Data Catalog.
Name
— required — (String
)The name of the data store.
Database
— required — (String
)The database to read from.
Table
— required — (String
)The database table to read from.
PartitionPredicate
— (String
)Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to
""
– empty by default.AdditionalOptions
— (map
)Specifies additional connection options.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
MicrosoftSQLServerCatalogSource
— (map
)Specifies a Microsoft SQL server data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MySQLCatalogSource
— (map
)Specifies a MySQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
OracleSQLCatalogSource
— (map
)Specifies an Oracle data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
PostgreSQLCatalogSource
— (map
)Specifies a PostgresSQL data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
MicrosoftSQLServerCatalogTarget
— (map
)Specifies a target that uses Microsoft SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
MySQLCatalogTarget
— (map
)Specifies a target that uses MySQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
OracleSQLCatalogTarget
— (map
)Specifies a target that uses Oracle SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
PostgreSQLCatalogTarget
— (map
)Specifies a target that uses Postgres SQL.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Database
— required — (String
)The name of the database to write to.
Table
— required — (String
)The name of the table in the database to write to.
DynamicTransform
— (map
)Specifies a custom visual transform created by a user.
Name
— required — (String
)Specifies the name of the dynamic transform.
TransformName
— required — (String
)Specifies the name of the dynamic transform as it appears in the Glue Studio visual editor.
Inputs
— required — (Array<String>
)Specifies the inputs for the dynamic transform that are required.
Parameters
— (Array<map>
)Specifies the parameters of the dynamic transform.
Name
— required — (String
)Specifies the name of the parameter in the config file of the dynamic transform.
Type
— required — (String
)Specifies the parameter type in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
ValidationRule
— (String
)Specifies the validation rule in the config file of the dynamic transform.
ValidationMessage
— (String
)Specifies the validation message in the config file of the dynamic transform.
Value
— (Array<String>
)Specifies the value of the parameter in the config file of the dynamic transform.
ListType
— (String
)Specifies the list type of the parameter in the config file of the dynamic transform.
Possible values include:"str"
"int"
"float"
"complex"
"bool"
"list"
"null"
IsOptional
— (Boolean
)Specifies whether the parameter is optional or not in the config file of the dynamic transform.
FunctionName
— required — (String
)Specifies the name of the function of the dynamic transform.
Path
— required — (String
)Specifies the path of the dynamic transform source and config files.
Version
— (String
)This field is not used and will be deprecated in future release.
OutputSchemas
— (Array<map>
)Specifies the data schema for the dynamic transform.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
EvaluateDataQuality
— (map
)Specifies your data quality evaluation criteria.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
Output
— (String
)The output of your data quality evaluation.
Possible values include:"PrimaryInput"
"EvaluationResults"
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
S3CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogHudiSource
— (map
)Specifies a Hudi data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Hudi data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiSource
— (map
)Specifies a Hudi data source stored in Amazon S3.
Name
— required — (String
)The name of the Hudi source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalHudiOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Hudi source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3HudiCatalogTarget
— (map
)Specifies a target that writes to a Hudi data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3HudiDirectTarget
— (map
)Specifies a target that writes to a Hudi data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
Path
— required — (String
)The Amazon S3 path of your Hudi data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."gzip"
"lzo"
"uncompressed"
"snappy"
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— required — (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
DirectJDBCSource
— (map
)Specifies the direct JDBC source connection.
Name
— required — (String
)The name of the JDBC source connection.
Database
— required — (String
)The database of the JDBC source connection.
Table
— required — (String
)The table of the JDBC source connection.
ConnectionName
— required — (String
)The connection name of the JDBC source.
ConnectionType
— required — (String
)The connection type of the JDBC source.
Possible values include:"sqlserver"
"mysql"
"oracle"
"postgresql"
"redshift"
RedshiftTmpDir
— (String
)The temp directory of the JDBC Redshift source.
S3CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog. The data source must be stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
CatalogDeltaSource
— (map
)Specifies a Delta Lake data source that is registered in the Glue Data Catalog.
Name
— required — (String
)The name of the Delta Lake data source.
Database
— required — (String
)The name of the database to read from.
Table
— required — (String
)The name of the table in the database to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaSource
— (map
)Specifies a Delta Lake data source stored in Amazon S3.
Name
— required — (String
)The name of the Delta Lake source.
Paths
— required — (Array<String>
)A list of the Amazon S3 paths to read from.
AdditionalDeltaOptions
— (map<String>
)Specifies additional connection options.
AdditionalOptions
— (map
)Specifies additional options for the connector.
BoundedSize
— (Integer
)Sets the upper limit for the target size of the dataset in bytes that will be processed.
BoundedFiles
— (Integer
)Sets the upper limit for the target number of files that will be processed.
EnableSamplePath
— (Boolean
)Sets option to enable a sample path.
SamplePath
— (String
)If enabled, specifies the sample path.
OutputSchemas
— (Array<map>
)Specifies the data schema for the Delta Lake source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
S3DeltaCatalogTarget
— (map
)Specifies a target that writes to a Delta Lake data source in the Glue Data Catalog.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Table
— required — (String
)The name of the table in the database to write to.
Database
— required — (String
)The name of the database to write to.
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
S3DeltaDirectTarget
— (map
)Specifies a target that writes to a Delta Lake data source in Amazon S3.
Name
— required — (String
)The name of the data target.
Inputs
— required — (Array<String>
)The nodes that are inputs to the data target.
PartitionKeys
— (Array<Array<String>>
)Specifies native partitioning using a sequence of keys.
Path
— required — (String
)The Amazon S3 path of your Delta Lake data source to write to.
Compression
— required — (String
)Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
Possible values include:"gzip"
and"bzip"
)."uncompressed"
"snappy"
Format
— required — (String
)Specifies the data output format for the target.
Possible values include:"json"
"csv"
"avro"
"orc"
"parquet"
"hudi"
"delta"
AdditionalOptions
— (map<String>
)Specifies additional connection options for the connector.
SchemaChangePolicy
— (map
)A policy that specifies update behavior for the crawler.
EnableUpdateCatalog
— (Boolean
)Whether to use the specified update behavior when the crawler finds a changed schema.
UpdateBehavior
— (String
)The update behavior when the crawler finds a changed schema.
Possible values include:"UPDATE_IN_DATABASE"
"LOG"
Table
— (String
)Specifies the table in the database that the schema change policy applies to.
Database
— (String
)Specifies the database that the schema change policy applies to.
AmazonRedshiftSource
— (map
)Specifies a target that writes to a data source in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift source.
Data
— (map
)Specifies the data of the Amazon Reshift source node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AmazonRedshiftTarget
— (map
)Specifies a target that writes to a data target in Amazon Redshift.
Name
— (String
)The name of the Amazon Redshift target.
Data
— (map
)Specifies the data of the Amazon Redshift target node.
AccessType
— (String
)The access type for the Redshift connection. Can be a direct connection or catalog connections.
SourceType
— (String
)The source type to specify whether a specific table is the source or a custom query.
Connection
— (map
)The Glue connection to the Redshift cluster.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (map
)The Redshift schema name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Table
— (map
)The Redshift table name when working with a direct connection.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogDatabase
— (map
)The name of the Glue Data Catalog database when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogTable
— (map
)The Glue Data Catalog table name when working with a data catalog.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
CatalogRedshiftSchema
— (String
)The Redshift schema name when working with a data catalog.
CatalogRedshiftTable
— (String
)The database table to read from.
TempDir
— (String
)The Amazon S3 path where temporary data can be staged when copying out of the database.
IamRole
— (map
)Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdvancedOptions
— (Array<map>
)Optional values when connecting to the Redshift cluster.
Key
— (String
)The key for the additional connection option.
Value
— (String
)The value for the additional connection option.
SampleQuery
— (String
)The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
PreAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
PostAction
— (String
)The SQL used before a MERGE or APPEND with upsert is run.
Action
— (String
)Specifies how writing to a Redshift cluser will occur.
TablePrefix
— (String
)Specifies the prefix to a table.
Upsert
— (Boolean
)The action used on Redshift sinks when doing an APPEND.
MergeAction
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled.
MergeWhenMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.
MergeWhenNotMatched
— (String
)The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.
MergeClause
— (String
)The SQL used in a custom merge to deal with matching records.
CrawlerConnection
— (String
)Specifies the name of the connection that is associated with the catalog table used.
TableSchema
— (Array<map>
)The array of schema output for a given node.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
StagingTable
— (String
)The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
SelectedColumns
— (Array<map>
)The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
EvaluateDataQualityMultiFrame
— (map
)Specifies your data quality evaluation criteria. Allows multiple input data and returns a collection of Dynamic Frames.
Name
— required — (String
)The name of the data quality evaluation.
Inputs
— required — (Array<String>
)The inputs of your data quality evaluation. The first input in this list is the primary data source.
AdditionalDataSources
— (map<String>
)The aliases of all data sources except primary.
Ruleset
— required — (String
)The ruleset for your data quality evaluation.
PublishingOptions
— (map
)Options to configure how your results are published.
EvaluationContext
— (String
)The context of the evaluation.
ResultsS3Prefix
— (String
)The Amazon S3 prefix prepended to the results.
CloudWatchMetricsEnabled
— (Boolean
)Enable metrics for your data quality results.
ResultsPublishingEnabled
— (Boolean
)Enable publishing for your data quality results.
AdditionalOptions
— (map<String>
)Options to configure runtime behavior of the transform.
StopJobOnFailureOptions
— (map
)Options to configure how your job will stop if your data quality evaluation fails.
StopJobOnFailureTiming
— (String
)When to stop job if your data quality evaluation fails. Options are Immediate or AfterDataLoad.
Possible values include:"Immediate"
"AfterDataLoad"
Recipe
— (map
)Specifies a Glue DataBrew recipe node.
Name
— required — (String
)The name of the Glue Studio node.
Inputs
— required — (Array<String>
)The nodes that are inputs to the recipe node, identified by id.
RecipeReference
— (map
)A reference to the DataBrew recipe used by the node.
RecipeArn
— required — (String
)The ARN of the DataBrew recipe.
RecipeVersion
— required — (String
)The RecipeVersion of the DataBrew recipe.
RecipeSteps
— (Array<map>
)Transform steps used in the recipe node.
Action
— required — (map
)The transformation action of the recipe step.
Operation
— required — (String
)The operation of the recipe action.
Parameters
— (map<String>
)The parameters of the recipe action.
ConditionExpressions
— (Array<map>
)The condition expressions for the recipe step.
Condition
— required — (String
)The condition of the condition expression.
Value
— (String
)The value of the condition expression.
TargetColumn
— required — (String
)The target column of the condition expressions.
SnowflakeSource
— (map
)Specifies a Snowflake data source.
Name
— required — (String
)The name of the Snowflake data source.
Data
— required — (map
)Configuration for the Snowflake data source.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
OutputSchemas
— (Array<map>
)Specifies user-defined schemas for your output data.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
SnowflakeTarget
— (map
)Specifies a target that writes to a Snowflake data source.
Name
— required — (String
)The name of the Snowflake target.
Data
— required — (map
)Specifies the data of the Snowflake target node.
SourceType
— (String
)Specifies how retrieved data is specified. Valid values:
"table"
,"query"
.Connection
— (map
)Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Schema
— (String
)Specifies a Snowflake database schema for your node to use.
Table
— (String
)Specifies a Snowflake table for your node to use.
Database
— (String
)Specifies a Snowflake database for your node to use.
TempDir
— (String
)Not currently used.
IamRole
— (map
)Not currently used.
Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AdditionalOptions
— (map<String>
)Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
SampleQuery
— (String
)A SQL string used to retrieve data with the
query
sourcetype.PreAction
— (String
)A SQL string run before the Snowflake connector performs its standard actions.
PostAction
— (String
)A SQL string run after the Snowflake connector performs its standard actions.
Action
— (String
)Specifies what action to take when writing to a table with preexisting data. Valid values:
append
,merge
,truncate
,drop
.Upsert
— (Boolean
)Used when Action is
append
. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.MergeAction
— (String
)Specifies a merge action. Valid values:
simple
,custom
. If simple, merge behavior is defined byMergeWhenMatched
andMergeWhenNotMatched
. If custom, defined byMergeClause
.MergeWhenMatched
— (String
)Specifies how to resolve records that match preexisting data when merging. Valid values:
update
,delete
.MergeWhenNotMatched
— (String
)Specifies how to process records that do not match preexisting data when merging. Valid values:
insert
,none
.MergeClause
— (String
)A SQL statement that specifies a custom merge behavior.
StagingTable
— (String
)The name of a staging table used when performing
merge
or upsertappend
actions. Data is written to this table, then moved totable
by a generated postaction.SelectedColumns
— (Array<map>
)Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with
value
,label
anddescription
keys. Each structure describes a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
AutoPushdown
— (Boolean
)Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
TableSchema
— (Array<map>
)Manually defines the target schema for the node. A list of structures with
value
,label
anddescription
keys. Each structure defines a column.Value
— (String
)Specifies the value of the option.
Label
— (String
)Specifies the label of the option.
Description
— (String
)Specifies the description of the option.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ConnectorDataSource
— (map
)Specifies a source generated with standard connection options.
Name
— required — (String
)The name of this source node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
OutputSchemas
— (Array<map>
)Specifies the data schema for this source.
Columns
— (Array<map>
)Specifies the column definitions that make up a Glue schema.
Name
— required — (String
)The name of the column in the Glue Studio schema.
Type
— (String
)The hive type for this column in the Glue Studio schema.
ConnectorDataTarget
— (map
)Specifies a target generated with standard connection options.
Name
— required — (String
)The name of this target node.
ConnectionType
— required — (String
)The
connectionType
, as provided to the underlying Glue library. This node type supports the following connection types:-
opensearch
-
azuresql
-
azurecosmos
-
bigquery
-
saphana
-
teradata
-
vertica
-
Data
— required — (map<String>
)A map specifying connection options for the node. You can find standard connection options for the corresponding connection type in the Connection parameters section of the Glue documentation.
Inputs
— (Array<String>
)The nodes that are inputs to the data target.
ExecutionClass
— (String
)Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type
Possible values include:glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs."FLEX"
"STANDARD"
SourceControlDetails
— (map
)The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Provider
— (String
)The provider for the remote repository.
Possible values include:"GITHUB"
"GITLAB"
"BITBUCKET"
"AWS_CODE_COMMIT"
Repository
— (String
)The name of the remote repository that contains the job artifacts.
Owner
— (String
)The owner of the remote repository that contains the job artifacts.
Branch
— (String
)An optional branch in the remote repository.
Folder
— (String
)An optional folder in the remote repository.
LastCommitId
— (String
)The last commit ID for a commit in the remote repository.
AuthStrategy
— (String
)The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
Possible values include:"PERSONAL_ACCESS_TOKEN"
"AWS_SECRETS_MANAGER"
AuthToken
— (String
)The value of an authorization token.
MaintenanceWindow
— (String
)This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
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. Thedata
object has the following properties:JobName
— (String
)Returns the name of the updated job definition.
-
(AWS.Response)
—
Returns:
updateJobFromSourceControl(params = {}, callback) ⇒ AWS.Request
Synchronizes a job from the source control repository. This operation takes the job artifacts that are located in the remote repository and updates the Glue internal stores with these artifacts.
This API supports optional parameters which take in the repository information.
Service Reference:
Examples:
Calling the updateJobFromSourceControl operation
var params = { AuthStrategy: PERSONAL_ACCESS_TOKEN | AWS_SECRETS_MANAGER, AuthToken: 'STRING_VALUE', BranchName: 'STRING_VALUE', CommitId: 'STRING_VALUE', Folder: 'STRING_VALUE', JobName: 'STRING_VALUE', Provider: GITHUB | GITLAB | BITBUCKET | AWS_CODE_COMMIT, RepositoryName: 'STRING_VALUE', RepositoryOwner: 'STRING_VALUE' }; glue.updateJobFromSourceControl(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 Glue job to be synchronized to or from the remote repository.
Provider
— (String
)The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.
Possible values include:"GITHUB"
"GITLAB"
"BITBUCKET"
"AWS_CODE_COMMIT"
RepositoryName
— (String
)The name of the remote repository that contains the job artifacts. For BitBucket providers,
RepositoryName
should includeWorkspaceName
. Use the format<WorkspaceName>/<RepositoryName>
.RepositoryOwner
— (String
)The owner of the remote repository that contains the job artifacts.
BranchName
— (String
)An optional branch in the remote repository.
Folder
— (String
)An optional folder in the remote repository.
CommitId
— (String
)A commit ID for a commit in the remote repository.
AuthStrategy
— (String
)The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
Possible values include:"PERSONAL_ACCESS_TOKEN"
"AWS_SECRETS_MANAGER"
AuthToken
— (String
)The value of the authorization 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. Thedata
object has the following properties:JobName
— (String
)The name of the Glue job.
-
(AWS.Response)
—
Returns:
updateMLTransform(params = {}, callback) ⇒ AWS.Request
Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.
After calling this operation, you can call the
StartMLEvaluationTaskRun
operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).Service Reference:
Examples:
Calling the updateMLTransform operation
var params = { TransformId: 'STRING_VALUE', /* required */ Description: 'STRING_VALUE', GlueVersion: 'STRING_VALUE', MaxCapacity: 'NUMBER_VALUE', MaxRetries: 'NUMBER_VALUE', Name: 'STRING_VALUE', NumberOfWorkers: 'NUMBER_VALUE', Parameters: { TransformType: FIND_MATCHES, /* required */ FindMatchesParameters: { AccuracyCostTradeoff: 'NUMBER_VALUE', EnforceProvidedLabels: true || false, PrecisionRecallTradeoff: 'NUMBER_VALUE', PrimaryKeyColumnName: 'STRING_VALUE' } }, Role: 'STRING_VALUE', Timeout: 'NUMBER_VALUE', WorkerType: Standard | G.1X | G.2X | G.025X | G.4X | G.8X | Z.2X }; glue.updateMLTransform(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: {})
—
TransformId
— (String
)A unique identifier that was generated when the transform was created.
Name
— (String
)The unique name that you gave the transform when you created it.
Description
— (String
)A description of the transform. The default is an empty string.
Parameters
— (map
)The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.
TransformType
— required — (String
)The type of machine learning transform.
For information about the types of machine learning transforms, see Creating Machine Learning Transforms.
Possible values include:"FIND_MATCHES"
FindMatchesParameters
— (map
)The parameters for the find matches algorithm.
PrimaryKeyColumnName
— (String
)The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
PrecisionRecallTradeoff
— (Float
)The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
AccuracyCostTradeoff
— (Float
)The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate
FindMatches
transform, sometimes with unacceptable accuracy.Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
EnforceProvidedLabels
— (Boolean
)The value to switch on or off to force the output to match the provided labels from users. If the value is
True
, thefind matches
transform forces the output to match the provided labels. The results override the normal conflation results. If the value isFalse
, thefind matches
transform does not ensure all the labels provided are respected, and the results rely on the trained model.Note that setting this value to true may increase the conflation execution time.
Role
— (String
)The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
GlueVersion
— (String
)This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
MaxCapacity
— (Float
)The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; 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 Glue pricing page.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.WorkerType
— (String
)The type of predefined worker that is allocated when this task 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.
"Standard"
"G.1X"
"G.2X"
"G.025X"
"G.4X"
"G.8X"
"Z.2X"
-
NumberOfWorkers
— (Integer
)The number of workers of a defined
workerType
that are allocated when this task runs.Timeout
— (Integer
)The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters
TIMEOUT
status. The default is 2,880 minutes (48 hours).MaxRetries
— (Integer
)The maximum number of times to retry a task for this transform after a task run fails.
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. Thedata
object has the following properties:TransformId
— (String
)The unique identifier for the transform that was updated.
-
(AWS.Response)
—
Returns:
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: { AdditionalLocations: [ 'STRING_VALUE', /* more items */ ], BucketColumns: [ 'STRING_VALUE', /* more items */ ], Columns: [ { Name: 'STRING_VALUE', /* required */ Comment: 'STRING_VALUE', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, 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>': ... */ }, SchemaReference: { SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: 'NUMBER_VALUE' }, 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 provided, the Amazon Web Services 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 in which the partition to be updated is located.
PartitionValueList
— (Array<String>
)List of partition key values that define the partition to update.
PartitionInput
— (map
)The new partition object to update the partition to.
The
Values
property can't be changed. If you want to change the partition key values for a partition, delete and recreate 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.
The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise Glue will add the values to the wrong keys.
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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
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.
-
(AWS.Response)
—
Returns:
updateRegistry(params = {}, callback) ⇒ AWS.Request
Updates an existing registry which is used to hold a collection of schemas. The updated properties relate to the registry, and do not modify any of the schemas within the registry.
Service Reference:
Examples:
Calling the updateRegistry operation
var params = { Description: 'STRING_VALUE', /* required */ RegistryId: { /* required */ RegistryArn: 'STRING_VALUE', RegistryName: 'STRING_VALUE' } }; glue.updateRegistry(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: {})
—
RegistryId
— (map
)This is a wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
RegistryName
— (String
)Name of the registry. Used only for lookup. One of
RegistryArn
orRegistryName
has to be provided.RegistryArn
— (String
)Arn of the registry to be updated. One of
RegistryArn
orRegistryName
has to be provided.
Description
— (String
)A description of the registry. If description is not provided, this field will not be updated.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:RegistryName
— (String
)The name of the updated registry.
RegistryArn
— (String
)The Amazon Resource name (ARN) of the updated registry.
-
(AWS.Response)
—
Returns:
updateSchema(params = {}, callback) ⇒ AWS.Request
Updates the description, compatibility setting, or version checkpoint for a schema set.
For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for
Compatibility
is provided, theVersionNumber
(a checkpoint) is also required. The API will validate the checkpoint version number for consistency.If the value for the
VersionNumber
(checkpoint) is provided,Compatibility
is optional and this can be used to set/reset a checkpoint for the schema.This update will happen only if the schema is in the AVAILABLE state.
Service Reference:
Examples:
Calling the updateSchema operation
var params = { SchemaId: { /* required */ RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, Compatibility: NONE | DISABLED | BACKWARD | BACKWARD_ALL | FORWARD | FORWARD_ALL | FULL | FULL_ALL, Description: 'STRING_VALUE', SchemaVersionNumber: { LatestVersion: true || false, VersionNumber: 'NUMBER_VALUE' } }; glue.updateSchema(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: {})
—
SchemaId
— (map
)This is a wrapper structure to contain schema identity fields. The structure contains:
-
SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided. -
SchemaId$SchemaName: The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.
SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
-
SchemaVersionNumber
— (map
)Version number required for check pointing. One of
VersionNumber
orCompatibility
has to be provided.LatestVersion
— (Boolean
)The latest version available for the schema.
VersionNumber
— (Integer
)The version number of the schema.
Compatibility
— (String
)The new compatibility setting for the schema.
Possible values include:"NONE"
"DISABLED"
"BACKWARD"
"BACKWARD_ALL"
"FORWARD"
"FORWARD_ALL"
"FULL"
"FULL_ALL"
Description
— (String
)The new description for the schema.
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. Thedata
object has the following properties:SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema.
SchemaName
— (String
)The name of the schema.
RegistryName
— (String
)The name of the registry that contains the schema.
-
(AWS.Response)
—
Returns:
updateSourceControlFromJob(params = {}, callback) ⇒ AWS.Request
Synchronizes a job to the source control repository. This operation takes the job artifacts from the Glue internal stores and makes a commit to the remote repository that is configured on the job.
This API supports optional parameters which take in the repository information.
Service Reference:
Examples:
Calling the updateSourceControlFromJob operation
var params = { AuthStrategy: PERSONAL_ACCESS_TOKEN | AWS_SECRETS_MANAGER, AuthToken: 'STRING_VALUE', BranchName: 'STRING_VALUE', CommitId: 'STRING_VALUE', Folder: 'STRING_VALUE', JobName: 'STRING_VALUE', Provider: GITHUB | GITLAB | BITBUCKET | AWS_CODE_COMMIT, RepositoryName: 'STRING_VALUE', RepositoryOwner: 'STRING_VALUE' }; glue.updateSourceControlFromJob(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 Glue job to be synchronized to or from the remote repository.
Provider
— (String
)The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.
Possible values include:"GITHUB"
"GITLAB"
"BITBUCKET"
"AWS_CODE_COMMIT"
RepositoryName
— (String
)The name of the remote repository that contains the job artifacts. For BitBucket providers,
RepositoryName
should includeWorkspaceName
. Use the format<WorkspaceName>/<RepositoryName>
.RepositoryOwner
— (String
)The owner of the remote repository that contains the job artifacts.
BranchName
— (String
)An optional branch in the remote repository.
Folder
— (String
)An optional folder in the remote repository.
CommitId
— (String
)A commit ID for a commit in the remote repository.
AuthStrategy
— (String
)The type of authentication, which can be an authentication token stored in Amazon Web Services Secrets Manager, or a personal access token.
Possible values include:"PERSONAL_ACCESS_TOKEN"
"AWS_SECRETS_MANAGER"
AuthToken
— (String
)The value of the authorization 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. Thedata
object has the following properties:JobName
— (String
)The name of the Glue job.
-
(AWS.Response)
—
Returns:
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', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, Type: 'STRING_VALUE' }, /* more items */ ], Retention: 'NUMBER_VALUE', StorageDescriptor: { AdditionalLocations: [ 'STRING_VALUE', /* more items */ ], BucketColumns: [ 'STRING_VALUE', /* more items */ ], Columns: [ { Name: 'STRING_VALUE', /* required */ Comment: 'STRING_VALUE', Parameters: { '<KeyString>': 'STRING_VALUE', /* '<KeyString>': ... */ }, 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>': ... */ }, SchemaReference: { SchemaId: { RegistryName: 'STRING_VALUE', SchemaArn: 'STRING_VALUE', SchemaName: 'STRING_VALUE' }, SchemaVersionId: 'STRING_VALUE', SchemaVersionNumber: 'NUMBER_VALUE' }, 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', TargetTable: { CatalogId: 'STRING_VALUE', DatabaseName: 'STRING_VALUE', Name: 'STRING_VALUE', Region: 'STRING_VALUE' }, ViewDefinition: { Definer: 'STRING_VALUE', IsProtected: true || false, Representations: [ { Dialect: REDSHIFT | ATHENA | SPARK, DialectVersion: 'STRING_VALUE', ValidationConnection: 'STRING_VALUE', ViewExpandedText: 'STRING_VALUE', ViewOriginalText: 'STRING_VALUE' }, /* more items */ ], SubObjects: [ 'STRING_VALUE', /* more items */ ] }, ViewExpandedText: 'STRING_VALUE', ViewOriginalText: 'STRING_VALUE' }, CatalogId: 'STRING_VALUE', Force: true || false, SkipArchive: true || false, TransactionId: 'STRING_VALUE', VersionId: 'STRING_VALUE', ViewUpdateAction: ADD | REPLACE | ADD_OR_REPLACE | DROP }; 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 provided, the Amazon Web Services 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
)The table name. For Hive compatibility, this is folded to lowercase when it is stored.
Description
— (String
)A description of the table.
Owner
— (String
)The table owner. Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
LastAccessTime
— (Date
)The last time that the table was accessed.
LastAnalyzedTime
— (Date
)The last time that column statistics were computed for this table.
Retention
— (Integer
)The 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 data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
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.
AdditionalLocations
— (Array<String>
)A list of locations that point to the path where a Delta table is located.
InputFormat
— (String
)The input format:
SequenceFileInputFormat
(binary), orTextInputFormat
, or a custom format.OutputFormat
— (String
)The output format:
SequenceFileOutputFormat
(binary), orIgnoreKeyTextOutputFormat
, or a custom format.Compressed
— (Boolean
)True
if the data in the table is compressed, orFalse
if not.NumberOfBuckets
— (Integer
)Must be specified if the table contains any dimension columns.
SerdeInfo
— (map
)The 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>
)The user-supplied properties in key-value form.
SkewedInfo
— (map
)The information about values that appear 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, orFalse
if not.SchemaReference
— (map
)An object that references a schema stored in the Glue Schema Registry.
When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.
SchemaId
— (map
)A structure that contains schema identity fields. Either this or the
SchemaVersionId
has to be provided.SchemaArn
— (String
)The Amazon Resource Name (ARN) of the schema. One of
SchemaArn
orSchemaName
has to be provided.SchemaName
— (String
)The name of the schema. One of
SchemaArn
orSchemaName
has to be provided.RegistryName
— (String
)The name of the schema registry that contains the schema.
SchemaVersionId
— (String
)The unique ID assigned to a version of the schema. Either this or the
SchemaId
has to be provided.SchemaVersionNumber
— (Integer
)The version number of the schema.
PartitionKeys
— (Array<map>
)A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
When you create a table used by Amazon Athena, and you do not specify any
partitionKeys
, you must at least set the value ofpartitionKeys
to an empty list. For example:"PartitionKeys": []
Name
— required — (String
)The name of the
Column
.Type
— (String
)The data type of the
Column
.Comment
— (String
)A free-form text comment.
Parameters
— (map<String>
)These key-value pairs define properties associated with the column.
ViewOriginalText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations. If the table is a
VIRTUAL_VIEW
, certain Athena configuration encoded in base64.ViewExpandedText
— (String
)Included for Apache Hive compatibility. Not used in the normal course of Glue operations.
TableType
— (String
)The type of this table. Glue will create tables with the
EXTERNAL_TABLE
type. Other services, such as Athena, may create tables with additional table types.Glue related table types:
- EXTERNAL_TABLE
-
Hive compatible attribute - indicates a non-Hive managed table.
- GOVERNED
-
Used by Lake Formation. The Glue Data Catalog understands
GOVERNED
.
Parameters
— (map<String>
)These key-value pairs define properties associated with the table.
TargetTable
— (map
)A
TableIdentifier
structure that describes a target table for resource linking.CatalogId
— (String
)The ID of the Data Catalog in which the table resides.
DatabaseName
— (String
)The name of the catalog database that contains the target table.
Name
— (String
)The name of the target table.
Region
— (String
)Region of the target table.
ViewDefinition
— (map
)A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
IsProtected
— (Boolean
)You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
Definer
— (String
)The definer of a view in SQL.
Representations
— (Array<map>
)A list of structures that contains the dialect of the view, and the query that defines the view.
Dialect
— (String
)A parameter that specifies the engine type of a specific representation.
Possible values include:"REDSHIFT"
"ATHENA"
"SPARK"
DialectVersion
— (String
)A parameter that specifies the version of the engine of a specific representation.
ViewOriginalText
— (String
)A string that represents the original SQL query that describes the view.
ValidationConnection
— (String
)The name of the connection to be used to validate the specific representation of the view.
ViewExpandedText
— (String
)A string that represents the SQL query that describes the view with expanded resource ARNs
SubObjects
— (Array<String>
)A list of base table ARNs that make up the view.
SkipArchive
— (Boolean
)By default,
UpdateTable
always creates an archived version of the table before updating it. However, ifskipArchive
is set to true,UpdateTable
does not create the archived version.TransactionId
— (String
)The transaction ID at which to update the table contents.
VersionId
— (String
)The version ID at which to update the table contents.
ViewUpdateAction
— (String
)The operation to be performed when updating the view.
Possible values include:"ADD"
"REPLACE"
"ADD_OR_REPLACE"
"DROP"
Force
— (Boolean
)A flag that can be set to true to ignore matching storage descriptor and subobject matching 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.
-
(AWS.Response)
—
Returns:
updateTableOptimizer(params = {}, callback) ⇒ AWS.Request
Updates the configuration for an existing table optimizer.
Service Reference:
Examples:
Calling the updateTableOptimizer operation
var params = { CatalogId: 'STRING_VALUE', /* required */ DatabaseName: 'STRING_VALUE', /* required */ TableName: 'STRING_VALUE', /* required */ TableOptimizerConfiguration: { /* required */ enabled: true || false, roleArn: 'STRING_VALUE' }, Type: compaction /* required */ }; glue.updateTableOptimizer(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 Catalog ID of the table.
DatabaseName
— (String
)The name of the database in the catalog in which the table resides.
TableName
— (String
)The name of the table.
Type
— (String
)The type of table optimizer. Currently, the only valid value is
Possible values include:compaction
."compaction"
TableOptimizerConfiguration
— (map
)A
TableOptimizerConfiguration
object representing the configuration of a table optimizer.roleArn
— (String
)A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.
enabled
— (Boolean
)Whether table optimization is enabled.
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.
-
(AWS.Response)
—
Returns:
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>': ... */ }, CrawlerName: 'STRING_VALUE', JobName: 'STRING_VALUE', NotificationProperty: { NotifyDelayAfter: 'NUMBER_VALUE' }, SecurityConfiguration: 'STRING_VALUE', Timeout: 'NUMBER_VALUE' }, /* more items */ ], Description: 'STRING_VALUE', EventBatchingCondition: { BatchSize: 'NUMBER_VALUE', /* required */ BatchWindow: 'NUMBER_VALUE' }, Name: 'STRING_VALUE', Predicate: { Conditions: [ { CrawlState: RUNNING | CANCELLING | CANCELLED | SUCCEEDED | FAILED | ERROR, CrawlerName: 'STRING_VALUE', JobName: 'STRING_VALUE', LogicalOperator: EQUALS, State: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT | ERROR | WAITING | EXPIRED }, /* 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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
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. Thedata
object has the following properties:Trigger
— (map
)The resulting trigger definition.
Name
— (String
)The name of the trigger.
WorkflowName
— (String
)The name of the workflow associated with the trigger.
Id
— (String
)Reserved for future use.
Type
— (String
)The type of trigger that this is.
Possible values include:"SCHEDULED"
"CONDITIONAL"
"ON_DEMAND"
"EVENT"
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 run.
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by 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 entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.SecurityConfiguration
— (String
)The name of the
SecurityConfiguration
structure to be used with this action.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.
CrawlerName
— (String
)The name of the crawler to be used with this action.
Predicate
— (map
)The predicate of this trigger, which defines when it will fire.
Logical
— (String
)An 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 whose
JobRuns
this condition applies to, and on which this trigger waits.State
— (String
)The condition state. Currently, the only job states that a trigger can listen for are
Possible values include:SUCCEEDED
,STOPPED
,FAILED
, andTIMEOUT
. The only crawler states that a trigger can listen for areSUCCEEDED
,FAILED
, andCANCELLED
."STARTING"
"RUNNING"
"STOPPING"
"STOPPED"
"SUCCEEDED"
"FAILED"
"TIMEOUT"
"ERROR"
"WAITING"
"EXPIRED"
CrawlerName
— (String
)The name of the crawler to which this condition applies.
CrawlState
— (String
)The state of the crawler to which this condition applies.
Possible values include:"RUNNING"
"CANCELLING"
"CANCELLED"
"SUCCEEDED"
"FAILED"
"ERROR"
EventBatchingCondition
— (map
)Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
BatchSize
— required — (Integer
)Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
BatchWindow
— (Integer
)Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
-
(AWS.Response)
—
Returns:
updateUsageProfile(params = {}, callback) ⇒ AWS.Request
Update an Glue usage profile.
Service Reference:
Examples:
Calling the updateUsageProfile operation
var params = { Configuration: { /* required */ JobConfiguration: { '<NameString>': { AllowedValues: [ 'STRING_VALUE', /* more items */ ], DefaultValue: 'STRING_VALUE', MaxValue: 'STRING_VALUE', MinValue: 'STRING_VALUE' }, /* '<NameString>': ... */ }, SessionConfiguration: { '<NameString>': { AllowedValues: [ 'STRING_VALUE', /* more items */ ], DefaultValue: 'STRING_VALUE', MaxValue: 'STRING_VALUE', MinValue: 'STRING_VALUE' }, /* '<NameString>': ... */ } }, Name: 'STRING_VALUE', /* required */ Description: 'STRING_VALUE' }; glue.updateUsageProfile(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 usage profile.
Description
— (String
)A description of the usage profile.
Configuration
— (map
)A
ProfileConfiguration
object specifying the job and session values for the profile.SessionConfiguration
— (map<map>
)A key-value map of configuration parameters for Glue sessions.
DefaultValue
— (String
)A default value for the parameter.
AllowedValues
— (Array<String>
)A list of allowed values for the parameter.
MinValue
— (String
)A minimum allowed value for the parameter.
MaxValue
— (String
)A maximum allowed value for the parameter.
JobConfiguration
— (map<map>
)A key-value map of configuration parameters for Glue jobs.
DefaultValue
— (String
)A default value for the parameter.
AllowedValues
— (Array<String>
)A list of allowed values for the parameter.
MinValue
— (String
)A minimum allowed value for the parameter.
MaxValue
— (String
)A maximum allowed value for the 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. Thedata
object has the following properties:Name
— (String
)The name of the usage profile that was updated.
-
(AWS.Response)
—
Returns:
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 provided, the Amazon Web Services 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 redefines 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.
-
(AWS.Response)
—
Returns:
updateWorkflow(params = {}, callback) ⇒ AWS.Request
Updates an existing workflow.
Service Reference:
Examples:
Calling the updateWorkflow operation
var params = { Name: 'STRING_VALUE', /* required */ DefaultRunProperties: { '<IdString>': 'STRING_VALUE', /* '<IdString>': ... */ }, Description: 'STRING_VALUE', MaxConcurrentRuns: 'NUMBER_VALUE' }; glue.updateWorkflow(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 workflow to be updated.
Description
— (String
)The description of the workflow.
DefaultRunProperties
— (map<String>
)A collection of properties to be used as part of each execution of the workflow.
MaxConcurrentRuns
— (Integer
)You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.
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. Thedata
object has the following properties:Name
— (String
)The name of the workflow which was specified in input.
-
(AWS.Response)
—
Returns:
Generated on Thu Aug 22 18:44:40 2024 by yard 0.9.36 (ruby-2.5.1). - batchDeleteTableVersion(params = {}, callback) ⇒ AWS.Request