Glue class

Defines the public endpoint for the Glue service.

Constructors

Glue({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

batchCreatePartition({required String databaseName, required List<PartitionInput> partitionInputList, required String tableName, String? catalogId}) → Future<BatchCreatePartitionResponse>

Creates one or more partitions in a batch operation.

batchDeleteConnection({required List<String> connectionNameList, String? catalogId}) → Future<BatchDeleteConnectionResponse>

Deletes a list of connection definitions from the Data Catalog.

batchDeletePartition({required String databaseName, required List<PartitionValueList> partitionsToDelete, required String tableName, String? catalogId}) → Future<BatchDeletePartitionResponse>

Deletes one or more partitions in a batch operation.

batchDeleteTable({required String databaseName, required List<String> tablesToDelete, String? catalogId, String? transactionId}) → Future<BatchDeleteTableResponse>

Deletes multiple tables at once.

batchDeleteTableVersion({required String databaseName, required String tableName, required List<String> versionIds, String? catalogId}) → Future<BatchDeleteTableVersionResponse>

Deletes a specified batch of versions of a table.

batchGetBlueprints({required List<String> names, bool? includeBlueprint, bool? includeParameterSpec}) → Future<BatchGetBlueprintsResponse>

Retrieves information about a list of blueprints.

batchGetCrawlers({required List<String> crawlerNames}) → Future<BatchGetCrawlersResponse>

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.

batchGetCustomEntityTypes({required List<String> names}) → Future<BatchGetCustomEntityTypesResponse>

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

batchGetDataQualityResult({required List<String> resultIds}) → Future<BatchGetDataQualityResultResponse>

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

batchGetDevEndpoints({required List<String> devEndpointNames}) → Future<BatchGetDevEndpointsResponse>

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.

batchGetJobs({required List<String> jobNames}) → Future<BatchGetJobsResponse>

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.

batchGetPartition({required String databaseName, required List<PartitionValueList> partitionsToGet, required String tableName, AuditContext? auditContext, String? catalogId, QuerySessionContext? querySessionContext}) → Future<BatchGetPartitionResponse>

Retrieves partitions in a batch request.

batchGetTableOptimizer({required List<BatchGetTableOptimizerEntry> entries}) → Future<BatchGetTableOptimizerResponse>

Returns the configuration for the specified table optimizers.

batchGetTriggers({required List<String> triggerNames}) → Future<BatchGetTriggersResponse>

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.

batchGetWorkflows({required List<String> names, bool? includeGraph}) → Future<BatchGetWorkflowsResponse>

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.

batchPutDataQualityStatisticAnnotation({required List<DatapointInclusionAnnotation> inclusionAnnotations, String? clientToken}) → Future<BatchPutDataQualityStatisticAnnotationResponse>

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

batchStopJobRun({required String jobName, required List<String> jobRunIds}) → Future<BatchStopJobRunResponse>

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

batchUpdatePartition({required String databaseName, required List<BatchUpdatePartitionRequestEntry> entries, required String tableName, String? catalogId}) → Future<BatchUpdatePartitionResponse>

Updates one or more partitions in a batch operation.

cancelDataQualityRuleRecommendationRun({required String runId}) → Future<void>

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

cancelDataQualityRulesetEvaluationRun({required String runId}) → Future<void>

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

cancelMLTaskRun({required String taskRunId, required String transformId}) → Future<CancelMLTaskRunResponse>

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.

cancelStatement({required int id, required String sessionId, String? requestOrigin}) → Future<void>

Cancels the statement.

checkSchemaVersionValidity({required DataFormat dataFormat, required String schemaDefinition}) → Future<CheckSchemaVersionValidityResponse>

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.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createBlueprint({required String blueprintLocation, required String name, String? description, Map<String, String>? tags}) → Future<CreateBlueprintResponse>

Registers a blueprint with Glue.

createCatalog({required CatalogInput catalogInput, required String name, Map<String, String>? tags}) → Future<void>

Creates a new catalog in the Glue Data Catalog.

createClassifier({CreateCsvClassifierRequest? csvClassifier, CreateGrokClassifierRequest? grokClassifier, CreateJsonClassifierRequest? jsonClassifier, CreateXMLClassifierRequest? xMLClassifier}) → Future<void>

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.

createColumnStatisticsTaskSettings({required String databaseName, required String role, required String tableName, String? catalogID, List<String>? columnNameList, double? sampleSize, String? schedule, String? securityConfiguration, Map<String, String>? tags}) → Future<void>

Creates settings for a column statistics task.

createConnection({required ConnectionInput connectionInput, String? catalogId, Map<String, String>? tags}) → Future<CreateConnectionResponse>

Creates a connection definition in the Data Catalog.

createCrawler({required String name, required String role, required CrawlerTargets targets, List<String>? classifiers, String? configuration, String? crawlerSecurityConfiguration, String? databaseName, String? description, LakeFormationConfiguration? lakeFormationConfiguration, LineageConfiguration? lineageConfiguration, RecrawlPolicy? recrawlPolicy, String? schedule, SchemaChangePolicy? schemaChangePolicy, String? tablePrefix, Map<String, String>? tags}) → Future<void>

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.

createCustomEntityType({required String name, required String regexString, List<String>? contextWords, Map<String, String>? tags}) → Future<CreateCustomEntityTypeResponse>

Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.

createDatabase({required DatabaseInput databaseInput, String? catalogId, Map<String, String>? tags}) → Future<void>

Creates a new database in a Data Catalog.

createDataQualityRuleset({required String name, required String ruleset, String? clientToken, String? dataQualitySecurityConfiguration, String? description, Map<String, String>? tags, DataQualityTargetTable? targetTable}) → Future<CreateDataQualityRulesetResponse>

Creates a data quality ruleset with DQDL rules applied to a specified Glue table.

createDevEndpoint({required String endpointName, required String roleArn, Map<String, String>? arguments, String? extraJarsS3Path, String? extraPythonLibsS3Path, String? glueVersion, int? numberOfNodes, int? numberOfWorkers, String? publicKey, List<String>? publicKeys, String? securityConfiguration, List<String>? securityGroupIds, String? subnetId, Map<String, String>? tags, WorkerType? workerType}) → Future<CreateDevEndpointResponse>

Creates a new development endpoint.

createGlueIdentityCenterConfiguration({required String instanceArn, List<String>? scopes, bool? userBackgroundSessionsEnabled}) → Future<CreateGlueIdentityCenterConfigurationResponse>

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

createIntegration({required String integrationName, required String sourceArn, required String targetArn, Map<String, String>? additionalEncryptionContext, String? dataFilter, String? description, IntegrationConfig? integrationConfig, String? kmsKeyId, List<Tag>? tags}) → Future<CreateIntegrationResponse>

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

createIntegrationResourceProperty({required String resourceArn, SourceProcessingProperties? sourceProcessingProperties, List<Tag>? tags, TargetProcessingProperties? targetProcessingProperties}) → Future<CreateIntegrationResourcePropertyResponse>

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

createIntegrationTableProperties({required String resourceArn, required String tableName, SourceTableConfig? sourceTableConfig, TargetTableConfig? targetTableConfig}) → Future<void>

This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively.

createJob({required JobCommand command, required String name, required String role, int? allocatedCapacity, Map<String, CodeGenConfigurationNode>? codeGenConfigurationNodes, ConnectionsList? connections, Map<String, String>? defaultArguments, String? description, ExecutionClass? executionClass, ExecutionProperty? executionProperty, String? glueVersion, JobMode? jobMode, bool? jobRunQueuingEnabled, String? logUri, String? maintenanceWindow, double? maxCapacity, int? maxRetries, Map<String, String>? nonOverridableArguments, NotificationProperty? notificationProperty, int? numberOfWorkers, String? securityConfiguration, SourceControlDetails? sourceControlDetails, Map<String, String>? tags, int? timeout, WorkerType? workerType}) → Future<CreateJobResponse>

Creates a new job definition.

createMLTransform({required List<GlueTable> inputRecordTables, required String name, required TransformParameters parameters, required String role, String? description, String? glueVersion, double? maxCapacity, int? maxRetries, int? numberOfWorkers, Map<String, String>? tags, int? timeout, TransformEncryption? transformEncryption, WorkerType? workerType}) → Future<CreateMLTransformResponse>

Creates an Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.

createPartition({required String databaseName, required PartitionInput partitionInput, required String tableName, String? catalogId}) → Future<void>

Creates a new partition.

createPartitionIndex({required String databaseName, required PartitionIndex partitionIndex, required String tableName, String? catalogId}) → Future<void>

Creates a specified partition index in an existing table.

createRegistry({required String registryName, String? description, Map<String, String>? tags}) → Future<CreateRegistryResponse>

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

createSchema({required DataFormat dataFormat, required String schemaName, Compatibility? compatibility, String? description, RegistryId? registryId, String? schemaDefinition, Map<String, String>? tags}) → Future<CreateSchemaResponse>

Creates a new schema set and registers the schema definition. Returns an error if the schema set already exists without actually registering the version.

createScript({List<CodeGenEdge>? dagEdges, List<CodeGenNode>? dagNodes, Language? language}) → Future<CreateScriptResponse>

Transforms a directed acyclic graph (DAG) into code.

createSecurityConfiguration({required EncryptionConfiguration encryptionConfiguration, required String name}) → Future<CreateSecurityConfigurationResponse>

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.

createSession({required SessionCommand command, required String id, required String role, ConnectionsList? connections, Map<String, String>? defaultArguments, String? description, String? glueVersion, int? idleTimeout, double? maxCapacity, int? numberOfWorkers, String? requestOrigin, String? securityConfiguration, SessionType? sessionType, Map<String, String>? tags, int? timeout, WorkerType? workerType}) → Future<CreateSessionResponse>

Creates a new session.

createTable({required String databaseName, String? catalogId, String? name, OpenTableFormatInput? openTableFormatInput, List<PartitionIndex>? partitionIndexes, TableInput? tableInput, String? transactionId}) → Future<void>

Creates a new table definition in the Data Catalog.

createTableOptimizer({required String catalogId, required String databaseName, required String tableName, required TableOptimizerConfiguration tableOptimizerConfiguration, required TableOptimizerType type}) → Future<void>

Creates a new table optimizer for a specific function.

createTrigger({required List<Action> actions, required String name, required TriggerType type, String? description, EventBatchingCondition? eventBatchingCondition, Predicate? predicate, String? schedule, bool? startOnCreation, Map<String, String>? tags, String? workflowName}) → Future<CreateTriggerResponse>

Creates a new trigger.

createUsageProfile({required ProfileConfiguration configuration, required String name, String? description, Map<String, String>? tags}) → Future<CreateUsageProfileResponse>

Creates an Glue usage profile.

createUserDefinedFunction({required String databaseName, required UserDefinedFunctionInput functionInput, String? catalogId}) → Future<void>

Creates a new function definition in the Data Catalog.

createWorkflow({required String name, Map<String, String>? defaultRunProperties, String? description, int? maxConcurrentRuns, Map<String, String>? tags}) → Future<CreateWorkflowResponse>

Creates a new workflow.

deleteBlueprint({required String name}) → Future<DeleteBlueprintResponse>

Deletes an existing blueprint.

deleteCatalog({required String catalogId}) → Future<void>

Removes the specified catalog from the Glue Data Catalog.

deleteClassifier({required String name}) → Future<void>

Removes a classifier from the Data Catalog.

deleteColumnStatisticsForPartition({required String columnName, required String databaseName, required List<String> partitionValues, required String tableName, String? catalogId}) → Future<void>

Delete the partition column statistics of a column.

deleteColumnStatisticsForTable({required String columnName, required String databaseName, required String tableName, String? catalogId}) → Future<void>

Retrieves table statistics of columns.

deleteColumnStatisticsTaskSettings({required String databaseName, required String tableName}) → Future<void>

Deletes settings for a column statistics task.

deleteConnection({required String connectionName, String? catalogId}) → Future<void>

Deletes a connection from the Data Catalog.

deleteConnectionType({required String connectionType}) → Future<void>

Deletes a custom connection type in Glue.

deleteCrawler({required String name}) → Future<void>

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

deleteCustomEntityType({required String name}) → Future<DeleteCustomEntityTypeResponse>

Deletes a custom pattern by specifying its name.

deleteDatabase({required String name, String? catalogId}) → Future<void>

Removes a specified database from a Data Catalog.

deleteDataQualityRuleset({required String name}) → Future<void>

Deletes a data quality ruleset.

deleteDevEndpoint({required String endpointName}) → Future<void>

Deletes a specified development endpoint.

deleteGlueIdentityCenterConfiguration() → Future<void>

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

deleteIntegration({required String integrationIdentifier}) → Future<DeleteIntegrationResponse>

Deletes the specified Zero-ETL integration.

deleteIntegrationResourceProperty({required String resourceArn}) → Future<void>

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

deleteIntegrationTableProperties({required String resourceArn, required String tableName}) → Future<void>

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

deleteJob({required String jobName}) → Future<DeleteJobResponse>

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

deleteMLTransform({required String transformId}) → Future<DeleteMLTransformResponse>

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.

deletePartition({required String databaseName, required List<String> partitionValues, required String tableName, String? catalogId}) → Future<void>

Deletes a specified partition.

deletePartitionIndex({required String databaseName, required String indexName, required String tableName, String? catalogId}) → Future<void>

Deletes a specified partition index from an existing table.

deleteRegistry({required RegistryId registryId}) → Future<DeleteRegistryResponse>

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.

deleteResourcePolicy({String? policyHashCondition, String? resourceArn}) → Future<void>

Deletes a specified policy.

deleteSchema({required SchemaId schemaId}) → Future<DeleteSchemaResponse>

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.

deleteSchemaVersions({required SchemaId schemaId, required String versions}) → Future<DeleteSchemaVersionsResponse>

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.

deleteSecurityConfiguration({required String name}) → Future<void>

Deletes a specified security configuration.

deleteSession({required String id, String? requestOrigin}) → Future<DeleteSessionResponse>

Deletes the session.

deleteTable({required String databaseName, required String name, String? catalogId, String? transactionId}) → Future<void>

Removes a table definition from the Data Catalog.

deleteTableOptimizer({required String catalogId, required String databaseName, required String tableName, required TableOptimizerType type}) → Future<void>

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

deleteTableVersion({required String databaseName, required String tableName, required String versionId, String? catalogId}) → Future<void>

Deletes a specified version of a table.

deleteTrigger({required String name}) → Future<DeleteTriggerResponse>

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

deleteUsageProfile({required String name}) → Future<void>

Deletes the Glue specified usage profile.

deleteUserDefinedFunction({required String databaseName, required String functionName, String? catalogId}) → Future<void>

Deletes an existing function definition from the Data Catalog.

deleteWorkflow({required String name}) → Future<DeleteWorkflowResponse>

Deletes a workflow.

describeConnectionType({required String connectionType}) → Future<DescribeConnectionTypeResponse>

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

describeEntity({required String connectionName, required String entityName, String? catalogId, String? dataStoreApiVersion, String? nextToken}) → Future<DescribeEntityResponse>

Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.

describeInboundIntegrations({String? integrationArn, String? marker, int? maxRecords, String? targetArn}) → Future<DescribeInboundIntegrationsResponse>

Returns a list of inbound integrations for the specified integration.

describeIntegrations({List<IntegrationFilter>? filters, String? integrationIdentifier, String? marker, int? maxRecords}) → Future<DescribeIntegrationsResponse>

The API is used to retrieve a list of integrations.

getBlueprint({required String name, bool? includeBlueprint, bool? includeParameterSpec}) → Future<GetBlueprintResponse>

Retrieves the details of a blueprint.

getBlueprintRun({required String blueprintName, required String runId}) → Future<GetBlueprintRunResponse>

Retrieves the details of a blueprint run.

getBlueprintRuns({required String blueprintName, int? maxResults, String? nextToken}) → Future<GetBlueprintRunsResponse>

Retrieves the details of blueprint runs for a specified blueprint.

getCatalog({required String catalogId}) → Future<GetCatalogResponse>

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

getCatalogImportStatus({String? catalogId}) → Future<GetCatalogImportStatusResponse>

Retrieves the status of a migration operation.

getCatalogs({bool? hasDatabases, bool? includeRoot, int? maxResults, String? nextToken, String? parentCatalogId, bool? recursive}) → Future<GetCatalogsResponse>

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

getClassifier({required String name}) → Future<GetClassifierResponse>

Retrieve a classifier by name.

getClassifiers({int? maxResults, String? nextToken}) → Future<GetClassifiersResponse>

Lists all classifier objects in the Data Catalog.

getColumnStatisticsForPartition({required List<String> columnNames, required String databaseName, required List<String> partitionValues, required String tableName, String? catalogId}) → Future<GetColumnStatisticsForPartitionResponse>

Retrieves partition statistics of columns.

getColumnStatisticsForTable({required List<String> columnNames, required String databaseName, required String tableName, String? catalogId}) → Future<GetColumnStatisticsForTableResponse>

Retrieves table statistics of columns.

getColumnStatisticsTaskRun({required String columnStatisticsTaskRunId}) → Future<GetColumnStatisticsTaskRunResponse>

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

getColumnStatisticsTaskRuns({required String databaseName, required String tableName, int? maxResults, String? nextToken}) → Future<GetColumnStatisticsTaskRunsResponse>

Retrieves information about all runs associated with the specified table.

getColumnStatisticsTaskSettings({required String databaseName, required String tableName}) → Future<GetColumnStatisticsTaskSettingsResponse>

Gets settings for a column statistics task.

getConnection({required String name, ComputeEnvironment? applyOverrideForComputeEnvironment, String? catalogId, bool? hidePassword}) → Future<GetConnectionResponse>

Retrieves a connection definition from the Data Catalog.

getConnections({String? catalogId, GetConnectionsFilter? filter, bool? hidePassword, int? maxResults, String? nextToken}) → Future<GetConnectionsResponse>

Retrieves a list of connection definitions from the Data Catalog.

getCrawler({required String name}) → Future<GetCrawlerResponse>

Retrieves metadata for a specified crawler.

getCrawlerMetrics({List<String>? crawlerNameList, int? maxResults, String? nextToken}) → Future<GetCrawlerMetricsResponse>

Retrieves metrics about specified crawlers.

getCrawlers({int? maxResults, String? nextToken}) → Future<GetCrawlersResponse>

Retrieves metadata for all crawlers defined in the customer account.

getCustomEntityType({required String name}) → Future<GetCustomEntityTypeResponse>

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

getDashboardUrl({required String resourceId, required GlueResourceType resourceType, String? requestOrigin}) → Future<GetDashboardUrlResponse>

Retrieves the URL for the Spark monitoring dashboard for a Glue resource.

getDatabase({required String name, String? catalogId}) → Future<GetDatabaseResponse>

Retrieves the definition of a specified database.

getDatabases({List<DatabaseAttributes>? attributesToGet, String? catalogId, int? maxResults, String? nextToken, ResourceShareType? resourceShareType}) → Future<GetDatabasesResponse>

Retrieves all databases defined in a given Data Catalog.

getDataCatalogEncryptionSettings({String? catalogId}) → Future<GetDataCatalogEncryptionSettingsResponse>

Retrieves the security configuration for a specified catalog.

getDataflowGraph({String? pythonScript}) → Future<GetDataflowGraphResponse>

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

getDataQualityModel({required String profileId, String? statisticId}) → Future<GetDataQualityModelResponse>

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

getDataQualityModelResult({required String profileId, required String statisticId}) → Future<GetDataQualityModelResultResponse>

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

getDataQualityResult({required String resultId}) → Future<GetDataQualityResultResponse>

Retrieves the result of a data quality rule evaluation.

getDataQualityRuleRecommendationRun({required String runId}) → Future<GetDataQualityRuleRecommendationRunResponse>

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

getDataQualityRuleset({required String name}) → Future<GetDataQualityRulesetResponse>

Returns an existing ruleset by identifier or name.

getDataQualityRulesetEvaluationRun({required String runId}) → Future<GetDataQualityRulesetEvaluationRunResponse>

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

getDevEndpoint({required String endpointName}) → Future<GetDevEndpointResponse>

Retrieves information about a specified development endpoint.

getDevEndpoints({int? maxResults, String? nextToken}) → Future<GetDevEndpointsResponse>

Retrieves all the development endpoints in this Amazon Web Services account.

getEntityRecords({required String entityName, required int limit, String? catalogId, String? connectionName, Map<String, String>? connectionOptions, String? dataStoreApiVersion, String? filterPredicate, String? nextToken, String? orderBy, List<String>? selectedFields}) → Future<GetEntityRecordsResponse>

This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog.

getGlueIdentityCenterConfiguration() → Future<GetGlueIdentityCenterConfigurationResponse>

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

getIntegrationResourceProperty({required String resourceArn}) → Future<GetIntegrationResourcePropertyResponse>

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

getIntegrationTableProperties({required String resourceArn, required String tableName}) → Future<GetIntegrationTablePropertiesResponse>

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

getJob({required String jobName}) → Future<GetJobResponse>

Retrieves an existing job definition.

getJobBookmark({required String jobName, String? runId}) → Future<GetJobBookmarkResponse>

Returns information on a job bookmark entry.

getJobRun({required String jobName, required String runId, bool? predecessorsIncluded}) → Future<GetJobRunResponse>

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

getJobRuns({required String jobName, int? maxResults, String? nextToken}) → Future<GetJobRunsResponse>

Retrieves metadata for all runs of a given job definition.

getJobs({int? maxResults, String? nextToken}) → Future<GetJobsResponse>

Retrieves all current job definitions.

getMapping({required CatalogEntry source, Location? location, List<CatalogEntry>? sinks}) → Future<GetMappingResponse>

Creates mappings.

getMaterializedViewRefreshTaskRun({required String catalogId, required String materializedViewRefreshTaskRunId}) → Future<GetMaterializedViewRefreshTaskRunResponse>

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

getMLTaskRun({required String taskRunId, required String transformId}) → Future<GetMLTaskRunResponse>

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.

getMLTaskRuns({required String transformId, TaskRunFilterCriteria? filter, int? maxResults, String? nextToken, TaskRunSortCriteria? sort}) → Future<GetMLTaskRunsResponse>

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.

getMLTransform({required String transformId}) → Future<GetMLTransformResponse>

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.

getMLTransforms({TransformFilterCriteria? filter, int? maxResults, String? nextToken, TransformSortCriteria? sort}) → Future<GetMLTransformsResponse>

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.

getPartition({required String databaseName, required List<String> partitionValues, required String tableName, AuditContext? auditContext, String? catalogId}) → Future<GetPartitionResponse>

Retrieves information about a specified partition.

getPartitionIndexes({required String databaseName, required String tableName, String? catalogId, String? nextToken}) → Future<GetPartitionIndexesResponse>

Retrieves the partition indexes associated with a table.

getPartitions({required String databaseName, required String tableName, AuditContext? auditContext, String? catalogId, bool? excludeColumnSchema, String? expression, int? maxResults, String? nextToken, DateTime? queryAsOfTime, Segment? segment, String? transactionId}) → Future<GetPartitionsResponse>

Retrieves information about the partitions in a table.

getPlan({required List<MappingEntry> mapping, required CatalogEntry source, Map<String, String>? additionalPlanOptionsMap, Language? language, Location? location, List<CatalogEntry>? sinks}) → Future<GetPlanResponse>

Gets code to perform a specified mapping.

getRegistry({required RegistryId registryId}) → Future<GetRegistryResponse>

Describes the specified registry in detail.

getResourcePolicies({int? maxResults, String? nextToken}) → Future<GetResourcePoliciesResponse>

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

getResourcePolicy({String? resourceArn}) → Future<GetResourcePolicyResponse>

Retrieves a specified resource policy.

getSchema({required SchemaId schemaId}) → Future<GetSchemaResponse>

Describes the specified schema in detail.

getSchemaByDefinition({required String schemaDefinition, required SchemaId schemaId}) → Future<GetSchemaByDefinitionResponse>

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.

getSchemaVersion({SchemaId? schemaId, String? schemaVersionId, SchemaVersionNumber? schemaVersionNumber}) → Future<GetSchemaVersionResponse>

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.

getSchemaVersionsDiff({required SchemaVersionNumber firstSchemaVersionNumber, required SchemaDiffType schemaDiffType, required SchemaId schemaId, required SchemaVersionNumber secondSchemaVersionNumber}) → Future<GetSchemaVersionsDiffResponse>

Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.

getSecurityConfiguration({required String name}) → Future<GetSecurityConfigurationResponse>

Retrieves a specified security configuration.

getSecurityConfigurations({int? maxResults, String? nextToken}) → Future<GetSecurityConfigurationsResponse>

Retrieves a list of all security configurations.

getSession({required String id, String? requestOrigin}) → Future<GetSessionResponse>

Retrieves the session.

getSessionEndpoint({required String sessionId}) → Future<GetSessionEndpointResponse>

Returns the Spark Connect endpoint URL and authentication token for an interactive session.

getStatement({required int id, required String sessionId, String? requestOrigin}) → Future<GetStatementResponse>

Retrieves the statement.

getTable({required String databaseName, required String name, AuditContext? auditContext, String? catalogId, bool? includeStatusDetails, DateTime? queryAsOfTime, String? transactionId}) → Future<GetTableResponse>

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

getTableOptimizer({required String catalogId, required String databaseName, required String tableName, required TableOptimizerType type}) → Future<GetTableOptimizerResponse>

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

getTables({required String databaseName, List<TableAttributes>? attributesToGet, AuditContext? auditContext, String? catalogId, String? expression, bool? includeStatusDetails, int? maxResults, String? nextToken, DateTime? queryAsOfTime, String? transactionId}) → Future<GetTablesResponse>

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

getTableVersion({required String databaseName, required String tableName, AuditContext? auditContext, String? catalogId, String? versionId}) → Future<GetTableVersionResponse>

Retrieves a specified version of a table.

getTableVersions({required String databaseName, required String tableName, AuditContext? auditContext, String? catalogId, int? maxResults, String? nextToken}) → Future<GetTableVersionsResponse>

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

getTags({required String resourceArn}) → Future<GetTagsResponse>

Retrieves a list of tags associated with a resource.

getTrigger({required String name}) → Future<GetTriggerResponse>

Retrieves the definition of a trigger.

getTriggers({String? dependentJobName, int? maxResults, String? nextToken}) → Future<GetTriggersResponse>

Gets all the triggers associated with a job.

getUnfilteredPartitionMetadata({required String catalogId, required String databaseName, required List<String> partitionValues, required List<PermissionType> supportedPermissionTypes, required String tableName, AuditContext? auditContext, QuerySessionContext? querySessionContext, String? region}) → Future<GetUnfilteredPartitionMetadataResponse>

Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.

getUnfilteredPartitionsMetadata({required String catalogId, required String databaseName, required List<PermissionType> supportedPermissionTypes, required String tableName, AuditContext? auditContext, String? expression, int? maxResults, String? nextToken, QuerySessionContext? querySessionContext, String? region, Segment? segment}) → Future<GetUnfilteredPartitionsMetadataResponse>

Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.

getUnfilteredTableMetadata({required String catalogId, required String databaseName, required String name, required List<PermissionType> supportedPermissionTypes, AuditContext? auditContext, String? parentResourceArn, List<Permission>? permissions, QuerySessionContext? querySessionContext, String? region, String? rootResourceArn, SupportedDialect? supportedDialect}) → Future<GetUnfilteredTableMetadataResponse>

Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.

getUsageProfile({required String name}) → Future<GetUsageProfileResponse>

Retrieves information about the specified Glue usage profile.

getUserDefinedFunction({required String databaseName, required String functionName, String? catalogId}) → Future<GetUserDefinedFunctionResponse>

Retrieves a specified function definition from the Data Catalog.

getUserDefinedFunctions({required String pattern, String? catalogId, String? databaseName, FunctionType? functionType, int? maxResults, String? nextToken}) → Future<GetUserDefinedFunctionsResponse>

Retrieves multiple function definitions from the Data Catalog.

getWorkflow({required String name, bool? includeGraph}) → Future<GetWorkflowResponse>

Retrieves resource metadata for a workflow.

getWorkflowRun({required String name, required String runId, bool? includeGraph}) → Future<GetWorkflowRunResponse>

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

getWorkflowRunProperties({required String name, required String runId}) → Future<GetWorkflowRunPropertiesResponse>

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

getWorkflowRuns({required String name, bool? includeGraph, int? maxResults, String? nextToken}) → Future<GetWorkflowRunsResponse>

Retrieves metadata for all runs of a given workflow.

importCatalogToGlue({String? catalogId}) → Future<void>

Imports an existing Amazon Athena Data Catalog to Glue.

listBlueprints({int? maxResults, String? nextToken, Map<String, String>? tags}) → Future<ListBlueprintsResponse>

Lists all the blueprint names in an account.

listColumnStatisticsTaskRuns({int? maxResults, String? nextToken}) → Future<ListColumnStatisticsTaskRunsResponse>

List all task runs for a particular account.

listConnectionTypes({int? maxResults, String? nextToken}) → Future<ListConnectionTypesResponse>

The ListConnectionTypes API provides a discovery mechanism to learn available connection types in Glue. The response contains a list of connection types with high-level details of what is supported for each connection type, including both built-in connection types and custom connection types registered via RegisterConnectionType. The connection types listed are the set of supported options for the ConnectionType value in the CreateConnection API.

listCrawlers({int? maxResults, String? nextToken, Map<String, String>? tags}) → Future<ListCrawlersResponse>

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.

listCrawls({required String crawlerName, List<CrawlsFilter>? filters, int? maxResults, String? nextToken}) → Future<ListCrawlsResponse>

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.

listCustomEntityTypes({int? maxResults, String? nextToken, Map<String, String>? tags}) → Future<ListCustomEntityTypesResponse>

Lists all the custom patterns that have been created.

listDataQualityResults({DataQualityResultFilterCriteria? filter, int? maxResults, String? nextToken}) → Future<ListDataQualityResultsResponse>

Returns all data quality execution results for your account.

listDataQualityRuleRecommendationRuns({DataQualityRuleRecommendationRunFilter? filter, int? maxResults, String? nextToken}) → Future<ListDataQualityRuleRecommendationRunsResponse>

Lists the recommendation runs meeting the filter criteria.

listDataQualityRulesetEvaluationRuns({DataQualityRulesetEvaluationRunFilter? filter, int? maxResults, String? nextToken}) → Future<ListDataQualityRulesetEvaluationRunsResponse>

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

listDataQualityRulesets({DataQualityRulesetFilterCriteria? filter, int? maxResults, String? nextToken, Map<String, String>? tags}) → Future<ListDataQualityRulesetsResponse>

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

listDataQualityStatisticAnnotations({int? maxResults, String? nextToken, String? profileId, String? statisticId, TimestampFilter? timestampFilter}) → Future<ListDataQualityStatisticAnnotationsResponse>

Retrieve annotations for a data quality statistic.

listDataQualityStatistics({int? maxResults, String? nextToken, String? profileId, String? statisticId, TimestampFilter? timestampFilter}) → Future<ListDataQualityStatisticsResponse>

Retrieves a list of data quality statistics.

listDevEndpoints({int? maxResults, String? nextToken, Map<String, String>? tags}) → Future<ListDevEndpointsResponse>

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.

listEntities({String? catalogId, String? connectionName, String? dataStoreApiVersion, String? nextToken, String? parentEntityName}) → Future<ListEntitiesResponse>

Returns the available entities supported by the connection type.

listIntegrationResourceProperties({List<IntegrationResourcePropertyFilter>? filters, String? marker, int? maxRecords}) → Future<ListIntegrationResourcePropertiesResponse>

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

listJobs({int? maxResults, String? nextToken, Map<String, String>? tags}) → Future<ListJobsResponse>

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.

listMaterializedViewRefreshTaskRuns({required String catalogId, String? databaseName, int? maxResults, String? nextToken, String? tableName}) → Future<ListMaterializedViewRefreshTaskRunsResponse>

List all task runs for a particular account.

listMLTransforms({TransformFilterCriteria? filter, int? maxResults, String? nextToken, TransformSortCriteria? sort, Map<String, String>? tags}) → Future<ListMLTransformsResponse>

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.

listRegistries({int? maxResults, String? nextToken}) → Future<ListRegistriesResponse>

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.

listSchemas({int? maxResults, String? nextToken, RegistryId? registryId}) → Future<ListSchemasResponse>

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.

listSchemaVersions({required SchemaId schemaId, int? maxResults, String? nextToken}) → Future<ListSchemaVersionsResponse>

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.

listSessions({int? maxResults, String? nextToken, String? requestOrigin, Map<String, String>? tags}) → Future<ListSessionsResponse>

Retrieve a list of sessions.

listStatements({required String sessionId, String? nextToken, String? requestOrigin}) → Future<ListStatementsResponse>

Lists statements for the session.

listTableOptimizerRuns({required String catalogId, required String databaseName, required String tableName, required TableOptimizerType type, int? maxResults, String? nextToken}) → Future<ListTableOptimizerRunsResponse>

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

listTriggers({String? dependentJobName, int? maxResults, String? nextToken, Map<String, String>? tags}) → Future<ListTriggersResponse>

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.

listUsageProfiles({int? maxResults, String? nextToken}) → Future<ListUsageProfilesResponse>

List all the Glue usage profiles.

listWorkflows({int? maxResults, String? nextToken}) → Future<ListWorkflowsResponse>

Lists names of workflows created in the account.

modifyIntegration({required String integrationIdentifier, String? dataFilter, String? description, IntegrationConfig? integrationConfig, String? integrationName}) → Future<ModifyIntegrationResponse>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putDataCatalogEncryptionSettings({required DataCatalogEncryptionSettings dataCatalogEncryptionSettings, String? catalogId}) → Future<void>

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

putDataQualityProfileAnnotation({required InclusionAnnotationValue inclusionAnnotation, required String profileId}) → Future<void>

Annotate all datapoints for a Profile.

putResourcePolicy({required String policyInJson, EnableHybridValues? enableHybrid, ExistCondition? policyExistsCondition, String? policyHashCondition, String? resourceArn}) → Future<PutResourcePolicyResponse>

Sets the Data Catalog resource policy for access control.

putSchemaVersionMetadata({required MetadataKeyValuePair metadataKeyValue, SchemaId? schemaId, String? schemaVersionId, SchemaVersionNumber? schemaVersionNumber}) → Future<PutSchemaVersionMetadataResponse>

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.

putWorkflowRunProperties({required String name, required String runId, required Map<String, String> runProperties}) → Future<void>

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.

querySchemaVersionMetadata({int? maxResults, List<MetadataKeyValuePair>? metadataList, String? nextToken, SchemaId? schemaId, String? schemaVersionId, SchemaVersionNumber? schemaVersionNumber}) → Future<QuerySchemaVersionMetadataResponse>

Queries for the schema version metadata information.

registerConnectionType({required ConnectionPropertiesConfiguration connectionProperties, required String connectionType, required ConnectorAuthenticationConfiguration connectorAuthenticationConfiguration, required IntegrationType integrationType, required RestConfiguration restConfiguration, String? description, Map<String, String>? tags}) → Future<RegisterConnectionTypeResponse>

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

registerSchemaVersion({required String schemaDefinition, required SchemaId schemaId}) → Future<RegisterSchemaVersionResponse>

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.

removeSchemaVersionMetadata({required MetadataKeyValuePair metadataKeyValue, SchemaId? schemaId, String? schemaVersionId, SchemaVersionNumber? schemaVersionNumber}) → Future<RemoveSchemaVersionMetadataResponse>

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

resetJobBookmark({required String jobName, String? runId}) → Future<ResetJobBookmarkResponse>

Resets a bookmark entry.

resumeWorkflowRun({required String name, required List<String> nodeIds, required String runId}) → Future<ResumeWorkflowRunResponse>

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.

runStatement({required String code, required String sessionId, String? requestOrigin}) → Future<RunStatementResponse>

Executes the statement.

searchTables({String? catalogId, List<PropertyPredicate>? filters, bool? includeStatusDetails, int? maxResults, String? nextToken, ResourceShareType? resourceShareType, String? searchText, List<SortCriterion>? sortCriteria}) → Future<SearchTablesResponse>

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.

startBlueprintRun({required String blueprintName, required String roleArn, String? parameters}) → Future<StartBlueprintRunResponse>

Starts a new run of the specified blueprint.

startColumnStatisticsTaskRun({required String databaseName, required String role, required String tableName, String? catalogID, List<String>? columnNameList, double? sampleSize, String? securityConfiguration}) → Future<StartColumnStatisticsTaskRunResponse>

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

startColumnStatisticsTaskRunSchedule({required String databaseName, required String tableName}) → Future<void>

Starts a column statistics task run schedule.

startCrawler({required String name}) → Future<void>

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

startCrawlerSchedule({required String crawlerName}) → Future<void>

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

startDataQualityRuleRecommendationRun({required DataSource dataSource, required String role, String? clientToken, String? createdRulesetName, String? dataQualitySecurityConfiguration, int? numberOfWorkers, int? timeout}) → Future<StartDataQualityRuleRecommendationRunResponse>

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.

startDataQualityRulesetEvaluationRun({required DataSource dataSource, required String role, required List<String> rulesetNames, Map<String, DataSource>? additionalDataSources, DataQualityEvaluationRunAdditionalRunOptions? additionalRunOptions, String? clientToken, int? numberOfWorkers, int? timeout}) → Future<StartDataQualityRulesetEvaluationRunResponse>

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.

startExportLabelsTaskRun({required String outputS3Path, required String transformId}) → Future<StartExportLabelsTaskRunResponse>

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.

startImportLabelsTaskRun({required String inputS3Path, required String transformId, bool? replaceAllLabels}) → Future<StartImportLabelsTaskRunResponse>

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.

startJobRun({required String jobName, int? allocatedCapacity, Map<String, String>? arguments, ExecutionClass? executionClass, String? executionRoleSessionPolicy, String? jobRunId, bool? jobRunQueuingEnabled, double? maxCapacity, NotificationProperty? notificationProperty, int? numberOfWorkers, String? securityConfiguration, int? timeout, WorkerType? workerType}) → Future<StartJobRunResponse>

Starts a job run using a job definition.

startMaterializedViewRefreshTaskRun({required String catalogId, required String databaseName, required String tableName, bool? fullRefresh}) → Future<StartMaterializedViewRefreshTaskRunResponse>

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

startMLEvaluationTaskRun({required String transformId}) → Future<StartMLEvaluationTaskRunResponse>

Starts a task to estimate the quality of the transform.

startMLLabelingSetGenerationTaskRun({required String outputS3Path, required String transformId}) → Future<StartMLLabelingSetGenerationTaskRunResponse>

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

startTrigger({required String name}) → Future<StartTriggerResponse>

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

startWorkflowRun({required String name, Map<String, String>? runProperties}) → Future<StartWorkflowRunResponse>

Starts a new run of the specified workflow.

stopColumnStatisticsTaskRun({required String databaseName, required String tableName}) → Future<void>

Stops a task run for the specified table.

stopColumnStatisticsTaskRunSchedule({required String databaseName, required String tableName}) → Future<void>

Stops a column statistics task run schedule.

stopCrawler({required String name}) → Future<void>

If the specified crawler is running, stops the crawl.

stopCrawlerSchedule({required String crawlerName}) → Future<void>

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

stopMaterializedViewRefreshTaskRun({required String catalogId, required String databaseName, required String tableName}) → Future<void>

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

stopSession({required String id, String? requestOrigin}) → Future<StopSessionResponse>

Stops the session.

stopTrigger({required String name}) → Future<StopTriggerResponse>

Stops a specified trigger.

stopWorkflowRun({required String name, required String runId}) → Future<void>

Stops the execution of the specified workflow run.

tagResource({required String resourceArn, required Map<String, String> tagsToAdd}) → Future<void>

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.

testConnection({String? catalogId, String? connectionName, TestConnectionInput? testConnectionInput}) → Future<void>

Tests a connection to a service to validate the service credentials that you provide.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required List<String> tagsToRemove}) → Future<void>

