Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon Connect Customer Profiles

Client for invoking operations on Amazon Connect Customer Profiles. Each operation on Amazon Connect Customer Profiles is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_customerprofiles::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_customerprofiles::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AddProfileKey operation has a Client::add_profile_key, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.add_profile_key()
    .profile_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn add_profile_key(&self) -> AddProfileKeyFluentBuilder

Constructs a fluent builder for the AddProfileKey operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of a customer profile.

    
    
  • key_name(impl Into<String>) / set_key_name(Option<String>):
    required: true
    

    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.

    
    
  • values(impl Into<String>) / set_values(Option<Vec::<String>>):
    required: true
    

    A list of key values.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with AddProfileKeyOutput with field(s):
  • key_name(Option<String>):

    A searchable identifier of a customer profile.

  • values(Option<Vec::<String>>):

    A list of key values.

• On failure, responds with SdkError<AddProfileKeyError>

impl Client

pub fn batch_get_calculated_attribute_for_profile( &self, ) -> BatchGetCalculatedAttributeForProfileFluentBuilder

Constructs a fluent builder for the BatchGetCalculatedAttributeForProfile operation.

• The fluent builder is configurable:
  • calculated_attribute_name(impl Into<String>) / set_calculated_attribute_name(Option<String>):
    required: true
    

    The unique name of the calculated attribute.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • profile_ids(impl Into<String>) / set_profile_ids(Option<Vec::<String>>):
    required: true
    

    List of unique identifiers for customer profiles to retrieve.

    
    
  • condition_overrides(ConditionOverrides) / set_condition_overrides(Option<ConditionOverrides>):
    required: false
    

    Overrides the condition block within the original calculated attribute definition.

    
    
• On success, responds with BatchGetCalculatedAttributeForProfileOutput with field(s):
  • errors(Option<Vec::<BatchGetCalculatedAttributeForProfileError>>):

    List of errors for calculated attribute values that could not be retrieved.

  • calculated_attribute_values(Option<Vec::<CalculatedAttributeValue>>):

    List of calculated attribute values retrieved.

  • condition_overrides(Option<ConditionOverrides>):

    Overrides the condition block within the original calculated attribute definition.

• On failure, responds with SdkError<BatchGetCalculatedAttributeForProfileError>

impl Client

pub fn batch_get_profile(&self) -> BatchGetProfileFluentBuilder

Constructs a fluent builder for the BatchGetProfile operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • profile_ids(impl Into<String>) / set_profile_ids(Option<Vec::<String>>):
    required: true
    

    List of unique identifiers for customer profiles to retrieve.

    
    
• On success, responds with BatchGetProfileOutput with field(s):
  • errors(Option<Vec::<BatchGetProfileError>>):

    For information about the errors that are common to all actions, see Common Errors.

  • profiles(Option<Vec::<Profile>>):

    Array of Profile Objects.

• On failure, responds with SdkError<BatchGetProfileError>

impl Client

pub fn create_calculated_attribute_definition( &self, ) -> CreateCalculatedAttributeDefinitionFluentBuilder

Constructs a fluent builder for the CreateCalculatedAttributeDefinition operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • calculated_attribute_name(impl Into<String>) / set_calculated_attribute_name(Option<String>):
    required: true
    

    The unique name of the calculated attribute.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name of the calculated attribute.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the calculated attribute.

    
    
  • attribute_details(AttributeDetails) / set_attribute_details(Option<AttributeDetails>):
    required: true
    

    Mathematical expression and a list of attribute items specified in that expression.

    
    
  • conditions(Conditions) / set_conditions(Option<Conditions>):
    required: false
    

    The conditions including range, object count, and threshold for the calculated attribute.

    
    
  • filter(Filter) / set_filter(Option<Filter>):
    required: false
    

    Defines how to filter incoming objects to include part of the Calculated Attribute.

    
    
  • statistic(Statistic) / set_statistic(Option<Statistic>):
    required: true
    

    The aggregation operation to perform for the calculated attribute.

    
    
  • use_historical_data(bool) / set_use_historical_data(Option<bool>):
    required: false
    

    Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateCalculatedAttributeDefinitionOutput with field(s):
  • calculated_attribute_name(Option<String>):

    The unique name of the calculated attribute.

  • display_name(Option<String>):

    The display name of the calculated attribute.

  • description(Option<String>):

    The description of the calculated attribute.

  • attribute_details(Option<AttributeDetails>):

    Mathematical expression and a list of attribute items specified in that expression.

  • conditions(Option<Conditions>):

    The conditions including range, object count, and threshold for the calculated attribute.

  • filter(Option<Filter>):

    The filter that was used as part of the request.

  • statistic(Option<Statistic>):

    The aggregation operation to perform for the calculated attribute.

  • created_at(Option<DateTime>):

    The timestamp of when the calculated attribute definition was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the calculated attribute definition was most recently edited.

  • use_historical_data(Option<bool>):

    Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

  • status(Option<ReadinessStatus>):

    Status of the Calculated Attribute creation (whether all historical data has been indexed.)

  • readiness(Option<Readiness>):

    Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<CreateCalculatedAttributeDefinitionError>

impl Client

pub fn create_domain(&self) -> CreateDomainFluentBuilder

Constructs a fluent builder for the CreateDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • default_expiration_days(i32) / set_default_expiration_days(Option<i32>):
    required: true
    

    The default number of days until the data within the domain expires.

    
    
  • default_encryption_key(impl Into<String>) / set_default_encryption_key(Option<String>):
    required: false
    

    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.

    
    
  • dead_letter_queue_url(impl Into<String>) / set_dead_letter_queue_url(Option<String>):
    required: false
    

    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.

    
    
  • matching(MatchingRequest) / set_matching(Option<MatchingRequest>):
    required: false
    

    The process of matching duplicate profiles. If Matching = true, 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.

    After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

    
    
  • rule_based_matching(RuleBasedMatchingRequest) / set_rule_based_matching(Option<RuleBasedMatchingRequest>):
    required: false
    

    The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

    
    
  • data_store(DataStoreRequest) / set_data_store(Option<DataStoreRequest>):
    required: false
    

    Set to true to enabled data store for this domain.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateDomainOutput with field(s):
  • domain_name(String):

    The unique name of the domain.

  • default_expiration_days(i32):

    The default number of days until the data within the domain expires.

  • default_encryption_key(Option<String>):

    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.

  • dead_letter_queue_url(Option<String>):

    The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

  • matching(Option<MatchingResponse>):

    The process of matching duplicate profiles. If Matching = true, 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.

    After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

  • rule_based_matching(Option<RuleBasedMatchingResponse>):

    The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

  • data_store(Option<DataStoreResponse>):

    The data store.

  • created_at(DateTime):

    The timestamp of when the domain was created.

  • last_updated_at(DateTime):

    The timestamp of when the domain was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<CreateDomainError>

impl Client

pub fn create_domain_layout(&self) -> CreateDomainLayoutFluentBuilder

Constructs a fluent builder for the CreateDomainLayout operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • layout_definition_name(impl Into<String>) / set_layout_definition_name(Option<String>):
    required: true
    

    The unique name of the layout.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    The description of the layout

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The display name of the layout

    
    
  • is_default(bool) / set_is_default(Option<bool>):
    required: false
    

    If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

    
    
  • layout_type(LayoutType) / set_layout_type(Option<LayoutType>):
    required: true
    

    The type of layout that can be used to view data under a Customer Profiles domain.

    
    
  • layout(impl Into<String>) / set_layout(Option<String>):
    required: true
    

    A customizable layout that can be used to view data under a Customer Profiles domain.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateDomainLayoutOutput with field(s):
  • layout_definition_name(String):

    The unique name of the layout.

  • description(String):

    The description of the layout

  • display_name(String):

    The display name of the layout

  • is_default(bool):

    If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

  • layout_type(LayoutType):

    The type of layout that can be used to view data under customer profiles domain.

  • layout(String):

    A customizable layout that can be used to view data under Customer Profiles domain.

  • version(String):

    The version used to create layout.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

  • created_at(DateTime):

    The timestamp of when the layout was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the layout was most recently updated.

• On failure, responds with SdkError<CreateDomainLayoutError>

impl Client

pub fn create_event_stream(&self) -> CreateEventStreamFluentBuilder

Constructs a fluent builder for the CreateEventStream operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • uri(impl Into<String>) / set_uri(Option<String>):
    required: true
    

    The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name

    
    
  • event_stream_name(impl Into<String>) / set_event_stream_name(Option<String>):
    required: true
    

    The name of the event stream.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateEventStreamOutput with field(s):
  • event_stream_arn(String):

    A unique identifier for the event stream.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<CreateEventStreamError>

impl Client

pub fn create_event_trigger(&self) -> CreateEventTriggerFluentBuilder

Constructs a fluent builder for the CreateEventTrigger operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • event_trigger_name(impl Into<String>) / set_event_trigger_name(Option<String>):
    required: true
    

    The unique name of the event trigger.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The unique name of the object type.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the event trigger.

    
    
  • event_trigger_conditions(EventTriggerCondition) / set_event_trigger_conditions(Option<Vec::<EventTriggerCondition>>):
    required: true
    

    A list of conditions that determine when an event should trigger the destination.

    
    
  • segment_filter(impl Into<String>) / set_segment_filter(Option<String>):
    required: false
    

    The destination is triggered only for profiles that meet the criteria of a segment definition.

    
    
  • event_trigger_limits(EventTriggerLimits) / set_event_trigger_limits(Option<EventTriggerLimits>):
    required: false
    

    Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    An array of key-value pairs to apply to this resource.

    
    
• On success, responds with CreateEventTriggerOutput with field(s):
  • event_trigger_name(Option<String>):

    The unique name of the event trigger.

  • object_type_name(Option<String>):

    The unique name of the object type.

  • description(Option<String>):

    The description of the event trigger.

  • event_trigger_conditions(Option<Vec::<EventTriggerCondition>>):

    A list of conditions that determine when an event should trigger the destination.

  • segment_filter(Option<String>):

    The destination is triggered only for profiles that meet the criteria of a segment definition.

  • event_trigger_limits(Option<EventTriggerLimits>):

    Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

  • created_at(Option<DateTime>):

    The timestamp of when the event trigger was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the event trigger was most recently updated.

  • tags(Option<HashMap::<String, String>>):

    An array of key-value pairs to apply to this resource.

• On failure, responds with SdkError<CreateEventTriggerError>

impl Client

pub fn create_integration_workflow( &self, ) -> CreateIntegrationWorkflowFluentBuilder

Constructs a fluent builder for the CreateIntegrationWorkflow operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • workflow_type(WorkflowType) / set_workflow_type(Option<WorkflowType>):
    required: true
    

    The type of workflow. The only supported value is APPFLOW_INTEGRATION.

    
    
  • integration_config(IntegrationConfig) / set_integration_config(Option<IntegrationConfig>):
    required: true
    

    Configuration data for integration workflow.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The name of the profile object type.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateIntegrationWorkflowOutput with field(s):
  • workflow_id(String):

    Unique identifier for the workflow.

  • message(String):

    A message indicating create request was received.

