AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing Glue

Glue

Defines the public endpoint for the Glue service.

Inheritance Hierarchy

Amazon.Glue.IAmazonGlue

Namespace: Amazon.Glue
Assembly: AWSSDK.Glue.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonGlue
         IAmazonService, IDisposable

The IAmazonGlue type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.Glue.Model.IGluePaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchCreatePartition(BatchCreatePartitionRequest)

Creates one or more partitions in a batch operation.

Public Method BatchCreatePartitionAsync(BatchCreatePartitionRequest, CancellationToken)

Creates one or more partitions in a batch operation.

Public Method BatchDeleteConnection(BatchDeleteConnectionRequest)

Deletes a list of connection definitions from the Data Catalog.

Public Method BatchDeleteConnectionAsync(BatchDeleteConnectionRequest, CancellationToken)

Deletes a list of connection definitions from the Data Catalog.

Public Method BatchDeletePartition(BatchDeletePartitionRequest)

Deletes one or more partitions in a batch operation.

Public Method BatchDeletePartitionAsync(BatchDeletePartitionRequest, CancellationToken)

Deletes one or more partitions in a batch operation.

Public Method BatchDeleteTable(BatchDeleteTableRequest)

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

Public Method BatchDeleteTableAsync(BatchDeleteTableRequest, CancellationToken)

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

Public Method BatchDeleteTableVersion(BatchDeleteTableVersionRequest)

Deletes a specified batch of versions of a table.

Public Method BatchDeleteTableVersionAsync(BatchDeleteTableVersionRequest, CancellationToken)

Deletes a specified batch of versions of a table.

Public Method BatchGetBlueprints(BatchGetBlueprintsRequest)

Retrieves information about a list of blueprints.

Public Method BatchGetBlueprintsAsync(BatchGetBlueprintsRequest, CancellationToken)

Retrieves information about a list of blueprints.

Public Method BatchGetCrawlers(BatchGetCrawlersRequest)

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.

Public Method BatchGetCrawlersAsync(BatchGetCrawlersRequest, CancellationToken)

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.

Public Method BatchGetCustomEntityTypes(BatchGetCustomEntityTypesRequest)

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

Public Method BatchGetCustomEntityTypesAsync(BatchGetCustomEntityTypesRequest, CancellationToken)

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

Public Method BatchGetDataQualityResult(BatchGetDataQualityResultRequest)

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

Public Method BatchGetDataQualityResultAsync(BatchGetDataQualityResultRequest, CancellationToken)

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

Public Method BatchGetDevEndpoints(BatchGetDevEndpointsRequest)

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.

Public Method BatchGetDevEndpointsAsync(BatchGetDevEndpointsRequest, CancellationToken)

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.

Public Method BatchGetJobs(BatchGetJobsRequest)

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.

Public Method BatchGetJobsAsync(BatchGetJobsRequest, CancellationToken)

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.

Public Method BatchGetPartition(BatchGetPartitionRequest)

Retrieves partitions in a batch request.

Public Method BatchGetPartitionAsync(BatchGetPartitionRequest, CancellationToken)

Retrieves partitions in a batch request.

Public Method BatchGetTableOptimizer(BatchGetTableOptimizerRequest)

Returns the configuration for the specified table optimizers.

Public Method BatchGetTableOptimizerAsync(BatchGetTableOptimizerRequest, CancellationToken)

Returns the configuration for the specified table optimizers.

Public Method BatchGetTriggers(BatchGetTriggersRequest)

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.

Public Method BatchGetTriggersAsync(BatchGetTriggersRequest, CancellationToken)

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.

Public Method BatchGetWorkflows(BatchGetWorkflowsRequest)

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.

Public Method BatchGetWorkflowsAsync(BatchGetWorkflowsRequest, CancellationToken)

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.

Public Method BatchStopJobRun(BatchStopJobRunRequest)

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

Public Method BatchStopJobRunAsync(BatchStopJobRunRequest, CancellationToken)

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

Public Method BatchUpdatePartition(BatchUpdatePartitionRequest)

Updates one or more partitions in a batch operation.

Public Method BatchUpdatePartitionAsync(BatchUpdatePartitionRequest, CancellationToken)

Updates one or more partitions in a batch operation.

Public Method CancelDataQualityRuleRecommendationRun(CancelDataQualityRuleRecommendationRunRequest)

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

Public Method CancelDataQualityRuleRecommendationRunAsync(CancelDataQualityRuleRecommendationRunRequest, CancellationToken)

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

Public Method CancelDataQualityRulesetEvaluationRun(CancelDataQualityRulesetEvaluationRunRequest)

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

Public Method CancelDataQualityRulesetEvaluationRunAsync(CancelDataQualityRulesetEvaluationRunRequest, CancellationToken)

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

Public Method CancelMLTaskRun(CancelMLTaskRunRequest)

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 run's TaskRunId.

Public Method CancelMLTaskRunAsync(CancelMLTaskRunRequest, CancellationToken)

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 run's TaskRunId.

Public Method CancelStatement(CancelStatementRequest)

Cancels the statement.

Public Method CancelStatementAsync(CancelStatementRequest, CancellationToken)

Cancels the statement.

Public Method CheckSchemaVersionValidity(CheckSchemaVersionValidityRequest)

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.

Public Method CheckSchemaVersionValidityAsync(CheckSchemaVersionValidityRequest, CancellationToken)

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.

Public Method CreateBlueprint(CreateBlueprintRequest)

Registers a blueprint with Glue.

Public Method CreateBlueprintAsync(CreateBlueprintRequest, CancellationToken)

Registers a blueprint with Glue.

Public Method CreateClassifier(CreateClassifierRequest)

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.

Public Method CreateClassifierAsync(CreateClassifierRequest, CancellationToken)

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.

Public Method CreateConnection(CreateConnectionRequest)

Creates a connection definition in the Data Catalog.

Connections used for creating federated resources require the IAM glue:PassConnection permission.

Public Method CreateConnectionAsync(CreateConnectionRequest, CancellationToken)

Creates a connection definition in the Data Catalog.

Connections used for creating federated resources require the IAM glue:PassConnection permission.

Public Method CreateCrawler(CreateCrawlerRequest)

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.

Public Method CreateCrawlerAsync(CreateCrawlerRequest, CancellationToken)

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.

