AWS AWS Glue CLI Commands

Creates one or more partitions in a batch operation.

Deletes a list of connection definitions from the Data Catalog.

Deletes one or more partitions in a batch operation.

Deletes multiple tables at once. 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 del

Deletes a specified batch of versions of a table.

Retrieves information about a list of blueprints.

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.

Retrieves the details for the custom patterns specified by a list of names.

Retrieves a list of data quality results for the specified result IDs.

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 th

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.

Retrieves partitions in a batch request.

Returns the configuration for the specified table optimizers.

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.

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.

Annotate datapoints over time for a specific data quality statistic. The API requires both profileID and statisticID as part of the InclusionAnnotation input. The API only works for a single statisticId across multiple profiles.

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

Updates one or more partitions in a batch operation.

Cancels the specified recommendation run that was being used to generate rules.

Cancels a run where a ruleset is being evaluated against a data source.

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's TransformID and the task r

Cancels the statement.

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.

Registers a blueprint with Glue.

Creates a new catalog in the Glue Data Catalog.

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

Creates settings for a column statistics task.

Creates a connection definition in the Data Catalog. Connections used for creating federated resources require the IAM glue:PassConnection permission.

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

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.

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.

Creates a new database in a Data Catalog.

Creates a new development endpoint.

Creates a new Glue Identity Center configuration to enable integration between Glue and Amazon Web Services IAM Identity Center for authentication and authorization.

Creates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names (ARNs): the SourceArn and TargetArn.

This API can be used for setting up the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. To set both source and target properties the same API needs to be invoked with the Glue

This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue conn

Creates a new job definition.

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 opt

Creates a new partition.

Creates a specified partition index in an existing table.

Creates a new registry which may be used to hold a collection of schemas.

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 sche

Transforms a directed acyclic graph (DAG) into code.

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 Devel

Creates a new session.

Creates a new table definition in the Data Catalog.

Creates a new table optimizer for a specific function.

Creates a new trigger. Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.

Creates an Glue usage profile.

Creates a new function definition in the Data Catalog.

Creates a new workflow.

Deletes an existing blueprint.

Removes the specified catalog from the Glue Data Catalog. After completing this operation, you no longer have access to the databases, tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted catalog. Glue deletes these "orphaned" r

Removes a classifier from the Data Catalog.

Delete the partition column statistics of a column. The Identity and Access Management (IAM) permission required for this operation is DeletePartition.

Retrieves table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is DeleteTable.

Deletes settings for a column statistics task.

Deletes a connection from the Data Catalog.

Deletes a custom connection type in Glue. The connection type must exist and be registered before it can be deleted. This operation supports cleanup of connection type resources and helps maintain proper lifecycle management of custom connection types.

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

Deletes a custom pattern by specifying its name.

Deletes a data quality ruleset.

Removes a specified database from a Data Catalog. 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 asynchro

Deletes a specified development endpoint.

Deletes the existing Glue Identity Center configuration, removing the integration between Glue and Amazon Web Services IAM Identity Center.

Deletes the specified Zero-ETL integration.

This API is used for deleting the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target).

Deletes the table properties that have been created for the tables that need to be replicated.

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

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 ne

Deletes a specified partition.

Deletes a specified partition index from an existing table.

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 the UpdateRegistry, CreateSchema, UpdateSch

Deletes a specified policy.

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 the GetSchemaByDefinition, and Registe

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 version

Deletes a specified security configuration.

Deletes the session.

Removes a table definition from the Data Catalog. 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

Deletes an optimizer and all associated metadata for a table. The optimization will no longer be performed on the table.

Deletes a specified version of a table.

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

Deletes the Glue specified usage profile.

Deletes an existing function definition from the Data Catalog.

Deletes a workflow.

The DescribeConnectionType API provides full details of the supported options for a given connection type in Glue. The response includes authentication configuration details that show supported authentication types and properties, and RestConfiguration for custom REST-based connection types register

Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity. The response includes all the fields which make up the entity.

Returns a list of inbound integrations for the specified integration.

The API is used to retrieve a list of integrations.

Retrieves the details of a blueprint.

Retrieves the details of a blueprint run.

Retrieves the details of blueprint runs for a specified blueprint.

The name of the Catalog to retrieve. This should be all lowercase.

Retrieves the status of a migration operation.

Retrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.

Retrieve a classifier by name.

Lists all classifier objects in the Data Catalog.

Retrieves partition statistics of columns. The Identity and Access Management (IAM) permission required for this operation is GetPartition.

Retrieves table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is GetTable.

Get the associated metadata/information for a task run, given a task run ID.

Retrieves information about all runs associated with the specified table.

Gets settings for a column statistics task.

Retrieves a connection definition from the Data Catalog.

Retrieves a list of connection definitions from the Data Catalog.

Retrieves metadata for a specified crawler.

Retrieves metrics about specified crawlers.

Retrieves metadata for all crawlers defined in the customer account.

Retrieves the details of a custom pattern by specifying its name.

Retrieves the security configuration for a specified catalog.

Retrieve the training status of the model along with more information (CompletedOn, StartedOn, FailureReason).

Retrieve a statistic's predictions for a given Profile ID.

Retrieves the result of a data quality rule evaluation.

Gets the specified recommendation run that was used to generate rules.

Returns an existing ruleset by identifier or name.

Retrieves a specific run where a ruleset is evaluated against a data source.

Retrieves the definition of a specified database.

Retrieves all databases defined in a given Data Catalog.

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

Retrieves information about a specified development endpoint. 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

Retrieves all the development endpoints in this Amazon Web Services account. 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

This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog. Returns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the DescribeEntity API. Spark connectors generate sche