• On failure, responds with SdkError<CreateIntegrationWorkflowError>

impl Client

pub fn create_profile(&self) -> CreateProfileFluentBuilder

Constructs a fluent builder for the CreateProfile operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • account_number(impl Into<String>) / set_account_number(Option<String>):
    required: false
    

    An account number that you have assigned to the customer.

    
    
  • additional_information(impl Into<String>) / set_additional_information(Option<String>):
    required: false
    

    Any additional information relevant to the customer’s profile.

    
    
  • party_type(PartyType) / set_party_type(Option<PartyType>):
    required: false
    

    The type of profile used to describe the customer.

    
    
  • business_name(impl Into<String>) / set_business_name(Option<String>):
    required: false
    

    The name of the customer’s business.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    The customer’s first name.

    
    
  • middle_name(impl Into<String>) / set_middle_name(Option<String>):
    required: false
    

    The customer’s middle name.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    The customer’s last name.

    
    
  • birth_date(impl Into<String>) / set_birth_date(Option<String>):
    required: false
    

    The customer’s birth date.

    
    
  • gender(Gender) / set_gender(Option<Gender>):
    required: false
    

    The gender with which the customer identifies.

    
    
  • phone_number(impl Into<String>) / set_phone_number(Option<String>):
    required: false
    

    The customer’s phone number, which has not been specified as a mobile, home, or business number.

    
    
  • mobile_phone_number(impl Into<String>) / set_mobile_phone_number(Option<String>):
    required: false
    

    The customer’s mobile phone number.

    
    
  • home_phone_number(impl Into<String>) / set_home_phone_number(Option<String>):
    required: false
    

    The customer’s home phone number.

    
    
  • business_phone_number(impl Into<String>) / set_business_phone_number(Option<String>):
    required: false
    

    The customer’s business phone number.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: false
    

    The customer’s email address, which has not been specified as a personal or business address.

    
    
  • personal_email_address(impl Into<String>) / set_personal_email_address(Option<String>):
    required: false
    

    The customer’s personal email address.

    
    
  • business_email_address(impl Into<String>) / set_business_email_address(Option<String>):
    required: false
    

    The customer’s business email address.

    
    
  • address(Address) / set_address(Option<Address>):
    required: false
    

    A generic address associated with the customer that is not mailing, shipping, or billing.

    
    
  • shipping_address(Address) / set_shipping_address(Option<Address>):
    required: false
    

    The customer’s shipping address.

    
    
  • mailing_address(Address) / set_mailing_address(Option<Address>):
    required: false
    

    The customer’s mailing address.

    
    
  • billing_address(Address) / set_billing_address(Option<Address>):
    required: false
    

    The customer’s billing address.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    A key value pair of attributes of a customer profile.

    
    
  • party_type_string(impl Into<String>) / set_party_type_string(Option<String>):
    required: false
    

    An alternative to PartyType which accepts any string as input.

    
    
  • gender_string(impl Into<String>) / set_gender_string(Option<String>):
    required: false
    

    An alternative to Gender which accepts any string as input.

    
    
  • profile_type(ProfileType) / set_profile_type(Option<ProfileType>):
    required: false
    

    The type of the profile.

    
    
  • engagement_preferences(EngagementPreferences) / set_engagement_preferences(Option<EngagementPreferences>):
    required: false
    

    Object that defines the preferred methods of engagement, per channel.

    
    
• On success, responds with CreateProfileOutput with field(s):
  • profile_id(String):

    The unique identifier of a customer profile.

• On failure, responds with SdkError<CreateProfileError>

impl Client

pub fn create_recommender(&self) -> CreateRecommenderFluentBuilder

Constructs a fluent builder for the CreateRecommender operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • recommender_name(impl Into<String>) / set_recommender_name(Option<String>):
    required: true
    

    The name of the recommender.

    
    
  • recommender_recipe_name(RecommenderRecipeName) / set_recommender_recipe_name(Option<RecommenderRecipeName>):
    required: true
    

    The name of the recommeder recipe.

    
    
  • recommender_config(RecommenderConfig) / set_recommender_config(Option<RecommenderConfig>):
    required: false
    

    The recommender configuration.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the domain object type.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateRecommenderOutput with field(s):
  • recommender_arn(String):

    The ARN of the recommender

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<CreateRecommenderError>

impl Client

pub fn create_segment_definition(&self) -> CreateSegmentDefinitionFluentBuilder

Constructs a fluent builder for the CreateSegmentDefinition operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • segment_definition_name(impl Into<String>) / set_segment_definition_name(Option<String>):
    required: true
    

    The unique name of the segment definition.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The display name of the segment definition.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the segment definition.

    
    
  • segment_groups(SegmentGroup) / set_segment_groups(Option<SegmentGroup>):
    required: false
    

    Specifies the base segments and dimensions for a segment definition along with their respective relationship.

    
    
  • segment_sql_query(impl Into<String>) / set_segment_sql_query(Option<String>):
    required: false
    

    The segment SQL query.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateSegmentDefinitionOutput with field(s):
  • segment_definition_name(String):

    The name of the segment definition.

  • display_name(Option<String>):

    The display name of the segment definition.

  • description(Option<String>):

    The description of the segment definition.

  • created_at(Option<DateTime>):

    The timestamp of when the segment definition was created.

  • segment_definition_arn(Option<String>):

    The arn of the segment definition.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<CreateSegmentDefinitionError>

impl Client

pub fn create_segment_estimate(&self) -> CreateSegmentEstimateFluentBuilder

Constructs a fluent builder for the CreateSegmentEstimate operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • segment_query(SegmentGroupStructure) / set_segment_query(Option<SegmentGroupStructure>):
    required: false
    

    The segment query for calculating a segment estimate.

    
    
  • segment_sql_query(impl Into<String>) / set_segment_sql_query(Option<String>):
    required: false
    

    The segment SQL query.

    
    
• On success, responds with CreateSegmentEstimateOutput with field(s):
  • domain_name(Option<String>):

    The unique name of the domain.

  • estimate_id(Option<String>):

    A unique identifier for the resource. The value can be passed to GetSegmentEstimate to retrieve the result of segment estimate status.

  • status_code(i32):

    The status code for the response.

• On failure, responds with SdkError<CreateSegmentEstimateError>

impl Client

pub fn create_segment_snapshot(&self) -> CreateSegmentSnapshotFluentBuilder