Removes tags from a resource.

updateBlueprint({required String blueprintLocation, required String name, String? description}) → Future<UpdateBlueprintResponse>

Updates a registered blueprint.

updateCatalog({required String catalogId, required CatalogInput catalogInput}) → Future<void>

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

updateClassifier({UpdateCsvClassifierRequest? csvClassifier, UpdateGrokClassifierRequest? grokClassifier, UpdateJsonClassifierRequest? jsonClassifier, UpdateXMLClassifierRequest? xMLClassifier}) → Future<void>

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

updateColumnStatisticsForPartition({required List<ColumnStatistics> columnStatisticsList, required String databaseName, required List<String> partitionValues, required String tableName, String? catalogId}) → Future<UpdateColumnStatisticsForPartitionResponse>

Creates or updates partition statistics of columns.

updateColumnStatisticsForTable({required List<ColumnStatistics> columnStatisticsList, required String databaseName, required String tableName, String? catalogId}) → Future<UpdateColumnStatisticsForTableResponse>

Creates or updates table statistics of columns.

updateColumnStatisticsTaskSettings({required String databaseName, required String tableName, String? catalogID, List<String>? columnNameList, String? role, double? sampleSize, String? schedule, String? securityConfiguration}) → Future<void>

Updates settings for a column statistics task.

updateConnection({required ConnectionInput connectionInput, required String name, String? catalogId}) → Future<void>

Updates a connection definition in the Data Catalog.

updateCrawler({required String name, List<String>? classifiers, String? configuration, String? crawlerSecurityConfiguration, String? databaseName, String? description, LakeFormationConfiguration? lakeFormationConfiguration, LineageConfiguration? lineageConfiguration, RecrawlPolicy? recrawlPolicy, String? role, String? schedule, SchemaChangePolicy? schemaChangePolicy, String? tablePrefix, CrawlerTargets? targets}) → Future<void>

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

updateCrawlerSchedule({required String crawlerName, String? schedule}) → Future<void>

Updates the schedule of a crawler using a cron expression.

updateDatabase({required DatabaseInput databaseInput, required String name, String? catalogId}) → Future<void>

Updates an existing database definition in a Data Catalog.

updateDataQualityRuleset({required String name, String? description, String? ruleset}) → Future<UpdateDataQualityRulesetResponse>

Updates the specified data quality ruleset.

updateDevEndpoint({required String endpointName, Map<String, String>? addArguments, List<String>? addPublicKeys, DevEndpointCustomLibraries? customLibraries, List<String>? deleteArguments, List<String>? deletePublicKeys, String? publicKey, bool? updateEtlLibraries}) → Future<void>

