aws glue
AWS Glue Defines the public endpoint for the AWS Glue service
Subcommands
| Name | Description |
|---|---|
batch-create-partition | Creates one or more partitions in a batch operation |
batch-delete-connection | Deletes a list of connection definitions from the Data Catalog |
batch-delete-partition | Deletes one or more partitions in a batch operation |
batch-delete-table | 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. AWS 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 calling BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table |
batch-delete-table-version | Deletes a specified batch of versions of a table |
batch-get-crawlers | 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 |
batch-get-dev-endpoints | 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 |
batch-get-jobs | 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 |
batch-get-partition | Retrieves partitions in a batch request |
batch-get-triggers | 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 |
batch-get-workflows | 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 |
batch-stop-job-run | Stops one or more job runs for a specified job definition |
batch-update-partition | Updates one or more partitions in a batch operation |
cancel-ml-task-run | Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that AWS 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 run's TaskRunId |
check-schema-version-validity | 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 |
create-classifier | 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 |
create-connection | Creates a connection definition in the Data Catalog |
create-crawler | 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 |
create-database | Creates a new database in a Data Catalog |
create-dev-endpoint | Creates a new development endpoint |
create-job | Creates a new job definition |
create-ml-transform | Creates an AWS 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 optional Description, in addition to the parameters that you want to use for your algorithm. You must also specify certain parameters for the tasks that AWS 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, and MaxRetries. For more information, see Jobs |
create-partition | Creates a new partition |
create-partition-index | Creates a specified partition index in an existing table |
create-registry | Creates a new registry which may be used to hold a collection of schemas |
create-schema | 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 |
create-script | Transforms a directed acyclic graph (DAG) into code |
create-security-configuration | Creates a new security configuration. A security configuration is a set of security properties that can be used by AWS Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints |
create-table | Creates a new table definition in the Data Catalog |
create-trigger | Creates a new trigger |
create-user-defined-function | Creates a new function definition in the Data Catalog |
create-workflow | Creates a new workflow |
delete-classifier | Removes a classifier from the Data Catalog |
delete-column-statistics-for-partition | Delete the partition column statistics of a column. The Identity and Access Management (IAM) permission required for this operation is DeletePartition |
delete-column-statistics-for-table | Retrieves table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is DeleteTable |
delete-connection | Deletes a connection from the Data Catalog |
delete-crawler | Removes a specified crawler from the AWS Glue Data Catalog, unless the crawler state is RUNNING |
delete-database | 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. AWS 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 calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database |
delete-dev-endpoint | Deletes a specified development endpoint |
delete-job | Deletes a specified job definition. If the job definition is not found, no exception is thrown |
delete-ml-transform | Deletes an AWS 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 AWS Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms. However, any AWS Glue jobs that still reference the deleted transform will no longer succeed |
delete-partition | Deletes a specified partition |
delete-partition-index | Deletes a specified partition index from an existing table |
delete-registry | 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 disable all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs |
delete-resource-policy | Deletes a specified policy |
delete-schema | 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 disable all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs |
delete-schema-versions | 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 the DeleteSchema API. This operation will also delete the attached SchemaVersionMetadata 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 |
delete-security-configuration | Deletes a specified security configuration |
delete-table | 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. AWS 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 calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table |
delete-table-version | Deletes a specified version of a table |
delete-trigger | Deletes a specified trigger. If the trigger is not found, no exception is thrown |
delete-user-defined-function | Deletes an existing function definition from the Data Catalog |
delete-workflow | Deletes a workflow |
get-catalog-import-status | Retrieves the status of a migration operation |
get-classifier | Retrieve a classifier by name |
get-classifiers | Lists all classifier objects in the Data Catalog |
get-column-statistics-for-partition | Retrieves partition statistics of columns. The Identity and Access Management (IAM) permission required for this operation is GetPartition |
get-column-statistics-for-table | Retrieves table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is GetTable |
get-connection | Retrieves a connection definition from the Data Catalog |
get-connections | Retrieves a list of connection definitions from the Data Catalog |
get-crawler | Retrieves metadata for a specified crawler |
get-crawler-metrics | Retrieves metrics about specified crawlers |
get-crawlers | Retrieves metadata for all crawlers defined in the customer account |
get-data-catalog-encryption-settings | Retrieves the security configuration for a specified catalog |
get-database | Retrieves the definition of a specified database |
get-databases | Retrieves all databases defined in a given Data Catalog |
get-dataflow-graph | Transforms a Python script into a directed acyclic graph (DAG) |
get-dev-endpoint | Retrieves information about a specified development endpoint. When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address |
get-dev-endpoints | Retrieves all the development endpoints in this AWS account. When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address |
get-job | Retrieves an existing job definition |
get-job-bookmark | Returns information on a job bookmark entry |
get-job-run | Retrieves the metadata for a given job run |
get-job-runs | Retrieves metadata for all runs of a given job definition |
get-jobs | Retrieves all current job definitions |
get-ml-task-run | Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that AWS 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 transform's TransformID |
get-ml-task-runs | Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that AWS 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's TransformID and other optional parameters as documented in this section. This operation returns a list of historic runs and must be paginated |
get-ml-transform | Gets an AWS 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 AWS Glue. You can retrieve their metadata by calling GetMLTransform |
get-ml-transforms | Gets a sortable, filterable list of existing AWS 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 AWS Glue, and you can retrieve their metadata by calling GetMLTransforms |
get-mapping | Creates mappings |
get-partition | Retrieves information about a specified partition |
get-partition-indexes | Retrieves the partition indexes associated with a table |
get-partitions | Retrieves information about the partitions in a table |
get-plan | Gets code to perform a specified mapping |
get-registry | Describes the specified registry in detail |
get-resource-policies | Retrieves the resource policies set on individual resources by AWS 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 AWS KMS key, the operation can't return the Data Catalog resource policy |
get-resource-policy | Retrieves a specified resource policy |
get-schema | Describes the specified schema in detail |
get-schema-by-definition | 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 NotFound error is returned. Schema versions in Deleted statuses will not be included in the results |
get-schema-version | 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 |
get-schema-versions-diff | 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 |
get-security-configuration | Retrieves a specified security configuration |
get-security-configurations | Retrieves a list of all security configurations |
get-table | Retrieves the Table definition in a Data Catalog for a specified table |
get-table-version | Retrieves a specified version of a table |
get-table-versions | Retrieves a list of strings that identify available versions of a specified table |
get-tables | Retrieves the definitions of some or all of the tables in a given Database |
get-tags | Retrieves a list of tags associated with a resource |
get-trigger | Retrieves the definition of a trigger |
get-triggers | Gets all the triggers associated with a job |
get-user-defined-function | Retrieves a specified function definition from the Data Catalog |
get-user-defined-functions | Retrieves multiple function definitions from the Data Catalog |
get-workflow | Retrieves resource metadata for a workflow |
get-workflow-run | Retrieves the metadata for a given workflow run |
get-workflow-run-properties | Retrieves the workflow run properties which were set during the run |
get-workflow-runs | Retrieves metadata for all runs of a given workflow |
import-catalog-to-glue | Imports an existing Amazon Athena Data Catalog to AWS Glue |
list-crawlers | Retrieves the names of all crawler resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved |
list-dev-endpoints | Retrieves the names of all DevEndpoint resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved |
list-jobs | Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved |
list-ml-transforms | Retrieves a sortable, filterable list of existing AWS Glue machine learning transforms in this AWS 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 |
list-registries | 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 |
list-schema-versions | 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 |
list-schemas | 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 |
list-triggers | Retrieves the names of all trigger resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names. This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved |
list-workflows | Lists names of workflows created in the account |
put-data-catalog-encryption-settings | Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter |
put-resource-policy | Sets the Data Catalog resource policy for access control |
put-schema-version-metadata | 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 |
put-workflow-run-properties | 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 |
query-schema-version-metadata | Queries for the schema version metadata information |
register-schema-version | 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 the SchemaVersionId 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 |
remove-schema-version-metadata | Removes a key value pair from the schema version metadata for the specified schema version ID |
reset-job-bookmark | Resets a bookmark entry |
resume-workflow-run | 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 |
search-tables | 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 |
start-crawler | Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException |
start-crawler-schedule | Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED |
start-export-labels-task-run | 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 the TransformId whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId. You can check on the status of your task run by calling the GetMLTaskRun API |
start-import-labels-task-run | 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, AWS 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 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, users upload their answers/labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun 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 set Replace to true. If you set Replace 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 |
start-job-run | Starts a job run using a job definition |
start-ml-evaluation-task-run | Starts a task to estimate the quality of the transform. When you provide label sets as examples of truth, AWS 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 the EvaluationTaskRun |
start-ml-labeling-set-generation-task-run | 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, AWS 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. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation |
start-trigger | Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started |
start-workflow-run | Starts a new run of the specified workflow |
stop-crawler | If the specified crawler is running, stops the crawl |
stop-crawler-schedule | Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running |
stop-trigger | Stops a specified trigger |
stop-workflow-run | Stops the execution of the specified workflow run |
tag-resource | Adds tags to a resource. A tag is a label you can assign to an AWS resource. In AWS Glue, you can tag only certain resources. For information about what resources you can tag, see AWS Tags in AWS Glue |
untag-resource | Removes tags from a resource |
update-classifier | Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present) |
update-column-statistics-for-partition | Creates or updates partition statistics of columns. The Identity and Access Management (IAM) permission required for this operation is UpdatePartition |
update-column-statistics-for-table | Creates or updates table statistics of columns. The Identity and Access Management (IAM) permission required for this operation is UpdateTable |
update-connection | Updates a connection definition in the Data Catalog |
update-crawler | Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it |
update-crawler-schedule | Updates the schedule of a crawler using a cron expression |
update-database | Updates an existing database definition in a Data Catalog |
update-dev-endpoint | Updates a specified development endpoint |
update-job | Updates an existing job definition |
update-ml-transform | 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) |
update-partition | Updates a partition |
update-registry | 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 |
update-schema | 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 VersionNumber (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 |
update-table | Updates a metadata table in the Data Catalog |
update-trigger | Updates a trigger definition |
update-user-defined-function | Updates an existing function definition in the Data Catalog |
update-workflow | Updates an existing workflow |