Retrieves the current Glue Identity Center configuration details, including the associated Identity Center instance and application information.

This API is used for fetching the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target)

This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.

Retrieves an existing job definition.

Returns information on a job bookmark entry. For more information about enabling and using job bookmarks, see: Tracking processed data using job bookmarks Job parameters used by Glue Job structure

Retrieves the metadata for a given job run. Job run history is accessible for 365 days for your workflow and job run.

Retrieves metadata for all runs of a given job definition. GetJobRuns returns the job runs in chronological order, with the newest jobs returned first.

Retrieves all current job definitions.

Creates mappings.

Get the associated metadata/information for a task run, given a task run ID.

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 the TaskRunID and its parent trans

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 transf

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 ar

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

Retrieves information about a specified partition.

Retrieves the partition indexes associated with a table.

Retrieves information about the partitions in a table.

Gets code to perform a specified mapping.

Describes the specified registry in detail.

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 ca

Retrieves a specified resource policy.

Describes the specified schema in detail.

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 the SchemaName or ARN (or the default registry, if none is supplied), that schema’s metadata is returned. Otherwise, a 404 or NotFou

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.

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.

Retrieves a specified security configuration.

Retrieves a list of all security configurations.

Retrieves the session.

Retrieves the statement.

Retrieves the Table definition in a Data Catalog for a specified table.

Returns the configuration of all optimizers associated with a specified table.

Retrieves a specified version of a table.

Retrieves a list of strings that identify available versions of a specified table.

Retrieves the definitions of some or all of the tables in a given Database.

Retrieves a list of tags associated with a resource.

Retrieves the definition of a trigger.

Gets all the triggers associated with a job.

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.

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.

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.

Retrieves information about the specified Glue usage profile.

Retrieves a specified function definition from the Data Catalog.

Retrieves multiple function definitions from the Data Catalog.

Retrieves resource metadata for a workflow.

Retrieves the metadata for a given workflow run. Job run history is accessible for 90 days for your workflow and job run.

Retrieves the workflow run properties which were set during the run.

Retrieves metadata for all runs of a given workflow.

Imports an existing Amazon Athena Data Catalog to Glue.

Lists all the blueprint names in an account.

List all task runs for a particular account.

The ListConnectionTypes API provides a discovery mechanism to learn available connection types in Glue. The response contains a list of connection types with high-level details of what is supported for each connection type, including both built-in connection types and custom connection types registe

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 t

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

Lists all the custom patterns that have been created.

Returns all data quality execution results for your account.

Lists the recommendation runs meeting the filter criteria.

Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.

Returns a paginated list of rulesets for the specified list of Glue tables.

Retrieve annotations for a data quality statistic.

Retrieves a list of data quality statistics.

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

Returns the available entities supported by the connection type.

List integration resource properties for a single customer. It supports the filters, maxRecords and markers.

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 r

List all task runs for a particular account.

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

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.

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.

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.

Retrieve a list of sessions.

Lists statements for the session.

Lists the history of previous optimizer runs for a specific table.

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 t

List all the Glue usage profiles.

Lists names of workflows created in the account.

Modifies a Zero-ETL integration in the caller's account.

Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.

Annotate all datapoints for a Profile.

Sets the Data Catalog resource policy for access control.

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.

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.

Queries for the schema version metadata information.

Registers a custom connection type in Glue based on the configuration provided. This operation enables customers to configure custom connectors for any data source with REST-based APIs, eliminating the need for building custom Lambda connectors. The registered connection type stores details about ho

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 f

Removes a key value pair from the schema version metadata for the specified schema version ID.

Resets a bookmark entry. For more information about enabling and using job bookmarks, see: Tracking processed data using job bookmarks Job parameters used by Glue Job structure

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.

Executes the statement.

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 t

Starts a new run of the specified blueprint.

Starts a column statistics task run, for a specified table and columns.

Starts a column statistics task run schedule.

Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.

Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.

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

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.

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

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 resu

Starts a job run using a job definition.

Starts a materialized view refresh task run, for a specified table and columns.

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 GetMLT

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 c

Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.

Starts a new run of the specified workflow.

Stops a task run for the specified table.

Stops a column statistics task run schedule.

If the specified crawler is running, stops the crawl.

Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running.

Stops a materialized view refresh task run, for a specified table and columns.

Stops the session.

Stops a specified trigger.

Stops the execution of the specified workflow run.

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.

Tests a connection to a service to validate the service credentials that you provide. You can either provide an existing connection name or a TestConnectionInput for testing a non-existing connection input. Providing both at the same time will cause an error. If the action is successful, the service

Removes tags from a resource.

Updates a registered blueprint.

Updates an existing catalog's properties in the Glue Data Catalog.

Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).

Creates or updates partition statistics of columns. The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.

Creates or updates table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is UpdateTable.

Updates settings for a column statistics task.

Updates a connection definition in the Data Catalog.

Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.

Updates the schedule of a crawler using a cron expression.

Updates the specified data quality ruleset.

Updates an existing database definition in a Data Catalog.

Updates a specified development endpoint.

Updates the existing Glue Identity Center configuration, allowing modification of scopes and permissions for the integration.

This API can be used for updating the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. Since the same resource can be used across multiple integrations, updating resource proper

This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connecti

Updates an existing job definition. The previous job definition is completely overwritten by this information.

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.

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

Updates a partition.

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.

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, the VersionNu

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.

Updates a metadata table in the Data Catalog.

Updates the configuration for an existing table optimizer.

Updates a trigger definition. Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.

Update an Glue usage profile.

Updates an existing function definition in the Data Catalog.

Updates an existing workflow.