Updates a specified development endpoint.

updateGlueIdentityCenterConfiguration({List<String>? scopes, bool? userBackgroundSessionsEnabled}) → Future<void>

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

updateIntegrationResourceProperty({required String resourceArn, SourceProcessingProperties? sourceProcessingProperties, TargetProcessingProperties? targetProcessingProperties}) → Future<UpdateIntegrationResourcePropertyResponse>

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

updateIntegrationTableProperties({required String resourceArn, required String tableName, SourceTableConfig? sourceTableConfig, TargetTableConfig? targetTableConfig}) → Future<void>

This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively.

updateJob({required String jobName, required JobUpdate jobUpdate}) → Future<UpdateJobResponse>

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

updateJobFromSourceControl({SourceControlAuthStrategy? authStrategy, String? authToken, String? branchName, String? commitId, String? folder, String? jobName, SourceControlProvider? provider, String? repositoryName, String? repositoryOwner}) → Future<UpdateJobFromSourceControlResponse>

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.

updateMLTransform({required String transformId, String? description, String? glueVersion, double? maxCapacity, int? maxRetries, String? name, int? numberOfWorkers, TransformParameters? parameters, String? role, int? timeout, WorkerType? workerType}) → Future<UpdateMLTransformResponse>

Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.

updatePartition({required String databaseName, required PartitionInput partitionInput, required List<String> partitionValueList, required String tableName, String? catalogId}) → Future<void>

