lib/aws-sdk-datazone/client.rb in aws-sdk-datazone-1.4.0 vs lib/aws-sdk-datazone/client.rb in aws-sdk-datazone-1.5.0

- old
+ new

@@ -390,10 +390,13 @@ # Accepts automatically generated business-friendly metadata for your # Amazon DataZone assets. # # @option params [Array<Types::AcceptChoice>] :accept_choices + # Specifies the prediction (aka, the automatically generated piece of + # metadata) and the target (for example, a column name) that can be + # accepted. # # @option params [Types::AcceptRule] :accept_rule # Specifies the rule (or the conditions) under which a prediction can be # accepted. # @@ -406,12 +409,14 @@ # # @option params [required, String] :domain_identifier # The identifier of the Amazon DataZone domain. # # @option params [required, String] :identifier + # The identifier of the asset. # # @option params [String] :revision + # The revision that is to be made to the asset. # # @return [Types::AcceptPredictionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::AcceptPredictionsOutput#asset_id #asset_id} => String # * {Types::AcceptPredictionsOutput#domain_id #domain_id} => String @@ -420,12 +425,13 @@ # @example Request syntax with placeholder values # # resp = client.accept_predictions({ # accept_choices: [ # { + # edited_value: "EditedValue", # prediction_choice: 1, - # prediction_target: "String", + # prediction_target: "String", # required # }, # ], # accept_rule: { # rule: "ALL", # accepts ALL, NONE # threshold: 1.0, @@ -525,10 +531,37 @@ def accept_subscription_request(params = {}, options = {}) req = build_request(:accept_subscription_request, params) req.send_request(options) end + # Cancels the metadata generation run. + # + # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain in which the metadata generation + # run is to be cancelled. + # + # @option params [required, String] :identifier + # The ID of the metadata generation run. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.cancel_metadata_generation_run({ + # domain_identifier: "DomainId", # required + # identifier: "MetadataGenerationRunIdentifier", # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CancelMetadataGenerationRun AWS API Documentation + # + # @overload cancel_metadata_generation_run(params = {}) + # @param [Hash] params ({}) + def cancel_metadata_generation_run(params = {}, options = {}) + req = build_request(:cancel_metadata_generation_run, params) + req.send_request(options) + end + # Cancels the subscription to the specified asset. # # @option params [required, String] :domain_identifier # The unique identifier of the Amazon DataZone domain where the # subscription request is being cancelled. @@ -607,10 +640,11 @@ # # @option params [required, String] :domain_identifier # Amazon DataZone domain where the asset is created. # # @option params [String] :external_identifier + # The external identifier of the asset. # # @option params [Array<Types::FormInput>] :forms_input # Metadata forms attached to the asset. # # @option params [Array<String>] :glossary_terms @@ -642,10 +676,11 @@ # * {Types::CreateAssetOutput#first_revision_created_at #first_revision_created_at} => Time # * {Types::CreateAssetOutput#first_revision_created_by #first_revision_created_by} => String # * {Types::CreateAssetOutput#forms_output #forms_output} => Array&lt;Types::FormOutput&gt; # * {Types::CreateAssetOutput#glossary_terms #glossary_terms} => Array&lt;String&gt; # * {Types::CreateAssetOutput#id #id} => String + # * {Types::CreateAssetOutput#latest_time_series_data_point_forms_output #latest_time_series_data_point_forms_output} => Array&lt;Types::TimeSeriesDataPointSummaryFormOutput&gt; # * {Types::CreateAssetOutput#listing #listing} => Types::AssetListingDetails # * {Types::CreateAssetOutput#name #name} => String # * {Types::CreateAssetOutput#owning_project_id #owning_project_id} => String # * {Types::CreateAssetOutput#prediction_configuration #prediction_configuration} => Types::PredictionConfiguration # * {Types::CreateAssetOutput#read_only_forms_output #read_only_forms_output} => Array&lt;Types::FormOutput&gt; @@ -695,10 +730,17 @@ # resp.forms_output[0].type_name #=> String # resp.forms_output[0].type_revision #=> String # resp.glossary_terms #=> Array # resp.glossary_terms[0] #=> String # resp.id #=> String + # resp.latest_time_series_data_point_forms_output #=> Array + # resp.latest_time_series_data_point_forms_output[0].content_summary #=> String + # resp.latest_time_series_data_point_forms_output[0].form_name #=> String + # resp.latest_time_series_data_point_forms_output[0].id #=> String + # resp.latest_time_series_data_point_forms_output[0].timestamp #=> Time + # resp.latest_time_series_data_point_forms_output[0].type_identifier #=> String + # resp.latest_time_series_data_point_forms_output[0].type_revision #=> String # resp.listing.listing_id #=> String # resp.listing.listing_status #=> String, one of "CREATING", "ACTIVE", "INACTIVE" # resp.name #=> String # resp.owning_project_id #=> String # resp.prediction_configuration.business_name_generation.enabled #=> Boolean @@ -766,10 +808,11 @@ # * {Types::CreateAssetRevisionOutput#first_revision_created_at #first_revision_created_at} => Time # * {Types::CreateAssetRevisionOutput#first_revision_created_by #first_revision_created_by} => String # * {Types::CreateAssetRevisionOutput#forms_output #forms_output} => Array&lt;Types::FormOutput&gt; # * {Types::CreateAssetRevisionOutput#glossary_terms #glossary_terms} => Array&lt;String&gt; # * {Types::CreateAssetRevisionOutput#id #id} => String + # * {Types::CreateAssetRevisionOutput#latest_time_series_data_point_forms_output #latest_time_series_data_point_forms_output} => Array&lt;Types::TimeSeriesDataPointSummaryFormOutput&gt; # * {Types::CreateAssetRevisionOutput#listing #listing} => Types::AssetListingDetails # * {Types::CreateAssetRevisionOutput#name #name} => String # * {Types::CreateAssetRevisionOutput#owning_project_id #owning_project_id} => String # * {Types::CreateAssetRevisionOutput#prediction_configuration #prediction_configuration} => Types::PredictionConfiguration # * {Types::CreateAssetRevisionOutput#read_only_forms_output #read_only_forms_output} => Array&lt;Types::FormOutput&gt; @@ -817,10 +860,17 @@ # resp.forms_output[0].type_name #=> String # resp.forms_output[0].type_revision #=> String # resp.glossary_terms #=> Array # resp.glossary_terms[0] #=> String # resp.id #=> String + # resp.latest_time_series_data_point_forms_output #=> Array + # resp.latest_time_series_data_point_forms_output[0].content_summary #=> String + # resp.latest_time_series_data_point_forms_output[0].form_name #=> String + # resp.latest_time_series_data_point_forms_output[0].id #=> String + # resp.latest_time_series_data_point_forms_output[0].timestamp #=> Time + # resp.latest_time_series_data_point_forms_output[0].type_identifier #=> String + # resp.latest_time_series_data_point_forms_output[0].type_revision #=> String # resp.listing.listing_id #=> String # resp.listing.listing_status #=> String, one of "CREATING", "ACTIVE", "INACTIVE" # resp.name #=> String # resp.owning_project_id #=> String # resp.prediction_configuration.business_name_generation.enabled #=> Boolean @@ -1005,10 +1055,11 @@ # }, # ], # client_token: "String", # configuration: { # glue_run_configuration: { + # auto_import_data_quality_result: false, # data_access_role: "GlueRunConfigurationInputDataAccessRoleString", # relational_filter_configurations: [ # required # { # database_name: "RelationalFilterConfigurationDatabaseNameString", # required # filter_expressions: [ @@ -1071,10 +1122,11 @@ # resp.asset_forms_output[0].content #=> String # resp.asset_forms_output[0].form_name #=> String # resp.asset_forms_output[0].type_name #=> String # resp.asset_forms_output[0].type_revision #=> String # resp.configuration.glue_run_configuration.account_id #=> String + # resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean # resp.configuration.glue_run_configuration.data_access_role #=> String # resp.configuration.glue_run_configuration.region #=> String # resp.configuration.glue_run_configuration.relational_filter_configurations #=> Array # resp.configuration.glue_run_configuration.relational_filter_configurations[0].database_name #=> String # resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array @@ -1681,23 +1733,34 @@ def create_group_profile(params = {}, options = {}) req = build_request(:create_group_profile, params) req.send_request(options) end + # Publishes a listing (a record of an asset at a given time) or removes + # a listing from the catalog. + # # @option params [required, String] :action + # Specifies whether to publish or unpublish a listing. # # @option params [String] :client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain. # # @option params [required, String] :entity_identifier + # The ID of the asset. # # @option params [String] :entity_revision + # The revision of an asset. # # @option params [required, String] :entity_type + # The type of an entity. # # @return [Types::CreateListingChangeSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateListingChangeSetOutput#listing_id #listing_id} => String # * {Types::CreateListingChangeSetOutput#listing_revision #listing_revision} => String @@ -1707,11 +1770,11 @@ # # resp = client.create_listing_change_set({ # action: "PUBLISH", # required, accepts PUBLISH, UNPUBLISH # client_token: "ClientToken", # domain_identifier: "DomainId", # required - # entity_identifier: "EntityId", # required + # entity_identifier: "EntityIdentifier", # required # entity_revision: "Revision", # entity_type: "ASSET", # required, accepts ASSET # }) # # @example Response structure @@ -1935,10 +1998,11 @@ # # @option params [required, String] :request_reason # The reason for the subscription request. # # @option params [required, Array<Types::SubscribedListingInput>] :subscribed_listings + # The published asset for which the subscription grant is to be created. # # @option params [required, Array<Types::SubscribedPrincipalInput>] :subscribed_principals # The Amazon DataZone principals for whom the subscription request is # created. # @@ -2283,10 +2347,11 @@ # resp.asset_forms_output[0].content #=> String # resp.asset_forms_output[0].form_name #=> String # resp.asset_forms_output[0].type_name #=> String # resp.asset_forms_output[0].type_revision #=> String # resp.configuration.glue_run_configuration.account_id #=> String + # resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean # resp.configuration.glue_run_configuration.data_access_role #=> String # resp.configuration.glue_run_configuration.region #=> String # resp.configuration.glue_run_configuration.relational_filter_configurations #=> Array # resp.configuration.glue_run_configuration.relational_filter_configurations[0].database_name #=> String # resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array @@ -2347,11 +2412,12 @@ # @option params [required, String] :identifier # The identifier of the Amazon Web Services domain that is to be # deleted. # # @option params [Boolean] :skip_deletion_check - # Optional flag to delete all child entities within the domain + # Specifies the optional flag to delete all child entities within the + # domain. # # @return [Types::DeleteDomainOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteDomainOutput#status #status} => String # @@ -2536,13 +2602,17 @@ def delete_glossary_term(params = {}, options = {}) req = build_request(:delete_glossary_term, params) req.send_request(options) end + # Deletes a listing (a record of an asset at a given time). + # # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain. # # @option params [required, String] :identifier + # The ID of the listing to be deleted. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -2567,12 +2637,12 @@ # # @option params [required, String] :identifier # The identifier of the project that is to be deleted. # # @option params [Boolean] :skip_deletion_check - # Optional flag to asynchronously delete child entities within the - # project + # Specifies the optional flag to delete all child entities within the + # project. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -2744,10 +2814,53 @@ def delete_subscription_target(params = {}, options = {}) req = build_request(:delete_subscription_target, params) req.send_request(options) end + # Deletes the specified time series form for the specified asset. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier to ensure idempotency of the + # request. This field is automatically populated if not provided. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain that houses the asset for which + # you want to delete a time series form. + # + # @option params [required, String] :entity_identifier + # The ID of the asset for which you want to delete a time series form. + # + # @option params [required, String] :entity_type + # The type of the asset for which you want to delete a time series form. + # + # @option params [required, String] :form_name + # The name of the time series form that you want to delete. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.delete_time_series_data_points({ + # client_token: "ClientToken", + # domain_identifier: "DomainId", # required + # entity_identifier: "EntityIdentifier", # required + # entity_type: "ASSET", # required, accepts ASSET, LISTING + # form_name: "TimeSeriesFormName", # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DeleteTimeSeriesDataPoints AWS API Documentation + # + # @overload delete_time_series_data_points(params = {}) + # @param [Hash] params ({}) + def delete_time_series_data_points(params = {}, options = {}) + req = build_request(:delete_time_series_data_points, params) + req.send_request(options) + end + # Gets an Amazon DataZone asset. # # @option params [required, String] :domain_identifier # The ID of the Amazon DataZone domain to which the asset belongs. # @@ -2767,10 +2880,11 @@ # * {Types::GetAssetOutput#first_revision_created_at #first_revision_created_at} => Time # * {Types::GetAssetOutput#first_revision_created_by #first_revision_created_by} => String # * {Types::GetAssetOutput#forms_output #forms_output} => Array&lt;Types::FormOutput&gt; # * {Types::GetAssetOutput#glossary_terms #glossary_terms} => Array&lt;String&gt; # * {Types::GetAssetOutput#id #id} => String + # * {Types::GetAssetOutput#latest_time_series_data_point_forms_output #latest_time_series_data_point_forms_output} => Array&lt;Types::TimeSeriesDataPointSummaryFormOutput&gt; # * {Types::GetAssetOutput#listing #listing} => Types::AssetListingDetails # * {Types::GetAssetOutput#name #name} => String # * {Types::GetAssetOutput#owning_project_id #owning_project_id} => String # * {Types::GetAssetOutput#read_only_forms_output #read_only_forms_output} => Array&lt;Types::FormOutput&gt; # * {Types::GetAssetOutput#revision #revision} => String @@ -2800,10 +2914,17 @@ # resp.forms_output[0].type_name #=> String # resp.forms_output[0].type_revision #=> String # resp.glossary_terms #=> Array # resp.glossary_terms[0] #=> String # resp.id #=> String + # resp.latest_time_series_data_point_forms_output #=> Array + # resp.latest_time_series_data_point_forms_output[0].content_summary #=> String + # resp.latest_time_series_data_point_forms_output[0].form_name #=> String + # resp.latest_time_series_data_point_forms_output[0].id #=> String + # resp.latest_time_series_data_point_forms_output[0].timestamp #=> Time + # resp.latest_time_series_data_point_forms_output[0].type_identifier #=> String + # resp.latest_time_series_data_point_forms_output[0].type_revision #=> String # resp.listing.listing_id #=> String # resp.listing.listing_status #=> String, one of "CREATING", "ACTIVE", "INACTIVE" # resp.name #=> String # resp.owning_project_id #=> String # resp.read_only_forms_output #=> Array @@ -2930,10 +3051,11 @@ # resp.asset_forms_output[0].content #=> String # resp.asset_forms_output[0].form_name #=> String # resp.asset_forms_output[0].type_name #=> String # resp.asset_forms_output[0].type_revision #=> String # resp.configuration.glue_run_configuration.account_id #=> String + # resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean # resp.configuration.glue_run_configuration.data_access_role #=> String # resp.configuration.glue_run_configuration.region #=> String # resp.configuration.glue_run_configuration.relational_filter_configurations #=> Array # resp.configuration.glue_run_configuration.relational_filter_configurations[0].database_name #=> String # resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array @@ -3599,15 +3721,20 @@ def get_iam_portal_login_url(params = {}, options = {}) req = build_request(:get_iam_portal_login_url, params) req.send_request(options) end + # Gets a listing (a record of an asset at a given time). + # # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain. # # @option params [required, String] :identifier + # The ID of the listing. # # @option params [String] :listing_revision + # The revision of the listing. # # @return [Types::GetListingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetListingOutput#created_at #created_at} => Time # * {Types::GetListingOutput#created_by #created_by} => String @@ -3642,10 +3769,17 @@ # resp.item.asset_listing.created_at #=> Time # resp.item.asset_listing.forms #=> String # resp.item.asset_listing.glossary_terms #=> Array # resp.item.asset_listing.glossary_terms[0].name #=> String # resp.item.asset_listing.glossary_terms[0].short_description #=> String + # resp.item.asset_listing.latest_time_series_data_point_forms #=> Array + # resp.item.asset_listing.latest_time_series_data_point_forms[0].content_summary #=> String + # resp.item.asset_listing.latest_time_series_data_point_forms[0].form_name #=> String + # resp.item.asset_listing.latest_time_series_data_point_forms[0].id #=> String + # resp.item.asset_listing.latest_time_series_data_point_forms[0].timestamp #=> Time + # resp.item.asset_listing.latest_time_series_data_point_forms[0].type_identifier #=> String + # resp.item.asset_listing.latest_time_series_data_point_forms[0].type_revision #=> String # resp.item.asset_listing.owning_project_id #=> String # resp.listing_revision #=> String # resp.name #=> String # resp.status #=> String, one of "CREATING", "ACTIVE", "INACTIVE" # resp.updated_at #=> Time @@ -3658,10 +3792,59 @@ def get_listing(params = {}, options = {}) req = build_request(:get_listing, params) req.send_request(options) end + # Gets a metadata generation run in Amazon DataZone. + # + # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain the metadata generation run of + # which you want to get. + # + # @option params [required, String] :identifier + # The identifier of the metadata generation run. + # + # @return [Types::GetMetadataGenerationRunOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetMetadataGenerationRunOutput#created_at #created_at} => Time + # * {Types::GetMetadataGenerationRunOutput#created_by #created_by} => String + # * {Types::GetMetadataGenerationRunOutput#domain_id #domain_id} => String + # * {Types::GetMetadataGenerationRunOutput#id #id} => String + # * {Types::GetMetadataGenerationRunOutput#owning_project_id #owning_project_id} => String + # * {Types::GetMetadataGenerationRunOutput#status #status} => String + # * {Types::GetMetadataGenerationRunOutput#target #target} => Types::MetadataGenerationRunTarget + # * {Types::GetMetadataGenerationRunOutput#type #type} => String + # + # @example Request syntax with placeholder values + # + # resp = client.get_metadata_generation_run({ + # domain_identifier: "DomainId", # required + # identifier: "MetadataGenerationRunIdentifier", # required + # }) + # + # @example Response structure + # + # resp.created_at #=> Time + # resp.created_by #=> String + # resp.domain_id #=> String + # resp.id #=> String + # resp.owning_project_id #=> String + # resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED" + # resp.target.identifier #=> String + # resp.target.revision #=> String + # resp.target.type #=> String, one of "ASSET" + # resp.type #=> String, one of "BUSINESS_DESCRIPTIONS" + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetMetadataGenerationRun AWS API Documentation + # + # @overload get_metadata_generation_run(params = {}) + # @param [Hash] params ({}) + def get_metadata_generation_run(params = {}, options = {}) + req = build_request(:get_metadata_generation_run, params) + req.send_request(options) + end + # Gets a project in Amazon DataZone. # # @option params [required, String] :domain_identifier # The ID of the Amazon DataZone domain in which the project exists. # @@ -3977,10 +4160,69 @@ def get_subscription_target(params = {}, options = {}) req = build_request(:get_subscription_target, params) req.send_request(options) end + # Gets the existing data point for the asset. + # + # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain that houses the asset for which + # you want to get the data point. + # + # @option params [required, String] :entity_identifier + # The ID of the asset for which you want to get the data point. + # + # @option params [required, String] :entity_type + # The type of the asset for which you want to get the data point. + # + # @option params [required, String] :form_name + # The name of the time series form that houses the data point that you + # want to get. + # + # @option params [required, String] :identifier + # The ID of the data point that you want to get. + # + # @return [Types::GetTimeSeriesDataPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetTimeSeriesDataPointOutput#domain_id #domain_id} => String + # * {Types::GetTimeSeriesDataPointOutput#entity_id #entity_id} => String + # * {Types::GetTimeSeriesDataPointOutput#entity_type #entity_type} => String + # * {Types::GetTimeSeriesDataPointOutput#form #form} => Types::TimeSeriesDataPointFormOutput + # * {Types::GetTimeSeriesDataPointOutput#form_name #form_name} => String + # + # @example Request syntax with placeholder values + # + # resp = client.get_time_series_data_point({ + # domain_identifier: "DomainId", # required + # entity_identifier: "EntityIdentifier", # required + # entity_type: "ASSET", # required, accepts ASSET, LISTING + # form_name: "TimeSeriesFormName", # required + # identifier: "TimeSeriesDataPointIdentifier", # required + # }) + # + # @example Response structure + # + # resp.domain_id #=> String + # resp.entity_id #=> String + # resp.entity_type #=> String, one of "ASSET", "LISTING" + # resp.form.content #=> String + # resp.form.form_name #=> String + # resp.form.id #=> String + # resp.form.timestamp #=> Time + # resp.form.type_identifier #=> String + # resp.form.type_revision #=> String + # resp.form_name #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetTimeSeriesDataPoint AWS API Documentation + # + # @overload get_time_series_data_point(params = {}) + # @param [Hash] params ({}) + def get_time_series_data_point(params = {}, options = {}) + req = build_request(:get_time_series_data_point, params) + req.send_request(options) + end + # Gets a user profile in Amazon DataZone. # # @option params [required, String] :domain_identifier # the ID of the Amazon DataZone domain the data portal of which you want # to get. @@ -4608,10 +4850,11 @@ # greater than the value of `MaxResults`, the response contains a # `NextToken` value that you can use in a subsequent call to # `ListEnvironments` to list the next set of environments. # # @option params [String] :name + # The name of the environment. # # @option params [String] :next_token # When the number of environments is greater than the default value for # the `MaxResults` parameter, or if you explicitly specify a value for # `MaxResults` that is less than the number of environments, the @@ -4676,10 +4919,79 @@ def list_environments(params = {}, options = {}) req = build_request(:list_environments, params) req.send_request(options) end + # Lists all metadata generation runs. + # + # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain where you want to list metadata + # generation runs. + # + # @option params [Integer] :max_results + # The maximum number of metadata generation runs to return in a single + # call to ListMetadataGenerationRuns. When the number of metadata + # generation runs to be listed is greater than the value of MaxResults, + # the response contains a NextToken value that you can use in a + # subsequent call to ListMetadataGenerationRuns to list the next set of + # revisions. + # + # @option params [String] :next_token + # When the number of metadata generation runs is greater than the + # default value for the MaxResults parameter, or if you explicitly + # specify a value for MaxResults that is less than the number of + # metadata generation runs, the response includes a pagination token + # named NextToken. You can specify this NextToken value in a subsequent + # call to ListMetadataGenerationRuns to list the next set of revisions. + # + # @option params [String] :status + # The status of the metadata generation runs. + # + # @option params [String] :type + # The type of the metadata generation runs. + # + # @return [Types::ListMetadataGenerationRunsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListMetadataGenerationRunsOutput#items #items} => Array&lt;Types::MetadataGenerationRunItem&gt; + # * {Types::ListMetadataGenerationRunsOutput#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_metadata_generation_runs({ + # domain_identifier: "DomainId", # required + # max_results: 1, + # next_token: "PaginationToken", + # status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELED, SUCCEEDED, FAILED + # type: "BUSINESS_DESCRIPTIONS", # accepts BUSINESS_DESCRIPTIONS + # }) + # + # @example Response structure + # + # resp.items #=> Array + # resp.items[0].created_at #=> Time + # resp.items[0].created_by #=> String + # resp.items[0].domain_id #=> String + # resp.items[0].id #=> String + # resp.items[0].owning_project_id #=> String + # resp.items[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED" + # resp.items[0].target.identifier #=> String + # resp.items[0].target.revision #=> String + # resp.items[0].target.type #=> String, one of "ASSET" + # resp.items[0].type #=> String, one of "BUSINESS_DESCRIPTIONS" + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListMetadataGenerationRuns AWS API Documentation + # + # @overload list_metadata_generation_runs(params = {}) + # @param [Hash] params ({}) + def list_metadata_generation_runs(params = {}, options = {}) + req = build_request(:list_metadata_generation_runs, params) + req.send_request(options) + end + # Lists all Amazon DataZone notifications. # # @option params [Time,DateTime,Date,Integer,String] :after_timestamp # The time after which you want to list notifications. # @@ -4842,10 +5154,11 @@ # than the value of `MaxResults`, the response contains a `NextToken` # value that you can use in a subsequent call to `ListProjects` to list # the next set of projects. # # @option params [String] :name + # The name of the project. # # @option params [String] :next_token # When the number of projects is greater than the default value for the # `MaxResults` parameter, or if you explicitly specify a value for # `MaxResults` that is less than the number of projects, the response @@ -5309,10 +5622,157 @@ def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end + # Lists time series data points. + # + # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain that houses the assets for which + # you want to list time series data points. + # + # @option params [Time,DateTime,Date,Integer,String] :ended_at + # The timestamp at which the data points that you wanted to list ended. + # + # @option params [required, String] :entity_identifier + # The ID of the asset for which you want to list data points. + # + # @option params [required, String] :entity_type + # The type of the asset for which you want to list data points. + # + # @option params [required, String] :form_name + # The name of the time series data points form. + # + # @option params [Integer] :max_results + # The maximum number of data points to return in a single call to + # ListTimeSeriesDataPoints. When the number of data points to be listed + # is greater than the value of MaxResults, the response contains a + # NextToken value that you can use in a subsequent call to + # ListTimeSeriesDataPoints to list the next set of data points. + # + # @option params [String] :next_token + # When the number of data points is greater than the default value for + # the MaxResults parameter, or if you explicitly specify a value for + # MaxResults that is less than the number of data points, the response + # includes a pagination token named NextToken. You can specify this + # NextToken value in a subsequent call to ListTimeSeriesDataPoints to + # list the next set of data points. + # + # @option params [Time,DateTime,Date,Integer,String] :started_at + # The timestamp at which the data points that you want to list started. + # + # @return [Types::ListTimeSeriesDataPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListTimeSeriesDataPointsOutput#items #items} => Array&lt;Types::TimeSeriesDataPointSummaryFormOutput&gt; + # * {Types::ListTimeSeriesDataPointsOutput#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_time_series_data_points({ + # domain_identifier: "DomainId", # required + # ended_at: Time.now, + # entity_identifier: "EntityIdentifier", # required + # entity_type: "ASSET", # required, accepts ASSET, LISTING + # form_name: "TimeSeriesFormName", # required + # max_results: 1, + # next_token: "PaginationToken", + # started_at: Time.now, + # }) + # + # @example Response structure + # + # resp.items #=> Array + # resp.items[0].content_summary #=> String + # resp.items[0].form_name #=> String + # resp.items[0].id #=> String + # resp.items[0].timestamp #=> Time + # resp.items[0].type_identifier #=> String + # resp.items[0].type_revision #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListTimeSeriesDataPoints AWS API Documentation + # + # @overload list_time_series_data_points(params = {}) + # @param [Hash] params ({}) + def list_time_series_data_points(params = {}, options = {}) + req = build_request(:list_time_series_data_points, params) + req.send_request(options) + end + + # Posts time series data points to Amazon DataZone for the specified + # asset. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier that is provided to ensure the + # idempotency of the request. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain in which you want to post time + # series data points. + # + # @option params [required, String] :entity_identifier + # The ID of the asset for which you want to post time series data + # points. + # + # @option params [required, String] :entity_type + # The type of the asset for which you want to post data points. + # + # @option params [required, Array<Types::TimeSeriesDataPointFormInput>] :forms + # The forms that contain the data points that you want to post. + # + # @return [Types::PostTimeSeriesDataPointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::PostTimeSeriesDataPointsOutput#domain_id #domain_id} => String + # * {Types::PostTimeSeriesDataPointsOutput#entity_id #entity_id} => String + # * {Types::PostTimeSeriesDataPointsOutput#entity_type #entity_type} => String + # * {Types::PostTimeSeriesDataPointsOutput#forms #forms} => Array&lt;Types::TimeSeriesDataPointFormOutput&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.post_time_series_data_points({ + # client_token: "ClientToken", + # domain_identifier: "DomainId", # required + # entity_identifier: "EntityIdentifier", # required + # entity_type: "ASSET", # required, accepts ASSET, LISTING + # forms: [ # required + # { + # content: "TimeSeriesDataPointFormInputContentString", + # form_name: "TimeSeriesFormName", # required + # timestamp: Time.now, # required + # type_identifier: "FormTypeIdentifier", # required + # type_revision: "Revision", + # }, + # ], + # }) + # + # @example Response structure + # + # resp.domain_id #=> String + # resp.entity_id #=> String + # resp.entity_type #=> String, one of "ASSET", "LISTING" + # resp.forms #=> Array + # resp.forms[0].content #=> String + # resp.forms[0].form_name #=> String + # resp.forms[0].id #=> String + # resp.forms[0].timestamp #=> Time + # resp.forms[0].type_identifier #=> String + # resp.forms[0].type_revision #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/PostTimeSeriesDataPoints AWS API Documentation + # + # @overload post_time_series_data_points(params = {}) + # @param [Hash] params ({}) + def post_time_series_data_points(params = {}, options = {}) + req = build_request(:post_time_series_data_points, params) + req.send_request(options) + end + # Writes the configuration for the specified environment blueprint in # Amazon DataZone. # # @option params [required, String] :domain_identifier # The identifier of the Amazon DataZone domain. @@ -5396,14 +5856,20 @@ # # @option params [required, String] :identifier # The identifier of the prediction. # # @option params [Array<Types::RejectChoice>] :reject_choices + # Specifies the prediction (aka, the automatically generated piece of + # metadata) and the target (for example, a column name) that can be + # rejected. # # @option params [Types::RejectRule] :reject_rule + # Specifies the rule (or the conditions) under which a prediction can be + # rejected. # # @option params [String] :revision + # The revision that is to be made to the asset. # # @return [Types::RejectPredictionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RejectPredictionsOutput#asset_id #asset_id} => String # * {Types::RejectPredictionsOutput#asset_revision #asset_revision} => String @@ -5416,11 +5882,11 @@ # domain_identifier: "DomainId", # required # identifier: "AssetIdentifier", # required # reject_choices: [ # { # prediction_choices: [1], - # prediction_target: "String", + # prediction_target: "String", # required # }, # ], # reject_rule: { # rule: "ALL", # accepts ALL, NONE # threshold: 1.0, @@ -5615,10 +6081,11 @@ # # @option params [String] :owning_project_identifier # The identifier of the owning project specified for the search. # # @option params [Array<Types::SearchInItem>] :search_in + # The details of the search. # # @option params [required, String] :search_scope # The scope of the search. # # @option params [String] :search_text @@ -5636,11 +6103,11 @@ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.search({ - # additional_attributes: ["FORMS"], # accepts FORMS + # additional_attributes: ["FORMS"], # accepts FORMS, TIME_SERIES_DATA_POINT_FORMS # domain_identifier: "DomainId", # required # filters: { # and: [ # { # # recursive FilterClause @@ -5678,10 +6145,17 @@ # resp.items[0].asset_item.additional_attributes.forms_output #=> Array # resp.items[0].asset_item.additional_attributes.forms_output[0].content #=> String # resp.items[0].asset_item.additional_attributes.forms_output[0].form_name #=> String # resp.items[0].asset_item.additional_attributes.forms_output[0].type_name #=> String # resp.items[0].asset_item.additional_attributes.forms_output[0].type_revision #=> String + # resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output #=> Array + # resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].content_summary #=> String + # resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].form_name #=> String + # resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].id #=> String + # resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].timestamp #=> Time + # resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].type_identifier #=> String + # resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].type_revision #=> String # resp.items[0].asset_item.additional_attributes.read_only_forms_output #=> Array # resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].content #=> String # resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].form_name #=> String # resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].type_name #=> String # resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].type_revision #=> String @@ -5810,11 +6284,12 @@ def search_group_profiles(params = {}, options = {}) req = build_request(:search_group_profiles, params) req.send_request(options) end - # Searches listings in Amazon DataZone. + # Searches listings (records of an asset at a given time) in Amazon + # DataZone. # # @option params [Array<String>] :additional_attributes # Specifies additional attributes for the search. # # @option params [required, String] :domain_identifier @@ -5837,10 +6312,11 @@ # includes a pagination token named `NextToken`. You can specify this # `NextToken` value in a subsequent call to `SearchListings` to list the # next set of results. # # @option params [Array<Types::SearchInItem>] :search_in + # The details of the search. # # @option params [String] :search_text # Specifies the text for which to search. # # @option params [Types::SearchSort] :sort @@ -5855,11 +6331,11 @@ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.search_listings({ - # additional_attributes: ["FORMS"], # accepts FORMS + # additional_attributes: ["FORMS"], # accepts FORMS, TIME_SERIES_DATA_POINT_FORMS # domain_identifier: "DomainId", # required # filters: { # and: [ # { # # recursive FilterClause @@ -5891,10 +6367,17 @@ # # @example Response structure # # resp.items #=> Array # resp.items[0].asset_listing.additional_attributes.forms #=> String + # resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms #=> Array + # resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].content_summary #=> String + # resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].form_name #=> String + # resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].id #=> String + # resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].timestamp #=> Time + # resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].type_identifier #=> String + # resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].type_revision #=> String # resp.items[0].asset_listing.created_at #=> Time # resp.items[0].asset_listing.description #=> String # resp.items[0].asset_listing.entity_id #=> String # resp.items[0].asset_listing.entity_revision #=> String # resp.items[0].asset_listing.entity_type #=> String @@ -5927,10 +6410,11 @@ # # @option params [Types::FilterClause] :filters # The filters for the `SearchTypes` action. # # @option params [required, Boolean] :managed + # Specifies whether the search is managed. # # @option params [Integer] :max_results # The maximum number of results to return in a single call to # `SearchTypes`. When the number of results to be listed is greater than # the value of `MaxResults`, the response contains a `NextToken` value @@ -5944,10 +6428,11 @@ # includes a pagination token named `NextToken`. You can specify this # `NextToken` value in a subsequent call to `SearchTypes` to list the # next set of results. # # @option params [Array<Types::SearchInItem>] :search_in + # The details of the search. # # @option params [required, String] :search_scope # Specifies the scope of the search for types. # # @option params [String] :search_text @@ -6178,10 +6663,76 @@ def start_data_source_run(params = {}, options = {}) req = build_request(:start_data_source_run, params) req.send_request(options) end + # Starts the metadata generation run. + # + # @option params [String] :client_token + # A unique, case-sensitive identifier to ensure idempotency of the + # request. This field is automatically populated if not provided. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option.** + # + # @option params [required, String] :domain_identifier + # The ID of the Amazon DataZone domain where you want to start a + # metadata generation run. + # + # @option params [required, String] :owning_project_identifier + # The ID of the project that owns the asset for which you want to start + # a metadata generation run. + # + # @option params [required, Types::MetadataGenerationRunTarget] :target + # The asset for which you want to start a metadata generation run. + # + # @option params [required, String] :type + # The type of the metadata generation run. + # + # @return [Types::StartMetadataGenerationRunOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::StartMetadataGenerationRunOutput#created_at #created_at} => Time + # * {Types::StartMetadataGenerationRunOutput#created_by #created_by} => String + # * {Types::StartMetadataGenerationRunOutput#domain_id #domain_id} => String + # * {Types::StartMetadataGenerationRunOutput#id #id} => String + # * {Types::StartMetadataGenerationRunOutput#owning_project_id #owning_project_id} => String + # * {Types::StartMetadataGenerationRunOutput#status #status} => String + # * {Types::StartMetadataGenerationRunOutput#type #type} => String + # + # @example Request syntax with placeholder values + # + # resp = client.start_metadata_generation_run({ + # client_token: "ClientToken", + # domain_identifier: "DomainId", # required + # owning_project_identifier: "ProjectId", # required + # target: { # required + # identifier: "String", # required + # revision: "Revision", + # type: "ASSET", # required, accepts ASSET + # }, + # type: "BUSINESS_DESCRIPTIONS", # required, accepts BUSINESS_DESCRIPTIONS + # }) + # + # @example Response structure + # + # resp.created_at #=> Time + # resp.created_by #=> String + # resp.domain_id #=> String + # resp.id #=> String + # resp.owning_project_id #=> String + # resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED" + # resp.type #=> String, one of "BUSINESS_DESCRIPTIONS" + # + # @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/StartMetadataGenerationRun AWS API Documentation + # + # @overload start_metadata_generation_run(params = {}) + # @param [Hash] params ({}) + def start_metadata_generation_run(params = {}, options = {}) + req = build_request(:start_metadata_generation_run, params) + req.send_request(options) + end + # Tags a resource in Amazon DataZone. # # @option params [required, String] :resource_arn # The ARN of the resource to be tagged in Amazon DataZone. # @@ -6306,10 +6857,11 @@ # type_revision: "Revision", # }, # ], # configuration: { # glue_run_configuration: { + # auto_import_data_quality_result: false, # data_access_role: "GlueRunConfigurationInputDataAccessRoleString", # relational_filter_configurations: [ # required # { # database_name: "RelationalFilterConfigurationDatabaseNameString", # required # filter_expressions: [ @@ -6370,10 +6922,11 @@ # resp.asset_forms_output[0].content #=> String # resp.asset_forms_output[0].form_name #=> String # resp.asset_forms_output[0].type_name #=> String # resp.asset_forms_output[0].type_revision #=> String # resp.configuration.glue_run_configuration.account_id #=> String + # resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean # resp.configuration.glue_run_configuration.data_access_role #=> String # resp.configuration.glue_run_configuration.region #=> String # resp.configuration.glue_run_configuration.relational_filter_configurations #=> Array # resp.configuration.glue_run_configuration.relational_filter_configurations[0].database_name #=> String # resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array @@ -7274,10 +7827,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-datazone' - context[:gem_version] = '1.4.0' + context[:gem_version] = '1.5.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated