aws_sdk_customerprofiles/client/
create_domain.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
25
26
27
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateDomain`](crate::operation::create_domain::builders::CreateDomainFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_name(impl Into<String>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
    ///   - [`default_expiration_days(i32)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::default_expiration_days) / [`set_default_expiration_days(Option<i32>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::set_default_expiration_days):<br>required: **true**<br><p>The default number of days until the data within the domain expires.</p><br>
    ///   - [`default_encryption_key(impl Into<String>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::default_encryption_key) / [`set_default_encryption_key(Option<String>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::set_default_encryption_key):<br>required: **false**<br><p>The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.</p><br>
    ///   - [`dead_letter_queue_url(impl Into<String>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::dead_letter_queue_url) / [`set_dead_letter_queue_url(Option<String>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::set_dead_letter_queue_url):<br>required: **false**<br><p>The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.</p><br>
    ///   - [`matching(MatchingRequest)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::matching) / [`set_matching(Option<MatchingRequest>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::set_matching):<br>required: **false**<br><p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.</p> <p>After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p><br>
    ///   - [`rule_based_matching(RuleBasedMatchingRequest)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::rule_based_matching) / [`set_rule_based_matching(Option<RuleBasedMatchingRequest>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::set_rule_based_matching):<br>required: **false**<br><p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can download the results from S3.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_domain::builders::CreateDomainFluentBuilder::set_tags):<br>required: **false**<br><p>The tags used to organize, track, or control access for this resource.</p><br>
    /// - On success, responds with [`CreateDomainOutput`](crate::operation::create_domain::CreateDomainOutput) with field(s):
    ///   - [`domain_name(String)`](crate::operation::create_domain::CreateDomainOutput::domain_name): <p>The unique name of the domain.</p>
    ///   - [`default_expiration_days(i32)`](crate::operation::create_domain::CreateDomainOutput::default_expiration_days): <p>The default number of days until the data within the domain expires.</p>
    ///   - [`default_encryption_key(Option<String>)`](crate::operation::create_domain::CreateDomainOutput::default_encryption_key): <p>The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.</p>
    ///   - [`dead_letter_queue_url(Option<String>)`](crate::operation::create_domain::CreateDomainOutput::dead_letter_queue_url): <p>The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.</p>
    ///   - [`matching(Option<MatchingResponse>)`](crate::operation::create_domain::CreateDomainOutput::matching): <p>The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.</p> <p>After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3.</p>
    ///   - [`rule_based_matching(Option<RuleBasedMatchingResponse>)`](crate::operation::create_domain::CreateDomainOutput::rule_based_matching): <p>The process of matching duplicate profiles using the Rule-Based matching. If <code>RuleBasedMatching</code> = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the <code>RuleBasedMatchingRequest</code>. You can use the <code>ListRuleBasedMatches</code> and <code>GetSimilarProfiles</code> API to return and review the results. Also, if you have configured <code>ExportingConfig</code> in the <code>RuleBasedMatchingRequest</code>, you can download the results from S3.</p>
    ///   - [`created_at(DateTime)`](crate::operation::create_domain::CreateDomainOutput::created_at): <p>The timestamp of when the domain was created.</p>
    ///   - [`last_updated_at(DateTime)`](crate::operation::create_domain::CreateDomainOutput::last_updated_at): <p>The timestamp of when the domain was most recently edited.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_domain::CreateDomainOutput::tags): <p>The tags used to organize, track, or control access for this resource.</p>
    /// - On failure, responds with [`SdkError<CreateDomainError>`](crate::operation::create_domain::CreateDomainError)
    pub fn create_domain(&self) -> crate::operation::create_domain::builders::CreateDomainFluentBuilder {
        crate::operation::create_domain::builders::CreateDomainFluentBuilder::new(self.handle.clone())
    }
}