Updates a partition.

updateRegistry({required String description, required RegistryId registryId}) → Future<UpdateRegistryResponse>

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.

updateSchema({required SchemaId schemaId, Compatibility? compatibility, String? description, SchemaVersionNumber? schemaVersionNumber}) → Future<UpdateSchemaResponse>

Updates the description, compatibility setting, or version checkpoint for a schema set.

updateSourceControlFromJob({SourceControlAuthStrategy? authStrategy, String? authToken, String? branchName, String? commitId, String? folder, String? jobName, SourceControlProvider? provider, String? repositoryName, String? repositoryOwner}) → Future<UpdateSourceControlFromJobResponse>

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.

updateTable({required String databaseName, String? catalogId, bool? force, String? name, bool? skipArchive, TableInput? tableInput, String? transactionId, UpdateOpenTableFormatInput? updateOpenTableFormatInput, String? versionId, ViewUpdateAction? viewUpdateAction}) → Future<void>

Updates a metadata table in the Data Catalog.

updateTableOptimizer({required String catalogId, required String databaseName, required String tableName, required TableOptimizerConfiguration tableOptimizerConfiguration, required TableOptimizerType type}) → Future<void>

Updates the configuration for an existing table optimizer.

updateTrigger({required String name, required TriggerUpdate triggerUpdate}) → Future<UpdateTriggerResponse>

Updates a trigger definition.

updateUsageProfile({required ProfileConfiguration configuration, required String name, String? description}) → Future<UpdateUsageProfileResponse>

Update an Glue usage profile.

updateUserDefinedFunction({required String databaseName, required UserDefinedFunctionInput functionInput, required String functionName, String? catalogId}) → Future<void>

Updates an existing function definition in the Data Catalog.

updateWorkflow({required String name, Map<String, String>? defaultRunProperties, String? description, int? maxConcurrentRuns}) → Future<UpdateWorkflowResponse>

Updates an existing workflow.

Operators

operator ==(Object other) → bool

The equality operator.

inherited