Class: Aws::Glue::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Glue::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-glue/client.rb
Overview
An API client for Glue. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Glue::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#batch_create_partition(params = {}) ⇒ Types::BatchCreatePartitionResponse
Creates one or more partitions in a batch operation.
-
#batch_delete_connection(params = {}) ⇒ Types::BatchDeleteConnectionResponse
Deletes a list of connection definitions from the Data Catalog.
-
#batch_delete_partition(params = {}) ⇒ Types::BatchDeletePartitionResponse
Deletes one or more partitions in a batch operation.
-
#batch_delete_table(params = {}) ⇒ Types::BatchDeleteTableResponse
Deletes multiple tables at once.
-
#batch_delete_table_version(params = {}) ⇒ Types::BatchDeleteTableVersionResponse
Deletes a specified batch of versions of a table.
-
#batch_get_blueprints(params = {}) ⇒ Types::BatchGetBlueprintsResponse
Retrieves information about a list of blueprints.
-
#batch_get_crawlers(params = {}) ⇒ Types::BatchGetCrawlersResponse
Returns a list of resource metadata for a given list of crawler names.
-
#batch_get_custom_entity_types(params = {}) ⇒ Types::BatchGetCustomEntityTypesResponse
Retrieves the details for the custom patterns specified by a list of names.
-
#batch_get_data_quality_result(params = {}) ⇒ Types::BatchGetDataQualityResultResponse
Retrieves a list of data quality results for the specified result IDs.
-
#batch_get_dev_endpoints(params = {}) ⇒ Types::BatchGetDevEndpointsResponse
Returns a list of resource metadata for a given list of development endpoint names.
-
#batch_get_jobs(params = {}) ⇒ Types::BatchGetJobsResponse
Returns a list of resource metadata for a given list of job names.
-
#batch_get_partition(params = {}) ⇒ Types::BatchGetPartitionResponse
Retrieves partitions in a batch request.
-
#batch_get_table_optimizer(params = {}) ⇒ Types::BatchGetTableOptimizerResponse
Returns the configuration for the specified table optimizers.
-
#batch_get_triggers(params = {}) ⇒ Types::BatchGetTriggersResponse
Returns a list of resource metadata for a given list of trigger names.
-
#batch_get_workflows(params = {}) ⇒ Types::BatchGetWorkflowsResponse
Returns a list of resource metadata for a given list of workflow names.
-
#batch_put_data_quality_statistic_annotation(params = {}) ⇒ Types::BatchPutDataQualityStatisticAnnotationResponse
Annotate datapoints over time for a specific data quality statistic.
-
#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_catalog(params = {}) ⇒ Struct
Creates a new catalog in the Glue Data Catalog.
-
#create_classifier(params = {}) ⇒ Struct
Creates a classifier in the user’s account.
-
#create_column_statistics_task_settings(params = {}) ⇒ Struct
Creates settings for a column statistics task.
-
#create_connection(params = {}) ⇒ Types::CreateConnectionResponse
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_integration(params = {}) ⇒ Types::CreateIntegrationResponse
Creates a Zero-ETL integration in the caller’s account between two resources with Amazon Resource Names (ARNs): the ‘SourceArn` and `TargetArn`.
-
#create_integration_resource_property(params = {}) ⇒ Types::CreateIntegrationResourcePropertyResponse
This API can be used for setting up the ‘ResourceProperty` of the Glue connection (for the source) or Glue database ARN (for the target).
-
#create_integration_table_properties(params = {}) ⇒ Struct
This API is used to provide optional override properties for the the tables that need to be replicated.
-
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates a new job definition.
-
#create_ml_transform(params = {}) ⇒ Types::CreateMLTransformResponse
Creates an Glue machine learning transform.
-
#create_partition(params = {}) ⇒ Struct
Creates a new partition.
-
#create_partition_index(params = {}) ⇒ Struct
Creates a specified partition index in an existing table.
-
#create_registry(params = {}) ⇒ Types::CreateRegistryResponse
Creates a new registry which may be used to hold a collection of schemas.
-
#create_schema(params = {}) ⇒ Types::CreateSchemaResponse
Creates a new schema set and registers the schema definition.
-
#create_script(params = {}) ⇒ Types::CreateScriptResponse
Transforms a directed acyclic graph (DAG) into code.
-
#create_security_configuration(params = {}) ⇒ Types::CreateSecurityConfigurationResponse
Creates a new security configuration.
-
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a new session.
-
#create_table(params = {}) ⇒ Struct
Creates a new table definition in the Data Catalog.
-
#create_table_optimizer(params = {}) ⇒ Struct
Creates a new table optimizer for a specific function.
-
#create_trigger(params = {}) ⇒ Types::CreateTriggerResponse
Creates a new trigger.
-
#create_usage_profile(params = {}) ⇒ Types::CreateUsageProfileResponse
Creates an Glue usage profile.
-
#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_catalog(params = {}) ⇒ Struct
Removes the specified catalog from the Glue Data Catalog.
-
#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_column_statistics_task_settings(params = {}) ⇒ Struct
Deletes settings for a column statistics task.
-
#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_integration(params = {}) ⇒ Types::DeleteIntegrationResponse
Deletes the specified Zero-ETL integration.
-
#delete_integration_table_properties(params = {}) ⇒ Struct
Deletes the table properties that have been created for the tables that need to be replicated.
-
#delete_job(params = {}) ⇒ Types::DeleteJobResponse
Deletes a specified job definition.
-
#delete_ml_transform(params = {}) ⇒ Types::DeleteMLTransformResponse
Deletes an Glue machine learning transform.
-
#delete_partition(params = {}) ⇒ Struct
Deletes a specified partition.
-
#delete_partition_index(params = {}) ⇒ Struct
Deletes a specified partition index from an existing table.
-
#delete_registry(params = {}) ⇒ Types::DeleteRegistryResponse
Delete the entire registry including schema and all of its versions.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a specified policy.
-
#delete_schema(params = {}) ⇒ Types::DeleteSchemaResponse
Deletes the entire schema set, including the schema set and all of its versions.
-
#delete_schema_versions(params = {}) ⇒ Types::DeleteSchemaVersionsResponse
Remove versions from the specified schema.
-
#delete_security_configuration(params = {}) ⇒ Struct
Deletes a specified security configuration.
-
#delete_session(params = {}) ⇒ Types::DeleteSessionResponse
Deletes the session.
-
#delete_table(params = {}) ⇒ Struct
Removes a table definition from the Data Catalog.
-
#delete_table_optimizer(params = {}) ⇒ Struct
Deletes an optimizer and all associated metadata for a table.
-
#delete_table_version(params = {}) ⇒ Struct
Deletes a specified version of a table.
-
#delete_trigger(params = {}) ⇒ Types::DeleteTriggerResponse
Deletes a specified trigger.
-
#delete_usage_profile(params = {}) ⇒ Struct
Deletes the Glue specified usage profile.
-
#delete_user_defined_function(params = {}) ⇒ Struct
Deletes an existing function definition from the Data Catalog.
-
#delete_workflow(params = {}) ⇒ Types::DeleteWorkflowResponse
Deletes a workflow.
-
#describe_connection_type(params = {}) ⇒ Types::DescribeConnectionTypeResponse
The ‘DescribeConnectionType` API provides full details of the supported options for a given connection type in Glue.
-
#describe_entity(params = {}) ⇒ Types::DescribeEntityResponse
Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.
-
#describe_inbound_integrations(params = {}) ⇒ Types::DescribeInboundIntegrationsResponse
Returns a list of inbound integrations for the specified integration.
-
#describe_integrations(params = {}) ⇒ Types::DescribeIntegrationsResponse
The API is used to retrieve a list of integrations.
-
#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(params = {}) ⇒ Types::GetCatalogResponse
The name of the Catalog to retrieve.
-
#get_catalog_import_status(params = {}) ⇒ Types::GetCatalogImportStatusResponse
Retrieves the status of a migration operation.
-
#get_catalogs(params = {}) ⇒ Types::GetCatalogsResponse
Retrieves all catalogs defined in a catalog in the Glue Data Catalog.
-
#get_classifier(params = {}) ⇒ Types::GetClassifierResponse
Retrieve a classifier by name.
-
#get_classifiers(params = {}) ⇒ Types::GetClassifiersResponse
Lists all classifier objects in the Data Catalog.
-
#get_column_statistics_for_partition(params = {}) ⇒ Types::GetColumnStatisticsForPartitionResponse
Retrieves partition statistics of columns.
-
#get_column_statistics_for_table(params = {}) ⇒ Types::GetColumnStatisticsForTableResponse
Retrieves table statistics of columns.
-
#get_column_statistics_task_run(params = {}) ⇒ Types::GetColumnStatisticsTaskRunResponse
Get the associated metadata/information for a task run, given a task run ID.
-
#get_column_statistics_task_runs(params = {}) ⇒ Types::GetColumnStatisticsTaskRunsResponse
Retrieves information about all runs associated with the specified table.
-
#get_column_statistics_task_settings(params = {}) ⇒ Types::GetColumnStatisticsTaskSettingsResponse
Gets settings for a column statistics task.
-
#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_model(params = {}) ⇒ Types::GetDataQualityModelResponse
Retrieve the training status of the model along with more information (CompletedOn, StartedOn, FailureReason).
-
#get_data_quality_model_result(params = {}) ⇒ Types::GetDataQualityModelResultResponse
Retrieve a statistic’s predictions for a given Profile ID.
-
#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_entity_records(params = {}) ⇒ Types::GetEntityRecordsResponse
This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog.
-
#get_integration_resource_property(params = {}) ⇒ Types::GetIntegrationResourcePropertyResponse
This API is used for fetching the ‘ResourceProperty` of the Glue connection (for the source) or Glue database ARN (for the target).
-
#get_integration_table_properties(params = {}) ⇒ Types::GetIntegrationTablePropertiesResponse
This API is used to retrieve optional override properties for the tables that need to be replicated.
-
#get_job(params = {}) ⇒ Types::GetJobResponse
Retrieves an existing job definition.
-
#get_job_bookmark(params = {}) ⇒ Types::GetJobBookmarkResponse
Returns information on a job bookmark entry.
-
#get_job_run(params = {}) ⇒ Types::GetJobRunResponse
Retrieves the metadata for a given job run.
-
#get_job_runs(params = {}) ⇒ Types::GetJobRunsResponse
Retrieves metadata for all runs of a given job definition.
-
#get_jobs(params = {}) ⇒ Types::GetJobsResponse
Retrieves all current job definitions.
-
#get_mapping(params = {}) ⇒ Types::GetMappingResponse
Creates mappings.
-
#get_ml_task_run(params = {}) ⇒ Types::GetMLTaskRunResponse
Gets details for a specific task run on a machine learning transform.
-
#get_ml_task_runs(params = {}) ⇒ Types::GetMLTaskRunsResponse
Gets a list of runs for a machine learning transform.
-
#get_ml_transform(params = {}) ⇒ Types::GetMLTransformResponse
Gets an Glue machine learning transform artifact and all its corresponding metadata.
-
#get_ml_transforms(params = {}) ⇒ Types::GetMLTransformsResponse
Gets a sortable, filterable list of existing Glue machine learning transforms.
-
#get_partition(params = {}) ⇒ Types::GetPartitionResponse
Retrieves information about a specified partition.
-
#get_partition_indexes(params = {}) ⇒ Types::GetPartitionIndexesResponse
Retrieves the partition indexes associated with a table.
-
#get_partitions(params = {}) ⇒ Types::GetPartitionsResponse
Retrieves information about the partitions in a table.
-
#get_plan(params = {}) ⇒ Types::GetPlanResponse
Gets code to perform a specified mapping.
-
#get_registry(params = {}) ⇒ Types::GetRegistryResponse
Describes the specified registry in detail.
-
#get_resource_policies(params = {}) ⇒ Types::GetResourcePoliciesResponse
Retrieves the resource policies set on individual resources by Resource Access Manager during cross-account permission grants.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves a specified resource policy.
-
#get_schema(params = {}) ⇒ Types::GetSchemaResponse
Describes the specified schema in detail.
-
#get_schema_by_definition(params = {}) ⇒ Types::GetSchemaByDefinitionResponse
Retrieves a schema by the ‘SchemaDefinition`.
-
#get_schema_version(params = {}) ⇒ Types::GetSchemaVersionResponse
Get the specified schema by its unique ID assigned when a version of the schema is created or registered.
-
#get_schema_versions_diff(params = {}) ⇒ Types::GetSchemaVersionsDiffResponse
Fetches the schema version difference in the specified difference type between two stored schema versions in the Schema Registry.
-
#get_security_configuration(params = {}) ⇒ Types::GetSecurityConfigurationResponse
Retrieves a specified security configuration.
-
#get_security_configurations(params = {}) ⇒ Types::GetSecurityConfigurationsResponse
Retrieves a list of all security configurations.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves the session.
-
#get_statement(params = {}) ⇒ Types::GetStatementResponse
Retrieves the statement.
-
#get_table(params = {}) ⇒ Types::GetTableResponse
Retrieves the ‘Table` definition in a Data Catalog for a specified table.
-
#get_table_optimizer(params = {}) ⇒ Types::GetTableOptimizerResponse
Returns the configuration of all optimizers associated with a specified table.
-
#get_table_version(params = {}) ⇒ Types::GetTableVersionResponse
Retrieves a specified version of a table.
-
#get_table_versions(params = {}) ⇒ Types::GetTableVersionsResponse
Retrieves a list of strings that identify available versions of a specified table.
-
#get_tables(params = {}) ⇒ Types::GetTablesResponse
Retrieves the definitions of some or all of the tables in a given ‘Database`.
-
#get_tags(params = {}) ⇒ Types::GetTagsResponse
Retrieves a list of tags associated with a resource.
-
#get_trigger(params = {}) ⇒ Types::GetTriggerResponse
Retrieves the definition of a trigger.
-
#get_triggers(params = {}) ⇒ Types::GetTriggersResponse
Gets all the triggers associated with a job.
-
#get_unfiltered_partition_metadata(params = {}) ⇒ Types::GetUnfilteredPartitionMetadataResponse
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
-
#get_unfiltered_partitions_metadata(params = {}) ⇒ Types::GetUnfilteredPartitionsMetadataResponse
Retrieves partition metadata from the Data Catalog that contains unfiltered metadata.
-
#get_unfiltered_table_metadata(params = {}) ⇒ Types::GetUnfilteredTableMetadataResponse
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
-
#get_usage_profile(params = {}) ⇒ Types::GetUsageProfileResponse
Retrieves information about the specified Glue usage profile.
-
#get_user_defined_function(params = {}) ⇒ Types::GetUserDefinedFunctionResponse
Retrieves a specified function definition from the Data Catalog.
-
#get_user_defined_functions(params = {}) ⇒ Types::GetUserDefinedFunctionsResponse
Retrieves multiple function definitions from the Data Catalog.
-
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Retrieves resource metadata for a workflow.
-
#get_workflow_run(params = {}) ⇒ Types::GetWorkflowRunResponse
Retrieves the metadata for a given workflow run.
-
#get_workflow_run_properties(params = {}) ⇒ Types::GetWorkflowRunPropertiesResponse
Retrieves the workflow run properties which were set during the run.
-
#get_workflow_runs(params = {}) ⇒ Types::GetWorkflowRunsResponse
Retrieves metadata for all runs of a given workflow.
-
#import_catalog_to_glue(params = {}) ⇒ Struct
Imports an existing Amazon Athena Data Catalog to Glue.
-
#list_blueprints(params = {}) ⇒ Types::ListBlueprintsResponse
Lists all the blueprint names in an account.
-
#list_column_statistics_task_runs(params = {}) ⇒ Types::ListColumnStatisticsTaskRunsResponse
List all task runs for a particular account.
-
#list_connection_types(params = {}) ⇒ Types::ListConnectionTypesResponse
The ‘ListConnectionTypes` API provides a discovery mechanism to learn available connection types in Glue.
-
#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_data_quality_statistic_annotations(params = {}) ⇒ Types::ListDataQualityStatisticAnnotationsResponse
Retrieve annotations for a data quality statistic.
-
#list_data_quality_statistics(params = {}) ⇒ Types::ListDataQualityStatisticsResponse
Retrieves a list of data quality statistics.
-
#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_entities(params = {}) ⇒ Types::ListEntitiesResponse
Returns the available entities supported by the connection type.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
Retrieves the names of all job resources in this Amazon Web Services account, or the resources with the specified tag.
-
#list_ml_transforms(params = {}) ⇒ Types::ListMLTransformsResponse
Retrieves a sortable, filterable list of existing Glue machine learning transforms in this Amazon Web Services account, or the resources with the specified tag.
-
#list_registries(params = {}) ⇒ Types::ListRegistriesResponse
Returns a list of registries that you have created, with minimal registry information.
-
#list_schema_versions(params = {}) ⇒ Types::ListSchemaVersionsResponse
Returns a list of schema versions that you have created, with minimal information.
-
#list_schemas(params = {}) ⇒ Types::ListSchemasResponse
Returns a list of schemas with minimal details.
-
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Retrieve a list of sessions.
-
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
Lists statements for the session.
-
#list_table_optimizer_runs(params = {}) ⇒ Types::ListTableOptimizerRunsResponse
Lists the history of previous optimizer runs for a specific table.
-
#list_triggers(params = {}) ⇒ Types::ListTriggersResponse
Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag.
-
#list_usage_profiles(params = {}) ⇒ Types::ListUsageProfilesResponse
List all the Glue usage profiles.
-
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Lists names of workflows created in the account.
-
#modify_integration(params = {}) ⇒ Types::ModifyIntegrationResponse
Modifies a Zero-ETL integration in the caller’s account.
-
#put_data_catalog_encryption_settings(params = {}) ⇒ Struct
Sets the security configuration for a specified catalog.
-
#put_data_quality_profile_annotation(params = {}) ⇒ Struct
Annotate all datapoints for a Profile.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Sets the Data Catalog resource policy for access control.
-
#put_schema_version_metadata(params = {}) ⇒ Types::PutSchemaVersionMetadataResponse
Puts the metadata key value pair for a specified schema version ID.
-
#put_workflow_run_properties(params = {}) ⇒ Struct
Puts the specified workflow run properties for the given workflow run.
-
#query_schema_version_metadata(params = {}) ⇒ Types::QuerySchemaVersionMetadataResponse
Queries for the schema version metadata information.
-
#register_schema_version(params = {}) ⇒ Types::RegisterSchemaVersionResponse
Adds a new version to the existing schema.
-
#remove_schema_version_metadata(params = {}) ⇒ Types::RemoveSchemaVersionMetadataResponse
Removes a key value pair from the schema version metadata for the specified schema version ID.
-
#reset_job_bookmark(params = {}) ⇒ Types::ResetJobBookmarkResponse
Resets a bookmark entry.
-
#resume_workflow_run(params = {}) ⇒ Types::ResumeWorkflowRunResponse
Restarts selected nodes of a previous partially completed workflow run and resumes the workflow run.
-
#run_statement(params = {}) ⇒ Types::RunStatementResponse
Executes the statement.
-
#search_tables(params = {}) ⇒ Types::SearchTablesResponse
Searches a set of tables based on properties in the table metadata as well as on the parent database.
-
#start_blueprint_run(params = {}) ⇒ Types::StartBlueprintRunResponse
Starts a new run of the specified blueprint.
-
#start_column_statistics_task_run(params = {}) ⇒ Types::StartColumnStatisticsTaskRunResponse
Starts a column statistics task run, for a specified table and columns.
-
#start_column_statistics_task_run_schedule(params = {}) ⇒ Struct
Starts a column statistics task run schedule.
-
#start_crawler(params = {}) ⇒ Struct
Starts a crawl using the specified crawler, regardless of what is scheduled.
-
#start_crawler_schedule(params = {}) ⇒ Struct
Changes the schedule state of the specified crawler to ‘SCHEDULED`, unless the crawler is already running or the schedule state is already `SCHEDULED`.
-
#start_data_quality_rule_recommendation_run(params = {}) ⇒ Types::StartDataQualityRuleRecommendationRunResponse
Starts a recommendation run that is used to generate rules when you don’t know what rules to write.
-
#start_data_quality_ruleset_evaluation_run(params = {}) ⇒ Types::StartDataQualityRulesetEvaluationRunResponse
Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table).
-
#start_export_labels_task_run(params = {}) ⇒ Types::StartExportLabelsTaskRunResponse
Begins an asynchronous task to export all labeled data for a particular transform.
-
#start_import_labels_task_run(params = {}) ⇒ Types::StartImportLabelsTaskRunResponse
Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality.
-
#start_job_run(params = {}) ⇒ Types::StartJobRunResponse
Starts a job run using a job definition.
-
#start_ml_evaluation_task_run(params = {}) ⇒ Types::StartMLEvaluationTaskRunResponse
Starts a task to estimate the quality of the transform.
-
#start_ml_labeling_set_generation_task_run(params = {}) ⇒ Types::StartMLLabelingSetGenerationTaskRunResponse
Starts the active learning workflow for your machine learning transform to improve the transform’s quality by generating label sets and adding labels.
-
#start_trigger(params = {}) ⇒ Types::StartTriggerResponse
Starts an existing trigger.
-
#start_workflow_run(params = {}) ⇒ Types::StartWorkflowRunResponse
Starts a new run of the specified workflow.
-
#stop_column_statistics_task_run(params = {}) ⇒ Struct
Stops a task run for the specified table.
-
#stop_column_statistics_task_run_schedule(params = {}) ⇒ Struct
Stops a column statistics task run schedule.
-
#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.
-
#test_connection(params = {}) ⇒ Struct
Tests a connection to a service to validate the service credentials that you provide.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates a registered blueprint.
-
#update_catalog(params = {}) ⇒ Struct
Updates an existing catalog’s properties in the Glue Data Catalog.
-
#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_column_statistics_task_settings(params = {}) ⇒ Struct
Updates settings for a column statistics task.
-
#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_integration_resource_property(params = {}) ⇒ Types::UpdateIntegrationResourcePropertyResponse
This API can be used for updating the ‘ResourceProperty` of the Glue connection (for the source) or Glue database ARN (for the target).
-
#update_integration_table_properties(params = {}) ⇒ Struct
This API is used to provide optional override properties for the tables that need to be replicated.
-
#update_job(params = {}) ⇒ Types::UpdateJobResponse
Updates an existing job definition.
-
#update_job_from_source_control(params = {}) ⇒ Types::UpdateJobFromSourceControlResponse
Synchronizes a job from the source control repository.
-
#update_ml_transform(params = {}) ⇒ Types::UpdateMLTransformResponse
Updates an existing machine learning transform.
-
#update_partition(params = {}) ⇒ Struct
Updates a partition.
-
#update_registry(params = {}) ⇒ Types::UpdateRegistryResponse
Updates an existing registry which is used to hold a collection of schemas.
-
#update_schema(params = {}) ⇒ Types::UpdateSchemaResponse
Updates the description, compatibility setting, or version checkpoint for a schema set.
-
#update_source_control_from_job(params = {}) ⇒ Types::UpdateSourceControlFromJobResponse
Synchronizes a job to the source control repository.
-
#update_table(params = {}) ⇒ Struct
Updates a metadata table in the Data Catalog.
-
#update_table_optimizer(params = {}) ⇒ Struct
Updates the configuration for an existing table optimizer.
-
#update_trigger(params = {}) ⇒ Types::UpdateTriggerResponse
Updates a trigger definition.
-
#update_usage_profile(params = {}) ⇒ Types::UpdateUsageProfileResponse
Update an Glue usage profile.
-
#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.
451 452 453 |
# File 'lib/aws-sdk-glue/client.rb', line 451 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.
20064 20065 20066 |
# File 'lib/aws-sdk-glue/client.rb', line 20064 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.
20067 20068 20069 |
# File 'lib/aws-sdk-glue/client.rb', line 20067 def errors_module Errors end |
Instance Method Details
#batch_create_partition(params = {}) ⇒ Types::BatchCreatePartitionResponse
Creates one or more partitions in a batch operation.
561 562 563 564 |
# File 'lib/aws-sdk-glue/client.rb', line 561 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.
599 600 601 602 |
# File 'lib/aws-sdk-glue/client.rb', line 599 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.
651 652 653 654 |
# File 'lib/aws-sdk-glue/client.rb', line 651 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>
709 710 711 712 |
# File 'lib/aws-sdk-glue/client.rb', line 709 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.
757 758 759 760 |
# File 'lib/aws-sdk-glue/client.rb', line 757 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.
811 812 813 814 |
# File 'lib/aws-sdk-glue/client.rb', line 811 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.
925 926 927 928 |
# File 'lib/aws-sdk-glue/client.rb', line 925 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.
961 962 963 964 |
# File 'lib/aws-sdk-glue/client.rb', line 961 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.
1032 1033 1034 1035 |
# File 'lib/aws-sdk-glue/client.rb', line 1032 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.
1096 1097 1098 1099 |
# File 'lib/aws-sdk-glue/client.rb', line 1096 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.
2028 2029 2030 2031 |
# File 'lib/aws-sdk-glue/client.rb', line 2028 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.
2124 2125 2126 2127 |
# File 'lib/aws-sdk-glue/client.rb', line 2124 def batch_get_partition(params = {}, = {}) req = build_request(:batch_get_partition, params) req.send_request() end |
#batch_get_table_optimizer(params = {}) ⇒ Types::BatchGetTableOptimizerResponse
Returns the configuration for the specified table optimizers.
2200 2201 2202 2203 |
# File 'lib/aws-sdk-glue/client.rb', line 2200 def batch_get_table_optimizer(params = {}, = {}) req = build_request(:batch_get_table_optimizer, params) req.send_request() end |
#batch_get_triggers(params = {}) ⇒ Types::BatchGetTriggersResponse
Returns a list of resource metadata for a given list of trigger names. After calling the ‘ListTriggers` operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.
2260 2261 2262 2263 |
# File 'lib/aws-sdk-glue/client.rb', line 2260 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.
2471 2472 2473 2474 |
# File 'lib/aws-sdk-glue/client.rb', line 2471 def batch_get_workflows(params = {}, = {}) req = build_request(:batch_get_workflows, params) req.send_request() end |
#batch_put_data_quality_statistic_annotation(params = {}) ⇒ Types::BatchPutDataQualityStatisticAnnotationResponse
Annotate datapoints over time for a specific data quality statistic.
2512 2513 2514 2515 |
# File 'lib/aws-sdk-glue/client.rb', line 2512 def batch_put_data_quality_statistic_annotation(params = {}, = {}) req = build_request(:batch_put_data_quality_statistic_annotation, params) req.send_request() end |
#batch_stop_job_run(params = {}) ⇒ Types::BatchStopJobRunResponse
Stops one or more job runs for a specified job definition.
2553 2554 2555 2556 |
# File 'lib/aws-sdk-glue/client.rb', line 2553 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.
2665 2666 2667 2668 |
# File 'lib/aws-sdk-glue/client.rb', line 2665 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.
20037 20038 20039 20040 20041 20042 20043 20044 20045 20046 20047 20048 20049 20050 20051 20052 20053 |
# File 'lib/aws-sdk-glue/client.rb', line 20037 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::Glue') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-glue' context[:gem_version] = '1.206.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.
2688 2689 2690 2691 |
# File 'lib/aws-sdk-glue/client.rb', line 2688 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.
2711 2712 2713 2714 |
# File 'lib/aws-sdk-glue/client.rb', line 2711 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`.
2751 2752 2753 2754 |
# File 'lib/aws-sdk-glue/client.rb', line 2751 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.
2781 2782 2783 2784 |
# File 'lib/aws-sdk-glue/client.rb', line 2781 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.
2819 2820 2821 2822 |
# File 'lib/aws-sdk-glue/client.rb', line 2819 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.
2861 2862 2863 2864 |
# File 'lib/aws-sdk-glue/client.rb', line 2861 def create_blueprint(params = {}, = {}) req = build_request(:create_blueprint, params) req.send_request() end |
#create_catalog(params = {}) ⇒ Struct
Creates a new catalog in the Glue Data Catalog.
2935 2936 2937 2938 |
# File 'lib/aws-sdk-glue/client.rb', line 2935 def create_catalog(params = {}, = {}) req = build_request(:create_catalog, 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.
2994 2995 2996 2997 |
# File 'lib/aws-sdk-glue/client.rb', line 2994 def create_classifier(params = {}, = {}) req = build_request(:create_classifier, params) req.send_request() end |
#create_column_statistics_task_settings(params = {}) ⇒ Struct
Creates settings for a column statistics task.
3052 3053 3054 3055 |
# File 'lib/aws-sdk-glue/client.rb', line 3052 def create_column_statistics_task_settings(params = {}, = {}) req = build_request(:create_column_statistics_task_settings, params) req.send_request() end |
#create_connection(params = {}) ⇒ Types::CreateConnectionResponse
Creates a connection definition in the Data Catalog.
Connections used for creating federated resources require the IAM ‘glue:PassConnection` permission.
3151 3152 3153 3154 |
# File 'lib/aws-sdk-glue/client.rb', line 3151 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.
3335 3336 3337 3338 |
# File 'lib/aws-sdk-glue/client.rb', line 3335 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.
3389 3390 3391 3392 |
# File 'lib/aws-sdk-glue/client.rb', line 3389 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.
3455 3456 3457 3458 |
# File 'lib/aws-sdk-glue/client.rb', line 3455 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.
3512 3513 3514 3515 |
# File 'lib/aws-sdk-glue/client.rb', line 3512 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.
3711 3712 3713 3714 |
# File 'lib/aws-sdk-glue/client.rb', line 3711 def create_dev_endpoint(params = {}, = {}) req = build_request(:create_dev_endpoint, params) req.send_request() end |
#create_integration(params = {}) ⇒ Types::CreateIntegrationResponse
Creates a Zero-ETL integration in the caller’s account between two resources with Amazon Resource Names (ARNs): the ‘SourceArn` and `TargetArn`.
3806 3807 3808 3809 |
# File 'lib/aws-sdk-glue/client.rb', line 3806 def create_integration(params = {}, = {}) req = build_request(:create_integration, params) req.send_request() end |
#create_integration_resource_property(params = {}) ⇒ Types::CreateIntegrationResourcePropertyResponse
This API can be used for setting up the ‘ResourceProperty` of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. To set both source and target properties the same API needs to be invoked with the Glue connection ARN as `ResourceArn` with `SourceProcessingProperties` and the Glue database ARN as `ResourceArn` with `TargetProcessingProperties` respectively.
3862 3863 3864 3865 |
# File 'lib/aws-sdk-glue/client.rb', line 3862 def create_integration_resource_property(params = {}, = {}) req = build_request(:create_integration_resource_property, params) req.send_request() end |
#create_integration_table_properties(params = {}) ⇒ Struct
This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ‘ResourceArn` with `SourceTableConfig`, and the Glue database ARN as `ResourceArn` with `TargetTableConfig` respectively.
3916 3917 3918 3919 |
# File 'lib/aws-sdk-glue/client.rb', line 3916 def create_integration_table_properties(params = {}, = {}) req = build_request(:create_integration_table_properties, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResponse
Creates a new job definition.
4192 4193 4194 4195 |
# File 'lib/aws-sdk-glue/client.rb', line 4192 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
4404 4405 4406 4407 |
# File 'lib/aws-sdk-glue/client.rb', line 4404 def create_ml_transform(params = {}, = {}) req = build_request(:create_ml_transform, params) req.send_request() end |
#create_partition(params = {}) ⇒ Struct
Creates a new partition.
4500 4501 4502 4503 |
# File 'lib/aws-sdk-glue/client.rb', line 4500 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.
4540 4541 4542 4543 |
# File 'lib/aws-sdk-glue/client.rb', line 4540 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.
4590 4591 4592 4593 |
# File 'lib/aws-sdk-glue/client.rb', line 4590 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.
4738 4739 4740 4741 |
# File 'lib/aws-sdk-glue/client.rb', line 4738 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.
4795 4796 4797 4798 |
# File 'lib/aws-sdk-glue/client.rb', line 4795 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
4856 4857 4858 4859 |
# File 'lib/aws-sdk-glue/client.rb', line 4856 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.
5017 5018 5019 5020 |
# File 'lib/aws-sdk-glue/client.rb', line 5017 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.
5169 5170 5171 5172 |
# File 'lib/aws-sdk-glue/client.rb', line 5169 def create_table(params = {}, = {}) req = build_request(:create_table, params) req.send_request() end |
#create_table_optimizer(params = {}) ⇒ Struct
Creates a new table optimizer for a specific function.
5227 5228 5229 5230 |
# File 'lib/aws-sdk-glue/client.rb', line 5227 def create_table_optimizer(params = {}, = {}) req = build_request(:create_table_optimizer, params) req.send_request() end |
#create_trigger(params = {}) ⇒ Types::CreateTriggerResponse
Creates a new trigger.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
5343 5344 5345 5346 |
# File 'lib/aws-sdk-glue/client.rb', line 5343 def create_trigger(params = {}, = {}) req = build_request(:create_trigger, params) req.send_request() end |
#create_usage_profile(params = {}) ⇒ Types::CreateUsageProfileResponse
Creates an Glue usage profile.
5403 5404 5405 5406 |
# File 'lib/aws-sdk-glue/client.rb', line 5403 def create_usage_profile(params = {}, = {}) req = build_request(:create_usage_profile, params) req.send_request() end |
#create_user_defined_function(params = {}) ⇒ Struct
Creates a new function definition in the Data Catalog.
5446 5447 5448 5449 |
# File 'lib/aws-sdk-glue/client.rb', line 5446 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.
5505 5506 5507 5508 |
# File 'lib/aws-sdk-glue/client.rb', line 5505 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_blueprint(params = {}) ⇒ Types::DeleteBlueprintResponse
Deletes an existing blueprint.
5533 5534 5535 5536 |
# File 'lib/aws-sdk-glue/client.rb', line 5533 def delete_blueprint(params = {}, = {}) req = build_request(:delete_blueprint, params) req.send_request() end |
#delete_catalog(params = {}) ⇒ Struct
Removes the specified catalog from the Glue Data Catalog.
After completing this operation, you no longer have access to the databases, tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted catalog. 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 the ‘DeleteCatalog` operation, use `DeleteTableVersion` (or `BatchDeleteTableVersion`), `DeletePartition` (or `BatchDeletePartition`), `DeleteTable` (or `BatchDeleteTable`), `DeleteUserDefinedFunction` and `DeleteDatabase` to delete any resources that belong to the catalog.
5568 5569 5570 5571 |
# File 'lib/aws-sdk-glue/client.rb', line 5568 def delete_catalog(params = {}, = {}) req = build_request(:delete_catalog, params) req.send_request() end |
#delete_classifier(params = {}) ⇒ Struct
Removes a classifier from the Data Catalog.
5590 5591 5592 5593 |
# File 'lib/aws-sdk-glue/client.rb', line 5590 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`.
5633 5634 5635 5636 |
# File 'lib/aws-sdk-glue/client.rb', line 5633 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`.
5672 5673 5674 5675 |
# File 'lib/aws-sdk-glue/client.rb', line 5672 def delete_column_statistics_for_table(params = {}, = {}) req = build_request(:delete_column_statistics_for_table, params) req.send_request() end |
#delete_column_statistics_task_settings(params = {}) ⇒ Struct
Deletes settings for a column statistics task.
5698 5699 5700 5701 |
# File 'lib/aws-sdk-glue/client.rb', line 5698 def delete_column_statistics_task_settings(params = {}, = {}) req = build_request(:delete_column_statistics_task_settings, params) req.send_request() end |
#delete_connection(params = {}) ⇒ Struct
Deletes a connection from the Data Catalog.
5725 5726 5727 5728 |
# File 'lib/aws-sdk-glue/client.rb', line 5725 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`.
5748 5749 5750 5751 |
# File 'lib/aws-sdk-glue/client.rb', line 5748 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.
5776 5777 5778 5779 |
# File 'lib/aws-sdk-glue/client.rb', line 5776 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.
5798 5799 5800 5801 |
# File 'lib/aws-sdk-glue/client.rb', line 5798 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>
5841 5842 5843 5844 |
# File 'lib/aws-sdk-glue/client.rb', line 5841 def delete_database(params = {}, = {}) req = build_request(:delete_database, params) req.send_request() end |
#delete_dev_endpoint(params = {}) ⇒ Struct
Deletes a specified development endpoint.
5863 5864 5865 5866 |
# File 'lib/aws-sdk-glue/client.rb', line 5863 def delete_dev_endpoint(params = {}, = {}) req = build_request(:delete_dev_endpoint, params) req.send_request() end |
#delete_integration(params = {}) ⇒ Types::DeleteIntegrationResponse
Deletes the specified Zero-ETL integration.
5918 5919 5920 5921 |
# File 'lib/aws-sdk-glue/client.rb', line 5918 def delete_integration(params = {}, = {}) req = build_request(:delete_integration, params) req.send_request() end |
#delete_integration_table_properties(params = {}) ⇒ Struct
Deletes the table properties that have been created for the tables that need to be replicated.
5945 5946 5947 5948 |
# File 'lib/aws-sdk-glue/client.rb', line 5945 def delete_integration_table_properties(params = {}, = {}) req = build_request(:delete_integration_table_properties, 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.
5974 5975 5976 5977 |
# File 'lib/aws-sdk-glue/client.rb', line 5974 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.
6008 6009 6010 6011 |
# File 'lib/aws-sdk-glue/client.rb', line 6008 def delete_ml_transform(params = {}, = {}) req = build_request(:delete_ml_transform, params) req.send_request() end |
#delete_partition(params = {}) ⇒ Struct
Deletes a specified partition.
6045 6046 6047 6048 |
# File 'lib/aws-sdk-glue/client.rb', line 6045 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.
6081 6082 6083 6084 |
# File 'lib/aws-sdk-glue/client.rb', line 6081 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.
6122 6123 6124 6125 |
# File 'lib/aws-sdk-glue/client.rb', line 6122 def delete_registry(params = {}, = {}) req = build_request(:delete_registry, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a specified policy.
6148 6149 6150 6151 |
# File 'lib/aws-sdk-glue/client.rb', line 6148 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.
6189 6190 6191 6192 |
# File 'lib/aws-sdk-glue/client.rb', line 6189 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.
6251 6252 6253 6254 |
# File 'lib/aws-sdk-glue/client.rb', line 6251 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.
6273 6274 6275 6276 |
# File 'lib/aws-sdk-glue/client.rb', line 6273 def delete_security_configuration(params = {}, = {}) req = build_request(:delete_security_configuration, params) req.send_request() end |
#delete_session(params = {}) ⇒ Types::DeleteSessionResponse
Deletes the session.
6305 6306 6307 6308 |
# File 'lib/aws-sdk-glue/client.rb', line 6305 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>
6355 6356 6357 6358 |
# File 'lib/aws-sdk-glue/client.rb', line 6355 def delete_table(params = {}, = {}) req = build_request(:delete_table, params) req.send_request() end |
#delete_table_optimizer(params = {}) ⇒ Struct
Deletes an optimizer and all associated metadata for a table. The optimization will no longer be performed on the table.
6390 6391 6392 6393 |
# File 'lib/aws-sdk-glue/client.rb', line 6390 def delete_table_optimizer(params = {}, = {}) req = build_request(:delete_table_optimizer, params) req.send_request() end |
#delete_table_version(params = {}) ⇒ Struct
Deletes a specified version of a table.
6428 6429 6430 6431 |
# File 'lib/aws-sdk-glue/client.rb', line 6428 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.
6457 6458 6459 6460 |
# File 'lib/aws-sdk-glue/client.rb', line 6457 def delete_trigger(params = {}, = {}) req = build_request(:delete_trigger, params) req.send_request() end |
#delete_usage_profile(params = {}) ⇒ Struct
Deletes the Glue specified usage profile.
6479 6480 6481 6482 |
# File 'lib/aws-sdk-glue/client.rb', line 6479 def delete_usage_profile(params = {}, = {}) req = build_request(:delete_usage_profile, params) req.send_request() end |
#delete_user_defined_function(params = {}) ⇒ Struct
Deletes an existing function definition from the Data Catalog.
6511 6512 6513 6514 |
# File 'lib/aws-sdk-glue/client.rb', line 6511 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.
6539 6540 6541 6542 |
# File 'lib/aws-sdk-glue/client.rb', line 6539 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#describe_connection_type(params = {}) ⇒ Types::DescribeConnectionTypeResponse
The ‘DescribeConnectionType` API provides full details of the supported options for a given connection type in Glue.
6740 6741 6742 6743 |
# File 'lib/aws-sdk-glue/client.rb', line 6740 def describe_connection_type(params = {}, = {}) req = build_request(:describe_connection_type, params) req.send_request() end |
#describe_entity(params = {}) ⇒ Types::DescribeEntityResponse
Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.
The response includes all the fields which make up the entity.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6817 6818 6819 6820 |
# File 'lib/aws-sdk-glue/client.rb', line 6817 def describe_entity(params = {}, = {}) req = build_request(:describe_entity, params) req.send_request() end |
#describe_inbound_integrations(params = {}) ⇒ Types::DescribeInboundIntegrationsResponse
Returns a list of inbound integrations for the specified integration.
6869 6870 6871 6872 |
# File 'lib/aws-sdk-glue/client.rb', line 6869 def describe_inbound_integrations(params = {}, = {}) req = build_request(:describe_inbound_integrations, params) req.send_request() end |
#describe_integrations(params = {}) ⇒ Types::DescribeIntegrationsResponse
The API is used to retrieve a list of integrations.
6936 6937 6938 6939 |
# File 'lib/aws-sdk-glue/client.rb', line 6936 def describe_integrations(params = {}, = {}) req = build_request(:describe_integrations, params) req.send_request() end |
#get_blueprint(params = {}) ⇒ Types::GetBlueprintResponse
Retrieves the details of a blueprint.
6985 6986 6987 6988 |
# File 'lib/aws-sdk-glue/client.rb', line 6985 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.
7026 7027 7028 7029 |
# File 'lib/aws-sdk-glue/client.rb', line 7026 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.
7076 7077 7078 7079 |
# File 'lib/aws-sdk-glue/client.rb', line 7076 def get_blueprint_runs(params = {}, = {}) req = build_request(:get_blueprint_runs, params) req.send_request() end |
#get_catalog(params = {}) ⇒ Types::GetCatalogResponse
The name of the Catalog to retrieve. This should be all lowercase.
7133 7134 7135 7136 |
# File 'lib/aws-sdk-glue/client.rb', line 7133 def get_catalog(params = {}, = {}) req = build_request(:get_catalog, params) req.send_request() end |
#get_catalog_import_status(params = {}) ⇒ Types::GetCatalogImportStatusResponse
Retrieves the status of a migration operation.
7164 7165 7166 7167 |
# File 'lib/aws-sdk-glue/client.rb', line 7164 def get_catalog_import_status(params = {}, = {}) req = build_request(:get_catalog_import_status, params) req.send_request() end |
#get_catalogs(params = {}) ⇒ Types::GetCatalogsResponse
Retrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.
7252 7253 7254 7255 |
# File 'lib/aws-sdk-glue/client.rb', line 7252 def get_catalogs(params = {}, = {}) req = build_request(:get_catalogs, params) req.send_request() end |
#get_classifier(params = {}) ⇒ Types::GetClassifierResponse
Retrieve a classifier by name.
7312 7313 7314 7315 |
# File 'lib/aws-sdk-glue/client.rb', line 7312 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.
7381 7382 7383 7384 |
# File 'lib/aws-sdk-glue/client.rb', line 7381 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`.
7467 7468 7469 7470 |
# File 'lib/aws-sdk-glue/client.rb', line 7467 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`.
7549 7550 7551 7552 |
# File 'lib/aws-sdk-glue/client.rb', line 7549 def get_column_statistics_for_table(params = {}, = {}) req = build_request(:get_column_statistics_for_table, params) req.send_request() end |
#get_column_statistics_task_run(params = {}) ⇒ Types::GetColumnStatisticsTaskRunResponse
Get the associated metadata/information for a task run, given a task run ID.
7597 7598 7599 7600 |
# File 'lib/aws-sdk-glue/client.rb', line 7597 def get_column_statistics_task_run(params = {}, = {}) req = build_request(:get_column_statistics_task_run, params) req.send_request() end |
#get_column_statistics_task_runs(params = {}) ⇒ Types::GetColumnStatisticsTaskRunsResponse
Retrieves information about all runs associated with the specified table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7662 7663 7664 7665 |
# File 'lib/aws-sdk-glue/client.rb', line 7662 def get_column_statistics_task_runs(params = {}, = {}) req = build_request(:get_column_statistics_task_runs, params) req.send_request() end |
#get_column_statistics_task_settings(params = {}) ⇒ Types::GetColumnStatisticsTaskSettingsResponse
Gets settings for a column statistics task.
7709 7710 7711 7712 |
# File 'lib/aws-sdk-glue/client.rb', line 7709 def get_column_statistics_task_settings(params = {}, = {}) req = build_request(:get_column_statistics_task_settings, params) req.send_request() end |
#get_connection(params = {}) ⇒ Types::GetConnectionResponse
Retrieves a connection definition from the Data Catalog.
7789 7790 7791 7792 |
# File 'lib/aws-sdk-glue/client.rb', line 7789 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.
7881 7882 7883 7884 |
# File 'lib/aws-sdk-glue/client.rb', line 7881 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.
7986 7987 7988 7989 |
# File 'lib/aws-sdk-glue/client.rb', line 7986 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.
8034 8035 8036 8037 |
# File 'lib/aws-sdk-glue/client.rb', line 8034 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.
8148 8149 8150 8151 |
# File 'lib/aws-sdk-glue/client.rb', line 8148 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.
8181 8182 8183 8184 |
# File 'lib/aws-sdk-glue/client.rb', line 8181 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.
8215 8216 8217 8218 |
# File 'lib/aws-sdk-glue/client.rb', line 8215 def get_data_catalog_encryption_settings(params = {}, = {}) req = build_request(:get_data_catalog_encryption_settings, params) req.send_request() end |
#get_data_quality_model(params = {}) ⇒ Types::GetDataQualityModelResponse
Retrieve the training status of the model along with more information (CompletedOn, StartedOn, FailureReason).
8254 8255 8256 8257 |
# File 'lib/aws-sdk-glue/client.rb', line 8254 def get_data_quality_model(params = {}, = {}) req = build_request(:get_data_quality_model, params) req.send_request() end |
#get_data_quality_model_result(params = {}) ⇒ Types::GetDataQualityModelResultResponse
Retrieve a statistic’s predictions for a given Profile ID.
8294 8295 8296 8297 |
# File 'lib/aws-sdk-glue/client.rb', line 8294 def get_data_quality_model_result(params = {}, = {}) req = build_request(:get_data_quality_model_result, params) req.send_request() end |
#get_data_quality_result(params = {}) ⇒ Types::GetDataQualityResultResponse
Retrieves the result of a data quality rule evaluation.
8374 8375 8376 8377 |
# File 'lib/aws-sdk-glue/client.rb', line 8374 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.
8433 8434 8435 8436 |
# File 'lib/aws-sdk-glue/client.rb', line 8433 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.
8477 8478 8479 8480 |
# File 'lib/aws-sdk-glue/client.rb', line 8477 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.
8549 8550 8551 8552 |
# File 'lib/aws-sdk-glue/client.rb', line 8549 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.
8598 8599 8600 8601 |
# File 'lib/aws-sdk-glue/client.rb', line 8598 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.
8676 8677 8678 8679 |
# File 'lib/aws-sdk-glue/client.rb', line 8676 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).
8716 8717 8718 8719 |
# File 'lib/aws-sdk-glue/client.rb', line 8716 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>
8778 8779 8780 8781 |
# File 'lib/aws-sdk-glue/client.rb', line 8778 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.
8850 8851 8852 8853 |
# File 'lib/aws-sdk-glue/client.rb', line 8850 def get_dev_endpoints(params = {}, = {}) req = build_request(:get_dev_endpoints, params) req.send_request() end |
#get_entity_records(params = {}) ⇒ Types::GetEntityRecordsResponse
This API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog.
Returns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the ‘DescribeEntity` API.
Spark connectors generate schemas according to the same data type mapping as in the ‘DescribeEntity` API. Spark connectors convert data to the appropriate data types matching the schema when returning rows.
8931 8932 8933 8934 |
# File 'lib/aws-sdk-glue/client.rb', line 8931 def get_entity_records(params = {}, = {}) req = build_request(:get_entity_records, params) req.send_request() end |
#get_integration_resource_property(params = {}) ⇒ Types::GetIntegrationResourcePropertyResponse
This API is used for fetching the ‘ResourceProperty` of the Glue connection (for the source) or Glue database ARN (for the target)
8967 8968 8969 8970 |
# File 'lib/aws-sdk-glue/client.rb', line 8967 def get_integration_resource_property(params = {}, = {}) req = build_request(:get_integration_resource_property, params) req.send_request() end |
#get_integration_table_properties(params = {}) ⇒ Types::GetIntegrationTablePropertiesResponse
This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.
9016 9017 9018 9019 |
# File 'lib/aws-sdk-glue/client.rb', line 9016 def get_integration_table_properties(params = {}, = {}) req = build_request(:get_integration_table_properties, params) req.send_request() end |
#get_job(params = {}) ⇒ Types::GetJobResponse
Retrieves an existing job definition.
9939 9940 9941 9942 |
# File 'lib/aws-sdk-glue/client.rb', line 9939 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
9991 9992 9993 9994 |
# File 'lib/aws-sdk-glue/client.rb', line 9991 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. Job run history is accessible for 365 days for your workflow and job run.
10059 10060 10061 10062 |
# File 'lib/aws-sdk-glue/client.rb', line 10059 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.
‘GetJobRuns` returns the job runs in chronological order, with the newest jobs returned first.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10134 10135 10136 10137 |
# File 'lib/aws-sdk-glue/client.rb', line 10134 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.
11066 11067 11068 11069 |
# File 'lib/aws-sdk-glue/client.rb', line 11066 def get_jobs(params = {}, = {}) req = build_request(:get_jobs, params) req.send_request() end |
#get_mapping(params = {}) ⇒ Types::GetMappingResponse
Creates mappings.
11487 11488 11489 11490 |
# File 'lib/aws-sdk-glue/client.rb', line 11487 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`.
11127 11128 11129 11130 |
# File 'lib/aws-sdk-glue/client.rb', line 11127 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.
11209 11210 11211 11212 |
# File 'lib/aws-sdk-glue/client.rb', line 11209 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`.
11304 11305 11306 11307 |
# File 'lib/aws-sdk-glue/client.rb', line 11304 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.
11415 11416 11417 11418 |
# File 'lib/aws-sdk-glue/client.rb', line 11415 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.
11574 11575 11576 11577 |
# File 'lib/aws-sdk-glue/client.rb', line 11574 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.
11630 11631 11632 11633 |
# File 'lib/aws-sdk-glue/client.rb', line 11630 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.
11845 11846 11847 11848 |
# File 'lib/aws-sdk-glue/client.rb', line 11845 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.
11944 11945 11946 11947 |
# File 'lib/aws-sdk-glue/client.rb', line 11944 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.
11986 11987 11988 11989 |
# File 'lib/aws-sdk-glue/client.rb', line 11986 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.
12032 12033 12034 12035 |
# File 'lib/aws-sdk-glue/client.rb', line 12032 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.
12073 12074 12075 12076 |
# File 'lib/aws-sdk-glue/client.rb', line 12073 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.
12137 12138 12139 12140 |
# File 'lib/aws-sdk-glue/client.rb', line 12137 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.
12193 12194 12195 12196 |
# File 'lib/aws-sdk-glue/client.rb', line 12193 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.
12260 12261 12262 12263 |
# File 'lib/aws-sdk-glue/client.rb', line 12260 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.
12321 12322 12323 12324 |
# File 'lib/aws-sdk-glue/client.rb', line 12321 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.
12359 12360 12361 12362 |
# File 'lib/aws-sdk-glue/client.rb', line 12359 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.
12406 12407 12408 12409 |
# File 'lib/aws-sdk-glue/client.rb', line 12406 def get_security_configurations(params = {}, = {}) req = build_request(:get_security_configurations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves the session.
12460 12461 12462 12463 |
# File 'lib/aws-sdk-glue/client.rb', line 12460 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_statement(params = {}) ⇒ Types::GetStatementResponse
Retrieves the statement.
12508 12509 12510 12511 |
# File 'lib/aws-sdk-glue/client.rb', line 12508 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.
12658 12659 12660 12661 |
# File 'lib/aws-sdk-glue/client.rb', line 12658 def get_table(params = {}, = {}) req = build_request(:get_table, params) req.send_request() end |
#get_table_optimizer(params = {}) ⇒ Types::GetTableOptimizerResponse
Returns the configuration of all optimizers associated with a specified table.
12733 12734 12735 12736 |
# File 'lib/aws-sdk-glue/client.rb', line 12733 def get_table_optimizer(params = {}, = {}) req = build_request(:get_table_optimizer, params) req.send_request() end |
#get_table_version(params = {}) ⇒ Types::GetTableVersionResponse
Retrieves a specified version of a table.
12873 12874 12875 12876 |
# File 'lib/aws-sdk-glue/client.rb', line 12873 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.
13022 13023 13024 13025 |
# File 'lib/aws-sdk-glue/client.rb', line 13022 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.
13197 13198 13199 13200 |
# File 'lib/aws-sdk-glue/client.rb', line 13197 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.
13227 13228 13229 13230 |
# File 'lib/aws-sdk-glue/client.rb', line 13227 def (params = {}, = {}) req = build_request(:get_tags, params) req.send_request() end |
#get_trigger(params = {}) ⇒ Types::GetTriggerResponse
Retrieves the definition of a trigger.
13278 13279 13280 13281 |
# File 'lib/aws-sdk-glue/client.rb', line 13278 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.
13344 13345 13346 13347 |
# File 'lib/aws-sdk-glue/client.rb', line 13344 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`.
13471 13472 13473 13474 |
# File 'lib/aws-sdk-glue/client.rb', line 13471 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.
13701 13702 13703 13704 |
# File 'lib/aws-sdk-glue/client.rb', line 13701 def (params = {}, = {}) req = build_request(:get_unfiltered_partitions_metadata, params) req.send_request() end |
#get_unfiltered_table_metadata(params = {}) ⇒ Types::GetUnfilteredTableMetadataResponse
Allows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog.
For IAM authorization, the public IAM action associated with this API is ‘glue:GetTable`.
13945 13946 13947 13948 |
# File 'lib/aws-sdk-glue/client.rb', line 13945 def (params = {}, = {}) req = build_request(:get_unfiltered_table_metadata, params) req.send_request() end |
#get_usage_profile(params = {}) ⇒ Types::GetUsageProfileResponse
Retrieves information about the specified Glue usage profile.
13992 13993 13994 13995 |
# File 'lib/aws-sdk-glue/client.rb', line 13992 def get_usage_profile(params = {}, = {}) req = build_request(:get_usage_profile, params) req.send_request() end |
#get_user_defined_function(params = {}) ⇒ Types::GetUserDefinedFunctionResponse
Retrieves a specified function definition from the Data Catalog.
14039 14040 14041 14042 |
# File 'lib/aws-sdk-glue/client.rb', line 14039 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.
14102 14103 14104 14105 |
# File 'lib/aws-sdk-glue/client.rb', line 14102 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.
14304 14305 14306 14307 |
# File 'lib/aws-sdk-glue/client.rb', line 14304 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. Job run history is accessible for 90 days for your workflow and job run.
14430 14431 14432 14433 |
# File 'lib/aws-sdk-glue/client.rb', line 14430 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.
14463 14464 14465 14466 |
# File 'lib/aws-sdk-glue/client.rb', line 14463 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.
14597 14598 14599 14600 |
# File 'lib/aws-sdk-glue/client.rb', line 14597 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.
14620 14621 14622 14623 |
# File 'lib/aws-sdk-glue/client.rb', line 14620 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.
14663 14664 14665 14666 |
# File 'lib/aws-sdk-glue/client.rb', line 14663 def list_blueprints(params = {}, = {}) req = build_request(:list_blueprints, params) req.send_request() end |
#list_column_statistics_task_runs(params = {}) ⇒ Types::ListColumnStatisticsTaskRunsResponse
List all task runs for a particular account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
14700 14701 14702 14703 |
# File 'lib/aws-sdk-glue/client.rb', line 14700 def list_column_statistics_task_runs(params = {}, = {}) req = build_request(:list_column_statistics_task_runs, params) req.send_request() end |
#list_connection_types(params = {}) ⇒ Types::ListConnectionTypesResponse
The ‘ListConnectionTypes` API provides a discovery mechanism to learn available connection types in Glue. The response contains a list of connection types with high-level details of what is supported for each connection type. The connection types listed are the set of supported options for the `ConnectionType` value in the `CreateConnection` API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
14748 14749 14750 14751 |
# File 'lib/aws-sdk-glue/client.rb', line 14748 def list_connection_types(params = {}, = {}) req = build_request(:list_connection_types, 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.
14799 14800 14801 14802 |
# File 'lib/aws-sdk-glue/client.rb', line 14799 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.
14875 14876 14877 14878 |
# File 'lib/aws-sdk-glue/client.rb', line 14875 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.
14921 14922 14923 14924 |
# File 'lib/aws-sdk-glue/client.rb', line 14921 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.
14987 14988 14989 14990 |
# File 'lib/aws-sdk-glue/client.rb', line 14987 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.
15050 15051 15052 15053 |
# File 'lib/aws-sdk-glue/client.rb', line 15050 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.
15114 15115 15116 15117 |
# File 'lib/aws-sdk-glue/client.rb', line 15114 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.
15182 15183 15184 15185 |
# File 'lib/aws-sdk-glue/client.rb', line 15182 def list_data_quality_rulesets(params = {}, = {}) req = build_request(:list_data_quality_rulesets, params) req.send_request() end |
#list_data_quality_statistic_annotations(params = {}) ⇒ Types::ListDataQualityStatisticAnnotationsResponse
Retrieve annotations for a data quality statistic.
15236 15237 15238 15239 |
# File 'lib/aws-sdk-glue/client.rb', line 15236 def list_data_quality_statistic_annotations(params = {}, = {}) req = build_request(:list_data_quality_statistic_annotations, params) req.send_request() end |
#list_data_quality_statistics(params = {}) ⇒ Types::ListDataQualityStatisticsResponse
Retrieves a list of data quality statistics.
15301 15302 15303 15304 |
# File 'lib/aws-sdk-glue/client.rb', line 15301 def list_data_quality_statistics(params = {}, = {}) req = build_request(:list_data_quality_statistics, 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.
15352 15353 15354 15355 |
# File 'lib/aws-sdk-glue/client.rb', line 15352 def list_dev_endpoints(params = {}, = {}) req = build_request(:list_dev_endpoints, params) req.send_request() end |
#list_entities(params = {}) ⇒ Types::ListEntitiesResponse
Returns the available entities supported by the connection type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
15412 15413 15414 15415 |
# File 'lib/aws-sdk-glue/client.rb', line 15412 def list_entities(params = {}, = {}) req = build_request(:list_entities, 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.
15463 15464 15465 15466 |
# File 'lib/aws-sdk-glue/client.rb', line 15463 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.
15539 15540 15541 15542 |
# File 'lib/aws-sdk-glue/client.rb', line 15539 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.
15585 15586 15587 15588 |
# File 'lib/aws-sdk-glue/client.rb', line 15585 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.
15646 15647 15648 15649 |
# File 'lib/aws-sdk-glue/client.rb', line 15646 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.
15703 15704 15705 15706 |
# File 'lib/aws-sdk-glue/client.rb', line 15703 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.
15776 15777 15778 15779 |
# File 'lib/aws-sdk-glue/client.rb', line 15776 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
Lists statements for the session.
15827 15828 15829 15830 |
# File 'lib/aws-sdk-glue/client.rb', line 15827 def list_statements(params = {}, = {}) req = build_request(:list_statements, params) req.send_request() end |
#list_table_optimizer_runs(params = {}) ⇒ Types::ListTableOptimizerRunsResponse
Lists the history of previous optimizer runs for a specific table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
15905 15906 15907 15908 |
# File 'lib/aws-sdk-glue/client.rb', line 15905 def list_table_optimizer_runs(params = {}, = {}) req = build_request(:list_table_optimizer_runs, params) req.send_request() end |
#list_triggers(params = {}) ⇒ Types::ListTriggersResponse
Retrieves the names of all trigger resources in this Amazon Web Services account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.
This operation takes the optional ‘Tags` field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
15962 15963 15964 15965 |
# File 'lib/aws-sdk-glue/client.rb', line 15962 def list_triggers(params = {}, = {}) req = build_request(:list_triggers, params) req.send_request() end |
#list_usage_profiles(params = {}) ⇒ Types::ListUsageProfilesResponse
List all the Glue usage profiles.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16002 16003 16004 16005 |
# File 'lib/aws-sdk-glue/client.rb', line 16002 def list_usage_profiles(params = {}, = {}) req = build_request(:list_usage_profiles, 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.
16039 16040 16041 16042 |
# File 'lib/aws-sdk-glue/client.rb', line 16039 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#modify_integration(params = {}) ⇒ Types::ModifyIntegrationResponse
Modifies a Zero-ETL integration in the caller’s account.
16106 16107 16108 16109 |
# File 'lib/aws-sdk-glue/client.rb', line 16106 def modify_integration(params = {}, = {}) req = build_request(:modify_integration, 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.
16146 16147 16148 16149 |
# File 'lib/aws-sdk-glue/client.rb', line 16146 def put_data_catalog_encryption_settings(params = {}, = {}) req = build_request(:put_data_catalog_encryption_settings, params) req.send_request() end |
#put_data_quality_profile_annotation(params = {}) ⇒ Struct
Annotate all datapoints for a Profile.
16172 16173 16174 16175 |
# File 'lib/aws-sdk-glue/client.rb', line 16172 def put_data_quality_profile_annotation(params = {}, = {}) req = build_request(:put_data_quality_profile_annotation, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Sets the Data Catalog resource policy for access control.
16232 16233 16234 16235 |
# File 'lib/aws-sdk-glue/client.rb', line 16232 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.
16298 16299 16300 16301 |
# File 'lib/aws-sdk-glue/client.rb', line 16298 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.
16338 16339 16340 16341 |
# File 'lib/aws-sdk-glue/client.rb', line 16338 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.
16410 16411 16412 16413 |
# File 'lib/aws-sdk-glue/client.rb', line 16410 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.
16474 16475 16476 16477 |
# File 'lib/aws-sdk-glue/client.rb', line 16474 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.
16540 16541 16542 16543 |
# File 'lib/aws-sdk-glue/client.rb', line 16540 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
16592 16593 16594 16595 |
# File 'lib/aws-sdk-glue/client.rb', line 16592 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.
16634 16635 16636 16637 |
# File 'lib/aws-sdk-glue/client.rb', line 16634 def resume_workflow_run(params = {}, = {}) req = build_request(:resume_workflow_run, params) req.send_request() end |
#run_statement(params = {}) ⇒ Types::RunStatementResponse
Executes the statement.
16670 16671 16672 16673 |
# File 'lib/aws-sdk-glue/client.rb', line 16670 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.
16871 16872 16873 16874 |
# File 'lib/aws-sdk-glue/client.rb', line 16871 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.
16907 16908 16909 16910 |
# File 'lib/aws-sdk-glue/client.rb', line 16907 def start_blueprint_run(params = {}, = {}) req = build_request(:start_blueprint_run, params) req.send_request() end |
#start_column_statistics_task_run(params = {}) ⇒ Types::StartColumnStatisticsTaskRunResponse
Starts a column statistics task run, for a specified table and columns.
16964 16965 16966 16967 |
# File 'lib/aws-sdk-glue/client.rb', line 16964 def start_column_statistics_task_run(params = {}, = {}) req = build_request(:start_column_statistics_task_run, params) req.send_request() end |
#start_column_statistics_task_run_schedule(params = {}) ⇒ Struct
Starts a column statistics task run schedule.
16991 16992 16993 16994 |
# File 'lib/aws-sdk-glue/client.rb', line 16991 def start_column_statistics_task_run_schedule(params = {}, = {}) req = build_request(:start_column_statistics_task_run_schedule, 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].
17019 17020 17021 17022 |
# File 'lib/aws-sdk-glue/client.rb', line 17019 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`.
17043 17044 17045 17046 |
# File 'lib/aws-sdk-glue/client.rb', line 17043 def start_crawler_schedule(params = {}, = {}) req = build_request(:start_crawler_schedule, params) req.send_request() end |
#start_data_quality_rule_recommendation_run(params = {}) ⇒ Types::StartDataQualityRuleRecommendationRunResponse
Starts a recommendation run that is used to generate rules when you don’t know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.
Recommendation runs are automatically deleted after 90 days.
17116 17117 17118 17119 |
# File 'lib/aws-sdk-glue/client.rb', line 17116 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.
17206 17207 17208 17209 |
# File 'lib/aws-sdk-glue/client.rb', line 17206 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.
17247 17248 17249 17250 |
# File 'lib/aws-sdk-glue/client.rb', line 17247 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.
17313 17314 17315 17316 |
# File 'lib/aws-sdk-glue/client.rb', line 17313 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.
17524 17525 17526 17527 |
# File 'lib/aws-sdk-glue/client.rb', line 17524 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`.
17559 17560 17561 17562 |
# File 'lib/aws-sdk-glue/client.rb', line 17559 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.
17608 17609 17610 17611 |
# File 'lib/aws-sdk-glue/client.rb', line 17608 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.
17641 17642 17643 17644 |
# File 'lib/aws-sdk-glue/client.rb', line 17641 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.
17680 17681 17682 17683 |
# File 'lib/aws-sdk-glue/client.rb', line 17680 def start_workflow_run(params = {}, = {}) req = build_request(:start_workflow_run, params) req.send_request() end |
#stop_column_statistics_task_run(params = {}) ⇒ Struct
Stops a task run for the specified table.
17706 17707 17708 17709 |
# File 'lib/aws-sdk-glue/client.rb', line 17706 def stop_column_statistics_task_run(params = {}, = {}) req = build_request(:stop_column_statistics_task_run, params) req.send_request() end |
#stop_column_statistics_task_run_schedule(params = {}) ⇒ Struct
Stops a column statistics task run schedule.
17733 17734 17735 17736 |
# File 'lib/aws-sdk-glue/client.rb', line 17733 def stop_column_statistics_task_run_schedule(params = {}, = {}) req = build_request(:stop_column_statistics_task_run_schedule, params) req.send_request() end |
#stop_crawler(params = {}) ⇒ Struct
If the specified crawler is running, stops the crawl.
17755 17756 17757 17758 |
# File 'lib/aws-sdk-glue/client.rb', line 17755 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.
17778 17779 17780 17781 |
# File 'lib/aws-sdk-glue/client.rb', line 17778 def stop_crawler_schedule(params = {}, = {}) req = build_request(:stop_crawler_schedule, params) req.send_request() end |
#stop_session(params = {}) ⇒ Types::StopSessionResponse
Stops the session.
17810 17811 17812 17813 |
# File 'lib/aws-sdk-glue/client.rb', line 17810 def stop_session(params = {}, = {}) req = build_request(:stop_session, params) req.send_request() end |
#stop_trigger(params = {}) ⇒ Types::StopTriggerResponse
Stops a specified trigger.
17838 17839 17840 17841 |
# File 'lib/aws-sdk-glue/client.rb', line 17838 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.
17864 17865 17866 17867 |
# File 'lib/aws-sdk-glue/client.rb', line 17864 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].
17905 17906 17907 17908 |
# File 'lib/aws-sdk-glue/client.rb', line 17905 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_connection(params = {}) ⇒ Struct
Tests a connection to a service to validate the service credentials that you provide.
You can either provide an existing connection name or a ‘TestConnectionInput` for testing a non-existing connection input. Providing both at the same time will cause an error.
If the action is successful, the service sends back an HTTP 200 response.
17983 17984 17985 17986 |
# File 'lib/aws-sdk-glue/client.rb', line 17983 def test_connection(params = {}, = {}) req = build_request(:test_connection, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
18010 18011 18012 18013 |
# File 'lib/aws-sdk-glue/client.rb', line 18010 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates a registered blueprint.
18046 18047 18048 18049 |
# File 'lib/aws-sdk-glue/client.rb', line 18046 def update_blueprint(params = {}, = {}) req = build_request(:update_blueprint, params) req.send_request() end |
#update_catalog(params = {}) ⇒ Struct
Updates an existing catalog’s properties in the Glue Data Catalog.
18112 18113 18114 18115 |
# File 'lib/aws-sdk-glue/client.rb', line 18112 def update_catalog(params = {}, = {}) req = build_request(:update_catalog, 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).
18171 18172 18173 18174 |
# File 'lib/aws-sdk-glue/client.rb', line 18171 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`.
18309 18310 18311 18312 |
# File 'lib/aws-sdk-glue/client.rb', line 18309 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`.
18443 18444 18445 18446 |
# File 'lib/aws-sdk-glue/client.rb', line 18443 def update_column_statistics_for_table(params = {}, = {}) req = build_request(:update_column_statistics_for_table, params) req.send_request() end |
#update_column_statistics_task_settings(params = {}) ⇒ Struct
Updates settings for a column statistics task.
18495 18496 18497 18498 |
# File 'lib/aws-sdk-glue/client.rb', line 18495 def update_column_statistics_task_settings(params = {}, = {}) req = build_request(:update_column_statistics_task_settings, params) req.send_request() end |
#update_connection(params = {}) ⇒ Struct
Updates a connection definition in the Data Catalog.
18583 18584 18585 18586 |
# File 'lib/aws-sdk-glue/client.rb', line 18583 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.
18753 18754 18755 18756 |
# File 'lib/aws-sdk-glue/client.rb', line 18753 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.
18786 18787 18788 18789 |
# File 'lib/aws-sdk-glue/client.rb', line 18786 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.
18827 18828 18829 18830 |
# File 'lib/aws-sdk-glue/client.rb', line 18827 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.
18885 18886 18887 18888 |
# File 'lib/aws-sdk-glue/client.rb', line 18885 def update_database(params = {}, = {}) req = build_request(:update_database, params) req.send_request() end |
#update_dev_endpoint(params = {}) ⇒ Struct
Updates a specified development endpoint.
18954 18955 18956 18957 |
# File 'lib/aws-sdk-glue/client.rb', line 18954 def update_dev_endpoint(params = {}, = {}) req = build_request(:update_dev_endpoint, params) req.send_request() end |
#update_integration_resource_property(params = {}) ⇒ Types::UpdateIntegrationResourcePropertyResponse
This API can be used for updating the ‘ResourceProperty` of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. Since the same resource can be used across multiple integrations, updating resource properties will impact all the integrations using it.
19009 19010 19011 19012 |
# File 'lib/aws-sdk-glue/client.rb', line 19009 def update_integration_resource_property(params = {}, = {}) req = build_request(:update_integration_resource_property, params) req.send_request() end |
#update_integration_table_properties(params = {}) ⇒ Struct
This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ‘ResourceArn` with `SourceTableConfig`, and the Glue database ARN as `ResourceArn` with `TargetTableConfig` respectively.
The override will be reflected across all the integrations using same ‘ResourceArn` and source table.
19066 19067 19068 19069 |
# File 'lib/aws-sdk-glue/client.rb', line 19066 def update_integration_table_properties(params = {}, = {}) req = build_request(:update_integration_table_properties, 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.
19093 19094 19095 19096 |
# File 'lib/aws-sdk-glue/client.rb', line 19093 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.
19164 19165 19166 19167 |
# File 'lib/aws-sdk-glue/client.rb', line 19164 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).
19282 19283 19284 19285 |
# File 'lib/aws-sdk-glue/client.rb', line 19282 def update_ml_transform(params = {}, = {}) req = build_request(:update_ml_transform, params) req.send_request() end |
#update_partition(params = {}) ⇒ Struct
Updates a partition.
19386 19387 19388 19389 |
# File 'lib/aws-sdk-glue/client.rb', line 19386 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.
19427 19428 19429 19430 |
# File 'lib/aws-sdk-glue/client.rb', line 19427 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.
19499 19500 19501 19502 |
# File 'lib/aws-sdk-glue/client.rb', line 19499 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.
19570 19571 19572 19573 |
# File 'lib/aws-sdk-glue/client.rb', line 19570 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.
19721 19722 19723 19724 |
# File 'lib/aws-sdk-glue/client.rb', line 19721 def update_table(params = {}, = {}) req = build_request(:update_table, params) req.send_request() end |
#update_table_optimizer(params = {}) ⇒ Struct
Updates the configuration for an existing table optimizer.
19779 19780 19781 19782 |
# File 'lib/aws-sdk-glue/client.rb', line 19779 def update_table_optimizer(params = {}, = {}) req = build_request(:update_table_optimizer, params) req.send_request() end |
#update_trigger(params = {}) ⇒ Types::UpdateTriggerResponse
Updates a trigger definition.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
19873 19874 19875 19876 |
# File 'lib/aws-sdk-glue/client.rb', line 19873 def update_trigger(params = {}, = {}) req = build_request(:update_trigger, params) req.send_request() end |
#update_usage_profile(params = {}) ⇒ Types::UpdateUsageProfileResponse
Update an Glue usage profile.
19927 19928 19929 19930 |
# File 'lib/aws-sdk-glue/client.rb', line 19927 def update_usage_profile(params = {}, = {}) req = build_request(:update_usage_profile, params) req.send_request() end |
#update_user_defined_function(params = {}) ⇒ Struct
Updates an existing function definition in the Data Catalog.
19976 19977 19978 19979 |
# File 'lib/aws-sdk-glue/client.rb', line 19976 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.
20028 20029 20030 20031 |
# File 'lib/aws-sdk-glue/client.rb', line 20028 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.
20057 20058 20059 |
# File 'lib/aws-sdk-glue/client.rb', line 20057 def waiter_names [] end |