Struct aws_sdk_customerprofiles::client::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 Config 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 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.

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

    The aggregation operation to perform for the calculated attribute.

    
    
  • 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.

  • 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.

  • 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.

    
    
  • 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.

  • 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_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_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
    

    A unique account number that you have given 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.

    
    
• 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 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_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_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_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.

  • 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.

  • 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.

• 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.

  • 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_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_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.

• 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_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.

  • 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_similar_profiles(&self) -> GetSimilarProfilesFluentBuilder

Constructs a fluent builder for the GetSimilarProfiles operation.

• 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_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_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_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_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_rule_based_matches(&self) -> ListRuleBasedMatchesFluentBuilder

Constructs a fluent builder for the ListRuleBasedMatches operation.

• 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_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_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_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.

    
    
  • 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.

    
    
  • 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.

    
    
• 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.

• 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.

    
    
  • 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.

  • 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 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.

  • 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.

    
    
  • 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.

  • 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_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
    

    A unique account number that you have given 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.

    
    
• 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 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 copy 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.