Class: Aws::Glue::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Glue::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-glue/client.rb
Overview
An API client for Glue. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Glue::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#batch_create_partition(params = {}) ⇒ Types::BatchCreatePartitionResponse
Creates one or more partitions in a batch operation.
-
#batch_delete_connection(params = {}) ⇒ Types::BatchDeleteConnectionResponse
Deletes a list of connection definitions from the Data Catalog.
-
#batch_delete_partition(params = {}) ⇒ Types::BatchDeletePartitionResponse
Deletes one or more partitions in a batch operation.
-
#batch_delete_table(params = {}) ⇒ Types::BatchDeleteTableResponse
Deletes multiple tables at once.
-
#batch_delete_table_version(params = {}) ⇒ Types::BatchDeleteTableVersionResponse
Deletes a specified batch of versions of a table.
-
#batch_get_blueprints(params = {}) ⇒ Types::BatchGetBlueprintsResponse
Retrieves information about a list of blueprints.
-
#batch_get_crawlers(params = {}) ⇒ Types::BatchGetCrawlersResponse
Returns a list of resource metadata for a given list of crawler names.
-
#batch_get_custom_entity_types(params = {}) ⇒ Types::BatchGetCustomEntityTypesResponse
Retrieves the details for the custom patterns specified by a list of names.
-
#batch_get_data_quality_result(params = {}) ⇒ Types::BatchGetDataQualityResultResponse
Retrieves a list of data quality results for the specified result IDs.
-
#batch_get_dev_endpoints(params = {}) ⇒ Types::BatchGetDevEndpointsResponse
Returns a list of resource metadata for a given list of development endpoint names.
-
#batch_get_jobs(params = {}) ⇒ Types::BatchGetJobsResponse
Returns a list of resource metadata for a given list of job names.
-
#batch_get_partition(params = {}) ⇒ Types::BatchGetPartitionResponse
Retrieves partitions in a batch request.
-
#batch_get_table_optimizer(params = {}) ⇒ Types::BatchGetTableOptimizerResponse
Returns the configuration for the specified table optimizers.
-
#batch_get_triggers(params = {}) ⇒ Types::BatchGetTriggersResponse
Returns a list of resource metadata for a given list of trigger names.
-
#batch_get_workflows(params = {}) ⇒ Types::BatchGetWorkflowsResponse
Returns a list of resource metadata for a given list of workflow names.
-
#batch_stop_job_run(params = {}) ⇒ Types::BatchStopJobRunResponse
Stops one or more job runs for a specified job definition.
-
#batch_update_partition(params = {}) ⇒ Types::BatchUpdatePartitionResponse
Updates one or more partitions in a batch operation.
-
#cancel_data_quality_rule_recommendation_run(params = {}) ⇒ Struct
Cancels the specified recommendation run that was being used to generate rules.
-
#cancel_data_quality_ruleset_evaluation_run(params = {}) ⇒ Struct
Cancels a run where a ruleset is being evaluated against a data source.
-
#cancel_ml_task_run(params = {}) ⇒ Types::CancelMLTaskRunResponse
Cancels (stops) a task run.
-
#cancel_statement(params = {}) ⇒ Struct
Cancels the statement.
-
#check_schema_version_validity(params = {}) ⇒ Types::CheckSchemaVersionValidityResponse
Validates the supplied schema.
-
#create_blueprint(params = {}) ⇒ Types::CreateBlueprintResponse
Registers a blueprint with Glue.
-
#create_classifier(params = {}) ⇒ Struct
Creates a classifier in the user’s account.
-
#create_connection(params = {}) ⇒ Struct
Creates a connection definition in the Data Catalog.
-
#create_crawler(params = {}) ⇒ Struct
Creates a new crawler with specified targets, role, configuration, and optional schedule.
-
#create_custom_entity_type(params = {}) ⇒ Types::CreateCustomEntityTypeResponse
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
-
#create_data_quality_ruleset(params = {}) ⇒ Types::CreateDataQualityRulesetResponse
Creates a data quality ruleset with DQDL rules applied to a specified Glue table.
-
#create_database(params = {}) ⇒ Struct
Creates a new database in a Data Catalog.
-
#create_dev_endpoint(params = {}) ⇒ Types::CreateDevEndpointResponse
Creates a new development endpoint.
-
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates a new job definition.
-
#create_ml_transform(params = {}) ⇒ Types::CreateMLTransformResponse
Creates an Glue machine learning transform.
-
#create_partition(params = {}) ⇒ Struct
Creates a new partition.
-
#create_partition_index(params = {}) ⇒ Struct
Creates a specified partition index in an existing table.
-
#create_registry(params = {}) ⇒ Types::CreateRegistryResponse
Creates a new registry which may be used to hold a collection of schemas.
-
#create_schema(params = {}) ⇒ Types::CreateSchemaResponse
Creates a new schema set and registers the schema definition.
-
#create_script(params = {}) ⇒ Types::CreateScriptResponse
Transforms a directed acyclic graph (DAG) into code.
-
#create_security_configuration(params = {}) ⇒ Types::CreateSecurityConfigurationResponse
Creates a new security configuration.
-
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a new session.
-
#create_table(params = {}) ⇒ Struct
Creates a new table definition in the Data Catalog.
-
#create_table_optimizer(params = {}) ⇒ Struct
Creates a new table optimizer for a specific function.
-
#create_trigger(params = {}) ⇒ Types::CreateTriggerResponse
Creates a new trigger.
-
#create_user_defined_function(params = {}) ⇒ Struct
Creates a new function definition in the Data Catalog.
-
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a new workflow.
-
#delete_blueprint(params = {}) ⇒ Types::DeleteBlueprintResponse
Deletes an existing blueprint.
-
#delete_classifier(params = {}) ⇒ Struct
Removes a classifier from the Data Catalog.
-
#delete_column_statistics_for_partition(params = {}) ⇒ Struct
Delete the partition column statistics of a column.
-
#delete_column_statistics_for_table(params = {}) ⇒ Struct
Retrieves table statistics of columns.
-
#delete_connection(params = {}) ⇒ Struct
Deletes a connection from the Data Catalog.
-
#delete_crawler(params = {}) ⇒ Struct
Removes a specified crawler from the Glue Data Catalog, unless the crawler state is ‘RUNNING`.
-
#delete_custom_entity_type(params = {}) ⇒ Types::DeleteCustomEntityTypeResponse
Deletes a custom pattern by specifying its name.
-
#delete_data_quality_ruleset(params = {}) ⇒ Struct
Deletes a data quality ruleset.
-
#delete_database(params = {}) ⇒ Struct
Removes a specified database from a Data Catalog.
-
#delete_dev_endpoint(params = {}) ⇒ Struct
Deletes a specified development endpoint.
-
#delete_job(params = {}) ⇒ Types::DeleteJobResponse
Deletes a specified job definition.
-
#delete_ml_transform(params = {}) ⇒ Types::DeleteMLTransformResponse
Deletes an Glue machine learning transform.
-
#delete_partition(params = {}) ⇒ Struct
Deletes a specified partition.
-
#delete_partition_index(params = {}) ⇒ Struct
Deletes a specified partition index from an existing table.
-
#delete_registry(params = {}) ⇒ Types::DeleteRegistryResponse
Delete the entire registry including schema and all of its versions.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a specified policy.
-
#delete_schema(params = {}) ⇒ Types::DeleteSchemaResponse
Deletes the entire schema set, including the schema set and all of its versions.
-
#delete_schema_versions(params = {}) ⇒ Types::DeleteSchemaVersionsResponse
Remove versions from the specified schema.
-
#delete_security_configuration(params = {}) ⇒ Struct
Deletes a specified security configuration.
-
#delete_session(params = {}) ⇒ Types::DeleteSessionResponse
Deletes the session.
-
#delete_table(params = {}) ⇒ Struct
Removes a table definition from the Data Catalog.
-
#delete_table_optimizer(params = {}) ⇒ Struct
Deletes an optimizer and all associated metadata for a table.
-
#delete_table_version(params = {}) ⇒ Struct
Deletes a specified version of a table.
-
#delete_trigger(params = {}) ⇒ Types::DeleteTriggerResponse
Deletes a specified trigger.
-
#delete_user_defined_function(params = {}) ⇒ Struct
Deletes an existing function definition from the Data Catalog.
-
#delete_workflow(params = {}) ⇒ Types::DeleteWorkflowResponse
Deletes a workflow.
-
#get_blueprint(params = {}) ⇒ Types::GetBlueprintResponse
Retrieves the details of a blueprint.
-
#get_blueprint_run(params = {}) ⇒ Types::GetBlueprintRunResponse
Retrieves the details of a blueprint run.
-
#get_blueprint_runs(params = {}) ⇒ Types::GetBlueprintRunsResponse
Retrieves the details of blueprint runs for a specified blueprint.
-
#get_catalog_import_status(params = {}) ⇒ Types::GetCatalogImportStatusResponse
Retrieves the status of a migration operation.
-
#get_classifier(params = {}) ⇒ Types::GetClassifierResponse
Retrieve a classifier by name.
-
#get_classifiers(params = {}) ⇒ Types::GetClassifiersResponse
Lists all classifier objects in the Data Catalog.
-
#get_column_statistics_for_partition(params = {}) ⇒ Types::GetColumnStatisticsForPartitionResponse
Retrieves partition statistics of columns.
-
#get_column_statistics_for_table(params = {}) ⇒ Types::GetColumnStatisticsForTableResponse
Retrieves table statistics of columns.
-
#get_column_statistics_task_run(params = {}) ⇒ Types::GetColumnStatisticsTaskRunResponse
Get the associated metadata/information for a task run, given a task run ID.
-
#get_column_statistics_task_runs(params = {}) ⇒ Types::GetColumnStatisticsTaskRunsResponse
Retrieves information about all runs associated with the specified table.
-
#get_connection(params = {}) ⇒ Types::GetConnectionResponse
Retrieves a connection definition from the Data Catalog.
-
#get_connections(params = {}) ⇒ Types::GetConnectionsResponse
Retrieves a list of connection definitions from the Data Catalog.
-
#get_crawler(params = {}) ⇒ Types::GetCrawlerResponse
Retrieves metadata for a specified crawler.
-
#get_crawler_metrics(params = {}) ⇒ Types::GetCrawlerMetricsResponse
Retrieves metrics about specified crawlers.
-
#get_crawlers(params = {}) ⇒ Types::GetCrawlersResponse
Retrieves metadata for all crawlers defined in the customer account.
-
#get_custom_entity_type(params = {}) ⇒ Types::GetCustomEntityTypeResponse
Retrieves the details of a custom pattern by specifying its name.
-
#get_data_catalog_encryption_settings(params = {}) ⇒ Types::GetDataCatalogEncryptionSettingsResponse
Retrieves the security configuration for a specified catalog.
-
#get_data_quality_result(params = {}) ⇒ Types::GetDataQualityResultResponse
Retrieves the result of a data quality rule evaluation.
-
#get_data_quality_rule_recommendation_run(params = {}) ⇒ Types::GetDataQualityRuleRecommendationRunResponse
Gets the specified recommendation run that was used to generate rules.
-
#get_data_quality_ruleset(params = {}) ⇒ Types::GetDataQualityRulesetResponse
Returns an existing ruleset by identifier or name.
-
#get_data_quality_ruleset_evaluation_run(params = {}) ⇒ Types::GetDataQualityRulesetEvaluationRunResponse
Retrieves a specific run where a ruleset is evaluated against a data source.
-
#get_database(params = {}) ⇒ Types::GetDatabaseResponse
Retrieves the definition of a specified database.
-
#get_databases(params = {}) ⇒ Types::GetDatabasesResponse
Retrieves all databases defined in a given Data Catalog.
-
#get_dataflow_graph(params = {}) ⇒ Types::GetDataflowGraphResponse
Transforms a Python script into a directed acyclic graph (DAG).
-
#get_dev_endpoint(params = {}) ⇒ Types::GetDevEndpointResponse
Retrieves information about a specified development endpoint.
-
#get_dev_endpoints(params = {}) ⇒ Types::GetDevEndpointsResponse
Retrieves all the development endpoints in this Amazon Web Services account.
-
#get_job(params = {}) ⇒ Types::GetJobResponse
Retrieves an existing job definition.
-
#get_job_bookmark(params = {}) ⇒ Types::GetJobBookmarkResponse
Returns information on a job bookmark entry.
-
#get_job_run(params = {}) ⇒ Types::GetJobRunResponse
Retrieves the metadata for a given job run.
-
#get_job_runs(params = {}) ⇒ Types::GetJobRunsResponse
Retrieves metadata for all runs of a given job definition.
-
#get_jobs(params = {}) ⇒ Types::GetJobsResponse
Retrieves all current job definitions.
-
#get_mapping(params = {}) ⇒ Types::GetMappingResponse
Creates mappings.
-
#get_ml_task_run(params = {}) ⇒ Types::GetMLTaskRunResponse
Gets details for a specific task run on a machine learning transform.
-
#get_ml_task_runs(params = {}) ⇒ Types::GetMLTaskRunsResponse
Gets a list of runs for a machine learning transform.
-
#get_ml_transform(params = {}) ⇒ Types::GetMLTransformResponse
Gets an Glue machine learning transform artifact and all its corresponding metadata.
-
#get_ml_transforms(params = {}) ⇒ Types::GetMLTransformsResponse
Gets a sortable, filterable list of existing Glue machine learning transforms.
-
#get_partition(params = {}) ⇒ Types::GetPartitionResponse
Retrieves information about a specified partition.
-
#get_partition_indexes(params = {}) ⇒ Types::GetPartitionIndexesResponse
Retrieves the partition indexes associated with a table.
-
#get_partitions(params = {}) ⇒ Types::GetPartitionsResponse
Retrieves information about the partitions in a table.
-
#get_plan(params = {}) ⇒ Types::GetPlanResponse
Gets code to perform a specified mapping.
-
#get_registry(params = {}) ⇒ Types::GetRegistryResponse
Describes the specified registry in detail.
-
#get_resource_policies(params = {}) ⇒ Types::GetResourcePoliciesResponse
Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves a specified resource policy.
-
#get_schema(params = {}) ⇒ Types::GetSchemaResponse
Describes the specified schema in detail.
-
#get_schema_by_definition(params = {}) ⇒ Types::GetSchemaByDefinitionResponse
Retrieves a schema by the ‘SchemaDefinition`.
-
#get_schema_version(params = {}) ⇒ Types::GetSchemaVersionResponse
Get the specified schema by its unique ID assigned when a version of the schema is created or registered.
-
#get_schema_versions_diff(params = {}) ⇒ Types::GetSchemaVersionsDiffResponse
Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
-
#get_security_configuration(params = {}) ⇒ Types::GetSecurityConfigurationResponse
Retrieves a specified security configuration.
-
#get_security_configurations(params = {}) ⇒ Types::GetSecurityConfigurationsResponse
Retrieves a list of all security configurations.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves the session.
-
#get_statement(params = {}) ⇒ Types::GetStatementResponse
Retrieves the statement.
-
#get_table(params = {}) ⇒ Types::GetTableResponse
Retrieves the ‘Table` definition in a Data Catalog for a specified table.
-
#get_table_optimizer(params = {}) ⇒ Types::GetTableOptimizerResponse
Returns the configuration of all optimizers associated with a specified table.
-
#get_table_version(params = {}) ⇒ Types::GetTableVersionResponse
Retrieves a specified version of a table.
-
#get_table_versions(params = {}) ⇒ Types::GetTableVersionsResponse
Retrieves a list of strings that identify available versions of a specified table.
-
#get_tables(params = {}) ⇒ Types::GetTablesResponse
Retrieves the definitions of some or all of the tables in a given ‘Database`.
-
#get_tags(params = {}) ⇒ Types::GetTagsResponse
Retrieves a list of tags associated with a resource.
-
#get_trigger(params = {}) ⇒ Types::GetTriggerResponse
Retrieves the definition of a trigger.
-
#get_triggers(params = {}) ⇒ Types::GetTriggersResponse
Gets all the triggers associated with a job.
-
#get_unfiltered_partition_metadata(params = {}) ⇒ Types::GetUnfilteredPartitionMetadataResponse
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
-
#get_unfiltered_partitions_metadata(params = {}) ⇒ Types::GetUnfilteredPartitionsMetadataResponse
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
-
#get_unfiltered_table_metadata(params = {}) ⇒ Types::GetUnfilteredTableMetadataResponse
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
-
#get_user_defined_function(params = {}) ⇒ Types::GetUserDefinedFunctionResponse
Retrieves a specified function definition from the Data Catalog.
-
#get_user_defined_functions(params = {}) ⇒ Types::GetUserDefinedFunctionsResponse
Retrieves multiple function definitions from the Data Catalog.
-
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Retrieves resource metadata for a workflow.
-
#get_workflow_run(params = {}) ⇒ Types::GetWorkflowRunResponse
Retrieves the metadata for a given workflow run.
-
#get_workflow_run_properties(params = {}) ⇒ Types::GetWorkflowRunPropertiesResponse
Retrieves the workflow run properties which were set during the run.
-
#get_workflow_runs(params = {}) ⇒ Types::GetWorkflowRunsResponse
Retrieves metadata for all runs of a given workflow.
-
#import_catalog_to_glue(params = {}) ⇒ Struct
Imports an existing Amazon Athena Data Catalog to Glue.
-
#list_blueprints(params = {}) ⇒ Types::ListBlueprintsResponse
Lists all the blueprint names in an account.
-
#list_column_statistics_task_runs(params = {}) ⇒ Types::ListColumnStatisticsTaskRunsResponse
List all task runs for a particular account.
-
#list_crawlers(params = {}) ⇒ Types::ListCrawlersResponse
Retrieves the names of all crawler resources in this Amazon Web Services account, or the resources with the specified tag.
-
#list_crawls(params = {}) ⇒ Types::ListCrawlsResponse
Returns all the crawls of a specified crawler.
-
#list_custom_entity_types(params = {}) ⇒ Types::ListCustomEntityTypesResponse
Lists all the custom patterns that have been created.
-
#list_data_quality_results(params = {}) ⇒ Types::ListDataQualityResultsResponse
Returns all data quality execution results for your account.
-
#list_data_quality_rule_recommendation_runs(params = {}) ⇒ Types::ListDataQualityRuleRecommendationRunsResponse
Lists the recommendation runs meeting the filter criteria.
-
#list_data_quality_ruleset_evaluation_runs(params = {}) ⇒ Types::ListDataQualityRulesetEvaluationRunsResponse
Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
-
#list_data_quality_rulesets(params = {}) ⇒ Types::ListDataQualityRulesetsResponse
Returns a paginated list of rulesets for the specified list of Glue tables.
-
#list_dev_endpoints(params = {}) ⇒ Types::ListDevEndpointsResponse
Retrieves the names of all ‘DevEndpoint` resources in this Amazon Web Services account, or the resources with the specified tag.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag.
-
#list_ml_transforms(params = {}) ⇒ Types::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.
-
#list_registries(params = {}) ⇒ Types::ListRegistriesResponse
Returns a list of registries that you have created, with minimal registry information.
-
#list_schema_versions(params = {}) ⇒ Types::ListSchemaVersionsResponse
Returns a list of schema versions that you have created, with minimal information.
-
#list_schemas(params = {}) ⇒ Types::ListSchemasResponse
Returns a list of schemas with minimal details.
-
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Retrieve a list of sessions.
-
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
Lists statements for the session.
-
#list_table_optimizer_runs(params = {}) ⇒ Types::ListTableOptimizerRunsResponse
Lists the history of previous optimizer runs for a specific table.
-
#list_triggers(params = {}) ⇒ Types::ListTriggersResponse
Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag.
-
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Lists names of workflows created in the account.
-
#put_data_catalog_encryption_settings(params = {}) ⇒ Struct
Sets the security configuration for a specified catalog.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Sets the Data Catalog resource policy for access control.
-
#put_schema_version_metadata(params = {}) ⇒ Types::PutSchemaVersionMetadataResponse
Puts the metadata key value pair for a specified schema version ID.
-
#put_workflow_run_properties(params = {}) ⇒ Struct
Puts the specified workflow run properties for the given workflow run.
-
#query_schema_version_metadata(params = {}) ⇒ Types::QuerySchemaVersionMetadataResponse
Queries for the schema version metadata information.
-
#register_schema_version(params = {}) ⇒ Types::RegisterSchemaVersionResponse
Adds a new version to the existing schema.
-
#remove_schema_version_metadata(params = {}) ⇒ Types::RemoveSchemaVersionMetadataResponse
Removes a key value pair from the schema version metadata for the specified schema version ID.
-
#reset_job_bookmark(params = {}) ⇒ Types::ResetJobBookmarkResponse
Resets a bookmark entry.
-
#resume_workflow_run(params = {}) ⇒ Types::ResumeWorkflowRunResponse
Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run.
-
#run_statement(params = {}) ⇒ Types::RunStatementResponse
Executes the statement.
-
#search_tables(params = {}) ⇒ Types::SearchTablesResponse
Searches a set of tables based on properties in the table metadata as well as on the parent database.
-
#start_blueprint_run(params = {}) ⇒ Types::StartBlueprintRunResponse
Starts a new run of the specified blueprint.
-
#start_column_statistics_task_run(params = {}) ⇒ Types::StartColumnStatisticsTaskRunResponse
Starts a column statistics task run, for a specified table and columns.
-
#start_crawler(params = {}) ⇒ Struct
Starts a crawl using the specified crawler, regardless of what is scheduled.
-
#start_crawler_schedule(params = {}) ⇒ Struct
Changes the schedule state of the specified crawler to ‘SCHEDULED`, unless the crawler is already running or the schedule state is already `SCHEDULED`.
-
#start_data_quality_rule_recommendation_run(params = {}) ⇒ Types::StartDataQualityRuleRecommendationRunResponse
Starts a recommendation run that is used to generate rules when you don’t know what rules to write.
-
#start_data_quality_ruleset_evaluation_run(params = {}) ⇒ Types::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).
-
#start_export_labels_task_run(params = {}) ⇒ Types::StartExportLabelsTaskRunResponse
Begins an asynchronous task to export all labeled data for a particular transform.
-
#start_import_labels_task_run(params = {}) ⇒ Types::StartImportLabelsTaskRunResponse
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality.
-
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Starts a job run using a job definition.
-
#start_ml_evaluation_task_run(params = {}) ⇒ Types::StartMLEvaluationTaskRunResponse
Starts a task to estimate the quality of the transform.
-
#start_ml_labeling_set_generation_task_run(params = {}) ⇒ Types::StartMLLabelingSetGenerationTaskRunResponse
Starts the active learning workflow for your machine learning transform to improve the transform’s quality by generating label sets and adding labels.
-
#start_trigger(params = {}) ⇒ Types::StartTriggerResponse
Starts an existing trigger.
-
#start_workflow_run(params = {}) ⇒ Types::StartWorkflowRunResponse
Starts a new run of the specified workflow.
-
#stop_column_statistics_task_run(params = {}) ⇒ Struct
Stops a task run for the specified table.
-
#stop_crawler(params = {}) ⇒ Struct
If the specified crawler is running, stops the crawl.
-
#stop_crawler_schedule(params = {}) ⇒ Struct
Sets the schedule state of the specified crawler to ‘NOT_SCHEDULED`, but does not stop the crawler if it is already running.
-
#stop_session(params = {}) ⇒ Types::StopSessionResponse
Stops the session.
-
#stop_trigger(params = {}) ⇒ Types::StopTriggerResponse
Stops a specified trigger.
-
#stop_workflow_run(params = {}) ⇒ Struct
Stops the execution of the specified workflow run.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates a registered blueprint.
-
#update_classifier(params = {}) ⇒ Struct
Modifies an existing classifier (a ‘GrokClassifier`, an `XMLClassifier`, a `JsonClassifier`, or a `CsvClassifier`, depending on which field is present).
-
#update_column_statistics_for_partition(params = {}) ⇒ Types::UpdateColumnStatisticsForPartitionResponse
Creates or updates partition statistics of columns.
-
#update_column_statistics_for_table(params = {}) ⇒ Types::UpdateColumnStatisticsForTableResponse
Creates or updates table statistics of columns.
-
#update_connection(params = {}) ⇒ Struct
Updates a connection definition in the Data Catalog.
-
#update_crawler(params = {}) ⇒ Struct
Updates a crawler.
-
#update_crawler_schedule(params = {}) ⇒ Struct
Updates the schedule of a crawler using a ‘cron` expression.
-
#update_data_quality_ruleset(params = {}) ⇒ Types::UpdateDataQualityRulesetResponse
Updates the specified data quality ruleset.
-
#update_database(params = {}) ⇒ Struct
Updates an existing database definition in a Data Catalog.
-
#update_dev_endpoint(params = {}) ⇒ Struct
Updates a specified development endpoint.
-
#update_job(params = {}) ⇒ Types::UpdateJobResponse
Updates an existing job definition.
-
#update_job_from_source_control(params = {}) ⇒ Types::UpdateJobFromSourceControlResponse
Synchronizes a job from the source control repository.
-
#update_ml_transform(params = {}) ⇒ Types::UpdateMLTransformResponse
Updates an existing machine learning transform.
-
#update_partition(params = {}) ⇒ Struct
Updates a partition.
-
#update_registry(params = {}) ⇒ Types::UpdateRegistryResponse
Updates an existing registry which is used to hold a collection of schemas.
-
#update_schema(params = {}) ⇒ Types::UpdateSchemaResponse
Updates the description, compatibility setting, or version checkpoint for a schema set.
-
#update_source_control_from_job(params = {}) ⇒ Types::UpdateSourceControlFromJobResponse
Synchronizes a job to the source control repository.
-
#update_table(params = {}) ⇒ Struct
Updates a metadata table in the Data Catalog.
-
#update_table_optimizer(params = {}) ⇒ Struct
Updates the configuration for an existing table optimizer.
-
#update_trigger(params = {}) ⇒ Types::UpdateTriggerResponse
Updates a trigger definition.
-
#update_user_defined_function(params = {}) ⇒ Struct
Updates an existing function definition in the Data Catalog.
-
#update_workflow(params = {}) ⇒ Types::UpdateWorkflowResponse
Updates an existing workflow.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
420 421 422 |
# File 'lib/aws-sdk-glue/client.rb', line 420 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
17184 17185 17186 |
# File 'lib/aws-sdk-glue/client.rb', line 17184 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
17187 17188 17189 |
# File 'lib/aws-sdk-glue/client.rb', line 17187 def errors_module Errors end |
Instance Method Details
#batch_create_partition(params = {}) ⇒ Types::BatchCreatePartitionResponse
Creates one or more partitions in a batch operation.
530 531 532 533 |
# File 'lib/aws-sdk-glue/client.rb', line 530 def batch_create_partition(params = {}, = {}) req = build_request(:batch_create_partition, params) req.send_request() end |
#batch_delete_connection(params = {}) ⇒ Types::BatchDeleteConnectionResponse
Deletes a list of connection definitions from the Data Catalog.
568 569 570 571 |
# File 'lib/aws-sdk-glue/client.rb', line 568 def batch_delete_connection(params = {}, = {}) req = build_request(:batch_delete_connection, params) req.send_request() end |
#batch_delete_partition(params = {}) ⇒ Types::BatchDeletePartitionResponse
Deletes one or more partitions in a batch operation.
620 621 622 623 |
# File 'lib/aws-sdk-glue/client.rb', line 620 def batch_delete_partition(params = {}, = {}) req = build_request(:batch_delete_partition, params) req.send_request() end |
#batch_delete_table(params = {}) ⇒ Types::BatchDeleteTableResponse
Deletes multiple tables at once.
<note markdown=“1”> 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.
</note>
678 679 680 681 |
# File 'lib/aws-sdk-glue/client.rb', line 678 def batch_delete_table(params = {}, = {}) req = build_request(:batch_delete_table, params) req.send_request() end |
#batch_delete_table_version(params = {}) ⇒ Types::BatchDeleteTableVersionResponse
Deletes a specified batch of versions of a table.
726 727 728 729 |
# File 'lib/aws-sdk-glue/client.rb', line 726 def batch_delete_table_version(params = {}, = {}) req = build_request(:batch_delete_table_version, params) req.send_request() end |
#batch_get_blueprints(params = {}) ⇒ Types::BatchGetBlueprintsResponse
Retrieves information about a list of blueprints.
780 781 782 783 |
# File 'lib/aws-sdk-glue/client.rb', line 780 def batch_get_blueprints(params = {}, = {}) req = build_request(:batch_get_blueprints, params) req.send_request() end |
#batch_get_crawlers(params = {}) ⇒ Types::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.
894 895 896 897 |
# File 'lib/aws-sdk-glue/client.rb', line 894 def batch_get_crawlers(params = {}, = {}) req = build_request(:batch_get_crawlers, params) req.send_request() end |
#batch_get_custom_entity_types(params = {}) ⇒ Types::BatchGetCustomEntityTypesResponse
Retrieves the details for the custom patterns specified by a list of names.
930 931 932 933 |
# File 'lib/aws-sdk-glue/client.rb', line 930 def batch_get_custom_entity_types(params = {}, = {}) req = build_request(:batch_get_custom_entity_types, params) req.send_request() end |
#batch_get_data_quality_result(params = {}) ⇒ Types::BatchGetDataQualityResultResponse
Retrieves a list of data quality results for the specified result IDs.
998 999 1000 1001 |
# File 'lib/aws-sdk-glue/client.rb', line 998 def batch_get_data_quality_result(params = {}, = {}) req = build_request(:batch_get_data_quality_result, params) req.send_request() end |
#batch_get_dev_endpoints(params = {}) ⇒ Types::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.
1062 1063 1064 1065 |
# File 'lib/aws-sdk-glue/client.rb', line 1062 def batch_get_dev_endpoints(params = {}, = {}) req = build_request(:batch_get_dev_endpoints, params) req.send_request() end |
#batch_get_jobs(params = {}) ⇒ Types::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.
1980 1981 1982 1983 |
# File 'lib/aws-sdk-glue/client.rb', line 1980 def batch_get_jobs(params = {}, = {}) req = build_request(:batch_get_jobs, params) req.send_request() end |
#batch_get_partition(params = {}) ⇒ Types::BatchGetPartitionResponse
Retrieves partitions in a batch request.
2076 2077 2078 2079 |
# File 'lib/aws-sdk-glue/client.rb', line 2076 def batch_get_partition(params = {}, = {}) req = build_request(:batch_get_partition, params) req.send_request() end |
#batch_get_table_optimizer(params = {}) ⇒ Types::BatchGetTableOptimizerResponse
Returns the configuration for the specified table optimizers.
2134 2135 2136 2137 |
# File 'lib/aws-sdk-glue/client.rb', line 2134 def batch_get_table_optimizer(params = {}, = {}) req = build_request(:batch_get_table_optimizer, params) req.send_request() end |
#batch_get_triggers(params = {}) ⇒ Types::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.
2194 2195 2196 2197 |
# File 'lib/aws-sdk-glue/client.rb', line 2194 def batch_get_triggers(params = {}, = {}) req = build_request(:batch_get_triggers, params) req.send_request() end |
#batch_get_workflows(params = {}) ⇒ Types::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.
2397 2398 2399 2400 |
# File 'lib/aws-sdk-glue/client.rb', line 2397 def batch_get_workflows(params = {}, = {}) req = build_request(:batch_get_workflows, params) req.send_request() end |
#batch_stop_job_run(params = {}) ⇒ Types::BatchStopJobRunResponse
Stops one or more job runs for a specified job definition.
2438 2439 2440 2441 |
# File 'lib/aws-sdk-glue/client.rb', line 2438 def batch_stop_job_run(params = {}, = {}) req = build_request(:batch_stop_job_run, params) req.send_request() end |
#batch_update_partition(params = {}) ⇒ Types::BatchUpdatePartitionResponse
Updates one or more partitions in a batch operation.
2550 2551 2552 2553 |
# File 'lib/aws-sdk-glue/client.rb', line 2550 def batch_update_partition(params = {}, = {}) req = build_request(:batch_update_partition, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
17162 17163 17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 |
# File 'lib/aws-sdk-glue/client.rb', line 17162 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-glue' context[:gem_version] = '1.174.0' Seahorse::Client::Request.new(handlers, context) end |
#cancel_data_quality_rule_recommendation_run(params = {}) ⇒ Struct
Cancels the specified recommendation run that was being used to generate rules.
2573 2574 2575 2576 |
# File 'lib/aws-sdk-glue/client.rb', line 2573 def cancel_data_quality_rule_recommendation_run(params = {}, = {}) req = build_request(:cancel_data_quality_rule_recommendation_run, params) req.send_request() end |
#cancel_data_quality_ruleset_evaluation_run(params = {}) ⇒ Struct
Cancels a run where a ruleset is being evaluated against a data source.
2596 2597 2598 2599 |
# File 'lib/aws-sdk-glue/client.rb', line 2596 def cancel_data_quality_ruleset_evaluation_run(params = {}, = {}) req = build_request(:cancel_data_quality_ruleset_evaluation_run, params) req.send_request() end |
#cancel_ml_task_run(params = {}) ⇒ Types::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`.
2636 2637 2638 2639 |
# File 'lib/aws-sdk-glue/client.rb', line 2636 def cancel_ml_task_run(params = {}, = {}) req = build_request(:cancel_ml_task_run, params) req.send_request() end |
#cancel_statement(params = {}) ⇒ Struct
Cancels the statement.
2666 2667 2668 2669 |
# File 'lib/aws-sdk-glue/client.rb', line 2666 def cancel_statement(params = {}, = {}) req = build_request(:cancel_statement, params) req.send_request() end |
#check_schema_version_validity(params = {}) ⇒ Types::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.
2704 2705 2706 2707 |
# File 'lib/aws-sdk-glue/client.rb', line 2704 def check_schema_version_validity(params = {}, = {}) req = build_request(:check_schema_version_validity, params) req.send_request() end |
#create_blueprint(params = {}) ⇒ Types::CreateBlueprintResponse
Registers a blueprint with Glue.
2746 2747 2748 2749 |
# File 'lib/aws-sdk-glue/client.rb', line 2746 def create_blueprint(params = {}, = {}) req = build_request(:create_blueprint, params) req.send_request() end |
#create_classifier(params = {}) ⇒ Struct
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.
2805 2806 2807 2808 |
# File 'lib/aws-sdk-glue/client.rb', line 2805 def create_classifier(params = {}, = {}) req = build_request(:create_classifier, params) req.send_request() end |
#create_connection(params = {}) ⇒ Struct
Creates a connection definition in the Data Catalog.
Connections used for creating federated resources require the IAM ‘glue:PassConnection` permission.
2854 2855 2856 2857 |
# File 'lib/aws-sdk-glue/client.rb', line 2854 def create_connection(params = {}, = {}) req = build_request(:create_connection, params) req.send_request() end |
#create_crawler(params = {}) ⇒ Struct
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.
3038 3039 3040 3041 |
# File 'lib/aws-sdk-glue/client.rb', line 3038 def create_crawler(params = {}, = {}) req = build_request(:create_crawler, params) req.send_request() end |
#create_custom_entity_type(params = {}) ⇒ Types::CreateCustomEntityTypeResponse
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.
3092 3093 3094 3095 |
# File 'lib/aws-sdk-glue/client.rb', line 3092 def create_custom_entity_type(params = {}, = {}) req = build_request(:create_custom_entity_type, params) req.send_request() end |
#create_data_quality_ruleset(params = {}) ⇒ Types::CreateDataQualityRulesetResponse
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.
3153 3154 3155 3156 |
# File 'lib/aws-sdk-glue/client.rb', line 3153 def create_data_quality_ruleset(params = {}, = {}) req = build_request(:create_data_quality_ruleset, params) req.send_request() end |
#create_database(params = {}) ⇒ Struct
Creates a new database in a Data Catalog.
3210 3211 3212 3213 |
# File 'lib/aws-sdk-glue/client.rb', line 3210 def create_database(params = {}, = {}) req = build_request(:create_database, params) req.send_request() end |
#create_dev_endpoint(params = {}) ⇒ Types::CreateDevEndpointResponse
Creates a new development endpoint.
3409 3410 3411 3412 |
# File 'lib/aws-sdk-glue/client.rb', line 3409 def create_dev_endpoint(params = {}, = {}) req = build_request(:create_dev_endpoint, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates a new job definition.
3655 3656 3657 3658 |
# File 'lib/aws-sdk-glue/client.rb', line 3655 def create_job(params = {}, = {}) req = build_request(:create_job, params) req.send_request() end |
#create_ml_transform(params = {}) ⇒ Types::CreateMLTransformResponse
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].
[1]: docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html
3867 3868 3869 3870 |
# File 'lib/aws-sdk-glue/client.rb', line 3867 def create_ml_transform(params = {}, = {}) req = build_request(:create_ml_transform, params) req.send_request() end |
#create_partition(params = {}) ⇒ Struct
Creates a new partition.
3963 3964 3965 3966 |
# File 'lib/aws-sdk-glue/client.rb', line 3963 def create_partition(params = {}, = {}) req = build_request(:create_partition, params) req.send_request() end |
#create_partition_index(params = {}) ⇒ Struct
Creates a specified partition index in an existing table.
4003 4004 4005 4006 |
# File 'lib/aws-sdk-glue/client.rb', line 4003 def create_partition_index(params = {}, = {}) req = build_request(:create_partition_index, params) req.send_request() end |
#create_registry(params = {}) ⇒ Types::CreateRegistryResponse
Creates a new registry which may be used to hold a collection of schemas.
4053 4054 4055 4056 |
# File 'lib/aws-sdk-glue/client.rb', line 4053 def create_registry(params = {}, = {}) req = build_request(:create_registry, params) req.send_request() end |
#create_schema(params = {}) ⇒ Types::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.
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.
4201 4202 4203 4204 |
# File 'lib/aws-sdk-glue/client.rb', line 4201 def create_schema(params = {}, = {}) req = build_request(:create_schema, params) req.send_request() end |
#create_script(params = {}) ⇒ Types::CreateScriptResponse
Transforms a directed acyclic graph (DAG) into code.
4258 4259 4260 4261 |
# File 'lib/aws-sdk-glue/client.rb', line 4258 def create_script(params = {}, = {}) req = build_request(:create_script, params) req.send_request() end |
#create_security_configuration(params = {}) ⇒ Types::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].
[1]: docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html
4315 4316 4317 4318 |
# File 'lib/aws-sdk-glue/client.rb', line 4315 def create_security_configuration(params = {}, = {}) req = build_request(:create_security_configuration, params) req.send_request() end |
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a new session.
4475 4476 4477 4478 |
# File 'lib/aws-sdk-glue/client.rb', line 4475 def create_session(params = {}, = {}) req = build_request(:create_session, params) req.send_request() end |
#create_table(params = {}) ⇒ Struct
Creates a new table definition in the Data Catalog.
4613 4614 4615 4616 |
# File 'lib/aws-sdk-glue/client.rb', line 4613 def create_table(params = {}, = {}) req = build_request(:create_table, params) req.send_request() end |
#create_table_optimizer(params = {}) ⇒ Struct
Creates a new table optimizer for a specific function. ‘compaction` is the only currently supported optimizer type.
4657 4658 4659 4660 |
# File 'lib/aws-sdk-glue/client.rb', line 4657 def create_table_optimizer(params = {}, = {}) req = build_request(:create_table_optimizer, params) req.send_request() end |
#create_trigger(params = {}) ⇒ Types::CreateTriggerResponse
Creates a new trigger.
4768 4769 4770 4771 |
# File 'lib/aws-sdk-glue/client.rb', line 4768 def create_trigger(params = {}, = {}) req = build_request(:create_trigger, params) req.send_request() end |
#create_user_defined_function(params = {}) ⇒ Struct
Creates a new function definition in the Data Catalog.
4811 4812 4813 4814 |
# File 'lib/aws-sdk-glue/client.rb', line 4811 def create_user_defined_function(params = {}, = {}) req = build_request(:create_user_defined_function, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a new workflow.
4865 4866 4867 4868 |
# File 'lib/aws-sdk-glue/client.rb', line 4865 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_blueprint(params = {}) ⇒ Types::DeleteBlueprintResponse
Deletes an existing blueprint.
4893 4894 4895 4896 |
# File 'lib/aws-sdk-glue/client.rb', line 4893 def delete_blueprint(params = {}, = {}) req = build_request(:delete_blueprint, params) req.send_request() end |
#delete_classifier(params = {}) ⇒ Struct
Removes a classifier from the Data Catalog.
4915 4916 4917 4918 |
# File 'lib/aws-sdk-glue/client.rb', line 4915 def delete_classifier(params = {}, = {}) req = build_request(:delete_classifier, params) req.send_request() end |
#delete_column_statistics_for_partition(params = {}) ⇒ Struct
Delete the partition column statistics of a column.
The Identity and Access Management (IAM) permission required for this operation is ‘DeletePartition`.
4958 4959 4960 4961 |
# File 'lib/aws-sdk-glue/client.rb', line 4958 def delete_column_statistics_for_partition(params = {}, = {}) req = build_request(:delete_column_statistics_for_partition, params) req.send_request() end |
#delete_column_statistics_for_table(params = {}) ⇒ Struct
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is ‘DeleteTable`.
4997 4998 4999 5000 |
# File 'lib/aws-sdk-glue/client.rb', line 4997 def delete_column_statistics_for_table(params = {}, = {}) req = build_request(:delete_column_statistics_for_table, params) req.send_request() end |
#delete_connection(params = {}) ⇒ Struct
Deletes a connection from the Data Catalog.
5024 5025 5026 5027 |
# File 'lib/aws-sdk-glue/client.rb', line 5024 def delete_connection(params = {}, = {}) req = build_request(:delete_connection, params) req.send_request() end |
#delete_crawler(params = {}) ⇒ Struct
Removes a specified crawler from the Glue Data Catalog, unless the crawler state is ‘RUNNING`.
5047 5048 5049 5050 |
# File 'lib/aws-sdk-glue/client.rb', line 5047 def delete_crawler(params = {}, = {}) req = build_request(:delete_crawler, params) req.send_request() end |
#delete_custom_entity_type(params = {}) ⇒ Types::DeleteCustomEntityTypeResponse
Deletes a custom pattern by specifying its name.
5075 5076 5077 5078 |
# File 'lib/aws-sdk-glue/client.rb', line 5075 def delete_custom_entity_type(params = {}, = {}) req = build_request(:delete_custom_entity_type, params) req.send_request() end |
#delete_data_quality_ruleset(params = {}) ⇒ Struct
Deletes a data quality ruleset.
5097 5098 5099 5100 |
# File 'lib/aws-sdk-glue/client.rb', line 5097 def delete_data_quality_ruleset(params = {}, = {}) req = build_request(:delete_data_quality_ruleset, params) req.send_request() end |
#delete_database(params = {}) ⇒ Struct
Removes a specified database from a Data Catalog.
<note markdown=“1”> 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.
</note>
5140 5141 5142 5143 |
# File 'lib/aws-sdk-glue/client.rb', line 5140 def delete_database(params = {}, = {}) req = build_request(:delete_database, params) req.send_request() end |
#delete_dev_endpoint(params = {}) ⇒ Struct
Deletes a specified development endpoint.
5162 5163 5164 5165 |
# File 'lib/aws-sdk-glue/client.rb', line 5162 def delete_dev_endpoint(params = {}, = {}) req = build_request(:delete_dev_endpoint, params) req.send_request() end |
#delete_job(params = {}) ⇒ Types::DeleteJobResponse
Deletes a specified job definition. If the job definition is not found, no exception is thrown.
5191 5192 5193 5194 |
# File 'lib/aws-sdk-glue/client.rb', line 5191 def delete_job(params = {}, = {}) req = build_request(:delete_job, params) req.send_request() end |
#delete_ml_transform(params = {}) ⇒ Types::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.
5225 5226 5227 5228 |
# File 'lib/aws-sdk-glue/client.rb', line 5225 def delete_ml_transform(params = {}, = {}) req = build_request(:delete_ml_transform, params) req.send_request() end |
#delete_partition(params = {}) ⇒ Struct
Deletes a specified partition.
5262 5263 5264 5265 |
# File 'lib/aws-sdk-glue/client.rb', line 5262 def delete_partition(params = {}, = {}) req = build_request(:delete_partition, params) req.send_request() end |
#delete_partition_index(params = {}) ⇒ Struct
Deletes a specified partition index from an existing table.
5298 5299 5300 5301 |
# File 'lib/aws-sdk-glue/client.rb', line 5298 def delete_partition_index(params = {}, = {}) req = build_request(:delete_partition_index, params) req.send_request() end |
#delete_registry(params = {}) ⇒ Types::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.
5339 5340 5341 5342 |
# File 'lib/aws-sdk-glue/client.rb', line 5339 def delete_registry(params = {}, = {}) req = build_request(:delete_registry, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a specified policy.
5365 5366 5367 5368 |
# File 'lib/aws-sdk-glue/client.rb', line 5365 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#delete_schema(params = {}) ⇒ Types::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.
5406 5407 5408 5409 |
# File 'lib/aws-sdk-glue/client.rb', line 5406 def delete_schema(params = {}, = {}) req = build_request(:delete_schema, params) req.send_request() end |
#delete_schema_versions(params = {}) ⇒ Types::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.
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.
5468 5469 5470 5471 |
# File 'lib/aws-sdk-glue/client.rb', line 5468 def delete_schema_versions(params = {}, = {}) req = build_request(:delete_schema_versions, params) req.send_request() end |
#delete_security_configuration(params = {}) ⇒ Struct
Deletes a specified security configuration.
5490 5491 5492 5493 |
# File 'lib/aws-sdk-glue/client.rb', line 5490 def delete_security_configuration(params = {}, = {}) req = build_request(:delete_security_configuration, params) req.send_request() end |
#delete_session(params = {}) ⇒ Types::DeleteSessionResponse
Deletes the session.
5522 5523 5524 5525 |
# File 'lib/aws-sdk-glue/client.rb', line 5522 def delete_session(params = {}, = {}) req = build_request(:delete_session, params) req.send_request() end |
#delete_table(params = {}) ⇒ Struct
Removes a table definition from the Data Catalog.
<note markdown=“1”> 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.
</note>
5572 5573 5574 5575 |
# File 'lib/aws-sdk-glue/client.rb', line 5572 def delete_table(params = {}, = {}) req = build_request(:delete_table, params) req.send_request() end |
#delete_table_optimizer(params = {}) ⇒ Struct
Deletes an optimizer and all associated metadata for a table. The optimization will no longer be performed on the table.
5607 5608 5609 5610 |
# File 'lib/aws-sdk-glue/client.rb', line 5607 def delete_table_optimizer(params = {}, = {}) req = build_request(:delete_table_optimizer, params) req.send_request() end |
#delete_table_version(params = {}) ⇒ Struct
Deletes a specified version of a table.
5645 5646 5647 5648 |
# File 'lib/aws-sdk-glue/client.rb', line 5645 def delete_table_version(params = {}, = {}) req = build_request(:delete_table_version, params) req.send_request() end |
#delete_trigger(params = {}) ⇒ Types::DeleteTriggerResponse
Deletes a specified trigger. If the trigger is not found, no exception is thrown.
5674 5675 5676 5677 |
# File 'lib/aws-sdk-glue/client.rb', line 5674 def delete_trigger(params = {}, = {}) req = build_request(:delete_trigger, params) req.send_request() end |
#delete_user_defined_function(params = {}) ⇒ Struct
Deletes an existing function definition from the Data Catalog.
5706 5707 5708 5709 |
# File 'lib/aws-sdk-glue/client.rb', line 5706 def delete_user_defined_function(params = {}, = {}) req = build_request(:delete_user_defined_function, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Types::DeleteWorkflowResponse
Deletes a workflow.
5734 5735 5736 5737 |
# File 'lib/aws-sdk-glue/client.rb', line 5734 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#get_blueprint(params = {}) ⇒ Types::GetBlueprintResponse
Retrieves the details of a blueprint.
5783 5784 5785 5786 |
# File 'lib/aws-sdk-glue/client.rb', line 5783 def get_blueprint(params = {}, = {}) req = build_request(:get_blueprint, params) req.send_request() end |
#get_blueprint_run(params = {}) ⇒ Types::GetBlueprintRunResponse
Retrieves the details of a blueprint run.
5824 5825 5826 5827 |
# File 'lib/aws-sdk-glue/client.rb', line 5824 def get_blueprint_run(params = {}, = {}) req = build_request(:get_blueprint_run, params) req.send_request() end |
#get_blueprint_runs(params = {}) ⇒ Types::GetBlueprintRunsResponse
Retrieves the details of blueprint runs for a specified blueprint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5874 5875 5876 5877 |
# File 'lib/aws-sdk-glue/client.rb', line 5874 def get_blueprint_runs(params = {}, = {}) req = build_request(:get_blueprint_runs, params) req.send_request() end |
#get_catalog_import_status(params = {}) ⇒ Types::GetCatalogImportStatusResponse
Retrieves the status of a migration operation.
5905 5906 5907 5908 |
# File 'lib/aws-sdk-glue/client.rb', line 5905 def get_catalog_import_status(params = {}, = {}) req = build_request(:get_catalog_import_status, params) req.send_request() end |
#get_classifier(params = {}) ⇒ Types::GetClassifierResponse
Retrieve a classifier by name.
5965 5966 5967 5968 |
# File 'lib/aws-sdk-glue/client.rb', line 5965 def get_classifier(params = {}, = {}) req = build_request(:get_classifier, params) req.send_request() end |
#get_classifiers(params = {}) ⇒ Types::GetClassifiersResponse
Lists all classifier objects in the Data Catalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6034 6035 6036 6037 |
# File 'lib/aws-sdk-glue/client.rb', line 6034 def get_classifiers(params = {}, = {}) req = build_request(:get_classifiers, params) req.send_request() end |
#get_column_statistics_for_partition(params = {}) ⇒ Types::GetColumnStatisticsForPartitionResponse
Retrieves partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is ‘GetPartition`.
6120 6121 6122 6123 |
# File 'lib/aws-sdk-glue/client.rb', line 6120 def get_column_statistics_for_partition(params = {}, = {}) req = build_request(:get_column_statistics_for_partition, params) req.send_request() end |
#get_column_statistics_for_table(params = {}) ⇒ Types::GetColumnStatisticsForTableResponse
Retrieves table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is ‘GetTable`.
6202 6203 6204 6205 |
# File 'lib/aws-sdk-glue/client.rb', line 6202 def get_column_statistics_for_table(params = {}, = {}) req = build_request(:get_column_statistics_for_table, params) req.send_request() end |
#get_column_statistics_task_run(params = {}) ⇒ Types::GetColumnStatisticsTaskRunResponse
Get the associated metadata/information for a task run, given a task run ID.
6249 6250 6251 6252 |
# File 'lib/aws-sdk-glue/client.rb', line 6249 def get_column_statistics_task_run(params = {}, = {}) req = build_request(:get_column_statistics_task_run, params) req.send_request() end |
#get_column_statistics_task_runs(params = {}) ⇒ Types::GetColumnStatisticsTaskRunsResponse
Retrieves information about all runs associated with the specified table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6313 6314 6315 6316 |
# File 'lib/aws-sdk-glue/client.rb', line 6313 def get_column_statistics_task_runs(params = {}, = {}) req = build_request(:get_column_statistics_task_runs, params) req.send_request() end |
#get_connection(params = {}) ⇒ Types::GetConnectionResponse
Retrieves a connection definition from the Data Catalog.
6368 6369 6370 6371 |
# File 'lib/aws-sdk-glue/client.rb', line 6368 def get_connection(params = {}, = {}) req = build_request(:get_connection, params) req.send_request() end |
#get_connections(params = {}) ⇒ Types::GetConnectionsResponse
Retrieves a list of connection definitions from the Data Catalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6439 6440 6441 6442 |
# File 'lib/aws-sdk-glue/client.rb', line 6439 def get_connections(params = {}, = {}) req = build_request(:get_connections, params) req.send_request() end |
#get_crawler(params = {}) ⇒ Types::GetCrawlerResponse
Retrieves metadata for a specified crawler.
6544 6545 6546 6547 |
# File 'lib/aws-sdk-glue/client.rb', line 6544 def get_crawler(params = {}, = {}) req = build_request(:get_crawler, params) req.send_request() end |
#get_crawler_metrics(params = {}) ⇒ Types::GetCrawlerMetricsResponse
Retrieves metrics about specified crawlers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6592 6593 6594 6595 |
# File 'lib/aws-sdk-glue/client.rb', line 6592 def get_crawler_metrics(params = {}, = {}) req = build_request(:get_crawler_metrics, params) req.send_request() end |
#get_crawlers(params = {}) ⇒ Types::GetCrawlersResponse
Retrieves metadata for all crawlers defined in the customer account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6706 6707 6708 6709 |
# File 'lib/aws-sdk-glue/client.rb', line 6706 def get_crawlers(params = {}, = {}) req = build_request(:get_crawlers, params) req.send_request() end |
#get_custom_entity_type(params = {}) ⇒ Types::GetCustomEntityTypeResponse
Retrieves the details of a custom pattern by specifying its name.
6739 6740 6741 6742 |
# File 'lib/aws-sdk-glue/client.rb', line 6739 def get_custom_entity_type(params = {}, = {}) req = build_request(:get_custom_entity_type, params) req.send_request() end |
#get_data_catalog_encryption_settings(params = {}) ⇒ Types::GetDataCatalogEncryptionSettingsResponse
Retrieves the security configuration for a specified catalog.
6773 6774 6775 6776 |
# File 'lib/aws-sdk-glue/client.rb', line 6773 def get_data_catalog_encryption_settings(params = {}, = {}) req = build_request(:get_data_catalog_encryption_settings, params) req.send_request() end |
#get_data_quality_result(params = {}) ⇒ Types::GetDataQualityResultResponse
Retrieves the result of a data quality rule evaluation.
6849 6850 6851 6852 |
# File 'lib/aws-sdk-glue/client.rb', line 6849 def get_data_quality_result(params = {}, = {}) req = build_request(:get_data_quality_result, params) req.send_request() end |
#get_data_quality_rule_recommendation_run(params = {}) ⇒ Types::GetDataQualityRuleRecommendationRunResponse
Gets the specified recommendation run that was used to generate rules.
6906 6907 6908 6909 |
# File 'lib/aws-sdk-glue/client.rb', line 6906 def get_data_quality_rule_recommendation_run(params = {}, = {}) req = build_request(:get_data_quality_rule_recommendation_run, params) req.send_request() end |
#get_data_quality_ruleset(params = {}) ⇒ Types::GetDataQualityRulesetResponse
Returns an existing ruleset by identifier or name.
6948 6949 6950 6951 |
# File 'lib/aws-sdk-glue/client.rb', line 6948 def get_data_quality_ruleset(params = {}, = {}) req = build_request(:get_data_quality_ruleset, params) req.send_request() end |
#get_data_quality_ruleset_evaluation_run(params = {}) ⇒ Types::GetDataQualityRulesetEvaluationRunResponse
Retrieves a specific run where a ruleset is evaluated against a data source.
7019 7020 7021 7022 |
# File 'lib/aws-sdk-glue/client.rb', line 7019 def get_data_quality_ruleset_evaluation_run(params = {}, = {}) req = build_request(:get_data_quality_ruleset_evaluation_run, params) req.send_request() end |
#get_database(params = {}) ⇒ Types::GetDatabaseResponse
Retrieves the definition of a specified database.
7068 7069 7070 7071 |
# File 'lib/aws-sdk-glue/client.rb', line 7068 def get_database(params = {}, = {}) req = build_request(:get_database, params) req.send_request() end |
#get_databases(params = {}) ⇒ Types::GetDatabasesResponse
Retrieves all databases defined in a given Data Catalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7140 7141 7142 7143 |
# File 'lib/aws-sdk-glue/client.rb', line 7140 def get_databases(params = {}, = {}) req = build_request(:get_databases, params) req.send_request() end |
#get_dataflow_graph(params = {}) ⇒ Types::GetDataflowGraphResponse
Transforms a Python script into a directed acyclic graph (DAG).
7180 7181 7182 7183 |
# File 'lib/aws-sdk-glue/client.rb', line 7180 def get_dataflow_graph(params = {}, = {}) req = build_request(:get_dataflow_graph, params) req.send_request() end |
#get_dev_endpoint(params = {}) ⇒ Types::GetDevEndpointResponse
Retrieves information about a specified development endpoint.
<note markdown=“1”> 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.
</note>
7242 7243 7244 7245 |
# File 'lib/aws-sdk-glue/client.rb', line 7242 def get_dev_endpoint(params = {}, = {}) req = build_request(:get_dev_endpoint, params) req.send_request() end |
#get_dev_endpoints(params = {}) ⇒ Types::GetDevEndpointsResponse
Retrieves all the development endpoints in this Amazon Web Services account.
<note markdown=“1”> 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.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7314 7315 7316 7317 |
# File 'lib/aws-sdk-glue/client.rb', line 7314 def get_dev_endpoints(params = {}, = {}) req = build_request(:get_dev_endpoints, params) req.send_request() end |
#get_job(params = {}) ⇒ Types::GetJobResponse
Retrieves an existing job definition.
8223 8224 8225 8226 |
# File 'lib/aws-sdk-glue/client.rb', line 8223 def get_job(params = {}, = {}) req = build_request(:get_job, params) req.send_request() end |
#get_job_bookmark(params = {}) ⇒ Types::GetJobBookmarkResponse
Returns information on a job bookmark entry.
For more information about enabling and using job bookmarks, see:
- Tracking processed data using job bookmarks][1
- Job parameters used by Glue][2
- Job structure][3
[1]: docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html [2]: docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html [3]: docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job
8275 8276 8277 8278 |
# File 'lib/aws-sdk-glue/client.rb', line 8275 def get_job_bookmark(params = {}, = {}) req = build_request(:get_job_bookmark, params) req.send_request() end |
#get_job_run(params = {}) ⇒ Types::GetJobRunResponse
Retrieves the metadata for a given job run.
8338 8339 8340 8341 |
# File 'lib/aws-sdk-glue/client.rb', line 8338 def get_job_run(params = {}, = {}) req = build_request(:get_job_run, params) req.send_request() end |
#get_job_runs(params = {}) ⇒ Types::GetJobRunsResponse
Retrieves metadata for all runs of a given job definition.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8406 8407 8408 8409 |
# File 'lib/aws-sdk-glue/client.rb', line 8406 def get_job_runs(params = {}, = {}) req = build_request(:get_job_runs, params) req.send_request() end |
#get_jobs(params = {}) ⇒ Types::GetJobsResponse
Retrieves all current job definitions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9324 9325 9326 9327 |
# File 'lib/aws-sdk-glue/client.rb', line 9324 def get_jobs(params = {}, = {}) req = build_request(:get_jobs, params) req.send_request() end |
#get_mapping(params = {}) ⇒ Types::GetMappingResponse
Creates mappings.
9745 9746 9747 9748 |
# File 'lib/aws-sdk-glue/client.rb', line 9745 def get_mapping(params = {}, = {}) req = build_request(:get_mapping, params) req.send_request() end |
#get_ml_task_run(params = {}) ⇒ Types::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`.
9385 9386 9387 9388 |
# File 'lib/aws-sdk-glue/client.rb', line 9385 def get_ml_task_run(params = {}, = {}) req = build_request(:get_ml_task_run, params) req.send_request() end |
#get_ml_task_runs(params = {}) ⇒ Types::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.
This operation returns a list of historic runs and must be paginated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9467 9468 9469 9470 |
# File 'lib/aws-sdk-glue/client.rb', line 9467 def get_ml_task_runs(params = {}, = {}) req = build_request(:get_ml_task_runs, params) req.send_request() end |
#get_ml_transform(params = {}) ⇒ Types::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`.
9562 9563 9564 9565 |
# File 'lib/aws-sdk-glue/client.rb', line 9562 def get_ml_transform(params = {}, = {}) req = build_request(:get_ml_transform, params) req.send_request() end |
#get_ml_transforms(params = {}) ⇒ Types::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`.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9673 9674 9675 9676 |
# File 'lib/aws-sdk-glue/client.rb', line 9673 def get_ml_transforms(params = {}, = {}) req = build_request(:get_ml_transforms, params) req.send_request() end |
#get_partition(params = {}) ⇒ Types::GetPartitionResponse
Retrieves information about a specified partition.
9832 9833 9834 9835 |
# File 'lib/aws-sdk-glue/client.rb', line 9832 def get_partition(params = {}, = {}) req = build_request(:get_partition, params) req.send_request() end |
#get_partition_indexes(params = {}) ⇒ Types::GetPartitionIndexesResponse
Retrieves the partition indexes associated with a table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9888 9889 9890 9891 |
# File 'lib/aws-sdk-glue/client.rb', line 9888 def get_partition_indexes(params = {}, = {}) req = build_request(:get_partition_indexes, params) req.send_request() end |
#get_partitions(params = {}) ⇒ Types::GetPartitionsResponse
Retrieves information about the partitions in a table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10103 10104 10105 10106 |
# File 'lib/aws-sdk-glue/client.rb', line 10103 def get_partitions(params = {}, = {}) req = build_request(:get_partitions, params) req.send_request() end |
#get_plan(params = {}) ⇒ Types::GetPlanResponse
Gets code to perform a specified mapping.
10202 10203 10204 10205 |
# File 'lib/aws-sdk-glue/client.rb', line 10202 def get_plan(params = {}, = {}) req = build_request(:get_plan, params) req.send_request() end |
#get_registry(params = {}) ⇒ Types::GetRegistryResponse
Describes the specified registry in detail.
10244 10245 10246 10247 |
# File 'lib/aws-sdk-glue/client.rb', line 10244 def get_registry(params = {}, = {}) req = build_request(:get_registry, params) req.send_request() end |
#get_resource_policies(params = {}) ⇒ Types::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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10290 10291 10292 10293 |
# File 'lib/aws-sdk-glue/client.rb', line 10290 def get_resource_policies(params = {}, = {}) req = build_request(:get_resource_policies, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves a specified resource policy.
10331 10332 10333 10334 |
# File 'lib/aws-sdk-glue/client.rb', line 10331 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#get_schema(params = {}) ⇒ Types::GetSchemaResponse
Describes the specified schema in detail.
10395 10396 10397 10398 |
# File 'lib/aws-sdk-glue/client.rb', line 10395 def get_schema(params = {}, = {}) req = build_request(:get_schema, params) req.send_request() end |
#get_schema_by_definition(params = {}) ⇒ Types::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.
10451 10452 10453 10454 |
# File 'lib/aws-sdk-glue/client.rb', line 10451 def get_schema_by_definition(params = {}, = {}) req = build_request(:get_schema_by_definition, params) req.send_request() end |
#get_schema_version(params = {}) ⇒ Types::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.
10518 10519 10520 10521 |
# File 'lib/aws-sdk-glue/client.rb', line 10518 def get_schema_version(params = {}, = {}) req = build_request(:get_schema_version, params) req.send_request() end |
#get_schema_versions_diff(params = {}) ⇒ Types::GetSchemaVersionsDiffResponse
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.
10579 10580 10581 10582 |
# File 'lib/aws-sdk-glue/client.rb', line 10579 def get_schema_versions_diff(params = {}, = {}) req = build_request(:get_schema_versions_diff, params) req.send_request() end |
#get_security_configuration(params = {}) ⇒ Types::GetSecurityConfigurationResponse
Retrieves a specified security configuration.
10615 10616 10617 10618 |
# File 'lib/aws-sdk-glue/client.rb', line 10615 def get_security_configuration(params = {}, = {}) req = build_request(:get_security_configuration, params) req.send_request() end |
#get_security_configurations(params = {}) ⇒ Types::GetSecurityConfigurationsResponse
Retrieves a list of all security configurations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10660 10661 10662 10663 |
# File 'lib/aws-sdk-glue/client.rb', line 10660 def get_security_configurations(params = {}, = {}) req = build_request(:get_security_configurations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves the session.
10713 10714 10715 10716 |
# File 'lib/aws-sdk-glue/client.rb', line 10713 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_statement(params = {}) ⇒ Types::GetStatementResponse
Retrieves the statement.
10761 10762 10763 10764 |
# File 'lib/aws-sdk-glue/client.rb', line 10761 def get_statement(params = {}, = {}) req = build_request(:get_statement, params) req.send_request() end |
#get_table(params = {}) ⇒ Types::GetTableResponse
Retrieves the ‘Table` definition in a Data Catalog for a specified table.
10888 10889 10890 10891 |
# File 'lib/aws-sdk-glue/client.rb', line 10888 def get_table(params = {}, = {}) req = build_request(:get_table, params) req.send_request() end |
#get_table_optimizer(params = {}) ⇒ Types::GetTableOptimizerResponse
Returns the configuration of all optimizers associated with a specified table.
10945 10946 10947 10948 |
# File 'lib/aws-sdk-glue/client.rb', line 10945 def get_table_optimizer(params = {}, = {}) req = build_request(:get_table_optimizer, params) req.send_request() end |
#get_table_version(params = {}) ⇒ Types::GetTableVersionResponse
Retrieves a specified version of a table.
11067 11068 11069 11070 |
# File 'lib/aws-sdk-glue/client.rb', line 11067 def get_table_version(params = {}, = {}) req = build_request(:get_table_version, params) req.send_request() end |
#get_table_versions(params = {}) ⇒ Types::GetTableVersionsResponse
Retrieves a list of strings that identify available versions of a specified table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11198 11199 11200 11201 |
# File 'lib/aws-sdk-glue/client.rb', line 11198 def get_table_versions(params = {}, = {}) req = build_request(:get_table_versions, params) req.send_request() end |
#get_tables(params = {}) ⇒ Types::GetTablesResponse
Retrieves the definitions of some or all of the tables in a given ‘Database`.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11338 11339 11340 11341 |
# File 'lib/aws-sdk-glue/client.rb', line 11338 def get_tables(params = {}, = {}) req = build_request(:get_tables, params) req.send_request() end |
#get_tags(params = {}) ⇒ Types::GetTagsResponse
Retrieves a list of tags associated with a resource.
11368 11369 11370 11371 |
# File 'lib/aws-sdk-glue/client.rb', line 11368 def (params = {}, = {}) req = build_request(:get_tags, params) req.send_request() end |
#get_trigger(params = {}) ⇒ Types::GetTriggerResponse
Retrieves the definition of a trigger.
11419 11420 11421 11422 |
# File 'lib/aws-sdk-glue/client.rb', line 11419 def get_trigger(params = {}, = {}) req = build_request(:get_trigger, params) req.send_request() end |
#get_triggers(params = {}) ⇒ Types::GetTriggersResponse
Gets all the triggers associated with a job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11485 11486 11487 11488 |
# File 'lib/aws-sdk-glue/client.rb', line 11485 def get_triggers(params = {}, = {}) req = build_request(:get_triggers, params) req.send_request() end |
#get_unfiltered_partition_metadata(params = {}) ⇒ Types::GetUnfilteredPartitionMetadataResponse
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`.
11612 11613 11614 11615 |
# File 'lib/aws-sdk-glue/client.rb', line 11612 def (params = {}, = {}) req = build_request(:get_unfiltered_partition_metadata, params) req.send_request() end |
#get_unfiltered_partitions_metadata(params = {}) ⇒ Types::GetUnfilteredPartitionsMetadataResponse
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`.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11842 11843 11844 11845 |
# File 'lib/aws-sdk-glue/client.rb', line 11842 def (params = {}, = {}) req = build_request(:get_unfiltered_partitions_metadata, params) req.send_request() end |
#get_unfiltered_table_metadata(params = {}) ⇒ Types::GetUnfilteredTableMetadataResponse
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`.
12068 12069 12070 12071 |
# File 'lib/aws-sdk-glue/client.rb', line 12068 def (params = {}, = {}) req = build_request(:get_unfiltered_table_metadata, params) req.send_request() end |
#get_user_defined_function(params = {}) ⇒ Types::GetUserDefinedFunctionResponse
Retrieves a specified function definition from the Data Catalog.
12115 12116 12117 12118 |
# File 'lib/aws-sdk-glue/client.rb', line 12115 def get_user_defined_function(params = {}, = {}) req = build_request(:get_user_defined_function, params) req.send_request() end |
#get_user_defined_functions(params = {}) ⇒ Types::GetUserDefinedFunctionsResponse
Retrieves multiple function definitions from the Data Catalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12178 12179 12180 12181 |
# File 'lib/aws-sdk-glue/client.rb', line 12178 def get_user_defined_functions(params = {}, = {}) req = build_request(:get_user_defined_functions, params) req.send_request() end |
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Retrieves resource metadata for a workflow.
12372 12373 12374 12375 |
# File 'lib/aws-sdk-glue/client.rb', line 12372 def get_workflow(params = {}, = {}) req = build_request(:get_workflow, params) req.send_request() end |
#get_workflow_run(params = {}) ⇒ Types::GetWorkflowRunResponse
Retrieves the metadata for a given workflow run.
12493 12494 12495 12496 |
# File 'lib/aws-sdk-glue/client.rb', line 12493 def get_workflow_run(params = {}, = {}) req = build_request(:get_workflow_run, params) req.send_request() end |
#get_workflow_run_properties(params = {}) ⇒ Types::GetWorkflowRunPropertiesResponse
Retrieves the workflow run properties which were set during the run.
12526 12527 12528 12529 |
# File 'lib/aws-sdk-glue/client.rb', line 12526 def get_workflow_run_properties(params = {}, = {}) req = build_request(:get_workflow_run_properties, params) req.send_request() end |
#get_workflow_runs(params = {}) ⇒ Types::GetWorkflowRunsResponse
Retrieves metadata for all runs of a given workflow.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12656 12657 12658 12659 |
# File 'lib/aws-sdk-glue/client.rb', line 12656 def get_workflow_runs(params = {}, = {}) req = build_request(:get_workflow_runs, params) req.send_request() end |
#import_catalog_to_glue(params = {}) ⇒ Struct
Imports an existing Amazon Athena Data Catalog to Glue.
12679 12680 12681 12682 |
# File 'lib/aws-sdk-glue/client.rb', line 12679 def import_catalog_to_glue(params = {}, = {}) req = build_request(:import_catalog_to_glue, params) req.send_request() end |
#list_blueprints(params = {}) ⇒ Types::ListBlueprintsResponse
Lists all the blueprint names in an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12722 12723 12724 12725 |
# File 'lib/aws-sdk-glue/client.rb', line 12722 def list_blueprints(params = {}, = {}) req = build_request(:list_blueprints, params) req.send_request() end |
#list_column_statistics_task_runs(params = {}) ⇒ Types::ListColumnStatisticsTaskRunsResponse
List all task runs for a particular account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12759 12760 12761 12762 |
# File 'lib/aws-sdk-glue/client.rb', line 12759 def list_column_statistics_task_runs(params = {}, = {}) req = build_request(:list_column_statistics_task_runs, params) req.send_request() end |
#list_crawlers(params = {}) ⇒ Types::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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12810 12811 12812 12813 |
# File 'lib/aws-sdk-glue/client.rb', line 12810 def list_crawlers(params = {}, = {}) req = build_request(:list_crawlers, params) req.send_request() end |
#list_crawls(params = {}) ⇒ Types::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.
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.
12886 12887 12888 12889 |
# File 'lib/aws-sdk-glue/client.rb', line 12886 def list_crawls(params = {}, = {}) req = build_request(:list_crawls, params) req.send_request() end |
#list_custom_entity_types(params = {}) ⇒ Types::ListCustomEntityTypesResponse
Lists all the custom patterns that have been created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12932 12933 12934 12935 |
# File 'lib/aws-sdk-glue/client.rb', line 12932 def list_custom_entity_types(params = {}, = {}) req = build_request(:list_custom_entity_types, params) req.send_request() end |
#list_data_quality_results(params = {}) ⇒ Types::ListDataQualityResultsResponse
Returns all data quality execution results for your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12998 12999 13000 13001 |
# File 'lib/aws-sdk-glue/client.rb', line 12998 def list_data_quality_results(params = {}, = {}) req = build_request(:list_data_quality_results, params) req.send_request() end |
#list_data_quality_rule_recommendation_runs(params = {}) ⇒ Types::ListDataQualityRuleRecommendationRunsResponse
Lists the recommendation runs meeting the filter criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13061 13062 13063 13064 |
# File 'lib/aws-sdk-glue/client.rb', line 13061 def list_data_quality_rule_recommendation_runs(params = {}, = {}) req = build_request(:list_data_quality_rule_recommendation_runs, params) req.send_request() end |
#list_data_quality_ruleset_evaluation_runs(params = {}) ⇒ Types::ListDataQualityRulesetEvaluationRunsResponse
Lists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13125 13126 13127 13128 |
# File 'lib/aws-sdk-glue/client.rb', line 13125 def list_data_quality_ruleset_evaluation_runs(params = {}, = {}) req = build_request(:list_data_quality_ruleset_evaluation_runs, params) req.send_request() end |
#list_data_quality_rulesets(params = {}) ⇒ Types::ListDataQualityRulesetsResponse
Returns a paginated list of rulesets for the specified list of Glue tables.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13193 13194 13195 13196 |
# File 'lib/aws-sdk-glue/client.rb', line 13193 def list_data_quality_rulesets(params = {}, = {}) req = build_request(:list_data_quality_rulesets, params) req.send_request() end |
#list_dev_endpoints(params = {}) ⇒ Types::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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13244 13245 13246 13247 |
# File 'lib/aws-sdk-glue/client.rb', line 13244 def list_dev_endpoints(params = {}, = {}) req = build_request(:list_dev_endpoints, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13295 13296 13297 13298 |
# File 'lib/aws-sdk-glue/client.rb', line 13295 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_ml_transforms(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13371 13372 13373 13374 |
# File 'lib/aws-sdk-glue/client.rb', line 13371 def list_ml_transforms(params = {}, = {}) req = build_request(:list_ml_transforms, params) req.send_request() end |
#list_registries(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13417 13418 13419 13420 |
# File 'lib/aws-sdk-glue/client.rb', line 13417 def list_registries(params = {}, = {}) req = build_request(:list_registries, params) req.send_request() end |
#list_schema_versions(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13478 13479 13480 13481 |
# File 'lib/aws-sdk-glue/client.rb', line 13478 def list_schema_versions(params = {}, = {}) req = build_request(:list_schema_versions, params) req.send_request() end |
#list_schemas(params = {}) ⇒ Types::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.
When the ‘RegistryId` is not provided, all the schemas across registries will be part of the API response.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13535 13536 13537 13538 |
# File 'lib/aws-sdk-glue/client.rb', line 13535 def list_schemas(params = {}, = {}) req = build_request(:list_schemas, params) req.send_request() end |
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Retrieve a list of sessions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13607 13608 13609 13610 |
# File 'lib/aws-sdk-glue/client.rb', line 13607 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
Lists statements for the session.
13658 13659 13660 13661 |
# File 'lib/aws-sdk-glue/client.rb', line 13658 def list_statements(params = {}, = {}) req = build_request(:list_statements, params) req.send_request() end |
#list_table_optimizer_runs(params = {}) ⇒ Types::ListTableOptimizerRunsResponse
Lists the history of previous optimizer runs for a specific table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13725 13726 13727 13728 |
# File 'lib/aws-sdk-glue/client.rb', line 13725 def list_table_optimizer_runs(params = {}, = {}) req = build_request(:list_table_optimizer_runs, params) req.send_request() end |
#list_triggers(params = {}) ⇒ Types::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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13782 13783 13784 13785 |
# File 'lib/aws-sdk-glue/client.rb', line 13782 def list_triggers(params = {}, = {}) req = build_request(:list_triggers, params) req.send_request() end |
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Lists names of workflows created in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13819 13820 13821 13822 |
# File 'lib/aws-sdk-glue/client.rb', line 13819 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#put_data_catalog_encryption_settings(params = {}) ⇒ Struct
Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.
13859 13860 13861 13862 |
# File 'lib/aws-sdk-glue/client.rb', line 13859 def put_data_catalog_encryption_settings(params = {}, = {}) req = build_request(:put_data_catalog_encryption_settings, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Sets the Data Catalog resource policy for access control.
13919 13920 13921 13922 |
# File 'lib/aws-sdk-glue/client.rb', line 13919 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#put_schema_version_metadata(params = {}) ⇒ Types::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.
13985 13986 13987 13988 |
# File 'lib/aws-sdk-glue/client.rb', line 13985 def (params = {}, = {}) req = build_request(:put_schema_version_metadata, params) req.send_request() end |
#put_workflow_run_properties(params = {}) ⇒ Struct
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.
14020 14021 14022 14023 |
# File 'lib/aws-sdk-glue/client.rb', line 14020 def put_workflow_run_properties(params = {}, = {}) req = build_request(:put_workflow_run_properties, params) req.send_request() end |
#query_schema_version_metadata(params = {}) ⇒ Types::QuerySchemaVersionMetadataResponse
Queries for the schema version metadata information.
14092 14093 14094 14095 |
# File 'lib/aws-sdk-glue/client.rb', line 14092 def (params = {}, = {}) req = build_request(:query_schema_version_metadata, params) req.send_request() end |
#register_schema_version(params = {}) ⇒ Types::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.
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.
14156 14157 14158 14159 |
# File 'lib/aws-sdk-glue/client.rb', line 14156 def register_schema_version(params = {}, = {}) req = build_request(:register_schema_version, params) req.send_request() end |
#remove_schema_version_metadata(params = {}) ⇒ Types::RemoveSchemaVersionMetadataResponse
Removes a key value pair from the schema version metadata for the specified schema version ID.
14222 14223 14224 14225 |
# File 'lib/aws-sdk-glue/client.rb', line 14222 def (params = {}, = {}) req = build_request(:remove_schema_version_metadata, params) req.send_request() end |
#reset_job_bookmark(params = {}) ⇒ Types::ResetJobBookmarkResponse
Resets a bookmark entry.
For more information about enabling and using job bookmarks, see:
- Tracking processed data using job bookmarks][1
- Job parameters used by Glue][2
- Job structure][3
[1]: docs.aws.amazon.com/glue/latest/dg/monitor-continuations.html [2]: docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html [3]: docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job
14274 14275 14276 14277 |
# File 'lib/aws-sdk-glue/client.rb', line 14274 def reset_job_bookmark(params = {}, = {}) req = build_request(:reset_job_bookmark, params) req.send_request() end |
#resume_workflow_run(params = {}) ⇒ Types::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.
14316 14317 14318 14319 |
# File 'lib/aws-sdk-glue/client.rb', line 14316 def resume_workflow_run(params = {}, = {}) req = build_request(:resume_workflow_run, params) req.send_request() end |
#run_statement(params = {}) ⇒ Types::RunStatementResponse
Executes the statement.
14352 14353 14354 14355 |
# File 'lib/aws-sdk-glue/client.rb', line 14352 def run_statement(params = {}, = {}) req = build_request(:run_statement, params) req.send_request() end |
#search_tables(params = {}) ⇒ Types::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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
14530 14531 14532 14533 |
# File 'lib/aws-sdk-glue/client.rb', line 14530 def search_tables(params = {}, = {}) req = build_request(:search_tables, params) req.send_request() end |
#start_blueprint_run(params = {}) ⇒ Types::StartBlueprintRunResponse
Starts a new run of the specified blueprint.
14566 14567 14568 14569 |
# File 'lib/aws-sdk-glue/client.rb', line 14566 def start_blueprint_run(params = {}, = {}) req = build_request(:start_blueprint_run, params) req.send_request() end |
#start_column_statistics_task_run(params = {}) ⇒ Types::StartColumnStatisticsTaskRunResponse
Starts a column statistics task run, for a specified table and columns.
14623 14624 14625 14626 |
# File 'lib/aws-sdk-glue/client.rb', line 14623 def start_column_statistics_task_run(params = {}, = {}) req = build_request(:start_column_statistics_task_run, params) req.send_request() end |
#start_crawler(params = {}) ⇒ Struct
Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a [CrawlerRunningException].
14651 14652 14653 14654 |
# File 'lib/aws-sdk-glue/client.rb', line 14651 def start_crawler(params = {}, = {}) req = build_request(:start_crawler, params) req.send_request() end |
#start_crawler_schedule(params = {}) ⇒ Struct
Changes the schedule state of the specified crawler to ‘SCHEDULED`, unless the crawler is already running or the schedule state is already `SCHEDULED`.
14675 14676 14677 14678 |
# File 'lib/aws-sdk-glue/client.rb', line 14675 def start_crawler_schedule(params = {}, = {}) req = build_request(:start_crawler_schedule, params) req.send_request() end |
#start_data_quality_rule_recommendation_run(params = {}) ⇒ Types::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.
Recommendation runs are automatically deleted after 90 days.
14743 14744 14745 14746 |
# File 'lib/aws-sdk-glue/client.rb', line 14743 def start_data_quality_rule_recommendation_run(params = {}, = {}) req = build_request(:start_data_quality_rule_recommendation_run, params) req.send_request() end |
#start_data_quality_ruleset_evaluation_run(params = {}) ⇒ Types::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.
14832 14833 14834 14835 |
# File 'lib/aws-sdk-glue/client.rb', line 14832 def start_data_quality_ruleset_evaluation_run(params = {}, = {}) req = build_request(:start_data_quality_ruleset_evaluation_run, params) req.send_request() end |
#start_export_labels_task_run(params = {}) ⇒ Types::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.
14873 14874 14875 14876 |
# File 'lib/aws-sdk-glue/client.rb', line 14873 def start_export_labels_task_run(params = {}, = {}) req = build_request(:start_export_labels_task_run, params) req.send_request() end |
#start_import_labels_task_run(params = {}) ⇒ Types::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.
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.
14939 14940 14941 14942 |
# File 'lib/aws-sdk-glue/client.rb', line 14939 def start_import_labels_task_run(params = {}, = {}) req = build_request(:start_import_labels_task_run, params) req.send_request() end |
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Starts a job run using a job definition.
15135 15136 15137 15138 |
# File 'lib/aws-sdk-glue/client.rb', line 15135 def start_job_run(params = {}, = {}) req = build_request(:start_job_run, params) req.send_request() end |
#start_ml_evaluation_task_run(params = {}) ⇒ Types::StartMLEvaluationTaskRunResponse
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`.
15170 15171 15172 15173 |
# File 'lib/aws-sdk-glue/client.rb', line 15170 def start_ml_evaluation_task_run(params = {}, = {}) req = build_request(:start_ml_evaluation_task_run, params) req.send_request() end |
#start_ml_labeling_set_generation_task_run(params = {}) ⇒ Types::StartMLLabelingSetGenerationTaskRunResponse
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.
15219 15220 15221 15222 |
# File 'lib/aws-sdk-glue/client.rb', line 15219 def start_ml_labeling_set_generation_task_run(params = {}, = {}) req = build_request(:start_ml_labeling_set_generation_task_run, params) req.send_request() end |
#start_trigger(params = {}) ⇒ Types::StartTriggerResponse
Starts an existing trigger. See [Triggering Jobs] for information about how different types of trigger are started.
15252 15253 15254 15255 |
# File 'lib/aws-sdk-glue/client.rb', line 15252 def start_trigger(params = {}, = {}) req = build_request(:start_trigger, params) req.send_request() end |
#start_workflow_run(params = {}) ⇒ Types::StartWorkflowRunResponse
Starts a new run of the specified workflow.
15286 15287 15288 15289 |
# File 'lib/aws-sdk-glue/client.rb', line 15286 def start_workflow_run(params = {}, = {}) req = build_request(:start_workflow_run, params) req.send_request() end |
#stop_column_statistics_task_run(params = {}) ⇒ Struct
Stops a task run for the specified table.
15312 15313 15314 15315 |
# File 'lib/aws-sdk-glue/client.rb', line 15312 def stop_column_statistics_task_run(params = {}, = {}) req = build_request(:stop_column_statistics_task_run, params) req.send_request() end |
#stop_crawler(params = {}) ⇒ Struct
If the specified crawler is running, stops the crawl.
15334 15335 15336 15337 |
# File 'lib/aws-sdk-glue/client.rb', line 15334 def stop_crawler(params = {}, = {}) req = build_request(:stop_crawler, params) req.send_request() end |
#stop_crawler_schedule(params = {}) ⇒ Struct
Sets the schedule state of the specified crawler to ‘NOT_SCHEDULED`, but does not stop the crawler if it is already running.
15357 15358 15359 15360 |
# File 'lib/aws-sdk-glue/client.rb', line 15357 def stop_crawler_schedule(params = {}, = {}) req = build_request(:stop_crawler_schedule, params) req.send_request() end |
#stop_session(params = {}) ⇒ Types::StopSessionResponse
Stops the session.
15389 15390 15391 15392 |
# File 'lib/aws-sdk-glue/client.rb', line 15389 def stop_session(params = {}, = {}) req = build_request(:stop_session, params) req.send_request() end |
#stop_trigger(params = {}) ⇒ Types::StopTriggerResponse
Stops a specified trigger.
15417 15418 15419 15420 |
# File 'lib/aws-sdk-glue/client.rb', line 15417 def stop_trigger(params = {}, = {}) req = build_request(:stop_trigger, params) req.send_request() end |
#stop_workflow_run(params = {}) ⇒ Struct
Stops the execution of the specified workflow run.
15443 15444 15445 15446 |
# File 'lib/aws-sdk-glue/client.rb', line 15443 def stop_workflow_run(params = {}, = {}) req = build_request(:stop_workflow_run, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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].
15484 15485 15486 15487 |
# File 'lib/aws-sdk-glue/client.rb', line 15484 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
15511 15512 15513 15514 |
# File 'lib/aws-sdk-glue/client.rb', line 15511 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates a registered blueprint.
15547 15548 15549 15550 |
# File 'lib/aws-sdk-glue/client.rb', line 15547 def update_blueprint(params = {}, = {}) req = build_request(:update_blueprint, params) req.send_request() end |
#update_classifier(params = {}) ⇒ Struct
Modifies an existing classifier (a ‘GrokClassifier`, an `XMLClassifier`, a `JsonClassifier`, or a `CsvClassifier`, depending on which field is present).
15606 15607 15608 15609 |
# File 'lib/aws-sdk-glue/client.rb', line 15606 def update_classifier(params = {}, = {}) req = build_request(:update_classifier, params) req.send_request() end |
#update_column_statistics_for_partition(params = {}) ⇒ Types::UpdateColumnStatisticsForPartitionResponse
Creates or updates partition statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is ‘UpdatePartition`.
15744 15745 15746 15747 |
# File 'lib/aws-sdk-glue/client.rb', line 15744 def update_column_statistics_for_partition(params = {}, = {}) req = build_request(:update_column_statistics_for_partition, params) req.send_request() end |
#update_column_statistics_for_table(params = {}) ⇒ Types::UpdateColumnStatisticsForTableResponse
Creates or updates table statistics of columns.
The Identity and Access Management (IAM) permission required for this operation is ‘UpdateTable`.
15878 15879 15880 15881 |
# File 'lib/aws-sdk-glue/client.rb', line 15878 def update_column_statistics_for_table(params = {}, = {}) req = build_request(:update_column_statistics_for_table, params) req.send_request() end |
#update_connection(params = {}) ⇒ Struct
Updates a connection definition in the Data Catalog.
15922 15923 15924 15925 |
# File 'lib/aws-sdk-glue/client.rb', line 15922 def update_connection(params = {}, = {}) req = build_request(:update_connection, params) req.send_request() end |
#update_crawler(params = {}) ⇒ Struct
Updates a crawler. If a crawler is running, you must stop it using ‘StopCrawler` before updating it.
16092 16093 16094 16095 |
# File 'lib/aws-sdk-glue/client.rb', line 16092 def update_crawler(params = {}, = {}) req = build_request(:update_crawler, params) req.send_request() end |
#update_crawler_schedule(params = {}) ⇒ Struct
Updates the schedule of a crawler using a ‘cron` expression.
16125 16126 16127 16128 |
# File 'lib/aws-sdk-glue/client.rb', line 16125 def update_crawler_schedule(params = {}, = {}) req = build_request(:update_crawler_schedule, params) req.send_request() end |
#update_data_quality_ruleset(params = {}) ⇒ Types::UpdateDataQualityRulesetResponse
Updates the specified data quality ruleset.
16166 16167 16168 16169 |
# File 'lib/aws-sdk-glue/client.rb', line 16166 def update_data_quality_ruleset(params = {}, = {}) req = build_request(:update_data_quality_ruleset, params) req.send_request() end |
#update_database(params = {}) ⇒ Struct
Updates an existing database definition in a Data Catalog.
16224 16225 16226 16227 |
# File 'lib/aws-sdk-glue/client.rb', line 16224 def update_database(params = {}, = {}) req = build_request(:update_database, params) req.send_request() end |
#update_dev_endpoint(params = {}) ⇒ Struct
Updates a specified development endpoint.
16293 16294 16295 16296 |
# File 'lib/aws-sdk-glue/client.rb', line 16293 def update_dev_endpoint(params = {}, = {}) req = build_request(:update_dev_endpoint, params) req.send_request() end |
#update_job(params = {}) ⇒ Types::UpdateJobResponse
Updates an existing job definition. The previous job definition is completely overwritten by this information.
16320 16321 16322 16323 |
# File 'lib/aws-sdk-glue/client.rb', line 16320 def update_job(params = {}, = {}) req = build_request(:update_job, params) req.send_request() end |
#update_job_from_source_control(params = {}) ⇒ Types::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.
This API supports optional parameters which take in the repository information.
16391 16392 16393 16394 |
# File 'lib/aws-sdk-glue/client.rb', line 16391 def update_job_from_source_control(params = {}, = {}) req = build_request(:update_job_from_source_control, params) req.send_request() end |
#update_ml_transform(params = {}) ⇒ Types::UpdateMLTransformResponse
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).
16509 16510 16511 16512 |
# File 'lib/aws-sdk-glue/client.rb', line 16509 def update_ml_transform(params = {}, = {}) req = build_request(:update_ml_transform, params) req.send_request() end |
#update_partition(params = {}) ⇒ Struct
Updates a partition.
16613 16614 16615 16616 |
# File 'lib/aws-sdk-glue/client.rb', line 16613 def update_partition(params = {}, = {}) req = build_request(:update_partition, params) req.send_request() end |
#update_registry(params = {}) ⇒ Types::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.
16654 16655 16656 16657 |
# File 'lib/aws-sdk-glue/client.rb', line 16654 def update_registry(params = {}, = {}) req = build_request(:update_registry, params) req.send_request() end |
#update_schema(params = {}) ⇒ Types::UpdateSchemaResponse
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.
16726 16727 16728 16729 |
# File 'lib/aws-sdk-glue/client.rb', line 16726 def update_schema(params = {}, = {}) req = build_request(:update_schema, params) req.send_request() end |
#update_source_control_from_job(params = {}) ⇒ Types::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.
This API supports optional parameters which take in the repository information.
16797 16798 16799 16800 |
# File 'lib/aws-sdk-glue/client.rb', line 16797 def update_source_control_from_job(params = {}, = {}) req = build_request(:update_source_control_from_job, params) req.send_request() end |
#update_table(params = {}) ⇒ Struct
Updates a metadata table in the Data Catalog.
16925 16926 16927 16928 |
# File 'lib/aws-sdk-glue/client.rb', line 16925 def update_table(params = {}, = {}) req = build_request(:update_table, params) req.send_request() end |
#update_table_optimizer(params = {}) ⇒ Struct
Updates the configuration for an existing table optimizer.
16968 16969 16970 16971 |
# File 'lib/aws-sdk-glue/client.rb', line 16968 def update_table_optimizer(params = {}, = {}) req = build_request(:update_table_optimizer, params) req.send_request() end |
#update_trigger(params = {}) ⇒ Types::UpdateTriggerResponse
Updates a trigger definition.
17057 17058 17059 17060 |
# File 'lib/aws-sdk-glue/client.rb', line 17057 def update_trigger(params = {}, = {}) req = build_request(:update_trigger, params) req.send_request() end |
#update_user_defined_function(params = {}) ⇒ Struct
Updates an existing function definition in the Data Catalog.
17106 17107 17108 17109 |
# File 'lib/aws-sdk-glue/client.rb', line 17106 def update_user_defined_function(params = {}, = {}) req = build_request(:update_user_defined_function, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Types::UpdateWorkflowResponse
Updates an existing workflow.
17153 17154 17155 17156 |
# File 'lib/aws-sdk-glue/client.rb', line 17153 def update_workflow(params = {}, = {}) req = build_request(:update_workflow, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
17177 17178 17179 |
# File 'lib/aws-sdk-glue/client.rb', line 17177 def waiter_names [] end |