Constructs a fluent builder for the CreateSegmentSnapshot operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • segment_definition_name(impl Into<String>) / set_segment_definition_name(Option<String>):
    required: true
    

    The name of the segment definition used in this snapshot request.

    
    
  • data_format(DataFormat) / set_data_format(Option<DataFormat>):
    required: true
    

    The format in which the segment will be exported.

    
    
  • encryption_key(impl Into<String>) / set_encryption_key(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.

    
    
  • destination_uri(impl Into<String>) / set_destination_uri(Option<String>):
    required: false
    

    The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.

    
    
• On success, responds with CreateSegmentSnapshotOutput with field(s):
  • snapshot_id(String):

    The unique identifier of the segment snapshot.

• On failure, responds with SdkError<CreateSegmentSnapshotError>

impl Client

pub fn create_upload_job(&self) -> CreateUploadJobFluentBuilder

Constructs a fluent builder for the CreateUploadJob operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain. Domain should be exists for the upload job to be created.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The unique name of the upload job. Could be a file name to identify the upload job.

    
    
  • fields(impl Into<String>, ObjectTypeField) / set_fields(Option<HashMap::<String, ObjectTypeField>>):
    required: true
    

    The mapping between CSV Columns and Profile Object attributes. A map of the name and ObjectType field.

    
    
  • unique_key(impl Into<String>) / set_unique_key(Option<String>):
    required: true
    

    The unique key columns for de-duping the profiles used to map data to the profile.

    
    
  • data_expiry(i32) / set_data_expiry(Option<i32>):
    required: false
    

    The expiry duration for the profiles ingested with the job. If not provided, the system default of 2 weeks is used.

    
    
• On success, responds with CreateUploadJobOutput with field(s):
  • job_id(String):

    The unique identifier for the created upload job.

• On failure, responds with SdkError<CreateUploadJobError>

impl Client

pub fn delete_calculated_attribute_definition( &self, ) -> DeleteCalculatedAttributeDefinitionFluentBuilder

Constructs a fluent builder for the DeleteCalculatedAttributeDefinition operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • calculated_attribute_name(impl Into<String>) / set_calculated_attribute_name(Option<String>):
    required: true
    

    The unique name of the calculated attribute.

    
    
• On success, responds with DeleteCalculatedAttributeDefinitionOutput
• On failure, responds with SdkError<DeleteCalculatedAttributeDefinitionError>

impl Client

pub fn delete_domain(&self) -> DeleteDomainFluentBuilder

Constructs a fluent builder for the DeleteDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with DeleteDomainOutput with field(s):
  • message(String):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteDomainError>

impl Client

pub fn delete_domain_layout(&self) -> DeleteDomainLayoutFluentBuilder

Constructs a fluent builder for the DeleteDomainLayout operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • layout_definition_name(impl Into<String>) / set_layout_definition_name(Option<String>):
    required: true
    

    The unique name of the layout.

    
    
• On success, responds with DeleteDomainLayoutOutput with field(s):
  • message(String):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteDomainLayoutError>

impl Client

pub fn delete_domain_object_type(&self) -> DeleteDomainObjectTypeFluentBuilder

Constructs a fluent builder for the DeleteDomainObjectType operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The unique name of the domain object type.

    
    
• On success, responds with DeleteDomainObjectTypeOutput
• On failure, responds with SdkError<DeleteDomainObjectTypeError>

impl Client

pub fn delete_event_stream(&self) -> DeleteEventStreamFluentBuilder

Constructs a fluent builder for the DeleteEventStream operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • event_stream_name(impl Into<String>) / set_event_stream_name(Option<String>):
    required: true
    

    The name of the event stream

    
    
• On success, responds with DeleteEventStreamOutput
• On failure, responds with SdkError<DeleteEventStreamError>

impl Client

pub fn delete_event_trigger(&self) -> DeleteEventTriggerFluentBuilder

Constructs a fluent builder for the DeleteEventTrigger operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • event_trigger_name(impl Into<String>) / set_event_trigger_name(Option<String>):
    required: true
    

    The unique name of the event trigger.

    
    
• On success, responds with DeleteEventTriggerOutput with field(s):
  • message(String):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteEventTriggerError>

impl Client

pub fn delete_integration(&self) -> DeleteIntegrationFluentBuilder

Constructs a fluent builder for the DeleteIntegration operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • uri(impl Into<String>) / set_uri(Option<String>):
    required: true
    

    The URI of the S3 bucket or any other type of data source.

    
    
• On success, responds with DeleteIntegrationOutput with field(s):
  • message(String):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteIntegrationError>

impl Client

pub fn delete_profile(&self) -> DeleteProfileFluentBuilder

Constructs a fluent builder for the DeleteProfile operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of a customer profile.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with DeleteProfileOutput with field(s):
  • message(Option<String>):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteProfileError>

impl Client

pub fn delete_profile_key(&self) -> DeleteProfileKeyFluentBuilder

Constructs a fluent builder for the DeleteProfileKey operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of a customer profile.

    
    
  • key_name(impl Into<String>) / set_key_name(Option<String>):
    required: true
    

    A searchable identifier of a customer profile.

    
    
  • values(impl Into<String>) / set_values(Option<Vec::<String>>):
    required: true
    

    A list of key values.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with DeleteProfileKeyOutput with field(s):
  • message(Option<String>):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteProfileKeyError>

impl Client

pub fn delete_profile_object(&self) -> DeleteProfileObjectFluentBuilder

Constructs a fluent builder for the DeleteProfileObject operation.

• The fluent builder is configurable:
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of a customer profile.

    
    
  • profile_object_unique_key(impl Into<String>) / set_profile_object_unique_key(Option<String>):
    required: true
    

    The unique identifier of the profile object generated by the service.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The name of the profile object type.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with DeleteProfileObjectOutput with field(s):
  • message(Option<String>):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteProfileObjectError>

impl Client

pub fn delete_profile_object_type(&self) -> DeleteProfileObjectTypeFluentBuilder

Constructs a fluent builder for the DeleteProfileObjectType operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The name of the profile object type.

    
    
• On success, responds with DeleteProfileObjectTypeOutput with field(s):
  • message(String):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteProfileObjectTypeError>

impl Client

pub fn delete_recommender(&self) -> DeleteRecommenderFluentBuilder

Constructs a fluent builder for the DeleteRecommender operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • recommender_name(impl Into<String>) / set_recommender_name(Option<String>):
    required: true
    

    The recommender name.

    
    
• On success, responds with DeleteRecommenderOutput
• On failure, responds with SdkError<DeleteRecommenderError>

impl Client

pub fn delete_segment_definition(&self) -> DeleteSegmentDefinitionFluentBuilder

Constructs a fluent builder for the DeleteSegmentDefinition operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • segment_definition_name(impl Into<String>) / set_segment_definition_name(Option<String>):
    required: true
    

    The unique name of the segment definition.

    
    
• On success, responds with DeleteSegmentDefinitionOutput with field(s):
  • message(Option<String>):

    A message that indicates the delete request is done.

• On failure, responds with SdkError<DeleteSegmentDefinitionError>

impl Client

pub fn delete_workflow(&self) -> DeleteWorkflowFluentBuilder

Constructs a fluent builder for the DeleteWorkflow operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    Unique identifier for the workflow.

    
    
• On success, responds with DeleteWorkflowOutput
• On failure, responds with SdkError<DeleteWorkflowError>

impl Client

pub fn detect_profile_object_type(&self) -> DetectProfileObjectTypeFluentBuilder

Constructs a fluent builder for the DetectProfileObjectType operation.

• The fluent builder is configurable:
  • objects(impl Into<String>) / set_objects(Option<Vec::<String>>):
    required: true
    

    A string that is serialized from a JSON object.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with DetectProfileObjectTypeOutput with field(s):
  • detected_profile_object_types(Option<Vec::<DetectedProfileObjectType>>):

    Detected ProfileObjectType mappings from given objects. A maximum of one mapping is supported.

• On failure, responds with SdkError<DetectProfileObjectTypeError>

impl Client

pub fn get_auto_merging_preview(&self) -> GetAutoMergingPreviewFluentBuilder

Constructs a fluent builder for the GetAutoMergingPreview operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • consolidation(Consolidation) / set_consolidation(Option<Consolidation>):
    required: true
    

    A list of matching attributes that represent matching criteria.

    
    
  • conflict_resolution(ConflictResolution) / set_conflict_resolution(Option<ConflictResolution>):
    required: true
    

    How the auto-merging process should resolve conflicts between different profiles.

    
    
  • min_allowed_confidence_score_for_merging(f64) / set_min_allowed_confidence_score_for_merging(Option<f64>):
    required: false
    

    Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.

    
    
• On success, responds with GetAutoMergingPreviewOutput with field(s):
  • domain_name(String):

    The unique name of the domain.

  • number_of_matches_in_sample(i64):

    The number of match groups in the domain that have been reviewed in this preview dry run.

  • number_of_profiles_in_sample(i64):

    The number of profiles found in this preview dry run.

  • number_of_profiles_will_be_merged(i64):

    The number of profiles that would be merged if this wasn’t a preview dry run.

• On failure, responds with SdkError<GetAutoMergingPreviewError>

impl Client

pub fn get_calculated_attribute_definition( &self, ) -> GetCalculatedAttributeDefinitionFluentBuilder

Constructs a fluent builder for the GetCalculatedAttributeDefinition operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • calculated_attribute_name(impl Into<String>) / set_calculated_attribute_name(Option<String>):
    required: true
    

    The unique name of the calculated attribute.

    
    
• On success, responds with GetCalculatedAttributeDefinitionOutput with field(s):
  • calculated_attribute_name(Option<String>):

    The unique name of the calculated attribute.

  • display_name(Option<String>):

    The display name of the calculated attribute.

  • description(Option<String>):

    The description of the calculated attribute.

  • created_at(Option<DateTime>):

    The timestamp of when the calculated attribute definition was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the calculated attribute definition was most recently edited.

  • statistic(Option<Statistic>):

    The aggregation operation to perform for the calculated attribute.

  • filter(Option<Filter>):

    The filter assigned to this calculated attribute definition.

  • conditions(Option<Conditions>):

    The conditions including range, object count, and threshold for the calculated attribute.

  • attribute_details(Option<AttributeDetails>):

    Mathematical expression and a list of attribute items specified in that expression.

  • use_historical_data(Option<bool>):

    Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

  • status(Option<ReadinessStatus>):

    Status of the Calculated Attribute creation (whether all historical data has been indexed).

  • readiness(Option<Readiness>):

    Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetCalculatedAttributeDefinitionError>

impl Client

pub fn get_calculated_attribute_for_profile( &self, ) -> GetCalculatedAttributeForProfileFluentBuilder

Constructs a fluent builder for the GetCalculatedAttributeForProfile operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of a customer profile.

    
    
  • calculated_attribute_name(impl Into<String>) / set_calculated_attribute_name(Option<String>):
    required: true
    

    The unique name of the calculated attribute.

    
    
• On success, responds with GetCalculatedAttributeForProfileOutput with field(s):
  • calculated_attribute_name(Option<String>):

    The unique name of the calculated attribute.

  • display_name(Option<String>):

    The display name of the calculated attribute.

  • is_data_partial(Option<String>):

    Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.

  • value(Option<String>):

    The value of the calculated attribute.

  • last_object_timestamp(Option<DateTime>):

    The timestamp of the newest object included in the calculated attribute calculation.

• On failure, responds with SdkError<GetCalculatedAttributeForProfileError>

impl Client

pub fn get_domain(&self) -> GetDomainFluentBuilder

Constructs a fluent builder for the GetDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with GetDomainOutput with field(s):
  • domain_name(String):

    The unique name of the domain.

  • default_expiration_days(Option<i32>):

    The default number of days until the data within the domain expires.

  • default_encryption_key(Option<String>):

    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.

  • dead_letter_queue_url(Option<String>):

    The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

  • stats(Option<DomainStats>):

    Usage-specific statistics about the domain.

  • matching(Option<MatchingResponse>):

    The process of matching duplicate profiles. If Matching = true, 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.

    After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

  • rule_based_matching(Option<RuleBasedMatchingResponse>):

    The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

  • data_store(Option<DataStoreResponse>):

    True if data store is enabled for this domain.

  • created_at(DateTime):

    The timestamp of when the domain was created.

  • last_updated_at(DateTime):

    The timestamp of when the domain was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetDomainError>

impl Client

pub fn get_domain_layout(&self) -> GetDomainLayoutFluentBuilder

Constructs a fluent builder for the GetDomainLayout operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • layout_definition_name(impl Into<String>) / set_layout_definition_name(Option<String>):
    required: true
    

    The unique name of the layout.

    
    
• On success, responds with GetDomainLayoutOutput with field(s):
  • layout_definition_name(String):

    The unique name of the layout.

  • description(String):

    The description of the layout

  • display_name(String):

    The display name of the layout

  • is_default(bool):

    If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

  • layout_type(LayoutType):

    The type of layout that can be used to view data under a Customer Profiles domain.

  • layout(String):

    A customizable layout that can be used to view data under a Customer Profiles domain.

  • version(String):

    The version used to create layout.

  • created_at(DateTime):

    The timestamp of when the layout was created.

  • last_updated_at(DateTime):

    The timestamp of when the layout was most recently updated.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetDomainLayoutError>

impl Client

pub fn get_domain_object_type(&self) -> GetDomainObjectTypeFluentBuilder

Constructs a fluent builder for the GetDomainObjectType operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The unique name of the domain object type.

    
    
• On success, responds with GetDomainObjectTypeOutput with field(s):
  • object_type_name(String):

    The unique name of the domain object type.

  • description(Option<String>):

    The description of the domain object type.

  • encryption_key(Option<String>):

    The customer provided KMS key used to encrypt this type of domain object.

  • fields(Option<HashMap::<String, DomainObjectTypeField>>):

    A map of field names to their corresponding domain object type field definitions.

  • created_at(Option<DateTime>):

    The timestamp of when the domain object type was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the domain object type was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetDomainObjectTypeError>

impl Client

pub fn get_event_stream(&self) -> GetEventStreamFluentBuilder

Constructs a fluent builder for the GetEventStream operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • event_stream_name(impl Into<String>) / set_event_stream_name(Option<String>):
    required: true
    

    The name of the event stream provided during create operations.

    
    
• On success, responds with GetEventStreamOutput with field(s):
  • domain_name(String):

    The unique name of the domain.

  • event_stream_arn(String):

    A unique identifier for the event stream.

  • created_at(DateTime):

    The timestamp of when the export was created.

  • state(EventStreamState):

    The operational state of destination stream for export.

  • stopped_since(Option<DateTime>):

    The timestamp when the State changed to STOPPED.

  • destination_details(Option<EventStreamDestinationDetails>):

    Details regarding the Kinesis stream.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetEventStreamError>

impl Client

pub fn get_event_trigger(&self) -> GetEventTriggerFluentBuilder

Constructs a fluent builder for the GetEventTrigger operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • event_trigger_name(impl Into<String>) / set_event_trigger_name(Option<String>):
    required: true
    

    The unique name of the event trigger.

    
    
• On success, responds with GetEventTriggerOutput with field(s):
  • event_trigger_name(Option<String>):

    The unique name of the event trigger.

  • object_type_name(Option<String>):

    The unique name of the object type.

  • description(Option<String>):

    The description of the event trigger.

  • event_trigger_conditions(Option<Vec::<EventTriggerCondition>>):

    A list of conditions that determine when an event should trigger the destination.

  • segment_filter(Option<String>):

    The destination is triggered only for profiles that meet the criteria of a segment definition.

  • event_trigger_limits(Option<EventTriggerLimits>):

    Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

  • created_at(Option<DateTime>):

    The timestamp of when the event trigger was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the event trigger was most recently updated.

  • tags(Option<HashMap::<String, String>>):

    An array of key-value pairs to apply to this resource.

• On failure, responds with SdkError<GetEventTriggerError>

impl Client

pub fn get_identity_resolution_job( &self, ) -> GetIdentityResolutionJobFluentBuilder

Constructs a fluent builder for the GetIdentityResolutionJob operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier of the Identity Resolution Job.

    
    
• On success, responds with GetIdentityResolutionJobOutput with field(s):
  • domain_name(Option<String>):

    The unique name of the domain.

  • job_id(Option<String>):

    The unique identifier of the Identity Resolution Job.

  • status(Option<IdentityResolutionJobStatus>):

    The status of the Identity Resolution Job.

    • PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.

    • PREPROCESSING: The Identity Resolution Job is loading your data.

    • FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.

    • MERGING: The Identity Resolution Job is merging duplicate profiles.

    • COMPLETED: The Identity Resolution Job completed successfully.

    • PARTIAL_SUCCESS: There’s a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.

    • FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.

  • message(Option<String>):

    The error messages that are generated when the Identity Resolution Job runs.

  • job_start_time(Option<DateTime>):

    The timestamp of when the Identity Resolution Job was started or will be started.

  • job_end_time(Option<DateTime>):

    The timestamp of when the Identity Resolution Job was completed.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the Identity Resolution Job was most recently edited.

  • job_expiration_time(Option<DateTime>):

    The timestamp of when the Identity Resolution Job will expire.

  • auto_merging(Option<AutoMerging>):

    Configuration settings for how to perform the auto-merging of profiles.

  • exporting_location(Option<ExportingLocation>):

    The S3 location where the Identity Resolution Job writes result files.

  • job_stats(Option<JobStats>):

    Statistics about the Identity Resolution Job.

• On failure, responds with SdkError<GetIdentityResolutionJobError>

impl Client

pub fn get_integration(&self) -> GetIntegrationFluentBuilder

Constructs a fluent builder for the GetIntegration operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • uri(impl Into<String>) / set_uri(Option<String>):
    required: true
    

    The URI of the S3 bucket or any other type of data source.

    
    
• On success, responds with GetIntegrationOutput with field(s):
  • domain_name(String):

    The unique name of the domain.

  • uri(String):

    The URI of the S3 bucket or any other type of data source.

  • object_type_name(Option<String>):

    The name of the profile object type.

  • created_at(DateTime):

    The timestamp of when the domain was created.

  • last_updated_at(DateTime):

    The timestamp of when the domain was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

  • object_type_names(Option<HashMap::<String, String>>):

    A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

  • workflow_id(Option<String>):

    Unique identifier for the workflow.

  • is_unstructured(Option<bool>):

    Boolean that shows if the Flow that’s associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.

  • role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.

  • event_trigger_names(Option<Vec::<String>>):

    A list of unique names for active event triggers associated with the integration. This list would be empty if no Event Trigger is associated with the integration.

  • scope(Option<Scope>):

    Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.

• On failure, responds with SdkError<GetIntegrationError>

impl Client

pub fn get_matches(&self) -> GetMatchesFluentBuilder

Constructs a fluent builder for the GetMatches operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with GetMatchesOutput with field(s):
  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

  • match_generation_date(Option<DateTime>):

    The timestamp this version of Match Result generated.

  • potential_matches(Option<i32>):

    The number of potential matches found.

  • matches(Option<Vec::<MatchItem>>):

    The list of matched profiles for this instance.

• On failure, responds with SdkError<GetMatchesError>

impl Client

pub fn get_object_type_attribute_statistics( &self, ) -> GetObjectTypeAttributeStatisticsFluentBuilder

Constructs a fluent builder for the GetObjectTypeAttributeStatistics operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The unique name of the domain object type.

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: true
    

    The attribute name.

    
    
• On success, responds with GetObjectTypeAttributeStatisticsOutput with field(s):
  • statistics(Option<GetObjectTypeAttributeStatisticsStats>):

    The statistics.

  • calculated_at(DateTime):

    Time when this statistics was calculated.

• On failure, responds with SdkError<GetObjectTypeAttributeStatisticsError>

impl Client

pub fn get_profile_history_record(&self) -> GetProfileHistoryRecordFluentBuilder

Constructs a fluent builder for the GetProfileHistoryRecord operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain for which to return a profile history record.

    
    
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of the profile for which to return a history record.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of the profile history record to return.

    
    
• On success, responds with GetProfileHistoryRecordOutput with field(s):
  • id(String):

    The unique identifier of the profile history record.

  • object_type_name(String):

    The name of the profile object type.

  • created_at(DateTime):

    The timestamp of when the profile history record was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the profile history record was last updated.

  • action_type(ActionType):

    The action type of the profile history record.

  • profile_object_unique_key(Option<String>):

    The unique identifier of the profile object generated by the service.

  • content(Option<String>):

    A string containing the customer profile, profile object, or profile key content.

  • performed_by(Option<String>):

    The Amazon Resource Name (ARN) of the person or service principal who performed the action.

• On failure, responds with SdkError<GetProfileHistoryRecordError>

impl Client

pub fn get_profile_object_type(&self) -> GetProfileObjectTypeFluentBuilder

Constructs a fluent builder for the GetProfileObjectType operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The name of the profile object type.

    
    
• On success, responds with GetProfileObjectTypeOutput with field(s):
  • object_type_name(String):

    The name of the profile object type.

  • description(String):

    The description of the profile object type.

  • template_id(Option<String>):

    A unique identifier for the object template.

  • expiration_days(Option<i32>):

    The number of days until the data in the object expires.

  • encryption_key(Option<String>):

    The customer-provided key to encrypt the profile object that will be created in this profile object type.

  • allow_profile_creation(bool):

    Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

  • source_last_updated_timestamp_format(Option<String>):

    The format of your sourceLastUpdatedTimestamp that was previously set up.

  • max_available_profile_object_count(Option<i32>):

    The amount of provisioned profile object max count available.

  • max_profile_object_count(Option<i32>):

    The amount of profile object max count assigned to the object type.

  • fields(Option<HashMap::<String, ObjectTypeField>>):

    A map of the name and ObjectType field.

  • keys(Option<HashMap::<String, Vec::<ObjectTypeKey>>>):

    A list of unique keys that can be used to map data to the profile.

  • created_at(Option<DateTime>):

    The timestamp of when the domain was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the domain was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetProfileObjectTypeError>

impl Client

pub fn get_profile_object_type_template( &self, ) -> GetProfileObjectTypeTemplateFluentBuilder

Constructs a fluent builder for the GetProfileObjectTypeTemplate operation.

• The fluent builder is configurable:
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: true
    

    A unique identifier for the object template.

    
    
• On success, responds with GetProfileObjectTypeTemplateOutput with field(s):
  • template_id(Option<String>):

    A unique identifier for the object template.

  • source_name(Option<String>):

    The name of the source of the object template.

  • source_object(Option<String>):

    The source of the object template.

  • allow_profile_creation(bool):

    Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

  • source_last_updated_timestamp_format(Option<String>):

    The format of your sourceLastUpdatedTimestamp that was previously set up.

  • fields(Option<HashMap::<String, ObjectTypeField>>):

    A map of the name and ObjectType field.

  • keys(Option<HashMap::<String, Vec::<ObjectTypeKey>>>):

    A list of unique keys that can be used to map data to the profile.

• On failure, responds with SdkError<GetProfileObjectTypeTemplateError>

impl Client

pub fn get_profile_recommendations( &self, ) -> GetProfileRecommendationsFluentBuilder

Constructs a fluent builder for the GetProfileRecommendations operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of the profile for which to retrieve recommendations.

    
    
  • recommender_name(impl Into<String>) / set_recommender_name(Option<String>):
    required: true
    

    The unique name of the recommender.

    
    
  • context(impl Into<String>, impl Into<String>) / set_context(Option<HashMap::<String, String>>):
    required: false
    

    The contextual metadata used to provide dynamic runtime information to tailor recommendations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of recommendations to return. The default value is 10.

    
    
• On success, responds with GetProfileRecommendationsOutput with field(s):
  • recommendations(Option<Vec::<Recommendation>>):

    List of recommendations generated by the recommender.

• On failure, responds with SdkError<GetProfileRecommendationsError>

impl Client

pub fn get_recommender(&self) -> GetRecommenderFluentBuilder

Constructs a fluent builder for the GetRecommender operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • recommender_name(impl Into<String>) / set_recommender_name(Option<String>):
    required: true
    

    The name of the recommender.

    
    
  • training_metrics_count(i32) / set_training_metrics_count(Option<i32>):
    required: false
    

    The number of training metrics to retrieve for the recommender.

    
    
• On success, responds with GetRecommenderOutput with field(s):
  • recommender_name(String):

    The name of the recommender.

  • recommender_recipe_name(RecommenderRecipeName):

    The name of the recipe used by the recommender to generate recommendations.

  • recommender_config(Option<RecommenderConfig>):

    The configuration settings for the recommender, including parameters and settings that define its behavior.

  • description(Option<String>):

    A detailed description of the recommender providing information about its purpose and functionality.

  • status(Option<RecommenderStatus>):

    The current status of the recommender, indicating whether it is active, creating, updating, or in another state.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the recommender was edited.

  • created_at(Option<DateTime>):

    The timestamp of when the recommender was created.

  • failure_reason(Option<String>):

    If the recommender fails, provides the reason for the failure.

  • latest_recommender_update(Option<RecommenderUpdate>):

    Information about the most recent update performed on the recommender, including status and timestamp.

  • training_metrics(Option<Vec::<TrainingMetrics>>):

    A set of metrics that provide information about the recommender’s training performance and accuracy.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetRecommenderError>

impl Client

pub fn get_segment_definition(&self) -> GetSegmentDefinitionFluentBuilder

Constructs a fluent builder for the GetSegmentDefinition operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • segment_definition_name(impl Into<String>) / set_segment_definition_name(Option<String>):
    required: true
    

    The unique name of the segment definition.

    
    
• On success, responds with GetSegmentDefinitionOutput with field(s):
  • segment_definition_name(Option<String>):

    The name of the segment definition.

  • display_name(Option<String>):

    The display name of the segment definition.

  • description(Option<String>):

    The description of the segment definition.

  • segment_groups(Option<SegmentGroup>):

    The segment criteria associated with this definition.

  • segment_definition_arn(String):

    The arn of the segment definition.

  • created_at(Option<DateTime>):

    The timestamp of when the segment definition was created.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

  • segment_sql_query(Option<String>):

    The segment SQL query.

  • segment_type(Option<SegmentType>):

    The segment type.

    Classic : Segments created using traditional SegmentGroup structure

    Enhanced : Segments created using SQL queries

• On failure, responds with SdkError<GetSegmentDefinitionError>

impl Client

pub fn get_segment_estimate(&self) -> GetSegmentEstimateFluentBuilder

Constructs a fluent builder for the GetSegmentEstimate operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • estimate_id(impl Into<String>) / set_estimate_id(Option<String>):
    required: true
    

    The query Id passed by a previous CreateSegmentEstimate operation.

    
    
• On success, responds with GetSegmentEstimateOutput with field(s):
  • domain_name(Option<String>):

    The unique name of the domain.

  • estimate_id(Option<String>):

    The QueryId which is the same as the value passed in QueryId.

  • status(Option<EstimateStatus>):

    The current status of the query.

  • estimate(Option<String>):

    The estimated number of profiles contained in the segment.

  • message(Option<String>):

    The error message if there is any error.

  • status_code(i32):

    The status code of the segment estimate.

• On failure, responds with SdkError<GetSegmentEstimateError>

impl Client

pub fn get_segment_membership(&self) -> GetSegmentMembershipFluentBuilder

Constructs a fluent builder for the GetSegmentMembership operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • segment_definition_name(impl Into<String>) / set_segment_definition_name(Option<String>):
    required: true
    

    The Id of the wanted segment. Needs to be a valid, and existing segment Id.

    
    
  • profile_ids(impl Into<String>) / set_profile_ids(Option<Vec::<String>>):
    required: true
    

    The list of profile IDs to query for.

    
    
• On success, responds with GetSegmentMembershipOutput with field(s):
  • segment_definition_name(Option<String>):

    The unique name of the segment definition.

  • profiles(Option<Vec::<ProfileQueryResult>>):

    An array of maps where each contains a response per profile requested.

  • failures(Option<Vec::<ProfileQueryFailures>>):

    An array of maps where each contains a response per profile failed for the request.

  • last_computed_at(Option<DateTime>):

    The timestamp indicating when the segment membership was last computed or updated.

• On failure, responds with SdkError<GetSegmentMembershipError>

impl Client

pub fn get_segment_snapshot(&self) -> GetSegmentSnapshotFluentBuilder

Constructs a fluent builder for the GetSegmentSnapshot operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique identifier of the domain.

    
    
  • segment_definition_name(impl Into<String>) / set_segment_definition_name(Option<String>):
    required: true
    

    The unique name of the segment definition.

    
    
  • snapshot_id(impl Into<String>) / set_snapshot_id(Option<String>):
    required: true
    

    The unique identifier of the segment snapshot.

    
    
• On success, responds with GetSegmentSnapshotOutput with field(s):
  • snapshot_id(String):

    The unique identifier of the segment snapshot.

  • status(SegmentSnapshotStatus):

    The status of the asynchronous job for exporting the segment snapshot.

  • status_message(Option<String>):

    The status message of the asynchronous job for exporting the segment snapshot.

  • data_format(DataFormat):

    The format in which the segment will be exported.

  • encryption_key(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.

  • role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.

  • destination_uri(Option<String>):

    The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.

• On failure, responds with SdkError<GetSegmentSnapshotError>

impl Client

pub fn get_similar_profiles(&self) -> GetSimilarProfilesFluentBuilder

Constructs a fluent builder for the GetSimilarProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous GetSimilarProfiles API call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • match_type(MatchType) / set_match_type(Option<MatchType>):
    required: true
    

    Specify the type of matching to get similar profiles for.

    
    
  • search_key(impl Into<String>) / set_search_key(Option<String>):
    required: true
    

    The string indicating the search key to be used.

    
    
  • search_value(impl Into<String>) / set_search_value(Option<String>):
    required: true
    

    The string based on SearchKey to be searched for similar profiles.

    
    
• On success, responds with GetSimilarProfilesOutput with field(s):
  • profile_ids(Option<Vec::<String>>):

    Set of profileIds that belong to the same matching group.

  • match_id(Option<String>):

    The string matchId that the similar profiles belong to.

  • match_type(Option<MatchType>):

    Specify the type of matching to get similar profiles for.

  • rule_level(Option<i32>):

    The integer rule level that the profiles matched on.

  • confidence_score(Option<f64>):

    It only has value when the MatchType is ML_BASED_MATCHING.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.

  • next_token(Option<String>):

    The pagination token from the previous GetSimilarProfiles API call.

• On failure, responds with SdkError<GetSimilarProfilesError>

impl Client

pub fn get_upload_job(&self) -> GetUploadJobFluentBuilder

Constructs a fluent builder for the GetUploadJob operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain containing the upload job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier of the upload job to retrieve.

    
    
• On success, responds with GetUploadJobOutput with field(s):
  • job_id(Option<String>):

    The unique identifier of the upload job.

  • display_name(Option<String>):

    The unique name of the upload job. Could be a file name to identify the upload job.

  • status(Option<UploadJobStatus>):

    The status describing the status for the upload job. The following are Valid Values:

    • CREATED: The upload job has been created, but has not started processing yet.

    • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

    • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

    • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

    • FAILED: The upload job has failed to complete.

    • STOPPED: The upload job has been manually stopped or terminated before completion.

  • status_reason(Option<StatusReason>):

    The reason for the current status of the upload job. Possible reasons:

    • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

    • INTERNAL_FAILURE: Failure caused from service side

  • created_at(Option<DateTime>):

    The timestamp when the upload job was created.

  • completed_at(Option<DateTime>):

    The timestamp when the upload job was completed.

  • fields(Option<HashMap::<String, ObjectTypeField>>):

    The mapping between CSV Columns and Profile Object attributes for the upload job.

  • unique_key(Option<String>):

    The unique key columns used for de-duping the keys in the upload job.

  • results_summary(Option<ResultsSummary>):

    The summary of results for the upload job, including the number of updated, created, and failed records.

  • data_expiry(Option<i32>):

    The expiry duration for the profiles ingested with the upload job.

• On failure, responds with SdkError<GetUploadJobError>

impl Client

pub fn get_upload_job_path(&self) -> GetUploadJobPathFluentBuilder

Constructs a fluent builder for the GetUploadJobPath operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain containing the upload job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier of the upload job to retrieve the upload path for. This is generated from the CreateUploadJob API.

    
    
• On success, responds with GetUploadJobPathOutput with field(s):
  • url(String):

    The pre-signed S3 URL for uploading the CSV file associated with the upload job.

  • client_token(Option<String>):

    The plaintext data key used to encrypt the upload file.

    To persist to the pre-signed url, use the client token and MD5 client token as header. The required headers are as follows:

    • x-amz-server-side-encryption-customer-key: Client Token

    • x-amz-server-side-encryption-customer-key-MD5: MD5 Client Token

    • x-amz-server-side-encryption-customer-algorithm: AES256

  • valid_until(Option<DateTime>):

    The expiry timestamp for the pre-signed URL, after which the URL will no longer be valid.

• On failure, responds with SdkError<GetUploadJobPathError>

impl Client

pub fn get_workflow(&self) -> GetWorkflowFluentBuilder

Constructs a fluent builder for the GetWorkflow operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    Unique identifier for the workflow.

    
    
• On success, responds with GetWorkflowOutput with field(s):
  • workflow_id(Option<String>):

    Unique identifier for the workflow.

  • workflow_type(Option<WorkflowType>):

    The type of workflow. The only supported value is APPFLOW_INTEGRATION.

  • status(Option<Status>):

    Status of workflow execution.

  • error_description(Option<String>):

    Workflow error messages during execution (if any).

  • start_date(Option<DateTime>):

    The timestamp that represents when workflow execution started.

  • last_updated_at(Option<DateTime>):

    The timestamp that represents when workflow execution last updated.

  • attributes(Option<WorkflowAttributes>):

    Attributes provided for workflow execution.

  • metrics(Option<WorkflowMetrics>):

    Workflow specific execution metrics.

• On failure, responds with SdkError<GetWorkflowError>

impl Client

pub fn get_workflow_steps(&self) -> GetWorkflowStepsFluentBuilder

Constructs a fluent builder for the GetWorkflowSteps operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    Unique identifier for the workflow.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with GetWorkflowStepsOutput with field(s):
  • workflow_id(Option<String>):

    Unique identifier for the workflow.

  • workflow_type(Option<WorkflowType>):

    The type of workflow. The only supported value is APPFLOW_INTEGRATION.

  • items(Option<Vec::<WorkflowStepItem>>):

    List containing workflow step details.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<GetWorkflowStepsError>

impl Client

pub fn list_account_integrations(&self) -> ListAccountIntegrationsFluentBuilder

Constructs a fluent builder for the ListAccountIntegrations operation.

• The fluent builder is configurable:
  • uri(impl Into<String>) / set_uri(Option<String>):
    required: true
    

    The URI of the S3 bucket or any other type of data source.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous ListAccountIntegrations API call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
  • include_hidden(bool) / set_include_hidden(Option<bool>):
    required: false
    

    Boolean to indicate if hidden integration should be returned. Defaults to False.

    
    
• On success, responds with ListAccountIntegrationsOutput with field(s):
  • items(Option<Vec::<ListIntegrationItem>>):

    The list of ListAccountIntegration instances.

  • next_token(Option<String>):

    The pagination token from the previous ListAccountIntegrations API call.

• On failure, responds with SdkError<ListAccountIntegrationsError>

impl Client

pub fn list_calculated_attribute_definitions( &self, ) -> ListCalculatedAttributeDefinitionsFluentBuilder

Constructs a fluent builder for the ListCalculatedAttributeDefinitions operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous call to ListCalculatedAttributeDefinitions.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of calculated attribute definitions returned per page.

    
    
• On success, responds with ListCalculatedAttributeDefinitionsOutput with field(s):
  • items(Option<Vec::<ListCalculatedAttributeDefinitionItem>>):

    The list of calculated attribute definitions.

  • next_token(Option<String>):

    The pagination token from the previous call to ListCalculatedAttributeDefinitions.

• On failure, responds with SdkError<ListCalculatedAttributeDefinitionsError>

impl Client

pub fn list_calculated_attributes_for_profile( &self, ) -> ListCalculatedAttributesForProfileFluentBuilder

Constructs a fluent builder for the ListCalculatedAttributesForProfile operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous call to ListCalculatedAttributesForProfile.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of calculated attributes returned per page.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of a customer profile.

    
    
• On success, responds with ListCalculatedAttributesForProfileOutput with field(s):
  • items(Option<Vec::<ListCalculatedAttributeForProfileItem>>):

    The list of calculated attributes.

  • next_token(Option<String>):

    The pagination token from the previous call to ListCalculatedAttributesForProfile.

• On failure, responds with SdkError<ListCalculatedAttributesForProfileError>

impl Client

pub fn list_domain_layouts(&self) -> ListDomainLayoutsFluentBuilder

Constructs a fluent builder for the ListDomainLayouts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
• On success, responds with ListDomainLayoutsOutput with field(s):
  • items(Option<Vec::<LayoutItem>>):

    Contains summary information about an EventStream.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListDomainLayoutsError>

impl Client

pub fn list_domain_object_types(&self) -> ListDomainObjectTypesFluentBuilder

Constructs a fluent builder for the ListDomainObjectTypes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of domain object types returned per page.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous call to ListDomainObjectTypes.

    
    
• On success, responds with ListDomainObjectTypesOutput with field(s):
  • items(Option<Vec::<DomainObjectTypesListItem>>):

    The list of domain object types.

  • next_token(Option<String>):

    The pagination token from the previous call to ListDomainObjectTypes.

• On failure, responds with SdkError<ListDomainObjectTypesError>

impl Client

pub fn list_domains(&self) -> ListDomainsFluentBuilder

Constructs a fluent builder for the ListDomains operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous ListDomain API call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
• On success, responds with ListDomainsOutput with field(s):
  • items(Option<Vec::<ListDomainItem>>):

    The list of ListDomains instances.

  • next_token(Option<String>):

    The pagination token from the previous ListDomains API call.

• On failure, responds with SdkError<ListDomainsError>

impl Client

pub fn list_event_streams(&self) -> ListEventStreamsFluentBuilder

Constructs a fluent builder for the ListEventStreams operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
• On success, responds with ListEventStreamsOutput with field(s):
  • items(Option<Vec::<EventStreamSummary>>):

    Contains summary information about an EventStream.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListEventStreamsError>

impl Client

pub fn list_event_triggers(&self) -> ListEventTriggersFluentBuilder

Constructs a fluent builder for the ListEventTriggers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token to use with ListEventTriggers.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListEventTriggersOutput with field(s):
  • items(Option<Vec::<EventTriggerSummaryItem>>):

    The list of Event Triggers.

  • next_token(Option<String>):

    The pagination token from the previous call to ListEventTriggers.

• On failure, responds with SdkError<ListEventTriggersError>

impl Client

pub fn list_identity_resolution_jobs( &self, ) -> ListIdentityResolutionJobsFluentBuilder

Constructs a fluent builder for the ListIdentityResolutionJobs operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListIdentityResolutionJobsOutput with field(s):
  • identity_resolution_jobs_list(Option<Vec::<IdentityResolutionJob>>):

    A list of Identity Resolution Jobs.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListIdentityResolutionJobsError>

impl Client

pub fn list_integrations(&self) -> ListIntegrationsFluentBuilder

Constructs a fluent builder for the ListIntegrations operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous ListIntegrations API call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
  • include_hidden(bool) / set_include_hidden(Option<bool>):
    required: false
    

    Boolean to indicate if hidden integration should be returned. Defaults to False.

    
    
• On success, responds with ListIntegrationsOutput with field(s):
  • items(Option<Vec::<ListIntegrationItem>>):

    The list of ListIntegrations instances.

  • next_token(Option<String>):

    The pagination token from the previous ListIntegrations API call.

• On failure, responds with SdkError<ListIntegrationsError>

impl Client

pub fn list_object_type_attribute_values( &self, ) -> ListObjectTypeAttributeValuesFluentBuilder

Constructs a fluent builder for the ListObjectTypeAttributeValues operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. If not provided default as 100.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The unique name of the domain object type.

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: true
    

    The attribute name.

    
    
• On success, responds with ListObjectTypeAttributeValuesOutput with field(s):
  • items(Option<Vec::<ListObjectTypeAttributeValuesItem>>):

    A list of unique attribute values sorted on the basis of LastUpdatedAt.

  • next_token(Option<String>):

    The pagination token from the previous call to call ListObjectTypeAttributeValues.

• On failure, responds with SdkError<ListObjectTypeAttributeValuesError>

impl Client

pub fn list_object_type_attributes( &self, ) -> ListObjectTypeAttributesFluentBuilder

Constructs a fluent builder for the ListObjectTypeAttributes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique identifier of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The name of the profile object type.

    
    
• On success, responds with ListObjectTypeAttributesOutput with field(s):
  • items(Option<Vec::<ListObjectTypeAttributeItem>>):

    The items returned as part of the response.

  • next_token(Option<String>):

    The pagination token from the previous call.

• On failure, responds with SdkError<ListObjectTypeAttributesError>

impl Client

pub fn list_profile_attribute_values( &self, ) -> ListProfileAttributeValuesFluentBuilder

Constructs a fluent builder for the ListProfileAttributeValues operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique identifier of the domain.

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: true
    

    The attribute name.

    
    
• On success, responds with ListProfileAttributeValuesOutput with field(s):
  • domain_name(Option<String>):

    The name of the domain.

  • attribute_name(Option<String>):

    The attribute name.

  • items(Option<Vec::<AttributeValueItem>>):

    The items returned as part of the response.

  • status_code(i32):

    The status code for the response.

• On failure, responds with SdkError<ListProfileAttributeValuesError>

impl Client

pub fn list_profile_history_records( &self, ) -> ListProfileHistoryRecordsFluentBuilder

Constructs a fluent builder for the ListProfileHistoryRecords operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain for which to return profile history records.

    
    
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The identifier of the profile to be taken.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: false
    

    Applies a filter to include profile history records only with the specified ObjectTypeName value in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
  • action_type(ActionType) / set_action_type(Option<ActionType>):
    required: false
    

    Applies a filter to include profile history records only with the specified ActionType value in the response.

    
    
  • performed_by(impl Into<String>) / set_performed_by(Option<String>):
    required: false
    

    Applies a filter to include profile history records only with the specified PerformedBy value in the response. The PerformedBy value can be the Amazon Resource Name (ARN) of the person or service principal who performed the action.

    
    
• On success, responds with ListProfileHistoryRecordsOutput with field(s):
  • profile_history_records(Option<Vec::<ProfileHistoryRecord>>):

    The list of profile history records.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListProfileHistoryRecordsError>

impl Client

pub fn list_profile_object_type_templates( &self, ) -> ListProfileObjectTypeTemplatesFluentBuilder

Constructs a fluent builder for the ListProfileObjectTypeTemplates operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous ListObjectTypeTemplates API call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
• On success, responds with ListProfileObjectTypeTemplatesOutput with field(s):
  • items(Option<Vec::<ListProfileObjectTypeTemplateItem>>):

    The list of ListProfileObjectType template instances.

  • next_token(Option<String>):

    The pagination token from the previous ListObjectTypeTemplates API call.

• On failure, responds with SdkError<ListProfileObjectTypeTemplatesError>

impl Client

pub fn list_profile_object_types(&self) -> ListProfileObjectTypesFluentBuilder

Constructs a fluent builder for the ListProfileObjectTypes operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
• On success, responds with ListProfileObjectTypesOutput with field(s):
  • items(Option<Vec::<ListProfileObjectTypeItem>>):

    The list of ListProfileObjectTypes instances.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListProfileObjectTypesError>

impl Client

pub fn list_profile_objects(&self) -> ListProfileObjectsFluentBuilder

Constructs a fluent builder for the ListProfileObjects operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous call to ListProfileObjects.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The name of the profile object type.

    
    
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of a customer profile.

    
    
  • object_filter(ObjectFilter) / set_object_filter(Option<ObjectFilter>):
    required: false
    

    Applies a filter to the response to include profile objects with the specified index values.

    
    
• On success, responds with ListProfileObjectsOutput with field(s):
  • items(Option<Vec::<ListProfileObjectsItem>>):

    The list of ListProfileObject instances.

  • next_token(Option<String>):

    The pagination token from the previous call to ListProfileObjects.

• On failure, responds with SdkError<ListProfileObjectsError>

impl Client

pub fn list_recommender_recipes(&self) -> ListRecommenderRecipesFluentBuilder

Constructs a fluent builder for the ListRecommenderRecipes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of recommender recipes to return in the response. The default value is 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token received from a previous ListRecommenderRecipes call to retrieve the next page of results.

    
    
• On success, responds with ListRecommenderRecipesOutput with field(s):
  • next_token(Option<String>):

    A token to retrieve the next page of results. Null if there are no more results to retrieve.

  • recommender_recipes(Option<Vec::<RecommenderRecipe>>):

    A list of available recommender recipes and their properties.

• On failure, responds with SdkError<ListRecommenderRecipesError>

impl Client

pub fn list_recommenders(&self) -> ListRecommendersFluentBuilder

Constructs a fluent builder for the ListRecommenders operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of recommenders to return in the response. The default value is 100.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token received from a previous ListRecommenders call to retrieve the next page of results.

    
    
• On success, responds with ListRecommendersOutput with field(s):
  • next_token(Option<String>):

    A token to retrieve the next page of results. Null if there are no more results to retrieve.

  • recommenders(Option<Vec::<RecommenderSummary>>):

    A list of recommenders and their properties in the specified domain.

• On failure, responds with SdkError<ListRecommendersError>

impl Client

pub fn list_rule_based_matches(&self) -> ListRuleBasedMatchesFluentBuilder

Constructs a fluent builder for the ListRuleBasedMatches operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous ListRuleBasedMatches API call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of MatchIds returned per page.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with ListRuleBasedMatchesOutput with field(s):
  • match_ids(Option<Vec::<String>>):

    The list of MatchIds for the given domain.

  • next_token(Option<String>):

    The pagination token from the previous ListRuleBasedMatches API call.

• On failure, responds with SdkError<ListRuleBasedMatchesError>

impl Client

pub fn list_segment_definitions(&self) -> ListSegmentDefinitionsFluentBuilder

Constructs a fluent builder for the ListSegmentDefinitions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique identifier of the domain.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous call.

    
    
• On success, responds with ListSegmentDefinitionsOutput with field(s):
  • next_token(Option<String>):

    The pagination token from the previous call.

  • items(Option<Vec::<SegmentDefinitionItem>>):

    List of segment definitions.

• On failure, responds with SdkError<ListSegmentDefinitionsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource for which you want to view tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_upload_jobs(&self) -> ListUploadJobsFluentBuilder

Constructs a fluent builder for the ListUploadJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain to list upload jobs for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of upload jobs to return per page.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous call to retrieve the next page of results.

    
    
• On success, responds with ListUploadJobsOutput with field(s):
  • next_token(Option<String>):

    The pagination token to use to retrieve the next page of results.

  • items(Option<Vec::<UploadJobItem>>):

    The list of upload jobs for the specified domain.

• On failure, responds with SdkError<ListUploadJobsError>

impl Client

pub fn list_workflows(&self) -> ListWorkflowsFluentBuilder

Constructs a fluent builder for the ListWorkflows operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • workflow_type(WorkflowType) / set_workflow_type(Option<WorkflowType>):
    required: false
    

    The type of workflow. The only supported value is APPFLOW_INTEGRATION.

    
    
  • status(Status) / set_status(Option<Status>):
    required: false
    

    Status of workflow execution.

    
    
  • query_start_date(DateTime) / set_query_start_date(Option<DateTime>):
    required: false
    

    Retrieve workflows started after timestamp.

    
    
  • query_end_date(DateTime) / set_query_end_date(Option<DateTime>):
    required: false
    

    Retrieve workflows ended after timestamp.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListWorkflowsOutput with field(s):
  • items(Option<Vec::<ListWorkflowsItem>>):

    List containing workflow details.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListWorkflowsError>

impl Client

pub fn merge_profiles(&self) -> MergeProfilesFluentBuilder

Constructs a fluent builder for the MergeProfiles operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • main_profile_id(impl Into<String>) / set_main_profile_id(Option<String>):
    required: true
    

    The identifier of the profile to be taken.

    
    
  • profile_ids_to_be_merged(impl Into<String>) / set_profile_ids_to_be_merged(Option<Vec::<String>>):
    required: true
    

    The identifier of the profile to be merged into MainProfileId.

    
    
  • field_source_profile_ids(FieldSourceProfileIds) / set_field_source_profile_ids(Option<FieldSourceProfileIds>):
    required: false
    

    The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1.

    
    
• On success, responds with MergeProfilesOutput with field(s):
  • message(Option<String>):

    A message that indicates the merge request is complete.

• On failure, responds with SdkError<MergeProfilesError>

impl Client

pub fn put_domain_object_type(&self) -> PutDomainObjectTypeFluentBuilder

Constructs a fluent builder for the PutDomainObjectType operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The unique name of the domain object type.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the domain object type.

    
    
  • encryption_key(impl Into<String>) / set_encryption_key(Option<String>):
    required: false
    

    The customer provided KMS key used to encrypt this type of domain object.

    
    
  • fields(impl Into<String>, DomainObjectTypeField) / set_fields(Option<HashMap::<String, DomainObjectTypeField>>):
    required: true
    

    A map of field names to their corresponding domain object type field definitions.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with PutDomainObjectTypeOutput with field(s):
  • object_type_name(Option<String>):

    The unique name of the domain object type.

  • description(Option<String>):

    The description of the domain object type.

  • encryption_key(Option<String>):

    The customer provided KMS key used to encrypt this type of domain object.

  • fields(Option<HashMap::<String, DomainObjectTypeField>>):

    A map of field names to their corresponding domain object type field definitions.

  • created_at(Option<DateTime>):

    The timestamp of when the domain object type was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the domain object type was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<PutDomainObjectTypeError>

impl Client

pub fn put_integration(&self) -> PutIntegrationFluentBuilder

Constructs a fluent builder for the PutIntegration operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • uri(impl Into<String>) / set_uri(Option<String>):
    required: false
    

    The URI of the S3 bucket or any other type of data source.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: false
    

    The name of the profile object type.

    
    
  • object_type_names(impl Into<String>, impl Into<String>) / set_object_type_names(Option<HashMap::<String, String>>):
    required: false
    

    A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
  • flow_definition(FlowDefinition) / set_flow_definition(Option<FlowDefinition>):
    required: false
    

    The configuration that controls how Customer Profiles retrieves data from the source.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.

    
    
  • event_trigger_names(impl Into<String>) / set_event_trigger_names(Option<Vec::<String>>):
    required: false
    

    A list of unique names for active event triggers associated with the integration.

    
    
  • scope(Scope) / set_scope(Option<Scope>):
    required: false
    

    Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.

    
    
• On success, responds with PutIntegrationOutput with field(s):
  • domain_name(String):

    The unique name of the domain.

  • uri(String):

    The URI of the S3 bucket or any other type of data source.

  • object_type_name(Option<String>):

    The name of the profile object type.

  • created_at(DateTime):

    The timestamp of when the domain was created.

  • last_updated_at(DateTime):

    The timestamp of when the domain was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

  • object_type_names(Option<HashMap::<String, String>>):

    A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

  • workflow_id(Option<String>):

    Unique identifier for the workflow.

  • is_unstructured(Option<bool>):

    Boolean that shows if the Flow that’s associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.

  • role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.

  • event_trigger_names(Option<Vec::<String>>):

    A list of unique names for active event triggers associated with the integration. This list would be empty if no Event Trigger is associated with the integration.

  • scope(Option<Scope>):

    Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.

• On failure, responds with SdkError<PutIntegrationError>

impl Client

pub fn put_profile_object(&self) -> PutProfileObjectFluentBuilder

Constructs a fluent builder for the PutProfileObject operation.

• The fluent builder is configurable:
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The name of the profile object type.

    
    
  • object(impl Into<String>) / set_object(Option<String>):
    required: true
    

    A string that is serialized from a JSON object.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
• On success, responds with PutProfileObjectOutput with field(s):
  • profile_object_unique_key(Option<String>):

    The unique identifier of the profile object generated by the service.

• On failure, responds with SdkError<PutProfileObjectError>

impl Client

pub fn put_profile_object_type(&self) -> PutProfileObjectTypeFluentBuilder

Constructs a fluent builder for the PutProfileObjectType operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: true
    

    The name of the profile object type.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    Description of the profile object type.

    
    
  • template_id(impl Into<String>) / set_template_id(Option<String>):
    required: false
    

    A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a BadRequestException. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a BadRequestException.

    
    
  • expiration_days(i32) / set_expiration_days(Option<i32>):
    required: false
    

    The number of days until the data in the object expires.

    
    
  • encryption_key(impl Into<String>) / set_encryption_key(Option<String>):
    required: false
    

    The customer-provided key to encrypt the profile object that will be created in this profile object type.

    
    
  • allow_profile_creation(bool) / set_allow_profile_creation(Option<bool>):
    required: false
    

    Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

    
    
  • source_last_updated_timestamp_format(impl Into<String>) / set_source_last_updated_timestamp_format(Option<String>):
    required: false
    

    The format of your sourceLastUpdatedTimestamp that was previously set up.

    
    
  • max_profile_object_count(i32) / set_max_profile_object_count(Option<i32>):
    required: false
    

    The amount of profile object max count assigned to the object type

    
    
  • fields(impl Into<String>, ObjectTypeField) / set_fields(Option<HashMap::<String, ObjectTypeField>>):
    required: false
    

    A map of the name and ObjectType field.

    
    
  • keys(impl Into<String>, Vec::<ObjectTypeKey>) / set_keys(Option<HashMap::<String, Vec::<ObjectTypeKey>>>):
    required: false
    

    A list of unique keys that can be used to map data to the profile.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with PutProfileObjectTypeOutput with field(s):
  • object_type_name(String):

    The name of the profile object type.

  • description(String):

    Description of the profile object type.

  • template_id(Option<String>):

    A unique identifier for the object template.

  • expiration_days(Option<i32>):

    The number of days until the data in the object expires.

  • encryption_key(Option<String>):

    The customer-provided key to encrypt the profile object that will be created in this profile object type.

  • allow_profile_creation(bool):

    Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

  • source_last_updated_timestamp_format(Option<String>):

    The format of your sourceLastUpdatedTimestamp that was previously set up in fields that were parsed using SimpleDateFormat. If you have sourceLastUpdatedTimestamp in your field, you must set up sourceLastUpdatedTimestampFormat.

  • max_profile_object_count(Option<i32>):

    The amount of profile object max count assigned to the object type.

  • max_available_profile_object_count(Option<i32>):

    The amount of provisioned profile object max count available.

  • fields(Option<HashMap::<String, ObjectTypeField>>):

    A map of the name and ObjectType field.

  • keys(Option<HashMap::<String, Vec::<ObjectTypeKey>>>):

    A list of unique keys that can be used to map data to the profile.

  • created_at(Option<DateTime>):

    The timestamp of when the domain was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the domain was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<PutProfileObjectTypeError>

impl Client

pub fn search_profiles(&self) -> SearchProfilesFluentBuilder

Constructs a fluent builder for the SearchProfiles operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token from the previous SearchProfiles API call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects returned per page.

    The default is 20 if this parameter is not included in the request.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • key_name(impl Into<String>) / set_key_name(Option<String>):
    required: true
    

    A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

    
    
  • values(impl Into<String>) / set_values(Option<Vec::<String>>):
    required: true
    

    A list of key values.

    
    
  • additional_search_keys(AdditionalSearchKey) / set_additional_search_keys(Option<Vec::<AdditionalSearchKey>>):
    required: false
    

    A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

    
    
  • logical_operator(LogicalOperator) / set_logical_operator(Option<LogicalOperator>):
    required: false
    

    Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

    This parameter influences which profiles will be returned in the response in the following manner:

    • AND - The response only includes profiles that match all of the search keys.

    • OR - The response includes profiles that match at least one of the search keys.

    The OR relationship is the default behavior if this parameter is not included in the request.

    
    
• On success, responds with SearchProfilesOutput with field(s):
  • items(Option<Vec::<Profile>>):

    The list of Profiles matching the search criteria.

  • next_token(Option<String>):

    The pagination token from the previous SearchProfiles API call.

• On failure, responds with SdkError<SearchProfilesError>

impl Client

pub fn start_recommender(&self) -> StartRecommenderFluentBuilder

Constructs a fluent builder for the StartRecommender operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • recommender_name(impl Into<String>) / set_recommender_name(Option<String>):
    required: true
    

    The name of the recommender to start.

    
    
• On success, responds with StartRecommenderOutput
• On failure, responds with SdkError<StartRecommenderError>

impl Client

pub fn start_upload_job(&self) -> StartUploadJobFluentBuilder

Constructs a fluent builder for the StartUploadJob operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain containing the upload job to start.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier of the upload job to start.

    
    
• On success, responds with StartUploadJobOutput
• On failure, responds with SdkError<StartUploadJobError>

impl Client

pub fn stop_recommender(&self) -> StopRecommenderFluentBuilder

Constructs a fluent builder for the StopRecommender operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • recommender_name(impl Into<String>) / set_recommender_name(Option<String>):
    required: true
    

    The name of the recommender to stop.

    
    
• On success, responds with StopRecommenderOutput
• On failure, responds with SdkError<StopRecommenderError>

impl Client

pub fn stop_upload_job(&self) -> StopUploadJobFluentBuilder

Constructs a fluent builder for the StopUploadJob operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain containing the upload job to stop.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier of the upload job to stop.

    
    
• On success, responds with StopUploadJobOutput
• On failure, responds with SdkError<StopUploadJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource that you’re adding tags to.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource from which you are removing tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_calculated_attribute_definition( &self, ) -> UpdateCalculatedAttributeDefinitionFluentBuilder

Constructs a fluent builder for the UpdateCalculatedAttributeDefinition operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • calculated_attribute_name(impl Into<String>) / set_calculated_attribute_name(Option<String>):
    required: true
    

    The unique name of the calculated attribute.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name of the calculated attribute.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the calculated attribute.

    
    
  • conditions(Conditions) / set_conditions(Option<Conditions>):
    required: false
    

    The conditions including range, object count, and threshold for the calculated attribute.

    
    
• On success, responds with UpdateCalculatedAttributeDefinitionOutput with field(s):
  • calculated_attribute_name(Option<String>):

    The unique name of the calculated attribute.

  • display_name(Option<String>):

    The display name of the calculated attribute.

  • description(Option<String>):

    The description of the calculated attribute.

  • created_at(Option<DateTime>):

    The timestamp of when the calculated attribute definition was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the calculated attribute definition was most recently edited.

  • statistic(Option<Statistic>):

    The aggregation operation to perform for the calculated attribute.

  • conditions(Option<Conditions>):

    The conditions including range, object count, and threshold for the calculated attribute.

  • attribute_details(Option<AttributeDetails>):

    The mathematical expression and a list of attribute items specified in that expression.

  • use_historical_data(Option<bool>):

    Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

  • status(Option<ReadinessStatus>):

    Status of the Calculated Attribute creation (whether all historical data has been indexed.)

  • readiness(Option<Readiness>):

    Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<UpdateCalculatedAttributeDefinitionError>

impl Client

pub fn update_domain(&self) -> UpdateDomainFluentBuilder

Constructs a fluent builder for the UpdateDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • default_expiration_days(i32) / set_default_expiration_days(Option<i32>):
    required: false
    

    The default number of days until the data within the domain expires.

    
    
  • default_encryption_key(impl Into<String>) / set_default_encryption_key(Option<String>):
    required: false
    

    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. If specified as an empty string, it will clear any existing value.

    
    
  • dead_letter_queue_url(impl Into<String>) / set_dead_letter_queue_url(Option<String>):
    required: false
    

    The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. 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.

    
    
  • matching(MatchingRequest) / set_matching(Option<MatchingRequest>):
    required: false
    

    The process of matching duplicate profiles. If Matching = true, 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.

    After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

    
    
  • rule_based_matching(RuleBasedMatchingRequest) / set_rule_based_matching(Option<RuleBasedMatchingRequest>):
    required: false
    

    The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

    
    
  • data_store(DataStoreRequest) / set_data_store(Option<DataStoreRequest>):
    required: false
    

    Set to true to enabled data store for this domain.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with UpdateDomainOutput with field(s):
  • domain_name(String):

    The unique name of the domain.

  • default_expiration_days(Option<i32>):

    The default number of days until the data within the domain expires.

  • default_encryption_key(Option<String>):

    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.

  • dead_letter_queue_url(Option<String>):

    The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

  • matching(Option<MatchingResponse>):

    The process of matching duplicate profiles. If Matching = true, 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.

    After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

  • rule_based_matching(Option<RuleBasedMatchingResponse>):

    The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

  • data_store(Option<DataStoreResponse>):

    The data store.

  • created_at(DateTime):

    The timestamp of when the domain was created.

  • last_updated_at(DateTime):

    The timestamp of when the domain was most recently edited.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<UpdateDomainError>

impl Client

pub fn update_domain_layout(&self) -> UpdateDomainLayoutFluentBuilder

Constructs a fluent builder for the UpdateDomainLayout operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • layout_definition_name(impl Into<String>) / set_layout_definition_name(Option<String>):
    required: true
    

    The unique name of the layout.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the layout

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The display name of the layout

    
    
  • is_default(bool) / set_is_default(Option<bool>):
    required: false
    

    If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

    
    
  • layout_type(LayoutType) / set_layout_type(Option<LayoutType>):
    required: false
    

    The type of layout that can be used to view data under a Customer Profiles domain.

    
    
  • layout(impl Into<String>) / set_layout(Option<String>):
    required: false
    

    A customizable layout that can be used to view data under a Customer Profiles domain.

    
    
• On success, responds with UpdateDomainLayoutOutput with field(s):
  • layout_definition_name(Option<String>):

    The unique name of the layout.

  • description(Option<String>):

    The description of the layout

  • display_name(Option<String>):

    The display name of the layout

  • is_default(bool):

    If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

  • layout_type(Option<LayoutType>):

    The type of layout that can be used to view data under a Customer Profiles domain.

  • layout(Option<String>):

    A customizable layout that can be used to view data under a Customer Profiles domain.

  • version(Option<String>):

    The version used to create layout.

  • created_at(Option<DateTime>):

    The timestamp of when the layout was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the layout was most recently updated.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<UpdateDomainLayoutError>

impl Client

pub fn update_event_trigger(&self) -> UpdateEventTriggerFluentBuilder

Constructs a fluent builder for the UpdateEventTrigger operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • event_trigger_name(impl Into<String>) / set_event_trigger_name(Option<String>):
    required: true
    

    The unique name of the event trigger.

    
    
  • object_type_name(impl Into<String>) / set_object_type_name(Option<String>):
    required: false
    

    The unique name of the object type.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the event trigger.

    
    
  • event_trigger_conditions(EventTriggerCondition) / set_event_trigger_conditions(Option<Vec::<EventTriggerCondition>>):
    required: false
    

    A list of conditions that determine when an event should trigger the destination.

    
    
  • segment_filter(impl Into<String>) / set_segment_filter(Option<String>):
    required: false
    

    The destination is triggered only for profiles that meet the criteria of a segment definition.

    
    
  • event_trigger_limits(EventTriggerLimits) / set_event_trigger_limits(Option<EventTriggerLimits>):
    required: false
    

    Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

    
    
• On success, responds with UpdateEventTriggerOutput with field(s):
  • event_trigger_name(Option<String>):

    The unique name of the event trigger.

  • object_type_name(Option<String>):

    The unique name of the object type.

  • description(Option<String>):

    The description of the event trigger.

  • event_trigger_conditions(Option<Vec::<EventTriggerCondition>>):

    A list of conditions that determine when an event should trigger the destination.

  • segment_filter(Option<String>):

    The destination is triggered only for profiles that meet the criteria of a segment definition.

  • event_trigger_limits(Option<EventTriggerLimits>):

    Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

  • created_at(Option<DateTime>):

    The timestamp of when the event trigger was created.

  • last_updated_at(Option<DateTime>):

    The timestamp of when the event trigger was most recently updated.

  • tags(Option<HashMap::<String, String>>):

    An array of key-value pairs to apply to this resource.

• On failure, responds with SdkError<UpdateEventTriggerError>

impl Client

pub fn update_profile(&self) -> UpdateProfileFluentBuilder

Constructs a fluent builder for the UpdateProfile operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • profile_id(impl Into<String>) / set_profile_id(Option<String>):
    required: true
    

    The unique identifier of a customer profile.

    
    
  • additional_information(impl Into<String>) / set_additional_information(Option<String>):
    required: false
    

    Any additional information relevant to the customer’s profile.

    
    
  • account_number(impl Into<String>) / set_account_number(Option<String>):
    required: false
    

    An account number that you have assigned to the customer.

    
    
  • party_type(PartyType) / set_party_type(Option<PartyType>):
    required: false
    

    The type of profile used to describe the customer.

    
    
  • business_name(impl Into<String>) / set_business_name(Option<String>):
    required: false
    

    The name of the customer’s business.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    The customer’s first name.

    
    
  • middle_name(impl Into<String>) / set_middle_name(Option<String>):
    required: false
    

    The customer’s middle name.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    The customer’s last name.

    
    
  • birth_date(impl Into<String>) / set_birth_date(Option<String>):
    required: false
    

    The customer’s birth date.

    
    
  • gender(Gender) / set_gender(Option<Gender>):
    required: false
    

    The gender with which the customer identifies.

    
    
  • phone_number(impl Into<String>) / set_phone_number(Option<String>):
    required: false
    

    The customer’s phone number, which has not been specified as a mobile, home, or business number.

    
    
  • mobile_phone_number(impl Into<String>) / set_mobile_phone_number(Option<String>):
    required: false
    

    The customer’s mobile phone number.

    
    
  • home_phone_number(impl Into<String>) / set_home_phone_number(Option<String>):
    required: false
    

    The customer’s home phone number.

    
    
  • business_phone_number(impl Into<String>) / set_business_phone_number(Option<String>):
    required: false
    

    The customer’s business phone number.

    
    
  • email_address(impl Into<String>) / set_email_address(Option<String>):
    required: false
    

    The customer’s email address, which has not been specified as a personal or business address.

    
    
  • personal_email_address(impl Into<String>) / set_personal_email_address(Option<String>):
    required: false
    

    The customer’s personal email address.

    
    
  • business_email_address(impl Into<String>) / set_business_email_address(Option<String>):
    required: false
    

    The customer’s business email address.

    
    
  • address(UpdateAddress) / set_address(Option<UpdateAddress>):
    required: false
    

    A generic address associated with the customer that is not mailing, shipping, or billing.

    
    
  • shipping_address(UpdateAddress) / set_shipping_address(Option<UpdateAddress>):
    required: false
    

    The customer’s shipping address.

    
    
  • mailing_address(UpdateAddress) / set_mailing_address(Option<UpdateAddress>):
    required: false
    

    The customer’s mailing address.

    
    
  • billing_address(UpdateAddress) / set_billing_address(Option<UpdateAddress>):
    required: false
    

    The customer’s billing address.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    A key value pair of attributes of a customer profile.

    
    
  • party_type_string(impl Into<String>) / set_party_type_string(Option<String>):
    required: false
    

    An alternative to PartyType which accepts any string as input.

    
    
  • gender_string(impl Into<String>) / set_gender_string(Option<String>):
    required: false
    

    An alternative to Gender which accepts any string as input.

    
    
  • profile_type(ProfileType) / set_profile_type(Option<ProfileType>):
    required: false
    

    Determines the type of the profile.

    
    
  • engagement_preferences(EngagementPreferences) / set_engagement_preferences(Option<EngagementPreferences>):
    required: false
    

    Object that defines users preferred methods of engagement.

    
    
• On success, responds with UpdateProfileOutput with field(s):
  • profile_id(String):

    The unique identifier of a customer profile.

• On failure, responds with SdkError<UpdateProfileError>

impl Client

pub fn update_recommender(&self) -> UpdateRecommenderFluentBuilder

Constructs a fluent builder for the UpdateRecommender operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: true
    

    The unique name of the domain.

    
    
  • recommender_name(impl Into<String>) / set_recommender_name(Option<String>):
    required: true
    

    The name of the recommender to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The new description to assign to the recommender.

    
    
  • recommender_config(RecommenderConfig) / set_recommender_config(Option<RecommenderConfig>):
    required: false
    

    The new configuration settings to apply to the recommender, including updated parameters and settings that define its behavior.

    
    
• On success, responds with UpdateRecommenderOutput with field(s):
  • recommender_name(String):

    The name of the recommender that was updated.

• On failure, responds with SdkError<UpdateRecommenderError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.