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_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_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_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_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_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
Retrieves table metadata from the Data Catalog that contains unfiltered metadata.
-
#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_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_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_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_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_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.
395 396 397 |
# File 'lib/aws-sdk-glue/client.rb', line 395 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.
15970 15971 15972 |
# File 'lib/aws-sdk-glue/client.rb', line 15970 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.
15973 15974 15975 |
# File 'lib/aws-sdk-glue/client.rb', line 15973 def errors_module Errors end |
Instance Method Details
#batch_create_partition(params = {}) ⇒ Types::BatchCreatePartitionResponse
Creates one or more partitions in a batch operation.
505 506 507 508 |
# File 'lib/aws-sdk-glue/client.rb', line 505 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.
543 544 545 546 |
# File 'lib/aws-sdk-glue/client.rb', line 543 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.
595 596 597 598 |
# File 'lib/aws-sdk-glue/client.rb', line 595 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>
653 654 655 656 |
# File 'lib/aws-sdk-glue/client.rb', line 653 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.
701 702 703 704 |
# File 'lib/aws-sdk-glue/client.rb', line 701 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.
755 756 757 758 |
# File 'lib/aws-sdk-glue/client.rb', line 755 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.
862 863 864 865 |
# File 'lib/aws-sdk-glue/client.rb', line 862 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.
898 899 900 901 |
# File 'lib/aws-sdk-glue/client.rb', line 898 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.
951 952 953 954 |
# File 'lib/aws-sdk-glue/client.rb', line 951 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.
1015 1016 1017 1018 |
# File 'lib/aws-sdk-glue/client.rb', line 1015 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.
1841 1842 1843 1844 |
# File 'lib/aws-sdk-glue/client.rb', line 1841 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.
1937 1938 1939 1940 |
# File 'lib/aws-sdk-glue/client.rb', line 1937 def batch_get_partition(params = {}, = {}) req = build_request(:batch_get_partition, 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.
1997 1998 1999 2000 |
# File 'lib/aws-sdk-glue/client.rb', line 1997 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.
2198 2199 2200 2201 |
# File 'lib/aws-sdk-glue/client.rb', line 2198 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.
2239 2240 2241 2242 |
# File 'lib/aws-sdk-glue/client.rb', line 2239 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.
2351 2352 2353 2354 |
# File 'lib/aws-sdk-glue/client.rb', line 2351 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.
15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 |
# File 'lib/aws-sdk-glue/client.rb', line 15948 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.148.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.
2374 2375 2376 2377 |
# File 'lib/aws-sdk-glue/client.rb', line 2374 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.
2397 2398 2399 2400 |
# File 'lib/aws-sdk-glue/client.rb', line 2397 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`.
2437 2438 2439 2440 |
# File 'lib/aws-sdk-glue/client.rb', line 2437 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.
2467 2468 2469 2470 |
# File 'lib/aws-sdk-glue/client.rb', line 2467 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.
2505 2506 2507 2508 |
# File 'lib/aws-sdk-glue/client.rb', line 2505 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.
2547 2548 2549 2550 |
# File 'lib/aws-sdk-glue/client.rb', line 2547 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.
2605 2606 2607 2608 |
# File 'lib/aws-sdk-glue/client.rb', line 2605 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.
2651 2652 2653 2654 |
# File 'lib/aws-sdk-glue/client.rb', line 2651 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.
2827 2828 2829 2830 |
# File 'lib/aws-sdk-glue/client.rb', line 2827 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.
2881 2882 2883 2884 |
# File 'lib/aws-sdk-glue/client.rb', line 2881 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.
2942 2943 2944 2945 |
# File 'lib/aws-sdk-glue/client.rb', line 2942 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.
2999 3000 3001 3002 |
# File 'lib/aws-sdk-glue/client.rb', line 2999 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.
3198 3199 3200 3201 |
# File 'lib/aws-sdk-glue/client.rb', line 3198 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.
3412 3413 3414 3415 |
# File 'lib/aws-sdk-glue/client.rb', line 3412 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
3624 3625 3626 3627 |
# File 'lib/aws-sdk-glue/client.rb', line 3624 def create_ml_transform(params = {}, = {}) req = build_request(:create_ml_transform, params) req.send_request() end |
#create_partition(params = {}) ⇒ Struct
Creates a new partition.
3720 3721 3722 3723 |
# File 'lib/aws-sdk-glue/client.rb', line 3720 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.
3760 3761 3762 3763 |
# File 'lib/aws-sdk-glue/client.rb', line 3760 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.
3810 3811 3812 3813 |
# File 'lib/aws-sdk-glue/client.rb', line 3810 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.
3958 3959 3960 3961 |
# File 'lib/aws-sdk-glue/client.rb', line 3958 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.
4015 4016 4017 4018 |
# File 'lib/aws-sdk-glue/client.rb', line 4015 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
4072 4073 4074 4075 |
# File 'lib/aws-sdk-glue/client.rb', line 4072 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.
4206 4207 4208 4209 |
# File 'lib/aws-sdk-glue/client.rb', line 4206 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.
4344 4345 4346 4347 |
# File 'lib/aws-sdk-glue/client.rb', line 4344 def create_table(params = {}, = {}) req = build_request(:create_table, params) req.send_request() end |
#create_trigger(params = {}) ⇒ Types::CreateTriggerResponse
Creates a new trigger.
4455 4456 4457 4458 |
# File 'lib/aws-sdk-glue/client.rb', line 4455 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.
4498 4499 4500 4501 |
# File 'lib/aws-sdk-glue/client.rb', line 4498 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.
4552 4553 4554 4555 |
# File 'lib/aws-sdk-glue/client.rb', line 4552 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_blueprint(params = {}) ⇒ Types::DeleteBlueprintResponse
Deletes an existing blueprint.
4580 4581 4582 4583 |
# File 'lib/aws-sdk-glue/client.rb', line 4580 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.
4602 4603 4604 4605 |
# File 'lib/aws-sdk-glue/client.rb', line 4602 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`.
4645 4646 4647 4648 |
# File 'lib/aws-sdk-glue/client.rb', line 4645 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`.
4684 4685 4686 4687 |
# File 'lib/aws-sdk-glue/client.rb', line 4684 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.
4711 4712 4713 4714 |
# File 'lib/aws-sdk-glue/client.rb', line 4711 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`.
4734 4735 4736 4737 |
# File 'lib/aws-sdk-glue/client.rb', line 4734 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.
4762 4763 4764 4765 |
# File 'lib/aws-sdk-glue/client.rb', line 4762 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.
4784 4785 4786 4787 |
# File 'lib/aws-sdk-glue/client.rb', line 4784 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>
4827 4828 4829 4830 |
# File 'lib/aws-sdk-glue/client.rb', line 4827 def delete_database(params = {}, = {}) req = build_request(:delete_database, params) req.send_request() end |
#delete_dev_endpoint(params = {}) ⇒ Struct
Deletes a specified development endpoint.
4849 4850 4851 4852 |
# File 'lib/aws-sdk-glue/client.rb', line 4849 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.
4878 4879 4880 4881 |
# File 'lib/aws-sdk-glue/client.rb', line 4878 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.
4912 4913 4914 4915 |
# File 'lib/aws-sdk-glue/client.rb', line 4912 def delete_ml_transform(params = {}, = {}) req = build_request(:delete_ml_transform, params) req.send_request() end |
#delete_partition(params = {}) ⇒ Struct
Deletes a specified partition.
4949 4950 4951 4952 |
# File 'lib/aws-sdk-glue/client.rb', line 4949 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.
4985 4986 4987 4988 |
# File 'lib/aws-sdk-glue/client.rb', line 4985 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.
5026 5027 5028 5029 |
# File 'lib/aws-sdk-glue/client.rb', line 5026 def delete_registry(params = {}, = {}) req = build_request(:delete_registry, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a specified policy.
5052 5053 5054 5055 |
# File 'lib/aws-sdk-glue/client.rb', line 5052 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.
5093 5094 5095 5096 |
# File 'lib/aws-sdk-glue/client.rb', line 5093 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.
5155 5156 5157 5158 |
# File 'lib/aws-sdk-glue/client.rb', line 5155 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.
5177 5178 5179 5180 |
# File 'lib/aws-sdk-glue/client.rb', line 5177 def delete_security_configuration(params = {}, = {}) req = build_request(:delete_security_configuration, params) req.send_request() end |
#delete_session(params = {}) ⇒ Types::DeleteSessionResponse
Deletes the session.
5209 5210 5211 5212 |
# File 'lib/aws-sdk-glue/client.rb', line 5209 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>
5259 5260 5261 5262 |
# File 'lib/aws-sdk-glue/client.rb', line 5259 def delete_table(params = {}, = {}) req = build_request(:delete_table, params) req.send_request() end |
#delete_table_version(params = {}) ⇒ Struct
Deletes a specified version of a table.
5297 5298 5299 5300 |
# File 'lib/aws-sdk-glue/client.rb', line 5297 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.
5326 5327 5328 5329 |
# File 'lib/aws-sdk-glue/client.rb', line 5326 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.
5358 5359 5360 5361 |
# File 'lib/aws-sdk-glue/client.rb', line 5358 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.
5386 5387 5388 5389 |
# File 'lib/aws-sdk-glue/client.rb', line 5386 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.
5435 5436 5437 5438 |
# File 'lib/aws-sdk-glue/client.rb', line 5435 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.
5476 5477 5478 5479 |
# File 'lib/aws-sdk-glue/client.rb', line 5476 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.
5526 5527 5528 5529 |
# File 'lib/aws-sdk-glue/client.rb', line 5526 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.
5557 5558 5559 5560 |
# File 'lib/aws-sdk-glue/client.rb', line 5557 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.
5616 5617 5618 5619 |
# File 'lib/aws-sdk-glue/client.rb', line 5616 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.
5684 5685 5686 5687 |
# File 'lib/aws-sdk-glue/client.rb', line 5684 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`.
5770 5771 5772 5773 |
# File 'lib/aws-sdk-glue/client.rb', line 5770 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`.
5852 5853 5854 5855 |
# File 'lib/aws-sdk-glue/client.rb', line 5852 def get_column_statistics_for_table(params = {}, = {}) req = build_request(:get_column_statistics_for_table, params) req.send_request() end |
#get_connection(params = {}) ⇒ Types::GetConnectionResponse
Retrieves a connection definition from the Data Catalog.
5907 5908 5909 5910 |
# File 'lib/aws-sdk-glue/client.rb', line 5907 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.
5978 5979 5980 5981 |
# File 'lib/aws-sdk-glue/client.rb', line 5978 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.
6076 6077 6078 6079 |
# File 'lib/aws-sdk-glue/client.rb', line 6076 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.
6124 6125 6126 6127 |
# File 'lib/aws-sdk-glue/client.rb', line 6124 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.
6231 6232 6233 6234 |
# File 'lib/aws-sdk-glue/client.rb', line 6231 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.
6264 6265 6266 6267 |
# File 'lib/aws-sdk-glue/client.rb', line 6264 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.
6297 6298 6299 6300 |
# File 'lib/aws-sdk-glue/client.rb', line 6297 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.
6356 6357 6358 6359 |
# File 'lib/aws-sdk-glue/client.rb', line 6356 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.
6413 6414 6415 6416 |
# File 'lib/aws-sdk-glue/client.rb', line 6413 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.
6455 6456 6457 6458 |
# File 'lib/aws-sdk-glue/client.rb', line 6455 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.
6526 6527 6528 6529 |
# File 'lib/aws-sdk-glue/client.rb', line 6526 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.
6575 6576 6577 6578 |
# File 'lib/aws-sdk-glue/client.rb', line 6575 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.
6647 6648 6649 6650 |
# File 'lib/aws-sdk-glue/client.rb', line 6647 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).
6687 6688 6689 6690 |
# File 'lib/aws-sdk-glue/client.rb', line 6687 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>
6749 6750 6751 6752 |
# File 'lib/aws-sdk-glue/client.rb', line 6749 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.
6821 6822 6823 6824 |
# File 'lib/aws-sdk-glue/client.rb', line 6821 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.
7638 7639 7640 7641 |
# File 'lib/aws-sdk-glue/client.rb', line 7638 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
7690 7691 7692 7693 |
# File 'lib/aws-sdk-glue/client.rb', line 7690 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.
7752 7753 7754 7755 |
# File 'lib/aws-sdk-glue/client.rb', line 7752 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.
7819 7820 7821 7822 |
# File 'lib/aws-sdk-glue/client.rb', line 7819 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.
8645 8646 8647 8648 |
# File 'lib/aws-sdk-glue/client.rb', line 8645 def get_jobs(params = {}, = {}) req = build_request(:get_jobs, params) req.send_request() end |
#get_mapping(params = {}) ⇒ Types::GetMappingResponse
Creates mappings.
9066 9067 9068 9069 |
# File 'lib/aws-sdk-glue/client.rb', line 9066 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`.
8706 8707 8708 8709 |
# File 'lib/aws-sdk-glue/client.rb', line 8706 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.
8788 8789 8790 8791 |
# File 'lib/aws-sdk-glue/client.rb', line 8788 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`.
8883 8884 8885 8886 |
# File 'lib/aws-sdk-glue/client.rb', line 8883 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.
8994 8995 8996 8997 |
# File 'lib/aws-sdk-glue/client.rb', line 8994 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.
9153 9154 9155 9156 |
# File 'lib/aws-sdk-glue/client.rb', line 9153 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.
9209 9210 9211 9212 |
# File 'lib/aws-sdk-glue/client.rb', line 9209 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.
9424 9425 9426 9427 |
# File 'lib/aws-sdk-glue/client.rb', line 9424 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.
9523 9524 9525 9526 |
# File 'lib/aws-sdk-glue/client.rb', line 9523 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.
9565 9566 9567 9568 |
# File 'lib/aws-sdk-glue/client.rb', line 9565 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.
9611 9612 9613 9614 |
# File 'lib/aws-sdk-glue/client.rb', line 9611 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.
9652 9653 9654 9655 |
# File 'lib/aws-sdk-glue/client.rb', line 9652 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.
9716 9717 9718 9719 |
# File 'lib/aws-sdk-glue/client.rb', line 9716 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.
9772 9773 9774 9775 |
# File 'lib/aws-sdk-glue/client.rb', line 9772 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.
9839 9840 9841 9842 |
# File 'lib/aws-sdk-glue/client.rb', line 9839 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.
9900 9901 9902 9903 |
# File 'lib/aws-sdk-glue/client.rb', line 9900 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.
9936 9937 9938 9939 |
# File 'lib/aws-sdk-glue/client.rb', line 9936 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.
9981 9982 9983 9984 |
# File 'lib/aws-sdk-glue/client.rb', line 9981 def get_security_configurations(params = {}, = {}) req = build_request(:get_security_configurations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves the session.
10028 10029 10030 10031 |
# File 'lib/aws-sdk-glue/client.rb', line 10028 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_statement(params = {}) ⇒ Types::GetStatementResponse
Retrieves the statement.
10076 10077 10078 10079 |
# File 'lib/aws-sdk-glue/client.rb', line 10076 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.
10192 10193 10194 10195 |
# File 'lib/aws-sdk-glue/client.rb', line 10192 def get_table(params = {}, = {}) req = build_request(:get_table, params) req.send_request() end |
#get_table_version(params = {}) ⇒ Types::GetTableVersionResponse
Retrieves a specified version of a table.
10303 10304 10305 10306 |
# File 'lib/aws-sdk-glue/client.rb', line 10303 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.
10423 10424 10425 10426 |
# File 'lib/aws-sdk-glue/client.rb', line 10423 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.
10552 10553 10554 10555 |
# File 'lib/aws-sdk-glue/client.rb', line 10552 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.
10582 10583 10584 10585 |
# File 'lib/aws-sdk-glue/client.rb', line 10582 def (params = {}, = {}) req = build_request(:get_tags, params) req.send_request() end |
#get_trigger(params = {}) ⇒ Types::GetTriggerResponse
Retrieves the definition of a trigger.
10633 10634 10635 10636 |
# File 'lib/aws-sdk-glue/client.rb', line 10633 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.
10699 10700 10701 10702 |
# File 'lib/aws-sdk-glue/client.rb', line 10699 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`.
10806 10807 10808 10809 |
# File 'lib/aws-sdk-glue/client.rb', line 10806 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.
11016 11017 11018 11019 |
# File 'lib/aws-sdk-glue/client.rb', line 11016 def (params = {}, = {}) req = build_request(:get_unfiltered_partitions_metadata, params) req.send_request() end |
#get_unfiltered_table_metadata(params = {}) ⇒ Types::GetUnfilteredTableMetadataResponse
Retrieves table metadata from the Data Catalog that contains unfiltered metadata.
For IAM authorization, the public IAM action associated with this API is ‘glue:GetTable`.
11144 11145 11146 11147 |
# File 'lib/aws-sdk-glue/client.rb', line 11144 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.
11191 11192 11193 11194 |
# File 'lib/aws-sdk-glue/client.rb', line 11191 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.
11254 11255 11256 11257 |
# File 'lib/aws-sdk-glue/client.rb', line 11254 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.
11446 11447 11448 11449 |
# File 'lib/aws-sdk-glue/client.rb', line 11446 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.
11566 11567 11568 11569 |
# File 'lib/aws-sdk-glue/client.rb', line 11566 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.
11599 11600 11601 11602 |
# File 'lib/aws-sdk-glue/client.rb', line 11599 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.
11728 11729 11730 11731 |
# File 'lib/aws-sdk-glue/client.rb', line 11728 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.
11751 11752 11753 11754 |
# File 'lib/aws-sdk-glue/client.rb', line 11751 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.
11794 11795 11796 11797 |
# File 'lib/aws-sdk-glue/client.rb', line 11794 def list_blueprints(params = {}, = {}) req = build_request(:list_blueprints, 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.
11845 11846 11847 11848 |
# File 'lib/aws-sdk-glue/client.rb', line 11845 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.
11921 11922 11923 11924 |
# File 'lib/aws-sdk-glue/client.rb', line 11921 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.
11967 11968 11969 11970 |
# File 'lib/aws-sdk-glue/client.rb', line 11967 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.
12033 12034 12035 12036 |
# File 'lib/aws-sdk-glue/client.rb', line 12033 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.
12096 12097 12098 12099 |
# File 'lib/aws-sdk-glue/client.rb', line 12096 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.
12160 12161 12162 12163 |
# File 'lib/aws-sdk-glue/client.rb', line 12160 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.
12228 12229 12230 12231 |
# File 'lib/aws-sdk-glue/client.rb', line 12228 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.
12279 12280 12281 12282 |
# File 'lib/aws-sdk-glue/client.rb', line 12279 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.
12330 12331 12332 12333 |
# File 'lib/aws-sdk-glue/client.rb', line 12330 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.
12406 12407 12408 12409 |
# File 'lib/aws-sdk-glue/client.rb', line 12406 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.
12452 12453 12454 12455 |
# File 'lib/aws-sdk-glue/client.rb', line 12452 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.
12513 12514 12515 12516 |
# File 'lib/aws-sdk-glue/client.rb', line 12513 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.
12570 12571 12572 12573 |
# File 'lib/aws-sdk-glue/client.rb', line 12570 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.
12636 12637 12638 12639 |
# File 'lib/aws-sdk-glue/client.rb', line 12636 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
Lists statements for the session.
12687 12688 12689 12690 |
# File 'lib/aws-sdk-glue/client.rb', line 12687 def list_statements(params = {}, = {}) req = build_request(:list_statements, 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.
12744 12745 12746 12747 |
# File 'lib/aws-sdk-glue/client.rb', line 12744 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.
12781 12782 12783 12784 |
# File 'lib/aws-sdk-glue/client.rb', line 12781 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.
12820 12821 12822 12823 |
# File 'lib/aws-sdk-glue/client.rb', line 12820 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.
12880 12881 12882 12883 |
# File 'lib/aws-sdk-glue/client.rb', line 12880 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.
12946 12947 12948 12949 |
# File 'lib/aws-sdk-glue/client.rb', line 12946 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.
12981 12982 12983 12984 |
# File 'lib/aws-sdk-glue/client.rb', line 12981 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.
13053 13054 13055 13056 |
# File 'lib/aws-sdk-glue/client.rb', line 13053 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.
13117 13118 13119 13120 |
# File 'lib/aws-sdk-glue/client.rb', line 13117 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.
13183 13184 13185 13186 |
# File 'lib/aws-sdk-glue/client.rb', line 13183 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
13235 13236 13237 13238 |
# File 'lib/aws-sdk-glue/client.rb', line 13235 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.
13277 13278 13279 13280 |
# File 'lib/aws-sdk-glue/client.rb', line 13277 def resume_workflow_run(params = {}, = {}) req = build_request(:resume_workflow_run, params) req.send_request() end |
#run_statement(params = {}) ⇒ Types::RunStatementResponse
Executes the statement.
13313 13314 13315 13316 |
# File 'lib/aws-sdk-glue/client.rb', line 13313 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.
13480 13481 13482 13483 |
# File 'lib/aws-sdk-glue/client.rb', line 13480 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.
13516 13517 13518 13519 |
# File 'lib/aws-sdk-glue/client.rb', line 13516 def start_blueprint_run(params = {}, = {}) req = build_request(:start_blueprint_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].
13544 13545 13546 13547 |
# File 'lib/aws-sdk-glue/client.rb', line 13544 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`.
13568 13569 13570 13571 |
# File 'lib/aws-sdk-glue/client.rb', line 13568 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.
13634 13635 13636 13637 |
# File 'lib/aws-sdk-glue/client.rb', line 13634 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.
13723 13724 13725 13726 |
# File 'lib/aws-sdk-glue/client.rb', line 13723 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.
13764 13765 13766 13767 |
# File 'lib/aws-sdk-glue/client.rb', line 13764 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.
13830 13831 13832 13833 |
# File 'lib/aws-sdk-glue/client.rb', line 13830 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.
14005 14006 14007 14008 |
# File 'lib/aws-sdk-glue/client.rb', line 14005 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`.
14040 14041 14042 14043 |
# File 'lib/aws-sdk-glue/client.rb', line 14040 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.
14089 14090 14091 14092 |
# File 'lib/aws-sdk-glue/client.rb', line 14089 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.
14122 14123 14124 14125 |
# File 'lib/aws-sdk-glue/client.rb', line 14122 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.
14156 14157 14158 14159 |
# File 'lib/aws-sdk-glue/client.rb', line 14156 def start_workflow_run(params = {}, = {}) req = build_request(:start_workflow_run, params) req.send_request() end |
#stop_crawler(params = {}) ⇒ Struct
If the specified crawler is running, stops the crawl.
14178 14179 14180 14181 |
# File 'lib/aws-sdk-glue/client.rb', line 14178 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.
14201 14202 14203 14204 |
# File 'lib/aws-sdk-glue/client.rb', line 14201 def stop_crawler_schedule(params = {}, = {}) req = build_request(:stop_crawler_schedule, params) req.send_request() end |
#stop_session(params = {}) ⇒ Types::StopSessionResponse
Stops the session.
14233 14234 14235 14236 |
# File 'lib/aws-sdk-glue/client.rb', line 14233 def stop_session(params = {}, = {}) req = build_request(:stop_session, params) req.send_request() end |
#stop_trigger(params = {}) ⇒ Types::StopTriggerResponse
Stops a specified trigger.
14261 14262 14263 14264 |
# File 'lib/aws-sdk-glue/client.rb', line 14261 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.
14287 14288 14289 14290 |
# File 'lib/aws-sdk-glue/client.rb', line 14287 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].
14328 14329 14330 14331 |
# File 'lib/aws-sdk-glue/client.rb', line 14328 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
14355 14356 14357 14358 |
# File 'lib/aws-sdk-glue/client.rb', line 14355 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates a registered blueprint.
14391 14392 14393 14394 |
# File 'lib/aws-sdk-glue/client.rb', line 14391 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).
14449 14450 14451 14452 |
# File 'lib/aws-sdk-glue/client.rb', line 14449 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`.
14587 14588 14589 14590 |
# File 'lib/aws-sdk-glue/client.rb', line 14587 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`.
14721 14722 14723 14724 |
# File 'lib/aws-sdk-glue/client.rb', line 14721 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.
14765 14766 14767 14768 |
# File 'lib/aws-sdk-glue/client.rb', line 14765 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.
14927 14928 14929 14930 |
# File 'lib/aws-sdk-glue/client.rb', line 14927 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.
14960 14961 14962 14963 |
# File 'lib/aws-sdk-glue/client.rb', line 14960 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.
15001 15002 15003 15004 |
# File 'lib/aws-sdk-glue/client.rb', line 15001 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.
15059 15060 15061 15062 |
# File 'lib/aws-sdk-glue/client.rb', line 15059 def update_database(params = {}, = {}) req = build_request(:update_database, params) req.send_request() end |
#update_dev_endpoint(params = {}) ⇒ Struct
Updates a specified development endpoint.
15128 15129 15130 15131 |
# File 'lib/aws-sdk-glue/client.rb', line 15128 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.
15155 15156 15157 15158 |
# File 'lib/aws-sdk-glue/client.rb', line 15155 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.
15223 15224 15225 15226 |
# File 'lib/aws-sdk-glue/client.rb', line 15223 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).
15341 15342 15343 15344 |
# File 'lib/aws-sdk-glue/client.rb', line 15341 def update_ml_transform(params = {}, = {}) req = build_request(:update_ml_transform, params) req.send_request() end |
#update_partition(params = {}) ⇒ Struct
Updates a partition.
15445 15446 15447 15448 |
# File 'lib/aws-sdk-glue/client.rb', line 15445 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.
15486 15487 15488 15489 |
# File 'lib/aws-sdk-glue/client.rb', line 15486 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.
15558 15559 15560 15561 |
# File 'lib/aws-sdk-glue/client.rb', line 15558 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.
15626 15627 15628 15629 |
# File 'lib/aws-sdk-glue/client.rb', line 15626 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.
15754 15755 15756 15757 |
# File 'lib/aws-sdk-glue/client.rb', line 15754 def update_table(params = {}, = {}) req = build_request(:update_table, params) req.send_request() end |
#update_trigger(params = {}) ⇒ Types::UpdateTriggerResponse
Updates a trigger definition.
15843 15844 15845 15846 |
# File 'lib/aws-sdk-glue/client.rb', line 15843 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.
15892 15893 15894 15895 |
# File 'lib/aws-sdk-glue/client.rb', line 15892 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.
15939 15940 15941 15942 |
# File 'lib/aws-sdk-glue/client.rb', line 15939 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.
15963 15964 15965 |
# File 'lib/aws-sdk-glue/client.rb', line 15963 def waiter_names [] end |