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.
16084 16085 16086 |
# File 'lib/aws-sdk-glue/client.rb', line 16084 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.
16087 16088 16089 |
# File 'lib/aws-sdk-glue/client.rb', line 16087 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.
869 870 871 872 |
# File 'lib/aws-sdk-glue/client.rb', line 869 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.
905 906 907 908 |
# File 'lib/aws-sdk-glue/client.rb', line 905 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.
958 959 960 961 |
# File 'lib/aws-sdk-glue/client.rb', line 958 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.
1022 1023 1024 1025 |
# File 'lib/aws-sdk-glue/client.rb', line 1022 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.
1853 1854 1855 1856 |
# File 'lib/aws-sdk-glue/client.rb', line 1853 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.
1949 1950 1951 1952 |
# File 'lib/aws-sdk-glue/client.rb', line 1949 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.
2009 2010 2011 2012 |
# File 'lib/aws-sdk-glue/client.rb', line 2009 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.
2210 2211 2212 2213 |
# File 'lib/aws-sdk-glue/client.rb', line 2210 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.
2251 2252 2253 2254 |
# File 'lib/aws-sdk-glue/client.rb', line 2251 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.
2363 2364 2365 2366 |
# File 'lib/aws-sdk-glue/client.rb', line 2363 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.
16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073 |
# File 'lib/aws-sdk-glue/client.rb', line 16062 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.151.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.
2386 2387 2388 2389 |
# File 'lib/aws-sdk-glue/client.rb', line 2386 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.
2409 2410 2411 2412 |
# File 'lib/aws-sdk-glue/client.rb', line 2409 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`.
2449 2450 2451 2452 |
# File 'lib/aws-sdk-glue/client.rb', line 2449 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.
2479 2480 2481 2482 |
# File 'lib/aws-sdk-glue/client.rb', line 2479 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.
2517 2518 2519 2520 |
# File 'lib/aws-sdk-glue/client.rb', line 2517 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.
2559 2560 2561 2562 |
# File 'lib/aws-sdk-glue/client.rb', line 2559 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.
2617 2618 2619 2620 |
# File 'lib/aws-sdk-glue/client.rb', line 2617 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.
2663 2664 2665 2666 |
# File 'lib/aws-sdk-glue/client.rb', line 2663 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.
2847 2848 2849 2850 |
# File 'lib/aws-sdk-glue/client.rb', line 2847 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.
2901 2902 2903 2904 |
# File 'lib/aws-sdk-glue/client.rb', line 2901 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.
2962 2963 2964 2965 |
# File 'lib/aws-sdk-glue/client.rb', line 2962 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.
3019 3020 3021 3022 |
# File 'lib/aws-sdk-glue/client.rb', line 3019 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.
3218 3219 3220 3221 |
# File 'lib/aws-sdk-glue/client.rb', line 3218 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.
3453 3454 3455 3456 |
# File 'lib/aws-sdk-glue/client.rb', line 3453 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
3665 3666 3667 3668 |
# File 'lib/aws-sdk-glue/client.rb', line 3665 def create_ml_transform(params = {}, = {}) req = build_request(:create_ml_transform, params) req.send_request() end |
#create_partition(params = {}) ⇒ Struct
Creates a new partition.
3761 3762 3763 3764 |
# File 'lib/aws-sdk-glue/client.rb', line 3761 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.
3801 3802 3803 3804 |
# File 'lib/aws-sdk-glue/client.rb', line 3801 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.
3851 3852 3853 3854 |
# File 'lib/aws-sdk-glue/client.rb', line 3851 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.
3999 4000 4001 4002 |
# File 'lib/aws-sdk-glue/client.rb', line 3999 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.
4056 4057 4058 4059 |
# File 'lib/aws-sdk-glue/client.rb', line 4056 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
4113 4114 4115 4116 |
# File 'lib/aws-sdk-glue/client.rb', line 4113 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.
4267 4268 4269 4270 |
# File 'lib/aws-sdk-glue/client.rb', line 4267 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.
4405 4406 4407 4408 |
# File 'lib/aws-sdk-glue/client.rb', line 4405 def create_table(params = {}, = {}) req = build_request(:create_table, params) req.send_request() end |
#create_trigger(params = {}) ⇒ Types::CreateTriggerResponse
Creates a new trigger.
4516 4517 4518 4519 |
# File 'lib/aws-sdk-glue/client.rb', line 4516 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.
4559 4560 4561 4562 |
# File 'lib/aws-sdk-glue/client.rb', line 4559 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.
4613 4614 4615 4616 |
# File 'lib/aws-sdk-glue/client.rb', line 4613 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_blueprint(params = {}) ⇒ Types::DeleteBlueprintResponse
Deletes an existing blueprint.
4641 4642 4643 4644 |
# File 'lib/aws-sdk-glue/client.rb', line 4641 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.
4663 4664 4665 4666 |
# File 'lib/aws-sdk-glue/client.rb', line 4663 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`.
4706 4707 4708 4709 |
# File 'lib/aws-sdk-glue/client.rb', line 4706 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`.
4745 4746 4747 4748 |
# File 'lib/aws-sdk-glue/client.rb', line 4745 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.
4772 4773 4774 4775 |
# File 'lib/aws-sdk-glue/client.rb', line 4772 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`.
4795 4796 4797 4798 |
# File 'lib/aws-sdk-glue/client.rb', line 4795 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.
4823 4824 4825 4826 |
# File 'lib/aws-sdk-glue/client.rb', line 4823 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.
4845 4846 4847 4848 |
# File 'lib/aws-sdk-glue/client.rb', line 4845 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>
4888 4889 4890 4891 |
# File 'lib/aws-sdk-glue/client.rb', line 4888 def delete_database(params = {}, = {}) req = build_request(:delete_database, params) req.send_request() end |
#delete_dev_endpoint(params = {}) ⇒ Struct
Deletes a specified development endpoint.
4910 4911 4912 4913 |
# File 'lib/aws-sdk-glue/client.rb', line 4910 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.
4939 4940 4941 4942 |
# File 'lib/aws-sdk-glue/client.rb', line 4939 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.
4973 4974 4975 4976 |
# File 'lib/aws-sdk-glue/client.rb', line 4973 def delete_ml_transform(params = {}, = {}) req = build_request(:delete_ml_transform, params) req.send_request() end |
#delete_partition(params = {}) ⇒ Struct
Deletes a specified partition.
5010 5011 5012 5013 |
# File 'lib/aws-sdk-glue/client.rb', line 5010 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.
5046 5047 5048 5049 |
# File 'lib/aws-sdk-glue/client.rb', line 5046 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.
5087 5088 5089 5090 |
# File 'lib/aws-sdk-glue/client.rb', line 5087 def delete_registry(params = {}, = {}) req = build_request(:delete_registry, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a specified policy.
5113 5114 5115 5116 |
# File 'lib/aws-sdk-glue/client.rb', line 5113 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.
5154 5155 5156 5157 |
# File 'lib/aws-sdk-glue/client.rb', line 5154 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.
5216 5217 5218 5219 |
# File 'lib/aws-sdk-glue/client.rb', line 5216 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.
5238 5239 5240 5241 |
# File 'lib/aws-sdk-glue/client.rb', line 5238 def delete_security_configuration(params = {}, = {}) req = build_request(:delete_security_configuration, params) req.send_request() end |
#delete_session(params = {}) ⇒ Types::DeleteSessionResponse
Deletes the session.
5270 5271 5272 5273 |
# File 'lib/aws-sdk-glue/client.rb', line 5270 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>
5320 5321 5322 5323 |
# File 'lib/aws-sdk-glue/client.rb', line 5320 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.
5358 5359 5360 5361 |
# File 'lib/aws-sdk-glue/client.rb', line 5358 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.
5387 5388 5389 5390 |
# File 'lib/aws-sdk-glue/client.rb', line 5387 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.
5419 5420 5421 5422 |
# File 'lib/aws-sdk-glue/client.rb', line 5419 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.
5447 5448 5449 5450 |
# File 'lib/aws-sdk-glue/client.rb', line 5447 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.
5496 5497 5498 5499 |
# File 'lib/aws-sdk-glue/client.rb', line 5496 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.
5537 5538 5539 5540 |
# File 'lib/aws-sdk-glue/client.rb', line 5537 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.
5587 5588 5589 5590 |
# File 'lib/aws-sdk-glue/client.rb', line 5587 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.
5618 5619 5620 5621 |
# File 'lib/aws-sdk-glue/client.rb', line 5618 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.
5677 5678 5679 5680 |
# File 'lib/aws-sdk-glue/client.rb', line 5677 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.
5745 5746 5747 5748 |
# File 'lib/aws-sdk-glue/client.rb', line 5745 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`.
5831 5832 5833 5834 |
# File 'lib/aws-sdk-glue/client.rb', line 5831 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`.
5913 5914 5915 5916 |
# File 'lib/aws-sdk-glue/client.rb', line 5913 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.
5968 5969 5970 5971 |
# File 'lib/aws-sdk-glue/client.rb', line 5968 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.
6039 6040 6041 6042 |
# File 'lib/aws-sdk-glue/client.rb', line 6039 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.
6144 6145 6146 6147 |
# File 'lib/aws-sdk-glue/client.rb', line 6144 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.
6192 6193 6194 6195 |
# File 'lib/aws-sdk-glue/client.rb', line 6192 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.
6306 6307 6308 6309 |
# File 'lib/aws-sdk-glue/client.rb', line 6306 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.
6339 6340 6341 6342 |
# File 'lib/aws-sdk-glue/client.rb', line 6339 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.
6372 6373 6374 6375 |
# File 'lib/aws-sdk-glue/client.rb', line 6372 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.
6431 6432 6433 6434 |
# File 'lib/aws-sdk-glue/client.rb', line 6431 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.
6488 6489 6490 6491 |
# File 'lib/aws-sdk-glue/client.rb', line 6488 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.
6530 6531 6532 6533 |
# File 'lib/aws-sdk-glue/client.rb', line 6530 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.
6601 6602 6603 6604 |
# File 'lib/aws-sdk-glue/client.rb', line 6601 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.
6650 6651 6652 6653 |
# File 'lib/aws-sdk-glue/client.rb', line 6650 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.
6722 6723 6724 6725 |
# File 'lib/aws-sdk-glue/client.rb', line 6722 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).
6762 6763 6764 6765 |
# File 'lib/aws-sdk-glue/client.rb', line 6762 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>
6824 6825 6826 6827 |
# File 'lib/aws-sdk-glue/client.rb', line 6824 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.
6896 6897 6898 6899 |
# File 'lib/aws-sdk-glue/client.rb', line 6896 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.
7718 7719 7720 7721 |
# File 'lib/aws-sdk-glue/client.rb', line 7718 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
7770 7771 7772 7773 |
# File 'lib/aws-sdk-glue/client.rb', line 7770 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.
7832 7833 7834 7835 |
# File 'lib/aws-sdk-glue/client.rb', line 7832 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.
7899 7900 7901 7902 |
# File 'lib/aws-sdk-glue/client.rb', line 7899 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.
8730 8731 8732 8733 |
# File 'lib/aws-sdk-glue/client.rb', line 8730 def get_jobs(params = {}, = {}) req = build_request(:get_jobs, params) req.send_request() end |
#get_mapping(params = {}) ⇒ Types::GetMappingResponse
Creates mappings.
9151 9152 9153 9154 |
# File 'lib/aws-sdk-glue/client.rb', line 9151 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`.
8791 8792 8793 8794 |
# File 'lib/aws-sdk-glue/client.rb', line 8791 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.
8873 8874 8875 8876 |
# File 'lib/aws-sdk-glue/client.rb', line 8873 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`.
8968 8969 8970 8971 |
# File 'lib/aws-sdk-glue/client.rb', line 8968 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.
9079 9080 9081 9082 |
# File 'lib/aws-sdk-glue/client.rb', line 9079 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.
9238 9239 9240 9241 |
# File 'lib/aws-sdk-glue/client.rb', line 9238 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.
9294 9295 9296 9297 |
# File 'lib/aws-sdk-glue/client.rb', line 9294 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.
9509 9510 9511 9512 |
# File 'lib/aws-sdk-glue/client.rb', line 9509 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.
9608 9609 9610 9611 |
# File 'lib/aws-sdk-glue/client.rb', line 9608 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.
9650 9651 9652 9653 |
# File 'lib/aws-sdk-glue/client.rb', line 9650 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.
9696 9697 9698 9699 |
# File 'lib/aws-sdk-glue/client.rb', line 9696 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.
9737 9738 9739 9740 |
# File 'lib/aws-sdk-glue/client.rb', line 9737 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.
9801 9802 9803 9804 |
# File 'lib/aws-sdk-glue/client.rb', line 9801 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.
9857 9858 9859 9860 |
# File 'lib/aws-sdk-glue/client.rb', line 9857 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.
9924 9925 9926 9927 |
# File 'lib/aws-sdk-glue/client.rb', line 9924 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.
9985 9986 9987 9988 |
# File 'lib/aws-sdk-glue/client.rb', line 9985 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.
10021 10022 10023 10024 |
# File 'lib/aws-sdk-glue/client.rb', line 10021 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.
10066 10067 10068 10069 |
# File 'lib/aws-sdk-glue/client.rb', line 10066 def get_security_configurations(params = {}, = {}) req = build_request(:get_security_configurations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves the session.
10113 10114 10115 10116 |
# File 'lib/aws-sdk-glue/client.rb', line 10113 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_statement(params = {}) ⇒ Types::GetStatementResponse
Retrieves the statement.
10161 10162 10163 10164 |
# File 'lib/aws-sdk-glue/client.rb', line 10161 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.
10277 10278 10279 10280 |
# File 'lib/aws-sdk-glue/client.rb', line 10277 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.
10388 10389 10390 10391 |
# File 'lib/aws-sdk-glue/client.rb', line 10388 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.
10508 10509 10510 10511 |
# File 'lib/aws-sdk-glue/client.rb', line 10508 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.
10637 10638 10639 10640 |
# File 'lib/aws-sdk-glue/client.rb', line 10637 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.
10667 10668 10669 10670 |
# File 'lib/aws-sdk-glue/client.rb', line 10667 def (params = {}, = {}) req = build_request(:get_tags, params) req.send_request() end |
#get_trigger(params = {}) ⇒ Types::GetTriggerResponse
Retrieves the definition of a trigger.
10718 10719 10720 10721 |
# File 'lib/aws-sdk-glue/client.rb', line 10718 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.
10784 10785 10786 10787 |
# File 'lib/aws-sdk-glue/client.rb', line 10784 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`.
10891 10892 10893 10894 |
# File 'lib/aws-sdk-glue/client.rb', line 10891 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.
11101 11102 11103 11104 |
# File 'lib/aws-sdk-glue/client.rb', line 11101 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`.
11229 11230 11231 11232 |
# File 'lib/aws-sdk-glue/client.rb', line 11229 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.
11276 11277 11278 11279 |
# File 'lib/aws-sdk-glue/client.rb', line 11276 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.
11339 11340 11341 11342 |
# File 'lib/aws-sdk-glue/client.rb', line 11339 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.
11531 11532 11533 11534 |
# File 'lib/aws-sdk-glue/client.rb', line 11531 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.
11651 11652 11653 11654 |
# File 'lib/aws-sdk-glue/client.rb', line 11651 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.
11684 11685 11686 11687 |
# File 'lib/aws-sdk-glue/client.rb', line 11684 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.
11813 11814 11815 11816 |
# File 'lib/aws-sdk-glue/client.rb', line 11813 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.
11836 11837 11838 11839 |
# File 'lib/aws-sdk-glue/client.rb', line 11836 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.
11879 11880 11881 11882 |
# File 'lib/aws-sdk-glue/client.rb', line 11879 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.
11930 11931 11932 11933 |
# File 'lib/aws-sdk-glue/client.rb', line 11930 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.
12006 12007 12008 12009 |
# File 'lib/aws-sdk-glue/client.rb', line 12006 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.
12052 12053 12054 12055 |
# File 'lib/aws-sdk-glue/client.rb', line 12052 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.
12118 12119 12120 12121 |
# File 'lib/aws-sdk-glue/client.rb', line 12118 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.
12181 12182 12183 12184 |
# File 'lib/aws-sdk-glue/client.rb', line 12181 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.
12245 12246 12247 12248 |
# File 'lib/aws-sdk-glue/client.rb', line 12245 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.
12313 12314 12315 12316 |
# File 'lib/aws-sdk-glue/client.rb', line 12313 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.
12364 12365 12366 12367 |
# File 'lib/aws-sdk-glue/client.rb', line 12364 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.
12415 12416 12417 12418 |
# File 'lib/aws-sdk-glue/client.rb', line 12415 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.
12491 12492 12493 12494 |
# File 'lib/aws-sdk-glue/client.rb', line 12491 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.
12537 12538 12539 12540 |
# File 'lib/aws-sdk-glue/client.rb', line 12537 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.
12598 12599 12600 12601 |
# File 'lib/aws-sdk-glue/client.rb', line 12598 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.
12655 12656 12657 12658 |
# File 'lib/aws-sdk-glue/client.rb', line 12655 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.
12721 12722 12723 12724 |
# File 'lib/aws-sdk-glue/client.rb', line 12721 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
Lists statements for the session.
12772 12773 12774 12775 |
# File 'lib/aws-sdk-glue/client.rb', line 12772 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.
12829 12830 12831 12832 |
# File 'lib/aws-sdk-glue/client.rb', line 12829 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.
12866 12867 12868 12869 |
# File 'lib/aws-sdk-glue/client.rb', line 12866 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.
12905 12906 12907 12908 |
# File 'lib/aws-sdk-glue/client.rb', line 12905 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.
12965 12966 12967 12968 |
# File 'lib/aws-sdk-glue/client.rb', line 12965 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.
13031 13032 13033 13034 |
# File 'lib/aws-sdk-glue/client.rb', line 13031 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.
13066 13067 13068 13069 |
# File 'lib/aws-sdk-glue/client.rb', line 13066 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.
13138 13139 13140 13141 |
# File 'lib/aws-sdk-glue/client.rb', line 13138 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.
13202 13203 13204 13205 |
# File 'lib/aws-sdk-glue/client.rb', line 13202 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.
13268 13269 13270 13271 |
# File 'lib/aws-sdk-glue/client.rb', line 13268 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
13320 13321 13322 13323 |
# File 'lib/aws-sdk-glue/client.rb', line 13320 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.
13362 13363 13364 13365 |
# File 'lib/aws-sdk-glue/client.rb', line 13362 def resume_workflow_run(params = {}, = {}) req = build_request(:resume_workflow_run, params) req.send_request() end |
#run_statement(params = {}) ⇒ Types::RunStatementResponse
Executes the statement.
13398 13399 13400 13401 |
# File 'lib/aws-sdk-glue/client.rb', line 13398 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.
13565 13566 13567 13568 |
# File 'lib/aws-sdk-glue/client.rb', line 13565 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.
13601 13602 13603 13604 |
# File 'lib/aws-sdk-glue/client.rb', line 13601 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].
13629 13630 13631 13632 |
# File 'lib/aws-sdk-glue/client.rb', line 13629 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`.
13653 13654 13655 13656 |
# File 'lib/aws-sdk-glue/client.rb', line 13653 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.
13719 13720 13721 13722 |
# File 'lib/aws-sdk-glue/client.rb', line 13719 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.
13808 13809 13810 13811 |
# File 'lib/aws-sdk-glue/client.rb', line 13808 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.
13849 13850 13851 13852 |
# File 'lib/aws-sdk-glue/client.rb', line 13849 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.
13915 13916 13917 13918 |
# File 'lib/aws-sdk-glue/client.rb', line 13915 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.
14111 14112 14113 14114 |
# File 'lib/aws-sdk-glue/client.rb', line 14111 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`.
14146 14147 14148 14149 |
# File 'lib/aws-sdk-glue/client.rb', line 14146 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.
14195 14196 14197 14198 |
# File 'lib/aws-sdk-glue/client.rb', line 14195 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.
14228 14229 14230 14231 |
# File 'lib/aws-sdk-glue/client.rb', line 14228 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.
14262 14263 14264 14265 |
# File 'lib/aws-sdk-glue/client.rb', line 14262 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.
14284 14285 14286 14287 |
# File 'lib/aws-sdk-glue/client.rb', line 14284 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.
14307 14308 14309 14310 |
# File 'lib/aws-sdk-glue/client.rb', line 14307 def stop_crawler_schedule(params = {}, = {}) req = build_request(:stop_crawler_schedule, params) req.send_request() end |
#stop_session(params = {}) ⇒ Types::StopSessionResponse
Stops the session.
14339 14340 14341 14342 |
# File 'lib/aws-sdk-glue/client.rb', line 14339 def stop_session(params = {}, = {}) req = build_request(:stop_session, params) req.send_request() end |
#stop_trigger(params = {}) ⇒ Types::StopTriggerResponse
Stops a specified trigger.
14367 14368 14369 14370 |
# File 'lib/aws-sdk-glue/client.rb', line 14367 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.
14393 14394 14395 14396 |
# File 'lib/aws-sdk-glue/client.rb', line 14393 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].
14434 14435 14436 14437 |
# File 'lib/aws-sdk-glue/client.rb', line 14434 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
14461 14462 14463 14464 |
# File 'lib/aws-sdk-glue/client.rb', line 14461 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates a registered blueprint.
14497 14498 14499 14500 |
# File 'lib/aws-sdk-glue/client.rb', line 14497 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).
14555 14556 14557 14558 |
# File 'lib/aws-sdk-glue/client.rb', line 14555 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`.
14693 14694 14695 14696 |
# File 'lib/aws-sdk-glue/client.rb', line 14693 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`.
14827 14828 14829 14830 |
# File 'lib/aws-sdk-glue/client.rb', line 14827 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.
14871 14872 14873 14874 |
# File 'lib/aws-sdk-glue/client.rb', line 14871 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.
15041 15042 15043 15044 |
# File 'lib/aws-sdk-glue/client.rb', line 15041 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.
15074 15075 15076 15077 |
# File 'lib/aws-sdk-glue/client.rb', line 15074 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.
15115 15116 15117 15118 |
# File 'lib/aws-sdk-glue/client.rb', line 15115 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.
15173 15174 15175 15176 |
# File 'lib/aws-sdk-glue/client.rb', line 15173 def update_database(params = {}, = {}) req = build_request(:update_database, params) req.send_request() end |
#update_dev_endpoint(params = {}) ⇒ Struct
Updates a specified development endpoint.
15242 15243 15244 15245 |
# File 'lib/aws-sdk-glue/client.rb', line 15242 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.
15269 15270 15271 15272 |
# File 'lib/aws-sdk-glue/client.rb', line 15269 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.
15337 15338 15339 15340 |
# File 'lib/aws-sdk-glue/client.rb', line 15337 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).
15455 15456 15457 15458 |
# File 'lib/aws-sdk-glue/client.rb', line 15455 def update_ml_transform(params = {}, = {}) req = build_request(:update_ml_transform, params) req.send_request() end |
#update_partition(params = {}) ⇒ Struct
Updates a partition.
15559 15560 15561 15562 |
# File 'lib/aws-sdk-glue/client.rb', line 15559 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.
15600 15601 15602 15603 |
# File 'lib/aws-sdk-glue/client.rb', line 15600 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.
15672 15673 15674 15675 |
# File 'lib/aws-sdk-glue/client.rb', line 15672 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.
15740 15741 15742 15743 |
# File 'lib/aws-sdk-glue/client.rb', line 15740 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.
15868 15869 15870 15871 |
# File 'lib/aws-sdk-glue/client.rb', line 15868 def update_table(params = {}, = {}) req = build_request(:update_table, params) req.send_request() end |
#update_trigger(params = {}) ⇒ Types::UpdateTriggerResponse
Updates a trigger definition.
15957 15958 15959 15960 |
# File 'lib/aws-sdk-glue/client.rb', line 15957 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.
16006 16007 16008 16009 |
# File 'lib/aws-sdk-glue/client.rb', line 16006 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.
16053 16054 16055 16056 |
# File 'lib/aws-sdk-glue/client.rb', line 16053 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.
16077 16078 16079 |
# File 'lib/aws-sdk-glue/client.rb', line 16077 def waiter_names [] end |