Public Method CreateCustomEntityType(CreateCustomEntityTypeRequest)

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.

Public Method CreateCustomEntityTypeAsync(CreateCustomEntityTypeRequest, CancellationToken)

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.

Public Method CreateDatabase(CreateDatabaseRequest)

Creates a new database in a Data Catalog.

Public Method CreateDatabaseAsync(CreateDatabaseRequest, CancellationToken)

Creates a new database in a Data Catalog.

Public Method CreateDataQualityRuleset(CreateDataQualityRulesetRequest)

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.

Public Method CreateDataQualityRulesetAsync(CreateDataQualityRulesetRequest, CancellationToken)

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.

Public Method CreateDevEndpoint(CreateDevEndpointRequest)

Creates a new development endpoint.

Public Method CreateDevEndpointAsync(CreateDevEndpointRequest, CancellationToken)

Creates a new development endpoint.

Public Method CreateJob(CreateJobRequest)

Creates a new job definition.

Public Method CreateJobAsync(CreateJobRequest, CancellationToken)

Creates a new job definition.

Public Method CreateMLTransform(CreateMLTransformRequest)

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

Public Method CreateMLTransformAsync(CreateMLTransformRequest, CancellationToken)

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

Public Method CreatePartition(CreatePartitionRequest)

Creates a new partition.

Public Method CreatePartitionAsync(CreatePartitionRequest, CancellationToken)

Creates a new partition.

Public Method CreatePartitionIndex(CreatePartitionIndexRequest)

Creates a specified partition index in an existing table.

Public Method CreatePartitionIndexAsync(CreatePartitionIndexRequest, CancellationToken)

Creates a specified partition index in an existing table.

Public Method CreateRegistry(CreateRegistryRequest)

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

Public Method CreateRegistryAsync(CreateRegistryRequest, CancellationToken)

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

Public Method CreateSchema(CreateSchemaRequest)

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.

Public Method CreateSchemaAsync(CreateSchemaRequest, CancellationToken)

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.

Public Method CreateScript(CreateScriptRequest)

Transforms a directed acyclic graph (DAG) into code.

Public Method CreateScriptAsync(CreateScriptRequest, CancellationToken)

Transforms a directed acyclic graph (DAG) into code.

Public Method CreateSecurityConfiguration(CreateSecurityConfigurationRequest)

Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.

Public Method CreateSecurityConfigurationAsync(CreateSecurityConfigurationRequest, CancellationToken)

Creates a new security configuration. A security configuration is a set of security properties that can be used by Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.

Public Method CreateSession(CreateSessionRequest)

Creates a new session.

Public Method CreateSessionAsync(CreateSessionRequest, CancellationToken)

Creates a new session.

Public Method CreateTable(CreateTableRequest)

Creates a new table definition in the Data Catalog.

Public Method CreateTableAsync(CreateTableRequest, CancellationToken)

Creates a new table definition in the Data Catalog.

Public Method CreateTableOptimizer(CreateTableOptimizerRequest)

Creates a new table optimizer for a specific function. compaction is the only currently supported optimizer type.

Public Method CreateTableOptimizerAsync(CreateTableOptimizerRequest, CancellationToken)

Creates a new table optimizer for a specific function. compaction is the only currently supported optimizer type.

Public Method CreateTrigger(CreateTriggerRequest)

Creates a new trigger.

Public Method CreateTriggerAsync(CreateTriggerRequest, CancellationToken)

Creates a new trigger.

Public Method CreateUserDefinedFunction(CreateUserDefinedFunctionRequest)

Creates a new function definition in the Data Catalog.

Public Method CreateUserDefinedFunctionAsync(CreateUserDefinedFunctionRequest, CancellationToken)

Creates a new function definition in the Data Catalog.

Public Method CreateWorkflow(CreateWorkflowRequest)

Creates a new workflow.

Public Method CreateWorkflowAsync(CreateWorkflowRequest, CancellationToken)

Creates a new workflow.

Public Method DeleteBlueprint(DeleteBlueprintRequest)

Deletes an existing blueprint.

Public Method DeleteBlueprintAsync(DeleteBlueprintRequest, CancellationToken)

Deletes an existing blueprint.

Public Method DeleteClassifier(DeleteClassifierRequest)

Removes a classifier from the Data Catalog.

Public Method DeleteClassifierAsync(DeleteClassifierRequest, CancellationToken)

Removes a classifier from the Data Catalog.

Public Method DeleteColumnStatisticsForPartition(DeleteColumnStatisticsForPartitionRequest)

Delete the partition column statistics of a column.

The Identity and Access Management (IAM) permission required for this operation is DeletePartition.

Public Method DeleteColumnStatisticsForPartitionAsync(DeleteColumnStatisticsForPartitionRequest, CancellationToken)

Delete the partition column statistics of a column.

The Identity and Access Management (IAM) permission required for this operation is DeletePartition.

Public Method DeleteColumnStatisticsForTable(DeleteColumnStatisticsForTableRequest)

Retrieves table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is DeleteTable.

Public Method DeleteColumnStatisticsForTableAsync(DeleteColumnStatisticsForTableRequest, CancellationToken)

Retrieves table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is DeleteTable.

Public Method DeleteConnection(DeleteConnectionRequest)

Deletes a connection from the Data Catalog.

Public Method DeleteConnectionAsync(DeleteConnectionRequest, CancellationToken)

Deletes a connection from the Data Catalog.

Public Method DeleteCrawler(DeleteCrawlerRequest)

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

Public Method DeleteCrawlerAsync(DeleteCrawlerRequest, CancellationToken)

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

Public Method DeleteCustomEntityType(DeleteCustomEntityTypeRequest)

Deletes a custom pattern by specifying its name.

Public Method DeleteCustomEntityTypeAsync(DeleteCustomEntityTypeRequest, CancellationToken)

Deletes a custom pattern by specifying its name.

Public Method DeleteDatabase(DeleteDatabaseRequest)

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

Public Method DeleteDatabaseAsync(DeleteDatabaseRequest, CancellationToken)

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

Public Method DeleteDataQualityRuleset(DeleteDataQualityRulesetRequest)

Deletes a data quality ruleset.

Public Method DeleteDataQualityRulesetAsync(DeleteDataQualityRulesetRequest, CancellationToken)

Deletes a data quality ruleset.

Public Method DeleteDevEndpoint(DeleteDevEndpointRequest)

Deletes a specified development endpoint.

Public Method DeleteDevEndpointAsync(DeleteDevEndpointRequest, CancellationToken)

Deletes a specified development endpoint.

Public Method DeleteJob(DeleteJobRequest)

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

Public Method DeleteJobAsync(DeleteJobRequest, CancellationToken)

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

Public Method DeleteMLTransform(DeleteMLTransformRequest)

Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms. However, any Glue jobs that still reference the deleted transform will no longer succeed.

Public Method DeleteMLTransformAsync(DeleteMLTransformRequest, CancellationToken)

Deletes an Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms. However, any Glue jobs that still reference the deleted transform will no longer succeed.

Public Method DeletePartition(DeletePartitionRequest)

Deletes a specified partition.

Public Method DeletePartitionAsync(DeletePartitionRequest, CancellationToken)

Deletes a specified partition.

Public Method DeletePartitionIndex(DeletePartitionIndexRequest)

Deletes a specified partition index from an existing table.

Public Method DeletePartitionIndexAsync(DeletePartitionIndexRequest, CancellationToken)

Deletes a specified partition index from an existing table.

Public Method DeleteRegistry(DeleteRegistryRequest)

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, UpdateSchema, and RegisterSchemaVersion APIs.

Public Method DeleteRegistryAsync(DeleteRegistryRequest, CancellationToken)

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, UpdateSchema, and RegisterSchemaVersion APIs.

Public Method DeleteResourcePolicy(DeleteResourcePolicyRequest)

Deletes a specified policy.

Public Method DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken)

Deletes a specified policy.

Public Method DeleteSchema(DeleteSchemaRequest)

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 RegisterSchemaVersion APIs.

Public Method DeleteSchemaAsync(DeleteSchemaRequest, CancellationToken)

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 RegisterSchemaVersion APIs.

Public Method DeleteSchemaVersions(DeleteSchemaVersionsRequest)

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.

Public Method DeleteSchemaVersionsAsync(DeleteSchemaVersionsRequest, CancellationToken)

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.

Public Method DeleteSecurityConfiguration(DeleteSecurityConfigurationRequest)

Deletes a specified security configuration.

Public Method DeleteSecurityConfigurationAsync(DeleteSecurityConfigurationRequest, CancellationToken)

Deletes a specified security configuration.

Public Method DeleteSession(DeleteSessionRequest)

Deletes the session.

Public Method DeleteSessionAsync(DeleteSessionRequest, CancellationToken)

Deletes the session.

Public Method DeleteTable(DeleteTableRequest)

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

Public Method DeleteTableAsync(DeleteTableRequest, CancellationToken)

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

Public Method DeleteTableOptimizer(DeleteTableOptimizerRequest)

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

Public Method DeleteTableOptimizerAsync(DeleteTableOptimizerRequest, CancellationToken)

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

Public Method DeleteTableVersion(DeleteTableVersionRequest)

Deletes a specified version of a table.

Public Method DeleteTableVersionAsync(DeleteTableVersionRequest, CancellationToken)

Deletes a specified version of a table.

Public Method DeleteTrigger(DeleteTriggerRequest)

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

Public Method DeleteTriggerAsync(DeleteTriggerRequest, CancellationToken)

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

Public Method DeleteUserDefinedFunction(DeleteUserDefinedFunctionRequest)

Deletes an existing function definition from the Data Catalog.

Public Method DeleteUserDefinedFunctionAsync(DeleteUserDefinedFunctionRequest, CancellationToken)

Deletes an existing function definition from the Data Catalog.

Public Method DeleteWorkflow(DeleteWorkflowRequest)

Deletes a workflow.

Public Method DeleteWorkflowAsync(DeleteWorkflowRequest, CancellationToken)

Deletes a workflow.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method GetBlueprint(GetBlueprintRequest)

Retrieves the details of a blueprint.

Public Method GetBlueprintAsync(GetBlueprintRequest, CancellationToken)

Retrieves the details of a blueprint.

Public Method GetBlueprintRun(GetBlueprintRunRequest)

Retrieves the details of a blueprint run.

Public Method GetBlueprintRunAsync(GetBlueprintRunRequest, CancellationToken)

Retrieves the details of a blueprint run.

Public Method GetBlueprintRuns(GetBlueprintRunsRequest)

Retrieves the details of blueprint runs for a specified blueprint.

Public Method GetBlueprintRunsAsync(GetBlueprintRunsRequest, CancellationToken)

Retrieves the details of blueprint runs for a specified blueprint.

Public Method GetCatalogImportStatus(GetCatalogImportStatusRequest)

Retrieves the status of a migration operation.

Public Method GetCatalogImportStatusAsync(GetCatalogImportStatusRequest, CancellationToken)

Retrieves the status of a migration operation.

Public Method GetClassifier(GetClassifierRequest)

Retrieve a classifier by name.

Public Method GetClassifierAsync(GetClassifierRequest, CancellationToken)

Retrieve a classifier by name.

Public Method GetClassifiers(GetClassifiersRequest)

Lists all classifier objects in the Data Catalog.

Public Method GetClassifiersAsync(GetClassifiersRequest, CancellationToken)

Lists all classifier objects in the Data Catalog.

Public Method GetColumnStatisticsForPartition(GetColumnStatisticsForPartitionRequest)

Retrieves partition statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is GetPartition.

Public Method GetColumnStatisticsForPartitionAsync(GetColumnStatisticsForPartitionRequest, CancellationToken)

Retrieves partition statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is GetPartition.

Public Method GetColumnStatisticsForTable(GetColumnStatisticsForTableRequest)

Retrieves table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is GetTable.

Public Method GetColumnStatisticsForTableAsync(GetColumnStatisticsForTableRequest, CancellationToken)

Retrieves table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is GetTable.

Public Method GetColumnStatisticsTaskRun(GetColumnStatisticsTaskRunRequest)

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

Public Method GetColumnStatisticsTaskRunAsync(GetColumnStatisticsTaskRunRequest, CancellationToken)

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

Public Method GetColumnStatisticsTaskRuns(GetColumnStatisticsTaskRunsRequest)

Retrieves information about all runs associated with the specified table.

Public Method GetColumnStatisticsTaskRunsAsync(GetColumnStatisticsTaskRunsRequest, CancellationToken)

