lib/aws-sdk-glue/client.rb in aws-sdk-glue-1.186.0 vs lib/aws-sdk-glue/client.rb in aws-sdk-glue-1.187.0

- old
+ new

@@ -959,10 +959,11 @@ # # @example Response structure # # resp.results #=> Array # resp.results[0].result_id #=> String + # resp.results[0].profile_id #=> String # resp.results[0].score #=> Float # resp.results[0].data_source.glue_table.database_name #=> String # resp.results[0].data_source.glue_table.table_name #=> String # resp.results[0].data_source.glue_table.catalog_id #=> String # resp.results[0].data_source.glue_table.connection_name #=> String @@ -980,19 +981,21 @@ # resp.results[0].rule_results[0].description #=> String # resp.results[0].rule_results[0].evaluation_message #=> String # resp.results[0].rule_results[0].result #=> String, one of "PASS", "FAIL", "ERROR" # resp.results[0].rule_results[0].evaluated_metrics #=> Hash # resp.results[0].rule_results[0].evaluated_metrics["NameString"] #=> Float + # resp.results[0].rule_results[0].evaluated_rule #=> String # resp.results[0].analyzer_results #=> Array # resp.results[0].analyzer_results[0].name #=> String # resp.results[0].analyzer_results[0].description #=> String # resp.results[0].analyzer_results[0].evaluation_message #=> String # resp.results[0].analyzer_results[0].evaluated_metrics #=> Hash # resp.results[0].analyzer_results[0].evaluated_metrics["NameString"] #=> Float # resp.results[0].observations #=> Array # resp.results[0].observations[0].description #=> String # resp.results[0].observations[0].metric_based_observation.metric_name #=> String + # resp.results[0].observations[0].metric_based_observation.statistic_id #=> String # resp.results[0].observations[0].metric_based_observation.metric_values.actual_value #=> Float # resp.results[0].observations[0].metric_based_observation.metric_values.expected_value #=> Float # resp.results[0].observations[0].metric_based_observation.metric_values.lower_limit #=> Float # resp.results[0].observations[0].metric_based_observation.metric_values.upper_limit #=> Float # resp.results[0].observations[0].metric_based_observation.new_rules #=> Array @@ -2420,10 +2423,51 @@ def batch_get_workflows(params = {}, options = {}) req = build_request(:batch_get_workflows, params) req.send_request(options) end + # Annotate datapoints over time for a specific data quality statistic. + # + # @option params [required, Array<Types::DatapointInclusionAnnotation>] :inclusion_annotations + # A list of `DatapointInclusionAnnotation`'s. + # + # @option params [String] :client_token + # Client Token. + # + # @return [Types::BatchPutDataQualityStatisticAnnotationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::BatchPutDataQualityStatisticAnnotationResponse#failed_inclusion_annotations #failed_inclusion_annotations} => Array&lt;Types::AnnotationError&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.batch_put_data_quality_statistic_annotation({ + # inclusion_annotations: [ # required + # { + # profile_id: "HashString", + # statistic_id: "HashString", + # inclusion_annotation: "INCLUDE", # accepts INCLUDE, EXCLUDE + # }, + # ], + # client_token: "HashString", + # }) + # + # @example Response structure + # + # resp.failed_inclusion_annotations #=> Array + # resp.failed_inclusion_annotations[0].profile_id #=> String + # resp.failed_inclusion_annotations[0].statistic_id #=> String + # resp.failed_inclusion_annotations[0].failure_reason #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/BatchPutDataQualityStatisticAnnotation AWS API Documentation + # + # @overload batch_put_data_quality_statistic_annotation(params = {}) + # @param [Hash] params ({}) + def batch_put_data_quality_statistic_annotation(params = {}, options = {}) + req = build_request(:batch_put_data_quality_statistic_annotation, params) + req.send_request(options) + end + # Stops one or more job runs for a specified job definition. # # @option params [required, String] :job_name # The name of the job definition for which to stop job runs. # @@ -3163,10 +3207,14 @@ # A list of tags applied to the data quality ruleset. # # @option params [Types::DataQualityTargetTable] :target_table # A target table associated with the data quality ruleset. # + # @option params [String] :data_quality_security_configuration + # The name of the security configuration created with the data quality + # encryption option. + # # @option params [String] :client_token # Used for idempotency and is recommended to be set to a random ID (such # as a UUID) to avoid creating or starting multiple instances of the # same resource. # @@ -3186,10 +3234,11 @@ # target_table: { # table_name: "NameString", # required # database_name: "NameString", # required # catalog_id: "NameString", # }, + # data_quality_security_configuration: "NameString", # client_token: "HashString", # }) # # @example Response structure # @@ -6960,18 +7009,98 @@ def get_data_catalog_encryption_settings(params = {}, options = {}) req = build_request(:get_data_catalog_encryption_settings, params) req.send_request(options) end + # Retrieve the training status of the model along with more information + # (CompletedOn, StartedOn, FailureReason). + # + # @option params [String] :statistic_id + # The Statistic ID. + # + # @option params [required, String] :profile_id + # The Profile ID. + # + # @return [Types::GetDataQualityModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetDataQualityModelResponse#status #status} => String + # * {Types::GetDataQualityModelResponse#started_on #started_on} => Time + # * {Types::GetDataQualityModelResponse#completed_on #completed_on} => Time + # * {Types::GetDataQualityModelResponse#failure_reason #failure_reason} => String + # + # @example Request syntax with placeholder values + # + # resp = client.get_data_quality_model({ + # statistic_id: "HashString", + # profile_id: "HashString", # required + # }) + # + # @example Response structure + # + # resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED" + # resp.started_on #=> Time + # resp.completed_on #=> Time + # resp.failure_reason #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataQualityModel AWS API Documentation + # + # @overload get_data_quality_model(params = {}) + # @param [Hash] params ({}) + def get_data_quality_model(params = {}, options = {}) + req = build_request(:get_data_quality_model, params) + req.send_request(options) + end + + # Retrieve a statistic's predictions for a given Profile ID. + # + # @option params [required, String] :statistic_id + # The Statistic ID. + # + # @option params [required, String] :profile_id + # The Profile ID. + # + # @return [Types::GetDataQualityModelResultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetDataQualityModelResultResponse#completed_on #completed_on} => Time + # * {Types::GetDataQualityModelResultResponse#model #model} => Array&lt;Types::StatisticModelResult&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.get_data_quality_model_result({ + # statistic_id: "HashString", # required + # profile_id: "HashString", # required + # }) + # + # @example Response structure + # + # resp.completed_on #=> Time + # resp.model #=> Array + # resp.model[0].lower_bound #=> Float + # resp.model[0].upper_bound #=> Float + # resp.model[0].predicted_value #=> Float + # resp.model[0].actual_value #=> Float + # resp.model[0].date #=> Time + # resp.model[0].inclusion_annotation #=> String, one of "INCLUDE", "EXCLUDE" + # + # @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataQualityModelResult AWS API Documentation + # + # @overload get_data_quality_model_result(params = {}) + # @param [Hash] params ({}) + def get_data_quality_model_result(params = {}, options = {}) + req = build_request(:get_data_quality_model_result, params) + req.send_request(options) + end + # Retrieves the result of a data quality rule evaluation. # # @option params [required, String] :result_id # A unique result ID for the data quality result. # # @return [Types::GetDataQualityResultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDataQualityResultResponse#result_id #result_id} => String + # * {Types::GetDataQualityResultResponse#profile_id #profile_id} => String # * {Types::GetDataQualityResultResponse#score #score} => Float # * {Types::GetDataQualityResultResponse#data_source #data_source} => Types::DataSource # * {Types::GetDataQualityResultResponse#ruleset_name #ruleset_name} => String # * {Types::GetDataQualityResultResponse#evaluation_context #evaluation_context} => String # * {Types::GetDataQualityResultResponse#started_on #started_on} => Time @@ -6990,10 +7119,11 @@ # }) # # @example Response structure # # resp.result_id #=> String + # resp.profile_id #=> String # resp.score #=> Float # resp.data_source.glue_table.database_name #=> String # resp.data_source.glue_table.table_name #=> String # resp.data_source.glue_table.catalog_id #=> String # resp.data_source.glue_table.connection_name #=> String @@ -7011,19 +7141,21 @@ # resp.rule_results[0].description #=> String # resp.rule_results[0].evaluation_message #=> String # resp.rule_results[0].result #=> String, one of "PASS", "FAIL", "ERROR" # resp.rule_results[0].evaluated_metrics #=> Hash # resp.rule_results[0].evaluated_metrics["NameString"] #=> Float + # resp.rule_results[0].evaluated_rule #=> String # resp.analyzer_results #=> Array # resp.analyzer_results[0].name #=> String # resp.analyzer_results[0].description #=> String # resp.analyzer_results[0].evaluation_message #=> String # resp.analyzer_results[0].evaluated_metrics #=> Hash # resp.analyzer_results[0].evaluated_metrics["NameString"] #=> Float # resp.observations #=> Array # resp.observations[0].description #=> String # resp.observations[0].metric_based_observation.metric_name #=> String + # resp.observations[0].metric_based_observation.statistic_id #=> String # resp.observations[0].metric_based_observation.metric_values.actual_value #=> Float # resp.observations[0].metric_based_observation.metric_values.expected_value #=> Float # resp.observations[0].metric_based_observation.metric_values.lower_limit #=> Float # resp.observations[0].metric_based_observation.metric_values.upper_limit #=> Float # resp.observations[0].metric_based_observation.new_rules #=> Array @@ -7056,10 +7188,11 @@ # * {Types::GetDataQualityRuleRecommendationRunResponse#last_modified_on #last_modified_on} => Time # * {Types::GetDataQualityRuleRecommendationRunResponse#completed_on #completed_on} => Time # * {Types::GetDataQualityRuleRecommendationRunResponse#execution_time #execution_time} => Integer # * {Types::GetDataQualityRuleRecommendationRunResponse#recommended_ruleset #recommended_ruleset} => String # * {Types::GetDataQualityRuleRecommendationRunResponse#created_ruleset_name #created_ruleset_name} => String + # * {Types::GetDataQualityRuleRecommendationRunResponse#data_quality_security_configuration #data_quality_security_configuration} => String # # @example Request syntax with placeholder values # # resp = client.get_data_quality_rule_recommendation_run({ # run_id: "HashString", # required @@ -7083,10 +7216,11 @@ # resp.last_modified_on #=> Time # resp.completed_on #=> Time # resp.execution_time #=> Integer # resp.recommended_ruleset #=> String # resp.created_ruleset_name #=> String + # resp.data_quality_security_configuration #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataQualityRuleRecommendationRun AWS API Documentation # # @overload get_data_quality_rule_recommendation_run(params = {}) # @param [Hash] params ({}) @@ -7107,10 +7241,11 @@ # * {Types::GetDataQualityRulesetResponse#ruleset #ruleset} => String # * {Types::GetDataQualityRulesetResponse#target_table #target_table} => Types::DataQualityTargetTable # * {Types::GetDataQualityRulesetResponse#created_on #created_on} => Time # * {Types::GetDataQualityRulesetResponse#last_modified_on #last_modified_on} => Time # * {Types::GetDataQualityRulesetResponse#recommendation_run_id #recommendation_run_id} => String + # * {Types::GetDataQualityRulesetResponse#data_quality_security_configuration #data_quality_security_configuration} => String # # @example Request syntax with placeholder values # # resp = client.get_data_quality_ruleset({ # name: "NameString", # required @@ -7125,10 +7260,11 @@ # resp.target_table.database_name #=> String # resp.target_table.catalog_id #=> String # resp.created_on #=> Time # resp.last_modified_on #=> Time # resp.recommendation_run_id #=> String + # resp.data_quality_security_configuration #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetDataQualityRuleset AWS API Documentation # # @overload get_data_quality_ruleset(params = {}) # @param [Hash] params ({}) @@ -13474,10 +13610,129 @@ def list_data_quality_rulesets(params = {}, options = {}) req = build_request(:list_data_quality_rulesets, params) req.send_request(options) end + # Retrieve annotations for a data quality statistic. + # + # @option params [String] :statistic_id + # The Statistic ID. + # + # @option params [String] :profile_id + # The Profile ID. + # + # @option params [Types::TimestampFilter] :timestamp_filter + # A timestamp filter. + # + # @option params [Integer] :max_results + # The maximum number of results to return in this request. + # + # @option params [String] :next_token + # A pagination token to retrieve the next set of results. + # + # @return [Types::ListDataQualityStatisticAnnotationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListDataQualityStatisticAnnotationsResponse#annotations #annotations} => Array&lt;Types::StatisticAnnotation&gt; + # * {Types::ListDataQualityStatisticAnnotationsResponse#next_token #next_token} => String + # + # @example Request syntax with placeholder values + # + # resp = client.list_data_quality_statistic_annotations({ + # statistic_id: "HashString", + # profile_id: "HashString", + # timestamp_filter: { + # recorded_before: Time.now, + # recorded_after: Time.now, + # }, + # max_results: 1, + # next_token: "PaginationToken", + # }) + # + # @example Response structure + # + # resp.annotations #=> Array + # resp.annotations[0].profile_id #=> String + # resp.annotations[0].statistic_id #=> String + # resp.annotations[0].statistic_recorded_on #=> Time + # resp.annotations[0].inclusion_annotation.value #=> String, one of "INCLUDE", "EXCLUDE" + # resp.annotations[0].inclusion_annotation.last_modified_on #=> Time + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/ListDataQualityStatisticAnnotations AWS API Documentation + # + # @overload list_data_quality_statistic_annotations(params = {}) + # @param [Hash] params ({}) + def list_data_quality_statistic_annotations(params = {}, options = {}) + req = build_request(:list_data_quality_statistic_annotations, params) + req.send_request(options) + end + + # Retrieves a list of data quality statistics. + # + # @option params [String] :statistic_id + # The Statistic ID. + # + # @option params [String] :profile_id + # The Profile ID. + # + # @option params [Types::TimestampFilter] :timestamp_filter + # A timestamp filter. + # + # @option params [Integer] :max_results + # The maximum number of results to return in this request. + # + # @option params [String] :next_token + # A pagination token to request the next page of results. + # + # @return [Types::ListDataQualityStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListDataQualityStatisticsResponse#statistics #statistics} => Array&lt;Types::StatisticSummary&gt; + # * {Types::ListDataQualityStatisticsResponse#next_token #next_token} => String + # + # @example Request syntax with placeholder values + # + # resp = client.list_data_quality_statistics({ + # statistic_id: "HashString", + # profile_id: "HashString", + # timestamp_filter: { + # recorded_before: Time.now, + # recorded_after: Time.now, + # }, + # max_results: 1, + # next_token: "PaginationToken", + # }) + # + # @example Response structure + # + # resp.statistics #=> Array + # resp.statistics[0].statistic_id #=> String + # resp.statistics[0].profile_id #=> String + # resp.statistics[0].run_identifier.run_id #=> String + # resp.statistics[0].run_identifier.job_run_id #=> String + # resp.statistics[0].statistic_name #=> String + # resp.statistics[0].double_value #=> Float + # resp.statistics[0].evaluation_level #=> String, one of "Dataset", "Column", "Multicolumn" + # resp.statistics[0].columns_referenced #=> Array + # resp.statistics[0].columns_referenced[0] #=> String + # resp.statistics[0].referenced_datasets #=> Array + # resp.statistics[0].referenced_datasets[0] #=> String + # resp.statistics[0].statistic_properties #=> Hash + # resp.statistics[0].statistic_properties["NameString"] #=> String + # resp.statistics[0].recorded_on #=> Time + # resp.statistics[0].inclusion_annotation.value #=> String, one of "INCLUDE", "EXCLUDE" + # resp.statistics[0].inclusion_annotation.last_modified_on #=> Time + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/ListDataQualityStatistics AWS API Documentation + # + # @overload list_data_quality_statistics(params = {}) + # @param [Hash] params ({}) + def list_data_quality_statistics(params = {}, options = {}) + req = build_request(:list_data_quality_statistics, params) + req.send_request(options) + end + # 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. # @@ -14181,10 +14436,36 @@ def put_data_catalog_encryption_settings(params = {}, options = {}) req = build_request(:put_data_catalog_encryption_settings, params) req.send_request(options) end + # Annotate all datapoints for a Profile. + # + # @option params [required, String] :profile_id + # The ID of the data quality monitoring profile to annotate. + # + # @option params [required, String] :inclusion_annotation + # The inclusion annotation value to apply to the profile. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.put_data_quality_profile_annotation({ + # profile_id: "HashString", # required + # inclusion_annotation: "INCLUDE", # required, accepts INCLUDE, EXCLUDE + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/PutDataQualityProfileAnnotation AWS API Documentation + # + # @overload put_data_quality_profile_annotation(params = {}) + # @param [Hash] params ({}) + def put_data_quality_profile_annotation(params = {}, options = {}) + req = build_request(:put_data_quality_profile_annotation, params) + req.send_request(options) + end + # Sets the Data Catalog resource policy for access control. # # @option params [required, String] :policy_in_json # Contains the policy document to set, in JSON format. # @@ -15023,10 +15304,14 @@ # status. The default is 2,880 minutes (48 hours). # # @option params [String] :created_ruleset_name # A name for the ruleset. # + # @option params [String] :data_quality_security_configuration + # The name of the security configuration created with the data quality + # encryption option. + # # @option params [String] :client_token # Used for idempotency and is recommended to be set to a random ID (such # as a UUID) to avoid creating or starting multiple instances of the # same resource. # @@ -15050,10 +15335,11 @@ # }, # role: "RoleString", # required # number_of_workers: 1, # timeout: 1, # created_ruleset_name: "NameString", + # data_quality_security_configuration: "NameString", # client_token: "HashString", # }) # # @example Response structure # @@ -17590,10 +17876,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-glue' - context[:gem_version] = '1.186.0' + context[:gem_version] = '1.187.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated