aws_sdk_customerprofiles/client/
get_similar_profiles.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetSimilarProfiles`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token from the previous <code>GetSimilarProfiles</code> API call.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of objects returned per page.</p><br>
    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
    ///   - [`match_type(MatchType)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::match_type) / [`set_match_type(Option<MatchType>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::set_match_type):<br>required: **true**<br><p>Specify the type of matching to get similar profiles for.</p><br>
    ///   - [`search_key(impl Into<String>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::search_key) / [`set_search_key(Option<String>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::set_search_key):<br>required: **true**<br><p>The string indicating the search key to be used.</p><br>
    ///   - [`search_value(impl Into<String>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::search_value) / [`set_search_value(Option<String>)`](crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::set_search_value):<br>required: **true**<br><p>The string based on <code>SearchKey</code> to be searched for similar profiles.</p><br>
    /// - On success, responds with [`GetSimilarProfilesOutput`](crate::operation::get_similar_profiles::GetSimilarProfilesOutput) with field(s):
    ///   - [`profile_ids(Option<Vec::<String>>)`](crate::operation::get_similar_profiles::GetSimilarProfilesOutput::profile_ids): <p>Set of <code>profileId</code>s that belong to the same matching group.</p>
    ///   - [`match_id(Option<String>)`](crate::operation::get_similar_profiles::GetSimilarProfilesOutput::match_id): <p>The string <code>matchId</code> that the similar profiles belong to.</p>
    ///   - [`match_type(Option<MatchType>)`](crate::operation::get_similar_profiles::GetSimilarProfilesOutput::match_type): <p>Specify the type of matching to get similar profiles for.</p>
    ///   - [`rule_level(Option<i32>)`](crate::operation::get_similar_profiles::GetSimilarProfilesOutput::rule_level): <p>The integer rule level that the profiles matched on.</p>
    ///   - [`confidence_score(Option<f64>)`](crate::operation::get_similar_profiles::GetSimilarProfilesOutput::confidence_score): <p>It only has value when the <code>MatchType</code> is <code>ML_BASED_MATCHING</code>.A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used as an absolute measure of matching quality.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_similar_profiles::GetSimilarProfilesOutput::next_token): <p>The pagination token from the previous <code>GetSimilarProfiles</code> API call.</p>
    /// - On failure, responds with [`SdkError<GetSimilarProfilesError>`](crate::operation::get_similar_profiles::GetSimilarProfilesError)
    pub fn get_similar_profiles(&self) -> crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder {
        crate::operation::get_similar_profiles::builders::GetSimilarProfilesFluentBuilder::new(self.handle.clone())
    }
}