Retrieves information about all runs associated with the specified table.

Public Method GetConnection(GetConnectionRequest)

Retrieves a connection definition from the Data Catalog.

Public Method GetConnectionAsync(GetConnectionRequest, CancellationToken)

Retrieves a connection definition from the Data Catalog.

Public Method GetConnections(GetConnectionsRequest)

Retrieves a list of connection definitions from the Data Catalog.

Public Method GetConnectionsAsync(GetConnectionsRequest, CancellationToken)

Retrieves a list of connection definitions from the Data Catalog.

Public Method GetCrawler(GetCrawlerRequest)

Retrieves metadata for a specified crawler.

Public Method GetCrawlerAsync(GetCrawlerRequest, CancellationToken)

Retrieves metadata for a specified crawler.

Public Method GetCrawlerMetrics(GetCrawlerMetricsRequest)

Retrieves metrics about specified crawlers.

Public Method GetCrawlerMetricsAsync(GetCrawlerMetricsRequest, CancellationToken)

Retrieves metrics about specified crawlers.

Public Method GetCrawlers(GetCrawlersRequest)

Retrieves metadata for all crawlers defined in the customer account.

Public Method GetCrawlersAsync(GetCrawlersRequest, CancellationToken)

Retrieves metadata for all crawlers defined in the customer account.

Public Method GetCustomEntityType(GetCustomEntityTypeRequest)

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

Public Method GetCustomEntityTypeAsync(GetCustomEntityTypeRequest, CancellationToken)

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

Public Method GetDatabase(GetDatabaseRequest)

Retrieves the definition of a specified database.

Public Method GetDatabaseAsync(GetDatabaseRequest, CancellationToken)

Retrieves the definition of a specified database.

Public Method GetDatabases(GetDatabasesRequest)

Retrieves all databases defined in a given Data Catalog.

Public Method GetDatabasesAsync(GetDatabasesRequest, CancellationToken)

Retrieves all databases defined in a given Data Catalog.

Public Method GetDataCatalogEncryptionSettings(GetDataCatalogEncryptionSettingsRequest)

Retrieves the security configuration for a specified catalog.

Public Method GetDataCatalogEncryptionSettingsAsync(GetDataCatalogEncryptionSettingsRequest, CancellationToken)

Retrieves the security configuration for a specified catalog.

Public Method GetDataflowGraph(GetDataflowGraphRequest)

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

Public Method GetDataflowGraphAsync(GetDataflowGraphRequest, CancellationToken)

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

Public Method GetDataQualityResult(GetDataQualityResultRequest)

Retrieves the result of a data quality rule evaluation.

Public Method GetDataQualityResultAsync(GetDataQualityResultRequest, CancellationToken)

Retrieves the result of a data quality rule evaluation.

Public Method GetDataQualityRuleRecommendationRun(GetDataQualityRuleRecommendationRunRequest)

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

Public Method GetDataQualityRuleRecommendationRunAsync(GetDataQualityRuleRecommendationRunRequest, CancellationToken)

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

Public Method GetDataQualityRuleset(GetDataQualityRulesetRequest)

Returns an existing ruleset by identifier or name.

Public Method GetDataQualityRulesetAsync(GetDataQualityRulesetRequest, CancellationToken)

Returns an existing ruleset by identifier or name.

Public Method GetDataQualityRulesetEvaluationRun(GetDataQualityRulesetEvaluationRunRequest)

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

Public Method GetDataQualityRulesetEvaluationRunAsync(GetDataQualityRulesetEvaluationRunRequest, CancellationToken)

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

Public Method GetDevEndpoint(GetDevEndpointRequest)

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 IP address.

Public Method GetDevEndpointAsync(GetDevEndpointRequest, CancellationToken)

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 IP address.

Public Method GetDevEndpoints(GetDevEndpointsRequest)

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 only a public IP address.

Public Method GetDevEndpointsAsync(GetDevEndpointsRequest, CancellationToken)

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 only a public IP address.

Public Method GetJob(GetJobRequest)

Retrieves an existing job definition.

Public Method GetJobAsync(GetJobRequest, CancellationToken)

Retrieves an existing job definition.

Public Method GetJobBookmark(GetJobBookmarkRequest)

Returns information on a job bookmark entry.

For more information about enabling and using job bookmarks, see:

Public Method GetJobBookmarkAsync(GetJobBookmarkRequest, CancellationToken)

Returns information on a job bookmark entry.

For more information about enabling and using job bookmarks, see:

Public Method GetJobRun(GetJobRunRequest)

Retrieves the metadata for a given job run.

Public Method GetJobRunAsync(GetJobRunRequest, CancellationToken)

Retrieves the metadata for a given job run.

Public Method GetJobRuns(GetJobRunsRequest)

Retrieves metadata for all runs of a given job definition.

Public Method GetJobRunsAsync(GetJobRunsRequest, CancellationToken)

Retrieves metadata for all runs of a given job definition.

Public Method GetJobs(GetJobsRequest)

Retrieves all current job definitions.

Public Method GetJobsAsync(GetJobsRequest, CancellationToken)

Retrieves all current job definitions.

Public Method GetMapping(GetMappingRequest)

Creates mappings.

Public Method GetMappingAsync(GetMappingRequest, CancellationToken)

Creates mappings.

Public Method GetMLTaskRun(GetMLTaskRunRequest)

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 transform's TransformID.

Public Method GetMLTaskRunAsync(GetMLTaskRunRequest, CancellationToken)

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 transform's TransformID.

Public Method GetMLTaskRuns(GetMLTaskRunsRequest)

Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform's TransformID and other optional parameters as documented in this section.

This operation returns a list of historic runs and must be paginated.

Public Method GetMLTaskRunsAsync(GetMLTaskRunsRequest, CancellationToken)

Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform's TransformID and other optional parameters as documented in this section.

This operation returns a list of historic runs and must be paginated.

Public Method GetMLTransform(GetMLTransformRequest)

Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform.

Public Method GetMLTransformAsync(GetMLTransformRequest, CancellationToken)

Gets an Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue. You can retrieve their metadata by calling GetMLTransform.

Public Method GetMLTransforms(GetMLTransformsRequest)

Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling GetMLTransforms.

Public Method GetMLTransformsAsync(GetMLTransformsRequest, CancellationToken)

Gets a sortable, filterable list of existing Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by Glue, and you can retrieve their metadata by calling GetMLTransforms.

Public Method GetPartition(GetPartitionRequest)

Retrieves information about a specified partition.

Public Method GetPartitionAsync(GetPartitionRequest, CancellationToken)

Retrieves information about a specified partition.

Public Method GetPartitionIndexes(GetPartitionIndexesRequest)

Retrieves the partition indexes associated with a table.

Public Method GetPartitionIndexesAsync(GetPartitionIndexesRequest, CancellationToken)

Retrieves the partition indexes associated with a table.

Public Method GetPartitions(GetPartitionsRequest)

Retrieves information about the partitions in a table.

Public Method GetPartitionsAsync(GetPartitionsRequest, CancellationToken)

Retrieves information about the partitions in a table.

Public Method GetPlan(GetPlanRequest)

Gets code to perform a specified mapping.

Public Method GetPlanAsync(GetPlanRequest, CancellationToken)

Gets code to perform a specified mapping.

Public Method GetRegistry(GetRegistryRequest)

Describes the specified registry in detail.

Public Method GetRegistryAsync(GetRegistryRequest, CancellationToken)

Describes the specified registry in detail.

Public Method GetResourcePolicies(GetResourcePoliciesRequest)

Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.

If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can't return the Data Catalog resource policy.

Public Method GetResourcePoliciesAsync(GetResourcePoliciesRequest, CancellationToken)

Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants. Also retrieves the Data Catalog resource policy.

If you enabled metadata encryption in Data Catalog settings, and you do not have permission on the KMS key, the operation can't return the Data Catalog resource policy.

Public Method GetResourcePolicy(GetResourcePolicyRequest)

Retrieves a specified resource policy.

Public Method GetResourcePolicyAsync(GetResourcePolicyRequest, CancellationToken)

Retrieves a specified resource policy.

Public Method GetSchema(GetSchemaRequest)

Describes the specified schema in detail.

Public Method GetSchemaAsync(GetSchemaRequest, CancellationToken)

Describes the specified schema in detail.

Public Method GetSchemaByDefinition(GetSchemaByDefinitionRequest)

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.

Public Method GetSchemaByDefinitionAsync(GetSchemaByDefinitionRequest, CancellationToken)

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.

Public Method GetSchemaVersion(GetSchemaVersionRequest)

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.

Public Method GetSchemaVersionAsync(GetSchemaVersionRequest, CancellationToken)

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.

Public Method GetSchemaVersionsDiff(GetSchemaVersionsDiffRequest)

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.

Public Method GetSchemaVersionsDiffAsync(GetSchemaVersionsDiffRequest, CancellationToken)

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.

Public Method GetSecurityConfiguration(GetSecurityConfigurationRequest)

Retrieves a specified security configuration.

Public Method GetSecurityConfigurationAsync(GetSecurityConfigurationRequest, CancellationToken)

Retrieves a specified security configuration.

Public Method GetSecurityConfigurations(GetSecurityConfigurationsRequest)

Retrieves a list of all security configurations.

Public Method GetSecurityConfigurationsAsync(GetSecurityConfigurationsRequest, CancellationToken)

Retrieves a list of all security configurations.

Public Method GetSession(GetSessionRequest)

Retrieves the session.

Public Method GetSessionAsync(GetSessionRequest, CancellationToken)

Retrieves the session.

Public Method GetStatement(GetStatementRequest)

Retrieves the statement.

Public Method GetStatementAsync(GetStatementRequest, CancellationToken)

Retrieves the statement.

Public Method GetTable(GetTableRequest)

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

Public Method GetTableAsync(GetTableRequest, CancellationToken)

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

Public Method GetTableOptimizer(GetTableOptimizerRequest)

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

Public Method GetTableOptimizerAsync(GetTableOptimizerRequest, CancellationToken)

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

Public Method GetTables(GetTablesRequest)

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

Public Method GetTablesAsync(GetTablesRequest, CancellationToken)

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

Public Method GetTableVersion(GetTableVersionRequest)

Retrieves a specified version of a table.

Public Method GetTableVersionAsync(GetTableVersionRequest, CancellationToken)

Retrieves a specified version of a table.

Public Method GetTableVersions(GetTableVersionsRequest)

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

Public Method GetTableVersionsAsync(GetTableVersionsRequest, CancellationToken)

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

Public Method GetTags(GetTagsRequest)

Retrieves a list of tags associated with a resource.

Public Method GetTagsAsync(GetTagsRequest, CancellationToken)

Retrieves a list of tags associated with a resource.

Public Method GetTrigger(GetTriggerRequest)

Retrieves the definition of a trigger.

Public Method GetTriggerAsync(GetTriggerRequest, CancellationToken)

Retrieves the definition of a trigger.

Public Method GetTriggers(GetTriggersRequest)

Gets all the triggers associated with a job.

Public Method GetTriggersAsync(GetTriggersRequest, CancellationToken)

Gets all the triggers associated with a job.

Public Method GetUnfilteredPartitionMetadata(GetUnfilteredPartitionMetadataRequest)

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.

Public Method GetUnfilteredPartitionMetadataAsync(GetUnfilteredPartitionMetadataRequest, CancellationToken)

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.

Public Method GetUnfilteredPartitionsMetadata(GetUnfilteredPartitionsMetadataRequest)

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.

Public Method GetUnfilteredPartitionsMetadataAsync(GetUnfilteredPartitionsMetadataRequest, CancellationToken)

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.

Public Method GetUnfilteredTableMetadata(GetUnfilteredTableMetadataRequest)

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.

Public Method GetUnfilteredTableMetadataAsync(GetUnfilteredTableMetadataRequest, CancellationToken)

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.

Public Method GetUserDefinedFunction(GetUserDefinedFunctionRequest)

Retrieves a specified function definition from the Data Catalog.

Public Method GetUserDefinedFunctionAsync(GetUserDefinedFunctionRequest, CancellationToken)

Retrieves a specified function definition from the Data Catalog.

Public Method GetUserDefinedFunctions(GetUserDefinedFunctionsRequest)

Retrieves multiple function definitions from the Data Catalog.

Public Method GetUserDefinedFunctionsAsync(GetUserDefinedFunctionsRequest, CancellationToken)

Retrieves multiple function definitions from the Data Catalog.

