amazonaws.com – glue
Glue
Defines the public endpoint for the Glue service.
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:glue/2017-03-31.json
- Provider
- amazonaws.com:glue / glue
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/glue/2017-03-31/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/glue/2017-03-31/openapi.yaml
Tools (204)
Extracted live via the executor SDK.
-
xAmzTargetAwsGlueBatchCreatePartition.batchCreatePartitionCreates one or more partitions in a batch operation.
-
xAmzTargetAwsGlueBatchDeleteConnection.batchDeleteConnectionDeletes a list of connection definitions from the Data Catalog.
-
xAmzTargetAwsGlueBatchDeletePartition.batchDeletePartitionDeletes one or more partitions in a batch operation.
-
xAmzTargetAwsGlueBatchDeleteTable.batchDeleteTableDeletes 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 deletion of all related resources, before calling
BatchDeleteTable, useDeleteTableVersionorBatchDeleteTableVersion, andDeletePartitionorBatchDeletePartition, to delete any resources that belong to the table. -
xAmzTargetAwsGlueBatchDeleteTableVersion.batchDeleteTableVersionDeletes a specified batch of versions of a table.
-
xAmzTargetAwsGlueBatchGetBlueprints.batchGetBlueprintsRetrieves information about a list of blueprints.
-
xAmzTargetAwsGlueBatchGetCrawlers.batchGetCrawlersReturns a list of resource metadata for a given list of crawler names. After calling the
ListCrawlersoperation, 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. -
xAmzTargetAwsGlueBatchGetCustomEntityTypes.batchGetCustomEntityTypesRetrieves the details for the custom patterns specified by a list of names.
-
xAmzTargetAwsGlueBatchGetDataQualityResult.batchGetDataQualityResultRetrieves a list of data quality results for the specified result IDs.
-
xAmzTargetAwsGlueBatchGetDevEndpoints.batchGetDevEndpointsReturns a list of resource metadata for a given list of development endpoint names. After calling the
ListDevEndpointsoperation, 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. -
xAmzTargetAwsGlueBatchGetJobs.batchGetJobsReturns a list of resource metadata for a given list of job names. After calling the
ListJobsoperation, 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. -
xAmzTargetAwsGlueBatchGetPartition.batchGetPartitionRetrieves partitions in a batch request.
-
xAmzTargetAwsGlueBatchGetTriggers.batchGetTriggersReturns a list of resource metadata for a given list of trigger names. After calling the
ListTriggersoperation, 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. -
xAmzTargetAwsGlueBatchGetWorkflows.batchGetWorkflowsReturns a list of resource metadata for a given list of workflow names. After calling the
ListWorkflowsoperation, 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. -
xAmzTargetAwsGlueBatchStopJobRun.batchStopJobRunStops one or more job runs for a specified job definition.
-
xAmzTargetAwsGlueBatchUpdatePartition.batchUpdatePartitionUpdates one or more partitions in a batch operation.
-
xAmzTargetAwsGlueCancelDataQualityRuleRecommendationRun.cancelDataQualityRuleRecommendationRunCancels the specified recommendation run that was being used to generate rules.
-
xAmzTargetAwsGlueCancelDataQualityRulesetEvaluationRun.cancelDataQualityRulesetEvaluationRunCancels a run where a ruleset is being evaluated against a data source.
-
xAmzTargetAwsGlueCancelMlTaskRun.cancelMlTaskRunCancels (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
CancelMLTaskRunwith a task run's parent transform'sTransformIDand the task run'sTaskRunId. -
xAmzTargetAwsGlueCancelStatement.cancelStatementCancels the statement.
-
xAmzTargetAwsGlueCheckSchemaVersionValidity.checkSchemaVersionValidityValidates the supplied schema. This call has no side effects, it simply validates using the supplied schema using
DataFormatas the format. Since it does not take a schema set name, no compatibility checks are performed. -
xAmzTargetAwsGlueCreateBlueprint.createBlueprintRegisters a blueprint with Glue.
-
xAmzTargetAwsGlueCreateClassifier.createClassifierCreates 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. -
xAmzTargetAwsGlueCreateConnection.createConnectionCreates a connection definition in the Data Catalog.
-
xAmzTargetAwsGlueCreateCrawler.createCrawlerCreates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the
s3Targetsfield, thejdbcTargetsfield, or theDynamoDBTargetsfield. -
xAmzTargetAwsGlueCreateCustomEntityType.createCustomEntityTypeCreates 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.
-
xAmzTargetAwsGlueCreateDatabase.createDatabaseCreates a new database in a Data Catalog.
-
xAmzTargetAwsGlueCreateDataQualityRuleset.createDataQualityRulesetCreates 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.
-
xAmzTargetAwsGlueCreateDevEndpoint.createDevEndpointCreates a new development endpoint.
-
xAmzTargetAwsGlueCreateJob.createJobCreates a new job definition.
-
xAmzTargetAwsGlueCreateMlTransform.createMlTransformCreates 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
FindMatchestransform) 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 . -
xAmzTargetAwsGlueCreatePartition.createPartitionCreates a new partition.
-
xAmzTargetAwsGlueCreatePartitionIndex.createPartitionIndexCreates a specified partition index in an existing table.
-
xAmzTargetAwsGlueCreateRegistry.createRegistryCreates a new registry which may be used to hold a collection of schemas.
-
xAmzTargetAwsGlueCreateSchema.createSchemaCreates 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
RegisterSchemaVersionAPI 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. -
xAmzTargetAwsGlueCreateScript.createScriptTransforms a directed acyclic graph (DAG) into code.
-
xAmzTargetAwsGlueCreateSecurityConfiguration.createSecurityConfigurationCreates 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 .
-
xAmzTargetAwsGlueCreateSession.createSessionCreates a new session.
-
xAmzTargetAwsGlueCreateTable.createTableCreates a new table definition in the Data Catalog.
-
xAmzTargetAwsGlueCreateTrigger.createTriggerCreates a new trigger.
-
xAmzTargetAwsGlueCreateUserDefinedFunction.createUserDefinedFunctionCreates a new function definition in the Data Catalog.
-
xAmzTargetAwsGlueCreateWorkflow.createWorkflowCreates a new workflow.
-
xAmzTargetAwsGlueDeleteBlueprint.deleteBlueprintDeletes an existing blueprint.
-
xAmzTargetAwsGlueDeleteClassifier.deleteClassifierRemoves a classifier from the Data Catalog.
-
xAmzTargetAwsGlueDeleteColumnStatisticsForPartition.deleteColumnStatisticsForPartitionDelete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is
DeletePartition. -
xAmzTargetAwsGlueDeleteColumnStatisticsForTable.deleteColumnStatisticsForTableRetrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
DeleteTable. -
xAmzTargetAwsGlueDeleteConnection.deleteConnectionDeletes a connection from the Data Catalog.
-
xAmzTargetAwsGlueDeleteCrawler.deleteCrawlerRemoves a specified crawler from the Glue Data Catalog, unless the crawler state is
RUNNING. -
xAmzTargetAwsGlueDeleteCustomEntityType.deleteCustomEntityTypeDeletes a custom pattern by specifying its name.
-
xAmzTargetAwsGlueDeleteDatabase.deleteDatabaseRemoves 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 asynchronously in a timely manner, at the discretion of the service.
To ensure the immediate deletion of all related resources, before calling
DeleteDatabase, useDeleteTableVersionorBatchDeleteTableVersion,DeletePartitionorBatchDeletePartition,DeleteUserDefinedFunction, andDeleteTableorBatchDeleteTable, to delete any resources that belong to the database. -
xAmzTargetAwsGlueDeleteDataQualityRuleset.deleteDataQualityRulesetDeletes a data quality ruleset.
-
xAmzTargetAwsGlueDeleteDevEndpoint.deleteDevEndpointDeletes a specified development endpoint.
-
xAmzTargetAwsGlueDeleteJob.deleteJobDeletes a specified job definition. If the job definition is not found, no exception is thrown.
-
xAmzTargetAwsGlueDeleteMlTransform.deleteMlTransformDeletes 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. -
xAmzTargetAwsGlueDeletePartition.deletePartitionDeletes a specified partition.
-
xAmzTargetAwsGlueDeletePartitionIndex.deletePartitionIndexDeletes a specified partition index from an existing table.
-
xAmzTargetAwsGlueDeleteRegistry.deleteRegistryDelete the entire registry including schema and all of its versions. To get the status of the delete operation, you can call the
GetRegistryAPI after the asynchronous call. Deleting a registry will deactivate all online operations for the registry such as theUpdateRegistry,CreateSchema,UpdateSchema, andRegisterSchemaVersionAPIs. -
xAmzTargetAwsGlueDeleteResourcePolicy.deleteResourcePolicyDeletes a specified policy.
-
xAmzTargetAwsGlueDeleteSchema.deleteSchemaDeletes the entire schema set, including the schema set and all of its versions. To get the status of the delete operation, you can call
GetSchemaAPI after the asynchronous call. Deleting a registry will deactivate all online operations for the schema, such as theGetSchemaByDefinition, andRegisterSchemaVersionAPIs. -
xAmzTargetAwsGlueDeleteSchemaVersions.deleteSchemaVersionsRemove 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
GetSchemaVersionsAPI 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
DeleteSchemaCheckpointAPI before using this API.You cannot use the
DeleteSchemaVersionsAPI to delete the first schema version in the schema set. The first schema version can only be deleted by theDeleteSchemaAPI. This operation will also delete the attachedSchemaVersionMetadataunder 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.
-
xAmzTargetAwsGlueDeleteSecurityConfiguration.deleteSecurityConfigurationDeletes a specified security configuration.
-
xAmzTargetAwsGlueDeleteSession.deleteSessionDeletes the session.
-
xAmzTargetAwsGlueDeleteTable.deleteTableRemoves 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 the immediate deletion of all related resources, before calling
DeleteTable, useDeleteTableVersionorBatchDeleteTableVersion, andDeletePartitionorBatchDeletePartition, to delete any resources that belong to the table. -
xAmzTargetAwsGlueDeleteTableVersion.deleteTableVersionDeletes a specified version of a table.
-
xAmzTargetAwsGlueDeleteTrigger.deleteTriggerDeletes a specified trigger. If the trigger is not found, no exception is thrown.
-
xAmzTargetAwsGlueDeleteUserDefinedFunction.deleteUserDefinedFunctionDeletes an existing function definition from the Data Catalog.
-
xAmzTargetAwsGlueDeleteWorkflow.deleteWorkflowDeletes a workflow.
-
xAmzTargetAwsGlueGetBlueprint.getBlueprintRetrieves the details of a blueprint.
-
xAmzTargetAwsGlueGetBlueprintRun.getBlueprintRunRetrieves the details of a blueprint run.
-
xAmzTargetAwsGlueGetBlueprintRuns.getBlueprintRunsRetrieves the details of blueprint runs for a specified blueprint.
-
xAmzTargetAwsGlueGetCatalogImportStatus.getCatalogImportStatusRetrieves the status of a migration operation.
-
xAmzTargetAwsGlueGetClassifier.getClassifierRetrieve a classifier by name.
-
xAmzTargetAwsGlueGetClassifiers.getClassifiersLists all classifier objects in the Data Catalog.
-
xAmzTargetAwsGlueGetColumnStatisticsForPartition.getColumnStatisticsForPartitionRetrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
GetPartition. -
xAmzTargetAwsGlueGetColumnStatisticsForTable.getColumnStatisticsForTableRetrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
GetTable. -
xAmzTargetAwsGlueGetConnection.getConnectionRetrieves a connection definition from the Data Catalog.
-
xAmzTargetAwsGlueGetConnections.getConnectionsRetrieves a list of connection definitions from the Data Catalog.
-
xAmzTargetAwsGlueGetCrawler.getCrawlerRetrieves metadata for a specified crawler.
-
xAmzTargetAwsGlueGetCrawlerMetrics.getCrawlerMetricsRetrieves metrics about specified crawlers.
-
xAmzTargetAwsGlueGetCrawlers.getCrawlersRetrieves metadata for all crawlers defined in the customer account.
-
xAmzTargetAwsGlueGetCustomEntityType.getCustomEntityTypeRetrieves the details of a custom pattern by specifying its name.
-
xAmzTargetAwsGlueGetDatabase.getDatabaseRetrieves the definition of a specified database.
-
xAmzTargetAwsGlueGetDatabases.getDatabasesRetrieves all databases defined in a given Data Catalog.
-
xAmzTargetAwsGlueGetDataCatalogEncryptionSettings.getDataCatalogEncryptionSettingsRetrieves the security configuration for a specified catalog.
-
xAmzTargetAwsGlueGetDataflowGraph.getDataflowGraphTransforms a Python script into a directed acyclic graph (DAG).
-
xAmzTargetAwsGlueGetDataQualityResult.getDataQualityResultRetrieves the result of a data quality rule evaluation.
-
xAmzTargetAwsGlueGetDataQualityRuleRecommendationRun.getDataQualityRuleRecommendationRunGets the specified recommendation run that was used to generate rules.
-
xAmzTargetAwsGlueGetDataQualityRuleset.getDataQualityRulesetReturns an existing ruleset by identifier or name.
-
xAmzTargetAwsGlueGetDataQualityRulesetEvaluationRun.getDataQualityRulesetEvaluationRunRetrieves a specific run where a ruleset is evaluated against a data source.
-
xAmzTargetAwsGlueGetDevEndpoint.getDevEndpointRetrieves 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 IP address.
-
xAmzTargetAwsGlueGetDevEndpoints.getDevEndpointsRetrieves 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 only a public IP address.
-
xAmzTargetAwsGlueGetJob.getJobRetrieves an existing job definition.
-
xAmzTargetAwsGlueGetJobBookmark.getJobBookmarkReturns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
-
-
xAmzTargetAwsGlueGetJobRun.getJobRunRetrieves the metadata for a given job run.
-
xAmzTargetAwsGlueGetJobRuns.getJobRunsRetrieves metadata for all runs of a given job definition.
-
xAmzTargetAwsGlueGetJobs.getJobsRetrieves all current job definitions.
-
xAmzTargetAwsGlueGetMapping.getMappingCreates mappings.
-
xAmzTargetAwsGlueGetMlTaskRun.getMlTaskRunGets 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
GetMLTaskRunwith theTaskRunIDand its parent transform'sTransformID. -
xAmzTargetAwsGlueGetMlTaskRuns.getMlTaskRunsGets 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
GetMLTaskRunswith their parent transform'sTransformIDand other optional parameters as documented in this section.This operation returns a list of historic runs and must be paginated.
-
xAmzTargetAwsGlueGetMlTransform.getMlTransformGets 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. -
xAmzTargetAwsGlueGetMlTransforms.getMlTransformsGets 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. -
xAmzTargetAwsGlueGetPartition.getPartitionRetrieves information about a specified partition.
-
xAmzTargetAwsGlueGetPartitionIndexes.getPartitionIndexesRetrieves the partition indexes associated with a table.
-
xAmzTargetAwsGlueGetPartitions.getPartitionsRetrieves information about the partitions in a table.
-
xAmzTargetAwsGlueGetPlan.getPlanGets code to perform a specified mapping.
-
xAmzTargetAwsGlueGetRegistry.getRegistryDescribes the specified registry in detail.
-
xAmzTargetAwsGlueGetResourcePolicies.getResourcePoliciesRetrieves 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.
-
xAmzTargetAwsGlueGetResourcePolicy.getResourcePolicyRetrieves a specified resource policy.
-
xAmzTargetAwsGlueGetSchema.getSchemaDescribes the specified schema in detail.
-
xAmzTargetAwsGlueGetSchemaByDefinition.getSchemaByDefinitionRetrieves 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 theSchemaNameor 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 inDeletedstatuses will not be included in the results. -
xAmzTargetAwsGlueGetSchemaVersion.getSchemaVersionGet 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.
-
xAmzTargetAwsGlueGetSchemaVersionsDiff.getSchemaVersionsDiffFetches 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.
-
xAmzTargetAwsGlueGetSecurityConfiguration.getSecurityConfigurationRetrieves a specified security configuration.
-
xAmzTargetAwsGlueGetSecurityConfigurations.getSecurityConfigurationsRetrieves a list of all security configurations.
-
xAmzTargetAwsGlueGetSession.getSessionRetrieves the session.
-
xAmzTargetAwsGlueGetStatement.getStatementRetrieves the statement.
-
xAmzTargetAwsGlueGetTable.getTableRetrieves the
Tabledefinition in a Data Catalog for a specified table. -
xAmzTargetAwsGlueGetTables.getTablesRetrieves the definitions of some or all of the tables in a given
Database. -
xAmzTargetAwsGlueGetTableVersion.getTableVersionRetrieves a specified version of a table.
-
xAmzTargetAwsGlueGetTableVersions.getTableVersionsRetrieves a list of strings that identify available versions of a specified table.
-
xAmzTargetAwsGlueGetTags.getTagsRetrieves a list of tags associated with a resource.
-
xAmzTargetAwsGlueGetTrigger.getTriggerRetrieves the definition of a trigger.
-
xAmzTargetAwsGlueGetTriggers.getTriggersGets all the triggers associated with a job.
-
xAmzTargetAwsGlueGetUnfilteredPartitionMetadata.getUnfilteredPartitionMetadataRetrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
glue:GetPartition. -
xAmzTargetAwsGlueGetUnfilteredPartitionsMetadata.getUnfilteredPartitionsMetadataRetrieves partition metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
glue:GetPartitions. -
xAmzTargetAwsGlueGetUnfilteredTableMetadata.getUnfilteredTableMetadataRetrieves table metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is
glue:GetTable. -
xAmzTargetAwsGlueGetUserDefinedFunction.getUserDefinedFunctionRetrieves a specified function definition from the Data Catalog.
-
xAmzTargetAwsGlueGetUserDefinedFunctions.getUserDefinedFunctionsRetrieves multiple function definitions from the Data Catalog.
-
xAmzTargetAwsGlueGetWorkflow.getWorkflowRetrieves resource metadata for a workflow.
-
xAmzTargetAwsGlueGetWorkflowRun.getWorkflowRunRetrieves the metadata for a given workflow run.
-
xAmzTargetAwsGlueGetWorkflowRunProperties.getWorkflowRunPropertiesRetrieves the workflow run properties which were set during the run.
-
xAmzTargetAwsGlueGetWorkflowRuns.getWorkflowRunsRetrieves metadata for all runs of a given workflow.
-
xAmzTargetAwsGlueImportCatalogToGlue.importCatalogToGlueImports an existing Amazon Athena Data Catalog to Glue.
-
xAmzTargetAwsGlueListBlueprints.listBlueprintsLists all the blueprint names in an account.
-
xAmzTargetAwsGlueListCrawlers.listCrawlersRetrieves 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
Tagsfield, 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. -
xAmzTargetAwsGlueListCrawls.listCrawlsReturns 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.
-
-
xAmzTargetAwsGlueListCustomEntityTypes.listCustomEntityTypesLists all the custom patterns that have been created.
-
xAmzTargetAwsGlueListDataQualityResults.listDataQualityResultsReturns all data quality execution results for your account.
-
xAmzTargetAwsGlueListDataQualityRuleRecommendationRuns.listDataQualityRuleRecommendationRunsLists the recommendation runs meeting the filter criteria.
-
xAmzTargetAwsGlueListDataQualityRulesetEvaluationRuns.listDataQualityRulesetEvaluationRunsLists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
-
xAmzTargetAwsGlueListDataQualityRulesets.listDataQualityRulesetsReturns a paginated list of rulesets for the specified list of Glue tables.
-
xAmzTargetAwsGlueListDevEndpoints.listDevEndpointsRetrieves the names of all
DevEndpointresources 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
Tagsfield, 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. -
xAmzTargetAwsGlueListJobs.listJobsRetrieves 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
Tagsfield, 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. -
xAmzTargetAwsGlueListMlTransforms.listMlTransformsRetrieves 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
Tagsfield, 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. -
xAmzTargetAwsGlueListRegistries.listRegistriesReturns a list of registries that you have created, with minimal registry information. Registries in the
Deletingstatus will not be included in the results. Empty results will be returned if there are no registries available. -
xAmzTargetAwsGlueListSchemas.listSchemasReturns 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
RegistryIdis not provided, all the schemas across registries will be part of the API response. -
xAmzTargetAwsGlueListSchemaVersions.listSchemaVersionsReturns 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.
-
xAmzTargetAwsGlueListSessions.listSessionsRetrieve a list of sessions.
-
xAmzTargetAwsGlueListStatements.listStatementsLists statements for the session.
-
xAmzTargetAwsGlueListTriggers.listTriggersRetrieves 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
Tagsfield, 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. -
xAmzTargetAwsGlueListWorkflows.listWorkflowsLists names of workflows created in the account.
-
xAmzTargetAwsGluePutDataCatalogEncryptionSettings.putDataCatalogEncryptionSettingsSets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.
-
xAmzTargetAwsGluePutResourcePolicy.putResourcePolicySets the Data Catalog resource policy for access control.
-
xAmzTargetAwsGluePutSchemaVersionMetadata.putSchemaVersionMetadataPuts 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.
-
xAmzTargetAwsGluePutWorkflowRunProperties.putWorkflowRunPropertiesPuts 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.
-
xAmzTargetAwsGlueQuerySchemaVersionMetadata.querySchemaVersionMetadataQueries for the schema version metadata information.
-
xAmzTargetAwsGlueRegisterSchemaVersion.registerSchemaVersionAdds 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
GetSchemaVersionAPI with theSchemaVersionIdto 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.
-
xAmzTargetAwsGlueRemoveSchemaVersionMetadata.removeSchemaVersionMetadataRemoves a key value pair from the schema version metadata for the specified schema version ID.
-
xAmzTargetAwsGlueResetJobBookmark.resetJobBookmarkResets a bookmark entry.
For more information about enabling and using job bookmarks, see:
-
-
xAmzTargetAwsGlueResumeWorkflowRun.resumeWorkflowRunRestarts 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.
-
xAmzTargetAwsGlueRunStatement.runStatementExecutes the statement.
-
xAmzTargetAwsGlueSearchTables.searchTablesSearches 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.
-
xAmzTargetAwsGlueStartBlueprintRun.startBlueprintRunStarts a new run of the specified blueprint.
-
xAmzTargetAwsGlueStartCrawler.startCrawlerStarts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a .
-
xAmzTargetAwsGlueStartCrawlerSchedule.startCrawlerScheduleChanges the schedule state of the specified crawler to
SCHEDULED, unless the crawler is already running or the schedule state is alreadySCHEDULED. -
xAmzTargetAwsGlueStartDataQualityRuleRecommendationRun.startDataQualityRuleRecommendationRunStarts 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.
-
xAmzTargetAwsGlueStartDataQualityRulesetEvaluationRun.startDataQualityRulesetEvaluationRunOnce 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
GetDataQualityResultAPI. -
xAmzTargetAwsGlueStartExportLabelsTaskRun.startExportLabelsTaskRunBegins 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
StartExportLabelsTaskRunwhen 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 theTransformIdwhose 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 theGetMLTaskRunAPI. -
xAmzTargetAwsGlueStartImportLabelsTaskRun.startImportLabelsTaskRunEnables 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
StartMLLabelingSetGenerationTaskRuncall and that ultimately results in improving the quality of your machine learning transform.After the
StartMLLabelingSetGenerationTaskRunfinishes, 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 theFindMatchestransform, 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. AfterStartImportLabelsTaskRunfinishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.By default,
StartMLLabelingSetGenerationTaskRuncontinually learns from and combines all labels that you upload unless you setReplaceto true. If you setReplaceto true,StartImportLabelsTaskRundeletes 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
GetMLTaskRunoperation. -
xAmzTargetAwsGlueStartJobRun.startJobRunStarts a job run using a job definition.
-
xAmzTargetAwsGlueStartMlEvaluationTaskRun.startMlEvaluationTaskRunStarts 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
GetMLTaskRunto get more information about the stats of theEvaluationTaskRun. -
xAmzTargetAwsGlueStartMlLabelingSetGenerationTaskRun.startMlLabelingSetGenerationTaskRunStarts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.
When the
StartMLLabelingSetGenerationTaskRunfinishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.In the case of the
FindMatchestransform, 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. AfterStartImportLabelsTaskRunfinishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation. -
xAmzTargetAwsGlueStartTrigger.startTriggerStarts an existing trigger. See for information about how different types of trigger are started.
-
xAmzTargetAwsGlueStartWorkflowRun.startWorkflowRunStarts a new run of the specified workflow.
-
xAmzTargetAwsGlueStopCrawler.stopCrawlerIf the specified crawler is running, stops the crawl.
-
xAmzTargetAwsGlueStopCrawlerSchedule.stopCrawlerScheduleSets the schedule state of the specified crawler to
NOT_SCHEDULED, but does not stop the crawler if it is already running. -
xAmzTargetAwsGlueStopSession.stopSessionStops the session.
-
xAmzTargetAwsGlueStopTrigger.stopTriggerStops a specified trigger.
-
xAmzTargetAwsGlueStopWorkflowRun.stopWorkflowRunStops the execution of the specified workflow run.
-
xAmzTargetAwsGlueTagResource.tagResourceAdds 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 .
-
xAmzTargetAwsGlueUntagResource.untagResourceRemoves tags from a resource.
-
xAmzTargetAwsGlueUpdateBlueprint.updateBlueprintUpdates a registered blueprint.
-
xAmzTargetAwsGlueUpdateClassifier.updateClassifierModifies an existing classifier (a
GrokClassifier, anXMLClassifier, aJsonClassifier, or aCsvClassifier, depending on which field is present). -
xAmzTargetAwsGlueUpdateColumnStatisticsForPartition.updateColumnStatisticsForPartitionCreates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
UpdatePartition. -
xAmzTargetAwsGlueUpdateColumnStatisticsForTable.updateColumnStatisticsForTableCreates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is
UpdateTable. -
xAmzTargetAwsGlueUpdateConnection.updateConnectionUpdates a connection definition in the Data Catalog.
-
xAmzTargetAwsGlueUpdateCrawler.updateCrawlerUpdates a crawler. If a crawler is running, you must stop it using
StopCrawlerbefore updating it. -
xAmzTargetAwsGlueUpdateCrawlerSchedule.updateCrawlerScheduleUpdates the schedule of a crawler using a
cronexpression. -
xAmzTargetAwsGlueUpdateDatabase.updateDatabaseUpdates an existing database definition in a Data Catalog.
-
xAmzTargetAwsGlueUpdateDataQualityRuleset.updateDataQualityRulesetUpdates the specified data quality ruleset.
-
xAmzTargetAwsGlueUpdateDevEndpoint.updateDevEndpointUpdates a specified development endpoint.
-
xAmzTargetAwsGlueUpdateJob.updateJobUpdates an existing job definition. The previous job definition is completely overwritten by this information.
-
xAmzTargetAwsGlueUpdateJobFromSourceControl.updateJobFromSourceControlSynchronizes 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.
-
xAmzTargetAwsGlueUpdateMlTransform.updateMlTransformUpdates 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
StartMLEvaluationTaskRunoperation 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). -
xAmzTargetAwsGlueUpdatePartition.updatePartitionUpdates a partition.
-
xAmzTargetAwsGlueUpdateRegistry.updateRegistryUpdates 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.
-
xAmzTargetAwsGlueUpdateSchema.updateSchemaUpdates 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
Compatibilityis 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,Compatibilityis 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.
-
xAmzTargetAwsGlueUpdateSourceControlFromJob.updateSourceControlFromJobSynchronizes 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.
-
xAmzTargetAwsGlueUpdateTable.updateTableUpdates a metadata table in the Data Catalog.
-
xAmzTargetAwsGlueUpdateTrigger.updateTriggerUpdates a trigger definition.
-
xAmzTargetAwsGlueUpdateUserDefinedFunction.updateUserDefinedFunctionUpdates an existing function definition in the Data Catalog.
-
xAmzTargetAwsGlueUpdateWorkflow.updateWorkflowUpdates an existing workflow.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools