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.
474 475 476 |
# File 'lib/aws-sdk-glue/client.rb', line 474 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.
20101 20102 20103 |
# File 'lib/aws-sdk-glue/client.rb', line 20101 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.
20104 20105 20106 |
# File 'lib/aws-sdk-glue/client.rb', line 20104 def errors_module Errors end |
Instance Method Details
#batch_create_partition(params = {}) ⇒ Types::BatchCreatePartitionResponse
Creates one or more partitions in a batch operation.
584 585 586 587 |
# File 'lib/aws-sdk-glue/client.rb', line 584 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.
622 623 624 625 |
# File 'lib/aws-sdk-glue/client.rb', line 622 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.
674 675 676 677 |
# File 'lib/aws-sdk-glue/client.rb', line 674 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>
732 733 734 735 |
# File 'lib/aws-sdk-glue/client.rb', line 732 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.
780 781 782 783 |
# File 'lib/aws-sdk-glue/client.rb', line 780 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.
834 835 836 837 |
# File 'lib/aws-sdk-glue/client.rb', line 834 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.
948 949 950 951 |
# File 'lib/aws-sdk-glue/client.rb', line 948 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.
984 985 986 987 |
# File 'lib/aws-sdk-glue/client.rb', line 984 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.
1055 1056 1057 1058 |
# File 'lib/aws-sdk-glue/client.rb', line 1055 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.
1119 1120 1121 1122 |
# File 'lib/aws-sdk-glue/client.rb', line 1119 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.
2051 2052 2053 2054 |
# File 'lib/aws-sdk-glue/client.rb', line 2051 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.
2147 2148 2149 2150 |
# File 'lib/aws-sdk-glue/client.rb', line 2147 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.
2223 2224 2225 2226 |
# File 'lib/aws-sdk-glue/client.rb', line 2223 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.
2283 2284 2285 2286 |
# File 'lib/aws-sdk-glue/client.rb', line 2283 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.
2494 2495 2496 2497 |
# File 'lib/aws-sdk-glue/client.rb', line 2494 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.
2535 2536 2537 2538 |
# File 'lib/aws-sdk-glue/client.rb', line 2535 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.
2576 2577 2578 2579 |
# File 'lib/aws-sdk-glue/client.rb', line 2576 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.
2688 2689 2690 2691 |
# File 'lib/aws-sdk-glue/client.rb', line 2688 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.
20074 20075 20076 20077 20078 20079 20080 20081 20082 20083 20084 20085 20086 20087 20088 20089 20090 |
# File 'lib/aws-sdk-glue/client.rb', line 20074 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.211.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.
2711 2712 2713 2714 |
# File 'lib/aws-sdk-glue/client.rb', line 2711 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.
2734 2735 2736 2737 |
# File 'lib/aws-sdk-glue/client.rb', line 2734 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`.
2774 2775 2776 2777 |
# File 'lib/aws-sdk-glue/client.rb', line 2774 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.
2804 2805 2806 2807 |
# File 'lib/aws-sdk-glue/client.rb', line 2804 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.
2842 2843 2844 2845 |
# File 'lib/aws-sdk-glue/client.rb', line 2842 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.
2884 2885 2886 2887 |
# File 'lib/aws-sdk-glue/client.rb', line 2884 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.
2959 2960 2961 2962 |
# File 'lib/aws-sdk-glue/client.rb', line 2959 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.
3018 3019 3020 3021 |
# File 'lib/aws-sdk-glue/client.rb', line 3018 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.
3076 3077 3078 3079 |
# File 'lib/aws-sdk-glue/client.rb', line 3076 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.
3175 3176 3177 3178 |
# File 'lib/aws-sdk-glue/client.rb', line 3175 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.
3359 3360 3361 3362 |
# File 'lib/aws-sdk-glue/client.rb', line 3359 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.
3413 3414 3415 3416 |
# File 'lib/aws-sdk-glue/client.rb', line 3413 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.
3479 3480 3481 3482 |
# File 'lib/aws-sdk-glue/client.rb', line 3479 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.
3536 3537 3538 3539 |
# File 'lib/aws-sdk-glue/client.rb', line 3536 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.
3735 3736 3737 3738 |
# File 'lib/aws-sdk-glue/client.rb', line 3735 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`.
3830 3831 3832 3833 |
# File 'lib/aws-sdk-glue/client.rb', line 3830 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.
3886 3887 3888 3889 |
# File 'lib/aws-sdk-glue/client.rb', line 3886 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.
3940 3941 3942 3943 |
# File 'lib/aws-sdk-glue/client.rb', line 3940 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.
4223 4224 4225 4226 |
# File 'lib/aws-sdk-glue/client.rb', line 4223 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
4435 4436 4437 4438 |
# File 'lib/aws-sdk-glue/client.rb', line 4435 def create_ml_transform(params = {}, = {}) req = build_request(:create_ml_transform, params) req.send_request() end |
#create_partition(params = {}) ⇒ Struct
Creates a new partition.
4531 4532 4533 4534 |
# File 'lib/aws-sdk-glue/client.rb', line 4531 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.
4571 4572 4573 4574 |
# File 'lib/aws-sdk-glue/client.rb', line 4571 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.
4621 4622 4623 4624 |
# File 'lib/aws-sdk-glue/client.rb', line 4621 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.
4769 4770 4771 4772 |
# File 'lib/aws-sdk-glue/client.rb', line 4769 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.
4826 4827 4828 4829 |
# File 'lib/aws-sdk-glue/client.rb', line 4826 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
4887 4888 4889 4890 |
# File 'lib/aws-sdk-glue/client.rb', line 4887 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.
5048 5049 5050 5051 |
# File 'lib/aws-sdk-glue/client.rb', line 5048 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.
5200 5201 5202 5203 |
# File 'lib/aws-sdk-glue/client.rb', line 5200 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.
5258 5259 5260 5261 |
# File 'lib/aws-sdk-glue/client.rb', line 5258 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.
5374 5375 5376 5377 |
# File 'lib/aws-sdk-glue/client.rb', line 5374 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.
5434 5435 5436 5437 |
# File 'lib/aws-sdk-glue/client.rb', line 5434 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.
5477 5478 5479 5480 |
# File 'lib/aws-sdk-glue/client.rb', line 5477 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.
5536 5537 5538 5539 |
# File 'lib/aws-sdk-glue/client.rb', line 5536 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_blueprint(params = {}) ⇒ Types::DeleteBlueprintResponse
Deletes an existing blueprint.
5564 5565 5566 5567 |
# File 'lib/aws-sdk-glue/client.rb', line 5564 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.
5599 5600 5601 5602 |
# File 'lib/aws-sdk-glue/client.rb', line 5599 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.
5621 5622 5623 5624 |
# File 'lib/aws-sdk-glue/client.rb', line 5621 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`.
5664 5665 5666 5667 |
# File 'lib/aws-sdk-glue/client.rb', line 5664 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`.
5703 5704 5705 5706 |
# File 'lib/aws-sdk-glue/client.rb', line 5703 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.
5729 5730 5731 5732 |
# File 'lib/aws-sdk-glue/client.rb', line 5729 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.
5756 5757 5758 5759 |
# File 'lib/aws-sdk-glue/client.rb', line 5756 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`.
5779 5780 5781 5782 |
# File 'lib/aws-sdk-glue/client.rb', line 5779 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.
5807 5808 5809 5810 |
# File 'lib/aws-sdk-glue/client.rb', line 5807 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.
5829 5830 5831 5832 |
# File 'lib/aws-sdk-glue/client.rb', line 5829 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>
5872 5873 5874 5875 |
# File 'lib/aws-sdk-glue/client.rb', line 5872 def delete_database(params = {}, = {}) req = build_request(:delete_database, params) req.send_request() end |
#delete_dev_endpoint(params = {}) ⇒ Struct
Deletes a specified development endpoint.
5894 5895 5896 5897 |
# File 'lib/aws-sdk-glue/client.rb', line 5894 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.
5949 5950 5951 5952 |
# File 'lib/aws-sdk-glue/client.rb', line 5949 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.
5976 5977 5978 5979 |
# File 'lib/aws-sdk-glue/client.rb', line 5976 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.
6005 6006 6007 6008 |
# File 'lib/aws-sdk-glue/client.rb', line 6005 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.
6039 6040 6041 6042 |
# File 'lib/aws-sdk-glue/client.rb', line 6039 def delete_ml_transform(params = {}, = {}) req = build_request(:delete_ml_transform, params) req.send_request() end |
#delete_partition(params = {}) ⇒ Struct
Deletes a specified partition.
6076 6077 6078 6079 |
# File 'lib/aws-sdk-glue/client.rb', line 6076 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.
6112 6113 6114 6115 |
# File 'lib/aws-sdk-glue/client.rb', line 6112 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.
6153 6154 6155 6156 |
# File 'lib/aws-sdk-glue/client.rb', line 6153 def delete_registry(params = {}, = {}) req = build_request(:delete_registry, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a specified policy.
6179 6180 6181 6182 |
# File 'lib/aws-sdk-glue/client.rb', line 6179 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.
6220 6221 6222 6223 |
# File 'lib/aws-sdk-glue/client.rb', line 6220 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.
6282 6283 6284 6285 |
# File 'lib/aws-sdk-glue/client.rb', line 6282 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.
6304 6305 6306 6307 |
# File 'lib/aws-sdk-glue/client.rb', line 6304 def delete_security_configuration(params = {}, = {}) req = build_request(:delete_security_configuration, params) req.send_request() end |
#delete_session(params = {}) ⇒ Types::DeleteSessionResponse
Deletes the session.
6336 6337 6338 6339 |
# File 'lib/aws-sdk-glue/client.rb', line 6336 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>
6386 6387 6388 6389 |
# File 'lib/aws-sdk-glue/client.rb', line 6386 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.
6421 6422 6423 6424 |
# File 'lib/aws-sdk-glue/client.rb', line 6421 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.
6459 6460 6461 6462 |
# File 'lib/aws-sdk-glue/client.rb', line 6459 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.
6488 6489 6490 6491 |
# File 'lib/aws-sdk-glue/client.rb', line 6488 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.
6510 6511 6512 6513 |
# File 'lib/aws-sdk-glue/client.rb', line 6510 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.
6542 6543 6544 6545 |
# File 'lib/aws-sdk-glue/client.rb', line 6542 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.
6570 6571 6572 6573 |
# File 'lib/aws-sdk-glue/client.rb', line 6570 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.
6771 6772 6773 6774 |
# File 'lib/aws-sdk-glue/client.rb', line 6771 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.
6848 6849 6850 6851 |
# File 'lib/aws-sdk-glue/client.rb', line 6848 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.
6900 6901 6902 6903 |
# File 'lib/aws-sdk-glue/client.rb', line 6900 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.
6967 6968 6969 6970 |
# File 'lib/aws-sdk-glue/client.rb', line 6967 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.
7016 7017 7018 7019 |
# File 'lib/aws-sdk-glue/client.rb', line 7016 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.
7057 7058 7059 7060 |
# File 'lib/aws-sdk-glue/client.rb', line 7057 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.
7107 7108 7109 7110 |
# File 'lib/aws-sdk-glue/client.rb', line 7107 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.
7165 7166 7167 7168 |
# File 'lib/aws-sdk-glue/client.rb', line 7165 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.
7196 7197 7198 7199 |
# File 'lib/aws-sdk-glue/client.rb', line 7196 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.
7285 7286 7287 7288 |
# File 'lib/aws-sdk-glue/client.rb', line 7285 def get_catalogs(params = {}, = {}) req = build_request(:get_catalogs, params) req.send_request() end |
#get_classifier(params = {}) ⇒ Types::GetClassifierResponse
Retrieve a classifier by name.
7345 7346 7347 7348 |
# File 'lib/aws-sdk-glue/client.rb', line 7345 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.
7414 7415 7416 7417 |
# File 'lib/aws-sdk-glue/client.rb', line 7414 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`.
7500 7501 7502 7503 |
# File 'lib/aws-sdk-glue/client.rb', line 7500 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`.
7582 7583 7584 7585 |
# File 'lib/aws-sdk-glue/client.rb', line 7582 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.
7630 7631 7632 7633 |
# File 'lib/aws-sdk-glue/client.rb', line 7630 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.
7695 7696 7697 7698 |
# File 'lib/aws-sdk-glue/client.rb', line 7695 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.
7742 7743 7744 7745 |
# File 'lib/aws-sdk-glue/client.rb', line 7742 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.
7822 7823 7824 7825 |
# File 'lib/aws-sdk-glue/client.rb', line 7822 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.
7914 7915 7916 7917 |
# File 'lib/aws-sdk-glue/client.rb', line 7914 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.
8019 8020 8021 8022 |
# File 'lib/aws-sdk-glue/client.rb', line 8019 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.
8067 8068 8069 8070 |
# File 'lib/aws-sdk-glue/client.rb', line 8067 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.
8181 8182 8183 8184 |
# File 'lib/aws-sdk-glue/client.rb', line 8181 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.
8214 8215 8216 8217 |
# File 'lib/aws-sdk-glue/client.rb', line 8214 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.
8248 8249 8250 8251 |
# File 'lib/aws-sdk-glue/client.rb', line 8248 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).
8287 8288 8289 8290 |
# File 'lib/aws-sdk-glue/client.rb', line 8287 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.
8327 8328 8329 8330 |
# File 'lib/aws-sdk-glue/client.rb', line 8327 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.
8407 8408 8409 8410 |
# File 'lib/aws-sdk-glue/client.rb', line 8407 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.
8466 8467 8468 8469 |
# File 'lib/aws-sdk-glue/client.rb', line 8466 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.
8510 8511 8512 8513 |
# File 'lib/aws-sdk-glue/client.rb', line 8510 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.
8582 8583 8584 8585 |
# File 'lib/aws-sdk-glue/client.rb', line 8582 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.
8631 8632 8633 8634 |
# File 'lib/aws-sdk-glue/client.rb', line 8631 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.
8709 8710 8711 8712 |
# File 'lib/aws-sdk-glue/client.rb', line 8709 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).
8749 8750 8751 8752 |
# File 'lib/aws-sdk-glue/client.rb', line 8749 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>
8811 8812 8813 8814 |
# File 'lib/aws-sdk-glue/client.rb', line 8811 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.
8883 8884 8885 8886 |
# File 'lib/aws-sdk-glue/client.rb', line 8883 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.
8964 8965 8966 8967 |
# File 'lib/aws-sdk-glue/client.rb', line 8964 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)
9000 9001 9002 9003 |
# File 'lib/aws-sdk-glue/client.rb', line 9000 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.
9049 9050 9051 9052 |
# File 'lib/aws-sdk-glue/client.rb', line 9049 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.
9972 9973 9974 9975 |
# File 'lib/aws-sdk-glue/client.rb', line 9972 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
10024 10025 10026 10027 |
# File 'lib/aws-sdk-glue/client.rb', line 10024 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.
10092 10093 10094 10095 |
# File 'lib/aws-sdk-glue/client.rb', line 10092 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.
10167 10168 10169 10170 |
# File 'lib/aws-sdk-glue/client.rb', line 10167 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.
11099 11100 11101 11102 |
# File 'lib/aws-sdk-glue/client.rb', line 11099 def get_jobs(params = {}, = {}) req = build_request(:get_jobs, params) req.send_request() end |
#get_mapping(params = {}) ⇒ Types::GetMappingResponse
Creates mappings.
11520 11521 11522 11523 |
# File 'lib/aws-sdk-glue/client.rb', line 11520 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`.
11160 11161 11162 11163 |
# File 'lib/aws-sdk-glue/client.rb', line 11160 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.
11242 11243 11244 11245 |
# File 'lib/aws-sdk-glue/client.rb', line 11242 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`.
11337 11338 11339 11340 |
# File 'lib/aws-sdk-glue/client.rb', line 11337 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.
11448 11449 11450 11451 |
# File 'lib/aws-sdk-glue/client.rb', line 11448 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.
11607 11608 11609 11610 |
# File 'lib/aws-sdk-glue/client.rb', line 11607 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.
11663 11664 11665 11666 |
# File 'lib/aws-sdk-glue/client.rb', line 11663 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.
11878 11879 11880 11881 |
# File 'lib/aws-sdk-glue/client.rb', line 11878 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.
11977 11978 11979 11980 |
# File 'lib/aws-sdk-glue/client.rb', line 11977 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.
12019 12020 12021 12022 |
# File 'lib/aws-sdk-glue/client.rb', line 12019 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.
12065 12066 12067 12068 |
# File 'lib/aws-sdk-glue/client.rb', line 12065 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.
12106 12107 12108 12109 |
# File 'lib/aws-sdk-glue/client.rb', line 12106 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.
12170 12171 12172 12173 |
# File 'lib/aws-sdk-glue/client.rb', line 12170 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.
12226 12227 12228 12229 |
# File 'lib/aws-sdk-glue/client.rb', line 12226 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.
12293 12294 12295 12296 |
# File 'lib/aws-sdk-glue/client.rb', line 12293 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.
12354 12355 12356 12357 |
# File 'lib/aws-sdk-glue/client.rb', line 12354 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.
12392 12393 12394 12395 |
# File 'lib/aws-sdk-glue/client.rb', line 12392 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.
12439 12440 12441 12442 |
# File 'lib/aws-sdk-glue/client.rb', line 12439 def get_security_configurations(params = {}, = {}) req = build_request(:get_security_configurations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves the session.
12493 12494 12495 12496 |
# File 'lib/aws-sdk-glue/client.rb', line 12493 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_statement(params = {}) ⇒ Types::GetStatementResponse
Retrieves the statement.
12541 12542 12543 12544 |
# File 'lib/aws-sdk-glue/client.rb', line 12541 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.
12691 12692 12693 12694 |
# File 'lib/aws-sdk-glue/client.rb', line 12691 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.
12766 12767 12768 12769 |
# File 'lib/aws-sdk-glue/client.rb', line 12766 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.
12906 12907 12908 12909 |
# File 'lib/aws-sdk-glue/client.rb', line 12906 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.
13055 13056 13057 13058 |
# File 'lib/aws-sdk-glue/client.rb', line 13055 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.
13230 13231 13232 13233 |
# File 'lib/aws-sdk-glue/client.rb', line 13230 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.
13260 13261 13262 13263 |
# File 'lib/aws-sdk-glue/client.rb', line 13260 def (params = {}, = {}) req = build_request(:get_tags, params) req.send_request() end |
#get_trigger(params = {}) ⇒ Types::GetTriggerResponse
Retrieves the definition of a trigger.
13311 13312 13313 13314 |
# File 'lib/aws-sdk-glue/client.rb', line 13311 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.
13377 13378 13379 13380 |
# File 'lib/aws-sdk-glue/client.rb', line 13377 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`.
13504 13505 13506 13507 |
# File 'lib/aws-sdk-glue/client.rb', line 13504 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.
13734 13735 13736 13737 |
# File 'lib/aws-sdk-glue/client.rb', line 13734 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`.
13978 13979 13980 13981 |
# File 'lib/aws-sdk-glue/client.rb', line 13978 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.
14025 14026 14027 14028 |
# File 'lib/aws-sdk-glue/client.rb', line 14025 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.
14072 14073 14074 14075 |
# File 'lib/aws-sdk-glue/client.rb', line 14072 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.
14135 14136 14137 14138 |
# File 'lib/aws-sdk-glue/client.rb', line 14135 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.
14337 14338 14339 14340 |
# File 'lib/aws-sdk-glue/client.rb', line 14337 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.
14463 14464 14465 14466 |
# File 'lib/aws-sdk-glue/client.rb', line 14463 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.
14496 14497 14498 14499 |
# File 'lib/aws-sdk-glue/client.rb', line 14496 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.
14630 14631 14632 14633 |
# File 'lib/aws-sdk-glue/client.rb', line 14630 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.
14653 14654 14655 14656 |
# File 'lib/aws-sdk-glue/client.rb', line 14653 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.
14696 14697 14698 14699 |
# File 'lib/aws-sdk-glue/client.rb', line 14696 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.
14733 14734 14735 14736 |
# File 'lib/aws-sdk-glue/client.rb', line 14733 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.
14781 14782 14783 14784 |
# File 'lib/aws-sdk-glue/client.rb', line 14781 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.
14832 14833 14834 14835 |
# File 'lib/aws-sdk-glue/client.rb', line 14832 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.
14908 14909 14910 14911 |
# File 'lib/aws-sdk-glue/client.rb', line 14908 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.
14954 14955 14956 14957 |
# File 'lib/aws-sdk-glue/client.rb', line 14954 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.
15020 15021 15022 15023 |
# File 'lib/aws-sdk-glue/client.rb', line 15020 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.
15083 15084 15085 15086 |
# File 'lib/aws-sdk-glue/client.rb', line 15083 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.
15147 15148 15149 15150 |
# File 'lib/aws-sdk-glue/client.rb', line 15147 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.
15215 15216 15217 15218 |
# File 'lib/aws-sdk-glue/client.rb', line 15215 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.
15269 15270 15271 15272 |
# File 'lib/aws-sdk-glue/client.rb', line 15269 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.
15334 15335 15336 15337 |
# File 'lib/aws-sdk-glue/client.rb', line 15334 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.
15385 15386 15387 15388 |
# File 'lib/aws-sdk-glue/client.rb', line 15385 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.
15445 15446 15447 15448 |
# File 'lib/aws-sdk-glue/client.rb', line 15445 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.
15496 15497 15498 15499 |
# File 'lib/aws-sdk-glue/client.rb', line 15496 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.
15572 15573 15574 15575 |
# File 'lib/aws-sdk-glue/client.rb', line 15572 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.
15618 15619 15620 15621 |
# File 'lib/aws-sdk-glue/client.rb', line 15618 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.
15679 15680 15681 15682 |
# File 'lib/aws-sdk-glue/client.rb', line 15679 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.
15736 15737 15738 15739 |
# File 'lib/aws-sdk-glue/client.rb', line 15736 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.
15809 15810 15811 15812 |
# File 'lib/aws-sdk-glue/client.rb', line 15809 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_statements(params = {}) ⇒ Types::ListStatementsResponse
Lists statements for the session.
15860 15861 15862 15863 |
# File 'lib/aws-sdk-glue/client.rb', line 15860 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.
15938 15939 15940 15941 |
# File 'lib/aws-sdk-glue/client.rb', line 15938 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.
15995 15996 15997 15998 |
# File 'lib/aws-sdk-glue/client.rb', line 15995 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.
16035 16036 16037 16038 |
# File 'lib/aws-sdk-glue/client.rb', line 16035 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.
16072 16073 16074 16075 |
# File 'lib/aws-sdk-glue/client.rb', line 16072 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.
16139 16140 16141 16142 |
# File 'lib/aws-sdk-glue/client.rb', line 16139 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.
16179 16180 16181 16182 |
# File 'lib/aws-sdk-glue/client.rb', line 16179 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.
16205 16206 16207 16208 |
# File 'lib/aws-sdk-glue/client.rb', line 16205 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.
16265 16266 16267 16268 |
# File 'lib/aws-sdk-glue/client.rb', line 16265 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.
16331 16332 16333 16334 |
# File 'lib/aws-sdk-glue/client.rb', line 16331 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.
16371 16372 16373 16374 |
# File 'lib/aws-sdk-glue/client.rb', line 16371 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.
16443 16444 16445 16446 |
# File 'lib/aws-sdk-glue/client.rb', line 16443 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.
16507 16508 16509 16510 |
# File 'lib/aws-sdk-glue/client.rb', line 16507 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.
16573 16574 16575 16576 |
# File 'lib/aws-sdk-glue/client.rb', line 16573 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
16625 16626 16627 16628 |
# File 'lib/aws-sdk-glue/client.rb', line 16625 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.
16667 16668 16669 16670 |
# File 'lib/aws-sdk-glue/client.rb', line 16667 def resume_workflow_run(params = {}, = {}) req = build_request(:resume_workflow_run, params) req.send_request() end |
#run_statement(params = {}) ⇒ Types::RunStatementResponse
Executes the statement.
16703 16704 16705 16706 |
# File 'lib/aws-sdk-glue/client.rb', line 16703 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.
16904 16905 16906 16907 |
# File 'lib/aws-sdk-glue/client.rb', line 16904 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.
16940 16941 16942 16943 |
# File 'lib/aws-sdk-glue/client.rb', line 16940 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.
16997 16998 16999 17000 |
# File 'lib/aws-sdk-glue/client.rb', line 16997 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.
17024 17025 17026 17027 |
# File 'lib/aws-sdk-glue/client.rb', line 17024 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].
17052 17053 17054 17055 |
# File 'lib/aws-sdk-glue/client.rb', line 17052 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`.
17076 17077 17078 17079 |
# File 'lib/aws-sdk-glue/client.rb', line 17076 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.
17149 17150 17151 17152 |
# File 'lib/aws-sdk-glue/client.rb', line 17149 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.
17239 17240 17241 17242 |
# File 'lib/aws-sdk-glue/client.rb', line 17239 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.
17280 17281 17282 17283 |
# File 'lib/aws-sdk-glue/client.rb', line 17280 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.
17346 17347 17348 17349 |
# File 'lib/aws-sdk-glue/client.rb', line 17346 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.
17560 17561 17562 17563 |
# File 'lib/aws-sdk-glue/client.rb', line 17560 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`.
17595 17596 17597 17598 |
# File 'lib/aws-sdk-glue/client.rb', line 17595 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.
17644 17645 17646 17647 |
# File 'lib/aws-sdk-glue/client.rb', line 17644 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.
17677 17678 17679 17680 |
# File 'lib/aws-sdk-glue/client.rb', line 17677 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.
17716 17717 17718 17719 |
# File 'lib/aws-sdk-glue/client.rb', line 17716 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.
17742 17743 17744 17745 |
# File 'lib/aws-sdk-glue/client.rb', line 17742 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.
17769 17770 17771 17772 |
# File 'lib/aws-sdk-glue/client.rb', line 17769 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.
17791 17792 17793 17794 |
# File 'lib/aws-sdk-glue/client.rb', line 17791 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.
17814 17815 17816 17817 |
# File 'lib/aws-sdk-glue/client.rb', line 17814 def stop_crawler_schedule(params = {}, = {}) req = build_request(:stop_crawler_schedule, params) req.send_request() end |
#stop_session(params = {}) ⇒ Types::StopSessionResponse
Stops the session.
17846 17847 17848 17849 |
# File 'lib/aws-sdk-glue/client.rb', line 17846 def stop_session(params = {}, = {}) req = build_request(:stop_session, params) req.send_request() end |
#stop_trigger(params = {}) ⇒ Types::StopTriggerResponse
Stops a specified trigger.
17874 17875 17876 17877 |
# File 'lib/aws-sdk-glue/client.rb', line 17874 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.
17900 17901 17902 17903 |
# File 'lib/aws-sdk-glue/client.rb', line 17900 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].
17941 17942 17943 17944 |
# File 'lib/aws-sdk-glue/client.rb', line 17941 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.
18019 18020 18021 18022 |
# File 'lib/aws-sdk-glue/client.rb', line 18019 def test_connection(params = {}, = {}) req = build_request(:test_connection, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
18046 18047 18048 18049 |
# File 'lib/aws-sdk-glue/client.rb', line 18046 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse
Updates a registered blueprint.
18082 18083 18084 18085 |
# File 'lib/aws-sdk-glue/client.rb', line 18082 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.
18149 18150 18151 18152 |
# File 'lib/aws-sdk-glue/client.rb', line 18149 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).
18208 18209 18210 18211 |
# File 'lib/aws-sdk-glue/client.rb', line 18208 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`.
18346 18347 18348 18349 |
# File 'lib/aws-sdk-glue/client.rb', line 18346 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`.
18480 18481 18482 18483 |
# File 'lib/aws-sdk-glue/client.rb', line 18480 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.
18532 18533 18534 18535 |
# File 'lib/aws-sdk-glue/client.rb', line 18532 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.
18620 18621 18622 18623 |
# File 'lib/aws-sdk-glue/client.rb', line 18620 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.
18790 18791 18792 18793 |
# File 'lib/aws-sdk-glue/client.rb', line 18790 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.
18823 18824 18825 18826 |
# File 'lib/aws-sdk-glue/client.rb', line 18823 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.
18864 18865 18866 18867 |
# File 'lib/aws-sdk-glue/client.rb', line 18864 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.
18922 18923 18924 18925 |
# File 'lib/aws-sdk-glue/client.rb', line 18922 def update_database(params = {}, = {}) req = build_request(:update_database, params) req.send_request() end |
#update_dev_endpoint(params = {}) ⇒ Struct
Updates a specified development endpoint.
18991 18992 18993 18994 |
# File 'lib/aws-sdk-glue/client.rb', line 18991 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.
19046 19047 19048 19049 |
# File 'lib/aws-sdk-glue/client.rb', line 19046 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.
19103 19104 19105 19106 |
# File 'lib/aws-sdk-glue/client.rb', line 19103 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.
19130 19131 19132 19133 |
# File 'lib/aws-sdk-glue/client.rb', line 19130 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.
19201 19202 19203 19204 |
# File 'lib/aws-sdk-glue/client.rb', line 19201 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).
19319 19320 19321 19322 |
# File 'lib/aws-sdk-glue/client.rb', line 19319 def update_ml_transform(params = {}, = {}) req = build_request(:update_ml_transform, params) req.send_request() end |
#update_partition(params = {}) ⇒ Struct
Updates a partition.
19423 19424 19425 19426 |
# File 'lib/aws-sdk-glue/client.rb', line 19423 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.
19464 19465 19466 19467 |
# File 'lib/aws-sdk-glue/client.rb', line 19464 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.
19536 19537 19538 19539 |
# File 'lib/aws-sdk-glue/client.rb', line 19536 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.
19607 19608 19609 19610 |
# File 'lib/aws-sdk-glue/client.rb', line 19607 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.
19758 19759 19760 19761 |
# File 'lib/aws-sdk-glue/client.rb', line 19758 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.
19816 19817 19818 19819 |
# File 'lib/aws-sdk-glue/client.rb', line 19816 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.
19910 19911 19912 19913 |
# File 'lib/aws-sdk-glue/client.rb', line 19910 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.
19964 19965 19966 19967 |
# File 'lib/aws-sdk-glue/client.rb', line 19964 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.
20013 20014 20015 20016 |
# File 'lib/aws-sdk-glue/client.rb', line 20013 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.
20065 20066 20067 20068 |
# File 'lib/aws-sdk-glue/client.rb', line 20065 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.
20094 20095 20096 |
# File 'lib/aws-sdk-glue/client.rb', line 20094 def waiter_names [] end |