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.
473 474 475 |
# File 'lib/aws-sdk-glue/client.rb', line 473 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.
20280 20281 20282 |
# File 'lib/aws-sdk-glue/client.rb', line 20280 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.
20283 20284 20285 |
# File 'lib/aws-sdk-glue/client.rb', line 20283 def errors_module Errors end |
Instance Method Details
#batch_create_partition(params = {}) ⇒ Types::BatchCreatePartitionResponse
Creates one or more partitions in a batch operation.
583 584 585 586 |
# File 'lib/aws-sdk-glue/client.rb', line 583 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.
621 622 623 624 |
# File 'lib/aws-sdk-glue/client.rb', line 621 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.
673 674 675 676 |
# File 'lib/aws-sdk-glue/client.rb', line 673 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>
731 732 733 734 |
# File 'lib/aws-sdk-glue/client.rb', line 731 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.
779 780 781 782 |
# File 'lib/aws-sdk-glue/client.rb', line 779 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.
833 834 835 836 |
# File 'lib/aws-sdk-glue/client.rb', line 833 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.
947 948 949 950 |
# File 'lib/aws-sdk-glue/client.rb', line 947 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.
983 984 985 986 |
# File 'lib/aws-sdk-glue/client.rb', line 983 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.
1054 1055 1056 1057 |
# File 'lib/aws-sdk-glue/client.rb', line 1054 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.
1118 1119 1120 1121 |
# File 'lib/aws-sdk-glue/client.rb', line 1118 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.
2103 2104 2105 2106 |
# File 'lib/aws-sdk-glue/client.rb', line 2103 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.
2199 2200 2201 2202 |
# File 'lib/aws-sdk-glue/client.rb', line 2199 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.
2278 2279 2280 2281 |
# File 'lib/aws-sdk-glue/client.rb', line 2278 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.
2338 2339 2340 2341 |
# File 'lib/aws-sdk-glue/client.rb', line 2338 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.
2549 2550 2551 2552 |
# File 'lib/aws-sdk-glue/client.rb', line 2549 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.
2590 2591 2592 2593 |
# File 'lib/aws-sdk-glue/client.rb', line 2590 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.
2631 2632 2633 2634 |
# File 'lib/aws-sdk-glue/client.rb', line 2631 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.
2743 2744 2745 2746 |
# File 'lib/aws-sdk-glue/client.rb', line 2743 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.
20253 20254 20255 20256 20257 20258 20259 20260 20261 20262 20263 20264 20265 20266 20267 20268 20269 |
# File 'lib/aws-sdk-glue/client.rb', line 20253 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.217.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.
2766 2767 2768 2769 |
# File 'lib/aws-sdk-glue/client.rb', line 2766 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.
2789 2790 2791 2792 |
# File 'lib/aws-sdk-glue/client.rb', line 2789 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`.
2829 2830 2831 2832 |
# File 'lib/aws-sdk-glue/client.rb', line 2829 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.
2859 2860 2861 2862 |
# File 'lib/aws-sdk-glue/client.rb', line 2859 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.
2897 2898 2899 2900 |
# File 'lib/aws-sdk-glue/client.rb', line 2897 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.
2939 2940 2941 2942 |
# File 'lib/aws-sdk-glue/client.rb', line 2939 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.
3014 3015 3016 3017 |
# File 'lib/aws-sdk-glue/client.rb', line 3014 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.
3073 3074 3075 3076 |
# File 'lib/aws-sdk-glue/client.rb', line 3073 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.
3131 3132 3133 3134 |
# File 'lib/aws-sdk-glue/client.rb', line 3131 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.
3230 3231 3232 3233 |
# File 'lib/aws-sdk-glue/client.rb', line 3230 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.
3414 3415 3416 3417 |
# File 'lib/aws-sdk-glue/client.rb', line 3414 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.
3468 3469 3470 3471 |
# File 'lib/aws-sdk-glue/client.rb', line 3468 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.
3534 3535 3536 3537 |
# File 'lib/aws-sdk-glue/client.rb', line 3534 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.
3591 3592 3593 3594 |
# File 'lib/aws-sdk-glue/client.rb', line 3591 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.
3790 3791 3792 3793 |
# File 'lib/aws-sdk-glue/client.rb', line 3790 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`.
3893 3894 3895 3896 |
# File 'lib/aws-sdk-glue/client.rb', line 3893 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.
3949 3950 3951 3952 |
# File 'lib/aws-sdk-glue/client.rb', line 3949 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.
4005 4006 4007 4008 |
# File 'lib/aws-sdk-glue/client.rb', line 4005 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.
4288 4289 4290 4291 |
# File 'lib/aws-sdk-glue/client.rb', line 4288 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
4500 4501 4502 4503 |
# File 'lib/aws-sdk-glue/client.rb', line 4500 def create_ml_transform(params = {}, = {}) req = build_request(:create_ml_transform, params) req.send_request() end |
#create_partition(params = {}) ⇒ Struct
Creates a new partition.
4596 4597 4598 4599 |
# File 'lib/aws-sdk-glue/client.rb', line 4596 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.
4636 4637 4638 4639 |
# File 'lib/aws-sdk-glue/client.rb', line 4636 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.
4686 4687 4688 4689 |
# File 'lib/aws-sdk-glue/client.rb', line 4686 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.
4834 4835 4836 4837 |
# File 'lib/aws-sdk-glue/client.rb', line 4834 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.
4891 4892 4893 4894 |
# File 'lib/aws-sdk-glue/client.rb', line 4891 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
4952 4953 4954 4955 |
# File 'lib/aws-sdk-glue/client.rb', line 4952 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.
5113 5114 5115 5116 |
# File 'lib/aws-sdk-glue/client.rb', line 5113 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.
5265 5266 5267 5268 |
# File 'lib/aws-sdk-glue/client.rb', line 5265 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.
5323 5324 5325 5326 |
# File 'lib/aws-sdk-glue/client.rb', line 5323 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.
5439 5440 5441 5442 |
# File 'lib/aws-sdk-glue/client.rb', line 5439 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.
5499 5500 5501 5502 |
# File 'lib/aws-sdk-glue/client.rb', line 5499 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.
5542 5543 5544 5545 |
# File 'lib/aws-sdk-glue/client.rb', line 5542 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.
5601 5602 5603 5604 |
# File 'lib/aws-sdk-glue/client.rb', line 5601 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_blueprint(params = {}) ⇒ Types::DeleteBlueprintResponse
Deletes an existing blueprint.
5629 5630 5631 5632 |
# File 'lib/aws-sdk-glue/client.rb', line 5629 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.
5664 5665 5666 5667 |
# File 'lib/aws-sdk-glue/client.rb', line 5664 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.
5686 5687 5688 5689 |
# File 'lib/aws-sdk-glue/client.rb', line 5686 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`.
5729 5730 5731 5732 |
# File 'lib/aws-sdk-glue/client.rb', line 5729 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`.
5768 5769 5770 5771 |
# File 'lib/aws-sdk-glue/client.rb', line 5768 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.
5794 5795 5796 5797 |
# File 'lib/aws-sdk-glue/client.rb', line 5794 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.
5821 5822 5823 5824 |
# File 'lib/aws-sdk-glue/client.rb', line 5821 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`.
5844 5845 5846 5847 |
# File 'lib/aws-sdk-glue/client.rb', line 5844 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.
5872 5873 5874 5875 |
# File 'lib/aws-sdk-glue/client.rb', line 5872 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.
5894 5895 5896 5897 |
# File 'lib/aws-sdk-glue/client.rb', line 5894 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>
5937 5938 5939 5940 |
# File 'lib/aws-sdk-glue/client.rb', line 5937 def delete_database(params = {}, = {}) req = build_request(:delete_database, params) req.send_request() end |
#delete_dev_endpoint(params = {}) ⇒ Struct
Deletes a specified development endpoint.
5959 5960 5961 5962 |
# File 'lib/aws-sdk-glue/client.rb', line 5959 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.
6014 6015 6016 6017 |
# File 'lib/aws-sdk-glue/client.rb', line 6014 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.
6041 6042 6043 6044 |
# File 'lib/aws-sdk-glue/client.rb', line 6041 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.
6070 6071 6072 6073 |
# File 'lib/aws-sdk-glue/client.rb', line 6070 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.
6104 6105 6106 6107 |
# File 'lib/aws-sdk-glue/client.rb', line 6104 def delete_ml_transform(params = {}, = {}) req = build_request(:delete_ml_transform, params) req.send_request() end |
#delete_partition(params = {}) ⇒ Struct
Deletes a specified partition.
6141 6142 6143 6144 |
# File 'lib/aws-sdk-glue/client.rb', line 6141 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.
6177 6178 6179 6180 |
# File 'lib/aws-sdk-glue/client.rb', line 6177 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.
6218 6219 6220 6221 |
# File 'lib/aws-sdk-glue/client.rb', line 6218 def delete_registry(params = {}, = {}) req = build_request(:delete_registry, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a specified policy.
6244 6245 6246 6247 |
# File 'lib/aws-sdk-glue/client.rb', line 6244 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.
6285 6286 6287 6288 |
# File 'lib/aws-sdk-glue/client.rb', line 6285 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.
6347 6348 6349 6350 |
# File 'lib/aws-sdk-glue/client.rb', line 6347 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.
6369 6370 6371 6372 |
# File 'lib/aws-sdk-glue/client.rb', line 6369 def delete_security_configuration(params = {}, = {}) req = build_request(:delete_security_configuration, params) req.send_request() end |
#delete_session(params = {}) ⇒ Types::DeleteSessionResponse
Deletes the session.
6401 6402 6403 6404 |
# File 'lib/aws-sdk-glue/client.rb', line 6401 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>
6451 6452 6453 6454 |
# File 'lib/aws-sdk-glue/client.rb', line 6451 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.
6486 6487 6488 6489 |
# File 'lib/aws-sdk-glue/client.rb', line 6486 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.
6524 6525 6526 6527 |
# File 'lib/aws-sdk-glue/client.rb', line 6524 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.
6553 6554 6555 6556 |
# File 'lib/aws-sdk-glue/client.rb', line 6553 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.
6575 6576 6577 6578 |
# File 'lib/aws-sdk-glue/client.rb', line 6575 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.
6607 6608 6609 6610 |
# File 'lib/aws-sdk-glue/client.rb', line 6607 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.
6635 6636 6637 6638 |
# File 'lib/aws-sdk-glue/client.rb', line 6635 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.
6836 6837 6838 6839 |
# File 'lib/aws-sdk-glue/client.rb', line 6836 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.
6913 6914 6915 6916 |
# File 'lib/aws-sdk-glue/client.rb', line 6913 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.
6966 6967 6968 6969 |
# File 'lib/aws-sdk-glue/client.rb', line 6966 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.
7034 7035 7036 7037 |
# File 'lib/aws-sdk-glue/client.rb', line 7034 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.
7083 7084 7085 7086 |
# File 'lib/aws-sdk-glue/client.rb', line 7083 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.
7124 7125 7126 7127 |
# File 'lib/aws-sdk-glue/client.rb', line 7124 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.
7174 7175 7176 7177 |
# File 'lib/aws-sdk-glue/client.rb', line 7174 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.
7232 7233 7234 7235 |
# File 'lib/aws-sdk-glue/client.rb', line 7232 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.
7263 7264 7265 7266 |
# File 'lib/aws-sdk-glue/client.rb', line 7263 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.
7352 7353 7354 7355 |
# File 'lib/aws-sdk-glue/client.rb', line 7352 def get_catalogs(params = {}, = {}) req = build_request(:get_catalogs, params) req.send_request() end |
#get_classifier(params = {}) ⇒ Types::GetClassifierResponse
Retrieve a classifier by name.
7412 7413 7414 7415 |
# File 'lib/aws-sdk-glue/client.rb', line 7412 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.
7481 7482 7483 7484 |
# File 'lib/aws-sdk-glue/client.rb', line 7481 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`.
7567 7568 7569 7570 |
# File 'lib/aws-sdk-glue/client.rb', line 7567 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`.
7649 7650 7651 7652 |
# File 'lib/aws-sdk-glue/client.rb', line 7649 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.
7697 7698 7699 7700 |
# File 'lib/aws-sdk-glue/client.rb', line 7697 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.
7762 7763 7764 7765 |
# File 'lib/aws-sdk-glue/client.rb', line 7762 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.
7809 7810 7811 7812 |
# File 'lib/aws-sdk-glue/client.rb', line 7809 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.
7889 7890 7891 7892 |
# File 'lib/aws-sdk-glue/client.rb', line 7889 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.
7981 7982 7983 7984 |
# File 'lib/aws-sdk-glue/client.rb', line 7981 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.
8086 8087 8088 8089 |
# File 'lib/aws-sdk-glue/client.rb', line 8086 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.
8134 8135 8136 8137 |
# File 'lib/aws-sdk-glue/client.rb', line 8134 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.
8248 8249 8250 8251 |
# File 'lib/aws-sdk-glue/client.rb', line 8248 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.
8281 8282 8283 8284 |
# File 'lib/aws-sdk-glue/client.rb', line 8281 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.
8315 8316 8317 8318 |
# File 'lib/aws-sdk-glue/client.rb', line 8315 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).
8354 8355 8356 8357 |
# File 'lib/aws-sdk-glue/client.rb', line 8354 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.
8394 8395 8396 8397 |
# File 'lib/aws-sdk-glue/client.rb', line 8394 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.
8474 8475 8476 8477 |
# File 'lib/aws-sdk-glue/client.rb', line 8474 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.
8533 8534 8535 8536 |
# File 'lib/aws-sdk-glue/client.rb', line 8533 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.
8577 8578 8579 8580 |
# File 'lib/aws-sdk-glue/client.rb', line 8577 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.
8649 8650 8651 8652 |
# File 'lib/aws-sdk-glue/client.rb', line 8649 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.
8698 8699 8700 8701 |
# File 'lib/aws-sdk-glue/client.rb', line 8698 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.
8776 8777 8778 8779 |
# File 'lib/aws-sdk-glue/client.rb', line 8776 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).
8816 8817 8818 8819 |
# File 'lib/aws-sdk-glue/client.rb', line 8816 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>
8878 8879 8880 8881 |
# File 'lib/aws-sdk-glue/client.rb', line 8878 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.
8950 8951 8952 8953 |
# File 'lib/aws-sdk-glue/client.rb', line 8950 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.
9031 9032 9033 9034 |
# File 'lib/aws-sdk-glue/client.rb', line 9031 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)
9067 9068 9069 9070 |
# File 'lib/aws-sdk-glue/client.rb', line 9067 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.
9116 9117 9118 9119 |
# File 'lib/aws-sdk-glue/client.rb', line 9116 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.
10092 10093 10094 10095 |
# File 'lib/aws-sdk-glue/client.rb', line 10092 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
10144 10145 10146 10147 |
# File 'lib/aws-sdk-glue/client.rb', line 10144 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.
10212 10213 10214 10215 |
# File 'lib/aws-sdk-glue/client.rb', line 10212 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.
10287 10288 10289 10290 |
# File 'lib/aws-sdk-glue/client.rb', line 10287 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.
11272 11273 11274 11275 |
# File 'lib/aws-sdk-glue/client.rb', line 11272 def get_jobs(params = {}, = {}) req = build_request(:get_jobs, params) req.send_request() end |
#get_mapping(params = {}) ⇒ Types::GetMappingResponse
Creates mappings.
11693 11694 11695 11696 |
# File 'lib/aws-sdk-glue/client.rb', line 11693 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`.
11333 11334 11335 11336 |
# File 'lib/aws-sdk-glue/client.rb', line 11333 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.
11415 11416 11417 11418 |
# File 'lib/aws-sdk-glue/client.rb', line 11415 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`.
11510 11511 11512 11513 |
# File 'lib/aws-sdk-glue/client.rb', line 11510 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.
11621 11622 11623 11624 |
# File 'lib/aws-sdk-glue/client.rb', line 11621 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.
11780 11781 11782 11783 |
# File 'lib/aws-sdk-glue/client.rb', line 11780 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.
11836 11837 11838 11839 |
# File 'lib/aws-sdk-glue/client.rb', line 11836 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.
12051 12052 12053 12054 |
# File 'lib/aws-sdk-glue/client.rb', line 12051 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.
12150 12151 12152 12153 |
# File 'lib/aws-sdk-glue/client.rb', line 12150 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.
12192 12193 12194 12195 |
# File 'lib/aws-sdk-glue/client.rb', line 12192 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.
12238 12239 12240 12241 |
# File 'lib/aws-sdk-glue/client.rb', line 12238 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.
12279 12280 12281 12282 |
# File 'lib/aws-sdk-glue/client.rb', line 12279 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.
12343 12344 12345 12346 |
# File 'lib/aws-sdk-glue/client.rb', line 12343 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.
12399 12400 12401 12402 |
# File 'lib/aws-sdk-glue/client.rb', line 12399 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.
12466 12467 12468 12469 |
# File 'lib/aws-sdk-glue/client.rb', line 12466 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.
12527 12528 12529 12530 |
# File 'lib/aws-sdk-glue/client.rb', line 12527 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.
12565 12566 12567 12568 |
# File 'lib/aws-sdk-glue/client.rb', line 12565 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.
12612 12613 12614 12615 |
# File 'lib/aws-sdk-glue/client.rb', line 12612 def get_security_configurations(params = {}, = {}) req = build_request(:get_security_configurations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves the session.
12666 12667 12668 12669 |
# File 'lib/aws-sdk-glue/client.rb', line 12666 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_statement(params = {}) ⇒ Types::GetStatementResponse
Retrieves the statement.
12714 12715 12716 12717 |
# File 'lib/aws-sdk-glue/client.rb', line 12714 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.
12864 12865 12866 12867 |
# File 'lib/aws-sdk-glue/client.rb', line 12864 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.
12942 12943 12944 12945 |
# File 'lib/aws-sdk-glue/client.rb', line 12942 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.
13082 13083 13084 13085 |
# File 'lib/aws-sdk-glue/client.rb', line 13082 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.
13231 13232 13233 13234 |
# File 'lib/aws-sdk-glue/client.rb', line 13231 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.
13406 13407 13408 13409 |
# File 'lib/aws-sdk-glue/client.rb', line 13406 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.
13436 13437 13438 13439 |
# File 'lib/aws-sdk-glue/client.rb', line 13436 def (params = {}, = {}) req = build_request(:get_tags, params) req.send_request() end |
#get_trigger(params = {}) ⇒ Types::GetTriggerResponse
Retrieves the definition of a trigger.
13487 13488 13489 13490 |
# File 'lib/aws-sdk-glue/client.rb', line 13487 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.
13553 13554 13555 13556 |
# File 'lib/aws-sdk-glue/client.rb', line 13553 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`.
13680 13681 13682 13683 |
# File 'lib/aws-sdk-glue/client.rb', line 13680 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.
13910 13911 13912 13913 |
# File 'lib/aws-sdk-glue/client.rb', line 13910 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`.
14154 14155 14156 14157 |
# File 'lib/aws-sdk-glue/client.rb', line 14154 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.
14201 14202 14203 14204 |
# File 'lib/aws-sdk-glue/client.rb', line 14201 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.
14248 14249 14250 14251 |
# File 'lib/aws-sdk-glue/client.rb', line 14248 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.
14311 14312 14313 14314 |
# File 'lib/aws-sdk-glue/client.rb', line 14311 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.
14513 14514 14515 14516 |
# File 'lib/aws-sdk-glue/client.rb', line 14513 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.
14639 14640 14641 14642 |
# File 'lib/aws-sdk-glue/client.rb', line 14639 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.
14672 14673 14674 14675 |
# File 'lib/aws-sdk-glue/client.rb', line 14672 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.
14806 14807 14808 14809 |
# File 'lib/aws-sdk-glue/client.rb', line 14806 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.
14829 14830 14831 14832 |
# File 'lib/aws-sdk-glue/client.rb', line 14829 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.
14872 14873 14874 14875 |
# File 'lib/aws-sdk-glue/client.rb', line 14872 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.
14909 14910 14911 14912 |
# File 'lib/aws-sdk-glue/client.rb', line 14909 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.
14957 14958 14959 14960 |
# File 'lib/aws-sdk-glue/client.rb', line 14957 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.
15008 15009 15010 15011 |
# File 'lib/aws-sdk-glue/client.rb', line 15008 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.
15084 15085 15086 15087 |
# File 'lib/aws-sdk-glue/client.rb', line 15084 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.
15130 15131 15132 15133 |
# File 'lib/aws-sdk-glue/client.rb', line 15130 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.
15196 15197 15198 15199 |
# File 'lib/aws-sdk-glue/client.rb', line 15196 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.
15259 15260 15261 15262 |
# File 'lib/aws-sdk-glue/client.rb', line 15259 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.
15323 15324 15325 15326 |
# File 'lib/aws-sdk-glue/client.rb', line 15323 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.
15391 15392 15393 15394 |
# File 'lib/aws-sdk-glue/client.rb', line 15391 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.
15445 15446 15447 15448 |
# File 'lib/aws-sdk-glue/client.rb', line 15445 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.
15510 15511 15512 15513 |
# File 'lib/aws-sdk-glue/client.rb', line 15510 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.
15561 15562 15563 15564 |
# File 'lib/aws-sdk-glue/client.rb', line 15561 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.
15621 15622 15623 15624 |
# File 'lib/aws-sdk-glue/client.rb', line 15621 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.
15672 15673 15674 15675 |
# File 'lib/aws-sdk-glue/client.rb', line 15672 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.
15748 15749 15750 15751 |
# File 'lib/aws-sdk-glue/client.rb', line 15748 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.
15794 15795 15796 15797 |
# File 'lib/aws-sdk-glue/client.rb', line 15794 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.
15855 15856 15857 15858 |
# File 'lib/aws-sdk-glue/client.rb', line 15855 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.
15912 15913 15914 15915 |
# File 'lib/aws-sdk-glue/client.rb', line 15912 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.
15985 15986 15987 15988 |
# File 'lib/aws-sdk-glue/client.rb', line 15985 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
Lists statements for the session.
16036 16037 16038 16039 |
# File 'lib/aws-sdk-glue/client.rb', line 16036 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.
16117 16118 16119 16120 |
# File 'lib/aws-sdk-glue/client.rb', line 16117 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.
16174 16175 16176 16177 |
# File 'lib/aws-sdk-glue/client.rb', line 16174 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.
16214 16215 16216 16217 |
# File 'lib/aws-sdk-glue/client.rb', line 16214 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.
16251 16252 16253 16254 |
# File 'lib/aws-sdk-glue/client.rb', line 16251 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.
16318 16319 16320 16321 |
# File 'lib/aws-sdk-glue/client.rb', line 16318 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.
16358 16359 16360 16361 |
# File 'lib/aws-sdk-glue/client.rb', line 16358 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.
16384 16385 16386 16387 |
# File 'lib/aws-sdk-glue/client.rb', line 16384 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.
16444 16445 16446 16447 |
# File 'lib/aws-sdk-glue/client.rb', line 16444 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.
16510 16511 16512 16513 |
# File 'lib/aws-sdk-glue/client.rb', line 16510 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.
16550 16551 16552 16553 |
# File 'lib/aws-sdk-glue/client.rb', line 16550 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.
16622 16623 16624 16625 |
# File 'lib/aws-sdk-glue/client.rb', line 16622 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.
16686 16687 16688 16689 |
# File 'lib/aws-sdk-glue/client.rb', line 16686 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.
16752 16753 16754 16755 |
# File 'lib/aws-sdk-glue/client.rb', line 16752 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
16804 16805 16806 16807 |
# File 'lib/aws-sdk-glue/client.rb', line 16804 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.
16846 16847 16848 16849 |
# File 'lib/aws-sdk-glue/client.rb', line 16846 def resume_workflow_run(params = {}, = {}) req = build_request(:resume_workflow_run, params) req.send_request() end |
#run_statement(params = {}) ⇒ Types::RunStatementResponse
Executes the statement.
16882 16883 16884 16885 |
# File 'lib/aws-sdk-glue/client.rb', line 16882 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.
17083 17084 17085 17086 |
# File 'lib/aws-sdk-glue/client.rb', line 17083 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.
17119 17120 17121 17122 |
# File 'lib/aws-sdk-glue/client.rb', line 17119 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.
17176 17177 17178 17179 |
# File 'lib/aws-sdk-glue/client.rb', line 17176 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.
17203 17204 17205 17206 |
# File 'lib/aws-sdk-glue/client.rb', line 17203 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].
17231 17232 17233 17234 |
# File 'lib/aws-sdk-glue/client.rb', line 17231 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`.
17255 17256 17257 17258 |
# File 'lib/aws-sdk-glue/client.rb', line 17255 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.
17328 17329 17330 17331 |
# File 'lib/aws-sdk-glue/client.rb', line 17328 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.
17418 17419 17420 17421 |
# File 'lib/aws-sdk-glue/client.rb', line 17418 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.
17459 17460 17461 17462 |
# File 'lib/aws-sdk-glue/client.rb', line 17459 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.
17525 17526 17527 17528 |
# File 'lib/aws-sdk-glue/client.rb', line 17525 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.
17739 17740 17741 17742 |
# File 'lib/aws-sdk-glue/client.rb', line 17739 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`.
17774 17775 17776 17777 |
# File 'lib/aws-sdk-glue/client.rb', line 17774 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.
17823 17824 17825 17826 |
# File 'lib/aws-sdk-glue/client.rb', line 17823 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.
17856 17857 17858 17859 |
# File 'lib/aws-sdk-glue/client.rb', line 17856 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.
17895 17896 17897 17898 |
# File 'lib/aws-sdk-glue/client.rb', line 17895 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.
17921 17922 17923 17924 |
# File 'lib/aws-sdk-glue/client.rb', line 17921 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.
17948 17949 17950 17951 |
# File 'lib/aws-sdk-glue/client.rb', line 17948 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.
17970 17971 17972 17973 |
# File 'lib/aws-sdk-glue/client.rb', line 17970 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.
17993 17994 17995 17996 |
# File 'lib/aws-sdk-glue/client.rb', line 17993 def stop_crawler_schedule(params = {}, = {}) req = build_request(:stop_crawler_schedule, params) req.send_request() end |
#stop_session(params = {}) ⇒ Types::StopSessionResponse
Stops the session.
18025 18026 18027 18028 |
# File 'lib/aws-sdk-glue/client.rb', line 18025 def stop_session(params = {}, = {}) req = build_request(:stop_session, params) req.send_request() end |
#stop_trigger(params = {}) ⇒ Types::StopTriggerResponse
Stops a specified trigger.
18053 18054 18055 18056 |
# File 'lib/aws-sdk-glue/client.rb', line 18053 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.
18079 18080 18081 18082 |
# File 'lib/aws-sdk-glue/client.rb', line 18079 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].
18120 18121 18122 18123 |
# File 'lib/aws-sdk-glue/client.rb', line 18120 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.
18198 18199 18200 18201 |
# File 'lib/aws-sdk-glue/client.rb', line 18198 def test_connection(params = {}, = {}) req = build_request(:test_connection, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
18225 18226 18227 18228 |
# File 'lib/aws-sdk-glue/client.rb', line 18225 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates a registered blueprint.
18261 18262 18263 18264 |
# File 'lib/aws-sdk-glue/client.rb', line 18261 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.
18328 18329 18330 18331 |
# File 'lib/aws-sdk-glue/client.rb', line 18328 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).
18387 18388 18389 18390 |
# File 'lib/aws-sdk-glue/client.rb', line 18387 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`.
18525 18526 18527 18528 |
# File 'lib/aws-sdk-glue/client.rb', line 18525 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`.
18659 18660 18661 18662 |
# File 'lib/aws-sdk-glue/client.rb', line 18659 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.
18711 18712 18713 18714 |
# File 'lib/aws-sdk-glue/client.rb', line 18711 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.
18799 18800 18801 18802 |
# File 'lib/aws-sdk-glue/client.rb', line 18799 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.
18969 18970 18971 18972 |
# File 'lib/aws-sdk-glue/client.rb', line 18969 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.
19002 19003 19004 19005 |
# File 'lib/aws-sdk-glue/client.rb', line 19002 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.
19043 19044 19045 19046 |
# File 'lib/aws-sdk-glue/client.rb', line 19043 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.
19101 19102 19103 19104 |
# File 'lib/aws-sdk-glue/client.rb', line 19101 def update_database(params = {}, = {}) req = build_request(:update_database, params) req.send_request() end |
#update_dev_endpoint(params = {}) ⇒ Struct
Updates a specified development endpoint.
19170 19171 19172 19173 |
# File 'lib/aws-sdk-glue/client.rb', line 19170 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.
19225 19226 19227 19228 |
# File 'lib/aws-sdk-glue/client.rb', line 19225 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.
19282 19283 19284 19285 |
# File 'lib/aws-sdk-glue/client.rb', line 19282 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.
19309 19310 19311 19312 |
# File 'lib/aws-sdk-glue/client.rb', line 19309 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.
19380 19381 19382 19383 |
# File 'lib/aws-sdk-glue/client.rb', line 19380 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).
19498 19499 19500 19501 |
# File 'lib/aws-sdk-glue/client.rb', line 19498 def update_ml_transform(params = {}, = {}) req = build_request(:update_ml_transform, params) req.send_request() end |
#update_partition(params = {}) ⇒ Struct
Updates a partition.
19602 19603 19604 19605 |
# File 'lib/aws-sdk-glue/client.rb', line 19602 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.
19643 19644 19645 19646 |
# File 'lib/aws-sdk-glue/client.rb', line 19643 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.
19715 19716 19717 19718 |
# File 'lib/aws-sdk-glue/client.rb', line 19715 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.
19786 19787 19788 19789 |
# File 'lib/aws-sdk-glue/client.rb', line 19786 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.
19937 19938 19939 19940 |
# File 'lib/aws-sdk-glue/client.rb', line 19937 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.
19995 19996 19997 19998 |
# File 'lib/aws-sdk-glue/client.rb', line 19995 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.
20089 20090 20091 20092 |
# File 'lib/aws-sdk-glue/client.rb', line 20089 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.
20143 20144 20145 20146 |
# File 'lib/aws-sdk-glue/client.rb', line 20143 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.
20192 20193 20194 20195 |
# File 'lib/aws-sdk-glue/client.rb', line 20192 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.
20244 20245 20246 20247 |
# File 'lib/aws-sdk-glue/client.rb', line 20244 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.
20273 20274 20275 |
# File 'lib/aws-sdk-glue/client.rb', line 20273 def waiter_names [] end |