aws_sdk_customerprofiles/client/
add_profile_key.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`AddProfileKey`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`profile_id(impl Into<String>)`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::profile_id) / [`set_profile_id(Option<String>)`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::set_profile_id):<br>required: **true**<br><p>The unique identifier of a customer profile.</p><br>
    ///   - [`key_name(impl Into<String>)`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::key_name) / [`set_key_name(Option<String>)`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::set_key_name):<br>required: **true**<br><p>A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</p><br>
    ///   - [`values(impl Into<String>)`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::values) / [`set_values(Option<Vec::<String>>)`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::set_values):<br>required: **true**<br><p>A list of key values.</p><br>
    ///   - [`domain_name(impl Into<String>)`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
    /// - On success, responds with [`AddProfileKeyOutput`](crate::operation::add_profile_key::AddProfileKeyOutput) with field(s):
    ///   - [`key_name(Option<String>)`](crate::operation::add_profile_key::AddProfileKeyOutput::key_name): <p>A searchable identifier of a customer profile.</p>
    ///   - [`values(Option<Vec::<String>>)`](crate::operation::add_profile_key::AddProfileKeyOutput::values): <p>A list of key values.</p>
    /// - On failure, responds with [`SdkError<AddProfileKeyError>`](crate::operation::add_profile_key::AddProfileKeyError)
    pub fn add_profile_key(&self) -> crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder {
        crate::operation::add_profile_key::builders::AddProfileKeyFluentBuilder::new(self.handle.clone())
    }
}