Public Method GetWorkflow(GetWorkflowRequest)

Retrieves resource metadata for a workflow.

Public Method GetWorkflowAsync(GetWorkflowRequest, CancellationToken)

Retrieves resource metadata for a workflow.

Public Method GetWorkflowRun(GetWorkflowRunRequest)

Retrieves the metadata for a given workflow run.

Public Method GetWorkflowRunAsync(GetWorkflowRunRequest, CancellationToken)

Retrieves the metadata for a given workflow run.

Public Method GetWorkflowRunProperties(GetWorkflowRunPropertiesRequest)

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

Public Method GetWorkflowRunPropertiesAsync(GetWorkflowRunPropertiesRequest, CancellationToken)

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

Public Method GetWorkflowRuns(GetWorkflowRunsRequest)

Retrieves metadata for all runs of a given workflow.

Public Method GetWorkflowRunsAsync(GetWorkflowRunsRequest, CancellationToken)

Retrieves metadata for all runs of a given workflow.

Public Method ImportCatalogToGlue(ImportCatalogToGlueRequest)

Imports an existing Amazon Athena Data Catalog to Glue.

Public Method ImportCatalogToGlueAsync(ImportCatalogToGlueRequest, CancellationToken)

Imports an existing Amazon Athena Data Catalog to Glue.

Public Method ListBlueprints(ListBlueprintsRequest)

Lists all the blueprint names in an account.

Public Method ListBlueprintsAsync(ListBlueprintsRequest, CancellationToken)

Lists all the blueprint names in an account.

Public Method ListColumnStatisticsTaskRuns(ListColumnStatisticsTaskRunsRequest)

List all task runs for a particular account.

Public Method ListColumnStatisticsTaskRunsAsync(ListColumnStatisticsTaskRunsRequest, CancellationToken)

List all task runs for a particular account.

Public Method ListCrawlers(ListCrawlersRequest)

Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Public Method ListCrawlersAsync(ListCrawlersRequest, CancellationToken)

Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Public Method ListCrawls(ListCrawlsRequest)

Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.

You may use this API to:

  • Retrive all the crawls of a specified crawler.

  • Retrieve all the crawls of a specified crawler within a limited count.

  • Retrieve all the crawls of a specified crawler in a specific time range.

  • Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.

Public Method ListCrawlsAsync(ListCrawlsRequest, CancellationToken)

Returns all the crawls of a specified crawler. Returns only the crawls that have occurred since the launch date of the crawler history feature, and only retains up to 12 months of crawls. Older crawls will not be returned.

You may use this API to:

  • Retrive all the crawls of a specified crawler.

  • Retrieve all the crawls of a specified crawler within a limited count.

  • Retrieve all the crawls of a specified crawler in a specific time range.

  • Retrieve all the crawls of a specified crawler with a particular state, crawl ID, or DPU hour value.

Public Method ListCustomEntityTypes(ListCustomEntityTypesRequest)

Lists all the custom patterns that have been created.

Public Method ListCustomEntityTypesAsync(ListCustomEntityTypesRequest, CancellationToken)

Lists all the custom patterns that have been created.

Public Method ListDataQualityResults(ListDataQualityResultsRequest)

Returns all data quality execution results for your account.

Public Method ListDataQualityResultsAsync(ListDataQualityResultsRequest, CancellationToken)

Returns all data quality execution results for your account.

Public Method ListDataQualityRuleRecommendationRuns(ListDataQualityRuleRecommendationRunsRequest)

Lists the recommendation runs meeting the filter criteria.

Public Method ListDataQualityRuleRecommendationRunsAsync(ListDataQualityRuleRecommendationRunsRequest, CancellationToken)

Lists the recommendation runs meeting the filter criteria.

Public Method ListDataQualityRulesetEvaluationRuns(ListDataQualityRulesetEvaluationRunsRequest)

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

Public Method ListDataQualityRulesetEvaluationRunsAsync(ListDataQualityRulesetEvaluationRunsRequest, CancellationToken)

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

Public Method ListDataQualityRulesets(ListDataQualityRulesetsRequest)

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

Public Method ListDataQualityRulesetsAsync(ListDataQualityRulesetsRequest, CancellationToken)

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

Public Method ListDevEndpoints(ListDevEndpointsRequest)

Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Public Method ListDevEndpointsAsync(ListDevEndpointsRequest, CancellationToken)

Retrieves the names of all DevEndpoint resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Public Method ListJobs(ListJobsRequest)

Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Public Method ListMLTransforms(ListMLTransformsRequest)

Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.

Public Method ListMLTransformsAsync(ListMLTransformsRequest, CancellationToken)

Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag. This operation takes the optional Tags field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved.

Public Method ListRegistries(ListRegistriesRequest)

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.

Public Method ListRegistriesAsync(ListRegistriesRequest, CancellationToken)

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.

Public Method ListSchemas(ListSchemasRequest)

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.

Public Method ListSchemasAsync(ListSchemasRequest, CancellationToken)

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.

Public Method ListSchemaVersions(ListSchemaVersionsRequest)

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.

Public Method ListSchemaVersionsAsync(ListSchemaVersionsRequest, CancellationToken)

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.

Public Method ListSessions(ListSessionsRequest)

Retrieve a list of sessions.

Public Method ListSessionsAsync(ListSessionsRequest, CancellationToken)

Retrieve a list of sessions.

Public Method ListStatements(ListStatementsRequest)

Lists statements for the session.

Public Method ListStatementsAsync(ListStatementsRequest, CancellationToken)

Lists statements for the session.

Public Method ListTableOptimizerRuns(ListTableOptimizerRunsRequest)

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

Public Method ListTableOptimizerRunsAsync(ListTableOptimizerRunsRequest, CancellationToken)

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

Public Method ListTriggers(ListTriggersRequest)

Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Public Method ListTriggersAsync(ListTriggersRequest, CancellationToken)

Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

Public Method ListWorkflows(ListWorkflowsRequest)

Lists names of workflows created in the account.

Public Method ListWorkflowsAsync(ListWorkflowsRequest, CancellationToken)

Lists names of workflows created in the account.

Public Method PutDataCatalogEncryptionSettings(PutDataCatalogEncryptionSettingsRequest)

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

Public Method PutDataCatalogEncryptionSettingsAsync(PutDataCatalogEncryptionSettingsRequest, CancellationToken)

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

Public Method PutResourcePolicy(PutResourcePolicyRequest)

Sets the Data Catalog resource policy for access control.

Public Method PutResourcePolicyAsync(PutResourcePolicyRequest, CancellationToken)

Sets the Data Catalog resource policy for access control.

Public Method PutSchemaVersionMetadata(PutSchemaVersionMetadataRequest)

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.

Public Method PutSchemaVersionMetadataAsync(PutSchemaVersionMetadataRequest, CancellationToken)

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.

Public Method PutWorkflowRunProperties(PutWorkflowRunPropertiesRequest)

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.

Public Method PutWorkflowRunPropertiesAsync(PutWorkflowRunPropertiesRequest, CancellationToken)

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.

Public Method QuerySchemaVersionMetadata(QuerySchemaVersionMetadataRequest)

Queries for the schema version metadata information.

Public Method QuerySchemaVersionMetadataAsync(QuerySchemaVersionMetadataRequest, CancellationToken)

Queries for the schema version metadata information.

Public Method RegisterSchemaVersion(RegisterSchemaVersionRequest)

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.

Public Method RegisterSchemaVersionAsync(RegisterSchemaVersionRequest, CancellationToken)

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.

Public Method RemoveSchemaVersionMetadata(RemoveSchemaVersionMetadataRequest)

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

Public Method RemoveSchemaVersionMetadataAsync(RemoveSchemaVersionMetadataRequest, CancellationToken)

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

Public Method ResetJobBookmark(ResetJobBookmarkRequest)

Resets a bookmark entry.

For more information about enabling and using job bookmarks, see:

Public Method ResetJobBookmarkAsync(ResetJobBookmarkRequest, CancellationToken)

Resets a bookmark entry.

For more information about enabling and using job bookmarks, see:

Public Method ResumeWorkflowRun(ResumeWorkflowRunRequest)

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.

Public Method ResumeWorkflowRunAsync(ResumeWorkflowRunRequest, CancellationToken)

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.

Public Method RunStatement(RunStatementRequest)

Executes the statement.

Public Method RunStatementAsync(RunStatementRequest, CancellationToken)

Executes the statement.

Public Method SearchTables(SearchTablesRequest)

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.

Public Method SearchTablesAsync(SearchTablesRequest, CancellationToken)

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.

Public Method StartBlueprintRun(StartBlueprintRunRequest)

Starts a new run of the specified blueprint.

Public Method StartBlueprintRunAsync(StartBlueprintRunRequest, CancellationToken)

Starts a new run of the specified blueprint.

Public Method StartColumnStatisticsTaskRun(StartColumnStatisticsTaskRunRequest)

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

Public Method StartColumnStatisticsTaskRunAsync(StartColumnStatisticsTaskRunRequest, CancellationToken)

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

Public Method StartCrawler(StartCrawlerRequest)

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

Public Method StartCrawlerAsync(StartCrawlerRequest, CancellationToken)

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

Public Method StartCrawlerSchedule(StartCrawlerScheduleRequest)

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

Public Method StartCrawlerScheduleAsync(StartCrawlerScheduleRequest, CancellationToken)

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

Public Method StartDataQualityRuleRecommendationRun(StartDataQualityRuleRecommendationRunRequest)

Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.

Recommendation runs are automatically deleted after 90 days.

Public Method StartDataQualityRuleRecommendationRunAsync(StartDataQualityRuleRecommendationRunRequest, CancellationToken)

Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.

Recommendation runs are automatically deleted after 90 days.

Public Method StartDataQualityRulesetEvaluationRun(StartDataQualityRulesetEvaluationRunRequest)

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.

Public Method StartDataQualityRulesetEvaluationRunAsync(StartDataQualityRulesetEvaluationRunRequest, CancellationToken)

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.

Public Method StartExportLabelsTaskRun(StartExportLabelsTaskRunRequest)

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.

Public Method StartExportLabelsTaskRunAsync(StartExportLabelsTaskRunRequest, CancellationToken)

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.

Public Method StartImportLabelsTaskRun(StartImportLabelsTaskRunRequest)

Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning transform.

After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called 'labeling' in the machine learning workflows). In the case of 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.

Public Method StartImportLabelsTaskRunAsync(StartImportLabelsTaskRunRequest, CancellationToken)

Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning transform.

After the StartMLLabelingSetGenerationTaskRun finishes, Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called 'labeling' in the machine learning workflows). In the case of 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.

Public Method StartJobRun(StartJobRunRequest)

Starts a job run using a job definition.

Public Method StartJobRunAsync(StartJobRunRequest, CancellationToken)

Starts a job run using a job definition.

Public Method StartMLEvaluationTaskRun(StartMLEvaluationTaskRunRequest)

Starts a task to estimate the quality of the transform.

When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.

Returns a unique identifier for the run. You can call GetMLTaskRun to get more information about the stats of the EvaluationTaskRun.

Public Method StartMLEvaluationTaskRunAsync(StartMLEvaluationTaskRunRequest, CancellationToken)

Starts a task to estimate the quality of the transform.

When you provide label sets as examples of truth, Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.

Returns a unique identifier for the run. You can call GetMLTaskRun to get more information about the stats of the EvaluationTaskRun.

Public Method StartMLLabelingSetGenerationTaskRun(StartMLLabelingSetGenerationTaskRunRequest)

Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.

When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.

In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”

After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.

Public Method StartMLLabelingSetGenerationTaskRunAsync(StartMLLabelingSetGenerationTaskRunRequest, CancellationToken)

Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.

When the StartMLLabelingSetGenerationTaskRun finishes, Glue will have generated a "labeling set" or a set of questions for humans to answer.

In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”

After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.

Public Method StartTrigger(StartTriggerRequest)

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

Public Method StartTriggerAsync(StartTriggerRequest, CancellationToken)

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

Public Method StartWorkflowRun(StartWorkflowRunRequest)

Starts a new run of the specified workflow.

Public Method StartWorkflowRunAsync(StartWorkflowRunRequest, CancellationToken)

Starts a new run of the specified workflow.

Public Method StopColumnStatisticsTaskRun(StopColumnStatisticsTaskRunRequest)

Stops a task run for the specified table.

Public Method StopColumnStatisticsTaskRunAsync(StopColumnStatisticsTaskRunRequest, CancellationToken)

Stops a task run for the specified table.

Public Method StopCrawler(StopCrawlerRequest)

If the specified crawler is running, stops the crawl.

Public Method StopCrawlerAsync(StopCrawlerRequest, CancellationToken)

If the specified crawler is running, stops the crawl.

Public Method StopCrawlerSchedule(StopCrawlerScheduleRequest)

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

Public Method StopCrawlerScheduleAsync(StopCrawlerScheduleRequest, CancellationToken)

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

Public Method StopSession(StopSessionRequest)

Stops the session.

Public Method StopSessionAsync(StopSessionRequest, CancellationToken)

Stops the session.

Public Method StopTrigger(StopTriggerRequest)

Stops a specified trigger.

Public Method StopTriggerAsync(StopTriggerRequest, CancellationToken)

Stops a specified trigger.

Public Method StopWorkflowRun(StopWorkflowRunRequest)

Stops the execution of the specified workflow run.

Public Method StopWorkflowRunAsync(StopWorkflowRunRequest, CancellationToken)

Stops the execution of the specified workflow run.

Public Method TagResource(TagResourceRequest)

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.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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.

Public Method UntagResource(UntagResourceRequest)

Removes tags from a resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from a resource.

Public Method UpdateBlueprint(UpdateBlueprintRequest)

Updates a registered blueprint.

Public Method UpdateBlueprintAsync(UpdateBlueprintRequest, CancellationToken)

Updates a registered blueprint.

Public Method UpdateClassifier(UpdateClassifierRequest)

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

Public Method UpdateClassifierAsync(UpdateClassifierRequest, CancellationToken)

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

Public Method UpdateColumnStatisticsForPartition(UpdateColumnStatisticsForPartitionRequest)

Creates or updates partition statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.

Public Method UpdateColumnStatisticsForPartitionAsync(UpdateColumnStatisticsForPartitionRequest, CancellationToken)

Creates or updates partition statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.

Public Method UpdateColumnStatisticsForTable(UpdateColumnStatisticsForTableRequest)

Creates or updates table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is UpdateTable.

Public Method UpdateColumnStatisticsForTableAsync(UpdateColumnStatisticsForTableRequest, CancellationToken)

Creates or updates table statistics of columns.

The Identity and Access Management (IAM) permission required for this operation is UpdateTable.

Public Method UpdateConnection(UpdateConnectionRequest)

Updates a connection definition in the Data Catalog.

Public Method UpdateConnectionAsync(UpdateConnectionRequest, CancellationToken)

Updates a connection definition in the Data Catalog.

Public Method UpdateCrawler(UpdateCrawlerRequest)

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

Public Method UpdateCrawlerAsync(UpdateCrawlerRequest, CancellationToken)

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

Public Method UpdateCrawlerSchedule(UpdateCrawlerScheduleRequest)

Updates the schedule of a crawler using a cron expression.

Public Method UpdateCrawlerScheduleAsync(UpdateCrawlerScheduleRequest, CancellationToken)

Updates the schedule of a crawler using a cron expression.

Public Method UpdateDatabase(UpdateDatabaseRequest)

Updates an existing database definition in a Data Catalog.

Public Method UpdateDatabaseAsync(UpdateDatabaseRequest, CancellationToken)

Updates an existing database definition in a Data Catalog.

Public Method UpdateDataQualityRuleset(UpdateDataQualityRulesetRequest)

Updates the specified data quality ruleset.

Public Method UpdateDataQualityRulesetAsync(UpdateDataQualityRulesetRequest, CancellationToken)

Updates the specified data quality ruleset.

Public Method UpdateDevEndpoint(UpdateDevEndpointRequest)

Updates a specified development endpoint.

Public Method UpdateDevEndpointAsync(UpdateDevEndpointRequest, CancellationToken)

Updates a specified development endpoint.

Public Method UpdateJob(UpdateJobRequest)

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

Public Method UpdateJobAsync(UpdateJobRequest, CancellationToken)

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

Public Method UpdateJobFromSourceControl(UpdateJobFromSourceControlRequest)

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.

Public Method UpdateJobFromSourceControlAsync(UpdateJobFromSourceControlRequest, CancellationToken)

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.

Public Method UpdateMLTransform(UpdateMLTransformRequest)

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

Public Method UpdateMLTransformAsync(UpdateMLTransformRequest, CancellationToken)

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

Public Method UpdatePartition(UpdatePartitionRequest)

Updates a partition.

Public Method UpdatePartitionAsync(UpdatePartitionRequest, CancellationToken)

Updates a partition.

Public Method UpdateRegistry(UpdateRegistryRequest)

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.

Public Method UpdateRegistryAsync(UpdateRegistryRequest, CancellationToken)

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.

Public Method UpdateSchema(UpdateSchemaRequest)

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.

Public Method UpdateSchemaAsync(UpdateSchemaRequest, CancellationToken)

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.

Public Method UpdateSourceControlFromJob(UpdateSourceControlFromJobRequest)

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.

Public Method UpdateSourceControlFromJobAsync(UpdateSourceControlFromJobRequest, CancellationToken)

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.

Public Method UpdateTable(UpdateTableRequest)

Updates a metadata table in the Data Catalog.

Public Method UpdateTableAsync(UpdateTableRequest, CancellationToken)

Updates a metadata table in the Data Catalog.

Public Method UpdateTableOptimizer(UpdateTableOptimizerRequest)

Updates the configuration for an existing table optimizer.

Public Method UpdateTableOptimizerAsync(UpdateTableOptimizerRequest, CancellationToken)

Updates the configuration for an existing table optimizer.

Public Method UpdateTrigger(UpdateTriggerRequest)

Updates a trigger definition.

Public Method UpdateTriggerAsync(UpdateTriggerRequest, CancellationToken)

Updates a trigger definition.

Public Method UpdateUserDefinedFunction(UpdateUserDefinedFunctionRequest)

Updates an existing function definition in the Data Catalog.

Public Method UpdateUserDefinedFunctionAsync(UpdateUserDefinedFunctionRequest, CancellationToken)

Updates an existing function definition in the Data Catalog.

Public Method UpdateWorkflow(UpdateWorkflowRequest)

Updates an existing workflow.

Public Method UpdateWorkflowAsync(UpdateWorkflowRequest, CancellationToken)

Updates an existing workflow.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5