Class: Aws::CustomerProfiles::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb

Overview

An API client for CustomerProfiles. To construct a client, you need to configure a :region and :credentials.

client = Aws::CustomerProfiles::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



324
325
326
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

#add_profile_key(params = {}) ⇒ Types::AddProfileKeyResponse

Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.

A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.

Examples:

Request syntax with placeholder values


resp = client.add_profile_key({
  profile_id: "uuid", # required
  key_name: "name", # required
  values: ["string1To255"], # required
  domain_name: "name", # required
})

Response structure


resp.key_name #=> String
resp.values #=> Array
resp.values[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of a customer profile.

  • :key_name (required, String) —

    A searchable identifier of a customer profile.

  • :values (required, Array<String>) —

    A list of key values.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



373
374
375
376
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 373

def add_profile_key(params = {}, options = {})
  req = build_request(:add_profile_key, params)
  req.send_request(options)
end

#create_domain(params = {}) ⇒ Types::CreateDomainResponse

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

Examples:

Request syntax with placeholder values


resp = client.create_domain({
  domain_name: "name", # required
  default_expiration_days: 1, # required
  default_encryption_key: "encryptionKey",
  dead_letter_queue_url: "sqsQueueUrl",
  matching: {
    enabled: false, # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.domain_name #=> String
resp.default_expiration_days #=> Integer
resp.default_encryption_key #=> String
resp.dead_letter_queue_url #=> String
resp.matching.enabled #=> Boolean
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :default_expiration_days (required, Integer) —

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

  • :default_encryption_key (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 (String) —

    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 (Types::MatchingRequest) —

    The process of matching duplicate profiles. This process runs every Saturday at 12AM.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



453
454
455
456
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 453

def create_domain(params = {}, options = {})
  req = build_request(:create_domain, params)
  req.send_request(options)
end

#create_profile(params = {}) ⇒ Types::CreateProfileResponse

Creates a standard profile.

A standard profile represents the following attributes for a customer profile in a domain.

Examples:

Request syntax with placeholder values


resp = client.create_profile({
  domain_name: "name", # required
  account_number: "string1To255",
  additional_information: "string1To1000",
  party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
  business_name: "string1To255",
  first_name: "string1To255",
  middle_name: "string1To255",
  last_name: "string1To255",
  birth_date: "string1To255",
  gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
  phone_number: "string1To255",
  mobile_phone_number: "string1To255",
  home_phone_number: "string1To255",
  business_phone_number: "string1To255",
  email_address: "string1To255",
  personal_email_address: "string1To255",
  business_email_address: "string1To255",
  address: {
    address_1: "string1To255",
    address_2: "string1To255",
    address_3: "string1To255",
    address_4: "string1To255",
    city: "string1To255",
    county: "string1To255",
    state: "string1To255",
    province: "string1To255",
    country: "string1To255",
    postal_code: "string1To255",
  },
  shipping_address: {
    address_1: "string1To255",
    address_2: "string1To255",
    address_3: "string1To255",
    address_4: "string1To255",
    city: "string1To255",
    county: "string1To255",
    state: "string1To255",
    province: "string1To255",
    country: "string1To255",
    postal_code: "string1To255",
  },
  mailing_address: {
    address_1: "string1To255",
    address_2: "string1To255",
    address_3: "string1To255",
    address_4: "string1To255",
    city: "string1To255",
    county: "string1To255",
    state: "string1To255",
    province: "string1To255",
    country: "string1To255",
    postal_code: "string1To255",
  },
  billing_address: {
    address_1: "string1To255",
    address_2: "string1To255",
    address_3: "string1To255",
    address_4: "string1To255",
    city: "string1To255",
    county: "string1To255",
    state: "string1To255",
    province: "string1To255",
    country: "string1To255",
    postal_code: "string1To255",
  },
  attributes: {
    "string1To255" => "string1To255",
  },
})

Response structure


resp.profile_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :account_number (String) —

    A unique account number that you have given to the customer.

  • :additional_information (String) —

    Any additional information relevant to the customer’s profile.

  • :party_type (String) —

    The type of profile used to describe the customer.

  • :business_name (String) —

    The name of the customer’s business.

  • :first_name (String) —

    The customer’s first name.

  • :middle_name (String) —

    The customer’s middle name.

  • :last_name (String) —

    The customer’s last name.

  • :birth_date (String) —

    The customer’s birth date.

  • :gender (String) —

    The gender with which the customer identifies.

  • :phone_number (String) —

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

  • :mobile_phone_number (String) —

    The customer’s mobile phone number.

  • :home_phone_number (String) —

    The customer’s home phone number.

  • :business_phone_number (String) —

    The customer’s business phone number.

  • :email_address (String) —

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

  • :personal_email_address (String) —

    The customer’s personal email address.

  • :business_email_address (String) —

    The customer’s business email address.

  • :address (Types::Address) —

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

  • :shipping_address (Types::Address) —

    The customer’s shipping address.

  • :mailing_address (Types::Address) —

    The customer’s mailing address.

  • :billing_address (Types::Address) —

    The customer’s billing address.

  • :attributes (Hash<String,String>) —

    A key value pair of attributes of a customer profile.

Returns:

See Also:



617
618
619
620
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 617

def create_profile(params = {}, options = {})
  req = build_request(:create_profile, params)
  req.send_request(options)
end

#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse

Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

Examples:

Request syntax with placeholder values


resp = client.delete_domain({
  domain_name: "name", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



646
647
648
649
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 646

def delete_domain(params = {}, options = {})
  req = build_request(:delete_domain, params)
  req.send_request(options)
end

#delete_integration(params = {}) ⇒ Types::DeleteIntegrationResponse

Removes an integration from a specific domain.

Examples:

Request syntax with placeholder values


resp = client.delete_integration({
  domain_name: "name", # required
  uri: "string1To255", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :uri (required, String) —

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

Returns:

See Also:



678
679
680
681
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 678

def delete_integration(params = {}, options = {})
  req = build_request(:delete_integration, params)
  req.send_request(options)
end

#delete_profile(params = {}) ⇒ Types::DeleteProfileResponse

Deletes the standard customer profile and all data pertaining to the profile.

Examples:

Request syntax with placeholder values


resp = client.delete_profile({
  profile_id: "uuid", # required
  domain_name: "name", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of a customer profile.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



711
712
713
714
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 711

def delete_profile(params = {}, options = {})
  req = build_request(:delete_profile, params)
  req.send_request(options)
end

#delete_profile_key(params = {}) ⇒ Types::DeleteProfileKeyResponse

Removes a searchable key from a customer profile.

Examples:

Request syntax with placeholder values


resp = client.delete_profile_key({
  profile_id: "uuid", # required
  key_name: "name", # required
  values: ["string1To255"], # required
  domain_name: "name", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of a customer profile.

  • :key_name (required, String) —

    A searchable identifier of a customer profile.

  • :values (required, Array<String>) —

    A list of key values.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



751
752
753
754
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 751

def delete_profile_key(params = {}, options = {})
  req = build_request(:delete_profile_key, params)
  req.send_request(options)
end

#delete_profile_object(params = {}) ⇒ Types::DeleteProfileObjectResponse

Removes an object associated with a profile of a given ProfileObjectType.

Examples:

Request syntax with placeholder values


resp = client.delete_profile_object({
  profile_id: "uuid", # required
  profile_object_unique_key: "string1To255", # required
  object_type_name: "typeName", # required
  domain_name: "name", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The unique identifier of a customer profile.

  • :profile_object_unique_key (required, String) —

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

  • :object_type_name (required, String) —

    The name of the profile object type.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



792
793
794
795
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 792

def delete_profile_object(params = {}, options = {})
  req = build_request(:delete_profile_object, params)
  req.send_request(options)
end

#delete_profile_object_type(params = {}) ⇒ Types::DeleteProfileObjectTypeResponse

Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.

Examples:

Request syntax with placeholder values


resp = client.delete_profile_object_type({
  domain_name: "name", # required
  object_type_name: "typeName", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :object_type_name (required, String) —

    The name of the profile object type.

Returns:

See Also:



828
829
830
831
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 828

def delete_profile_object_type(params = {}, options = {})
  req = build_request(:delete_profile_object_type, params)
  req.send_request(options)
end

#get_domain(params = {}) ⇒ Types::GetDomainResponse

Returns information about a specific domain.

Examples:

Request syntax with placeholder values


resp = client.get_domain({
  domain_name: "name", # required
})

Response structure


resp.domain_name #=> String
resp.default_expiration_days #=> Integer
resp.default_encryption_key #=> String
resp.dead_letter_queue_url #=> String
resp.stats.profile_count #=> Integer
resp.stats.metering_profile_count #=> Integer
resp.stats.object_count #=> Integer
resp.stats.total_size #=> Integer
resp.matching.enabled #=> Boolean
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



876
877
878
879
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 876

def get_domain(params = {}, options = {})
  req = build_request(:get_domain, params)
  req.send_request(options)
end

#get_integration(params = {}) ⇒ Types::GetIntegrationResponse

Returns an integration for a domain.

Examples:

Request syntax with placeholder values


resp = client.get_integration({
  domain_name: "name", # required
  uri: "string1To255", # required
})

Response structure


resp.domain_name #=> String
resp.uri #=> String
resp.object_type_name #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :uri (required, String) —

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

Returns:

See Also:



919
920
921
922
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 919

def get_integration(params = {}, options = {})
  req = build_request(:get_integration, params)
  req.send_request(options)
end

#get_matches(params = {}) ⇒ Types::GetMatchesResponse

This API is in preview release for Amazon Connect and subject to change.

Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true.

GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.

Amazon Connect runs a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.

Amazon Connect uses the following profile attributes to identify matches:

  • PhoneNumber

  • HomePhoneNumber

  • BusinessPhoneNumber

  • MobilePhoneNumber

  • EmailAddress

  • PersonalEmailAddress

  • BusinessEmailAddress

  • FullName

  • BusinessName

Examples:

Request syntax with placeholder values


resp = client.get_matches({
  next_token: "token",
  max_results: 1,
  domain_name: "name", # required
})

Response structure


resp.next_token #=> String
resp.match_generation_date #=> Time
resp.potential_matches #=> Integer
resp.matches #=> Array
resp.matches[0].match_id #=> String
resp.matches[0].profile_ids #=> Array
resp.matches[0].profile_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    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 (Integer) —

    The maximum number of results to return per page.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



1003
1004
1005
1006
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1003

def get_matches(params = {}, options = {})
  req = build_request(:get_matches, params)
  req.send_request(options)
end

#get_profile_object_type(params = {}) ⇒ Types::GetProfileObjectTypeResponse

Returns the object types for a specific domain.

Examples:

Request syntax with placeholder values


resp = client.get_profile_object_type({
  domain_name: "name", # required
  object_type_name: "typeName", # required
})

Response structure


resp.object_type_name #=> String
resp.description #=> String
resp.template_id #=> String
resp.expiration_days #=> Integer
resp.encryption_key #=> String
resp.allow_profile_creation #=> Boolean
resp.fields #=> Hash
resp.fields["name"].source #=> String
resp.fields["name"].target #=> String
resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
resp.keys #=> Hash
resp.keys["name"] #=> Array
resp.keys["name"][0].standard_identifiers #=> Array
resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
resp.keys["name"][0].field_names #=> Array
resp.keys["name"][0].field_names[0] #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :object_type_name (required, String) —

    The name of the profile object type.

Returns:

See Also:



1064
1065
1066
1067
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1064

def get_profile_object_type(params = {}, options = {})
  req = build_request(:get_profile_object_type, params)
  req.send_request(options)
end

#get_profile_object_type_template(params = {}) ⇒ Types::GetProfileObjectTypeTemplateResponse

Returns the template information for a specific object type.

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

Examples:

Request syntax with placeholder values


resp = client.get_profile_object_type_template({
  template_id: "name", # required
})

Response structure


resp.template_id #=> String
resp.source_name #=> String
resp.source_object #=> String
resp.allow_profile_creation #=> Boolean
resp.fields #=> Hash
resp.fields["name"].source #=> String
resp.fields["name"].target #=> String
resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
resp.keys #=> Hash
resp.keys["name"] #=> Array
resp.keys["name"][0].standard_identifiers #=> Array
resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
resp.keys["name"][0].field_names #=> Array
resp.keys["name"][0].field_names[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_id (required, String) —

    A unique identifier for the object template.

Returns:

See Also:



1116
1117
1118
1119
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1116

def get_profile_object_type_template(params = {}, options = {})
  req = build_request(:get_profile_object_type_template, params)
  req.send_request(options)
end

#list_account_integrations(params = {}) ⇒ Types::ListAccountIntegrationsResponse

Lists all of the integrations associated to a specific URI in the AWS account.

Examples:

Request syntax with placeholder values


resp = client.({
  uri: "string1To255", # required
  next_token: "token",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_name #=> String
resp.items[0].uri #=> String
resp.items[0].object_type_name #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :uri (required, String) —

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

  • :next_token (String) —

    The pagination token from the previous ListAccountIntegrations API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1163
1164
1165
1166
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1163

def (params = {}, options = {})
  req = build_request(:list_account_integrations, params)
  req.send_request(options)
end

#list_domains(params = {}) ⇒ Types::ListDomainsResponse

Returns a list of all the domains for an AWS account that have been created.

Examples:

Request syntax with placeholder values


resp = client.list_domains({
  next_token: "token",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_name #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous ListDomain API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1203
1204
1205
1206
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1203

def list_domains(params = {}, options = {})
  req = build_request(:list_domains, params)
  req.send_request(options)
end

#list_integrations(params = {}) ⇒ Types::ListIntegrationsResponse

Lists all of the integrations in your domain.

Examples:

Request syntax with placeholder values


resp = client.list_integrations({
  domain_name: "name", # required
  next_token: "token",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_name #=> String
resp.items[0].uri #=> String
resp.items[0].object_type_name #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :next_token (String) —

    The pagination token from the previous ListIntegrations API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1248
1249
1250
1251
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1248

def list_integrations(params = {}, options = {})
  req = build_request(:list_integrations, params)
  req.send_request(options)
end

#list_profile_object_type_templates(params = {}) ⇒ Types::ListProfileObjectTypeTemplatesResponse

Lists all of the template information for object types.

Examples:

Request syntax with placeholder values


resp = client.list_profile_object_type_templates({
  next_token: "token",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].template_id #=> String
resp.items[0].source_name #=> String
resp.items[0].source_object #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous ListObjectTypeTemplates API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1286
1287
1288
1289
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1286

def list_profile_object_type_templates(params = {}, options = {})
  req = build_request(:list_profile_object_type_templates, params)
  req.send_request(options)
end

#list_profile_object_types(params = {}) ⇒ Types::ListProfileObjectTypesResponse

Lists all of the templates available within the service.

Examples:

Request syntax with placeholder values


resp = client.list_profile_object_types({
  domain_name: "name", # required
  next_token: "token",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].object_type_name #=> String
resp.items[0].description #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :next_token (String) —

    Identifies the next page of results to return.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1330
1331
1332
1333
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1330

def list_profile_object_types(params = {}, options = {})
  req = build_request(:list_profile_object_types, params)
  req.send_request(options)
end

#list_profile_objects(params = {}) ⇒ Types::ListProfileObjectsResponse

Returns a list of objects associated with a profile of a given ProfileObjectType.

Examples:

Request syntax with placeholder values


resp = client.list_profile_objects({
  next_token: "token",
  max_results: 1,
  domain_name: "name", # required
  object_type_name: "typeName", # required
  profile_id: "uuid", # required
})

Response structure


resp.items #=> Array
resp.items[0].object_type_name #=> String
resp.items[0].profile_object_unique_key #=> String
resp.items[0].object #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous call to ListProfileObjects.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

  • :domain_name (required, String) —

    The unique name of the domain.

  • :object_type_name (required, String) —

    The name of the profile object type.

  • :profile_id (required, String) —

    The unique identifier of a customer profile.

Returns:

See Also:



1380
1381
1382
1383
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1380

def list_profile_objects(params = {}, options = {})
  req = build_request(:list_profile_objects, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TagArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



1411
1412
1413
1414
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1411

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#merge_profiles(params = {}) ⇒ Types::MergeProfilesResponse

This API is in preview release for Amazon Connect and subject to change.

Runs an AWS Lambda job that does the following:

  1. All the profileKeys in the ProfileToBeMerged will be moved to the main profile.

  2. All the objects in the ProfileToBeMerged will be moved to the main profile.

  3. All the ProfileToBeMerged will be deleted at the end.

  4. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile.

  5. Standard fields are merged as follows:

    1. Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.

    2. When there are conflicting fields:

      1. If no SourceProfileIds entry is specified, the main Profile value is always taken.

      2. If a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value.

You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).

Examples:

Request syntax with placeholder values


resp = client.merge_profiles({
  domain_name: "name", # required
  main_profile_id: "uuid", # required
  profile_ids_to_be_merged: ["uuid"], # required
  field_source_profile_ids: {
    account_number: "uuid",
    additional_information: "uuid",
    party_type: "uuid",
    business_name: "uuid",
    first_name: "uuid",
    middle_name: "uuid",
    last_name: "uuid",
    birth_date: "uuid",
    gender: "uuid",
    phone_number: "uuid",
    mobile_phone_number: "uuid",
    home_phone_number: "uuid",
    business_phone_number: "uuid",
    email_address: "uuid",
    personal_email_address: "uuid",
    business_email_address: "uuid",
    address: "uuid",
    shipping_address: "uuid",
    mailing_address: "uuid",
    billing_address: "uuid",
    attributes: {
      "string1To255" => "uuid",
    },
  },
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :main_profile_id (required, String) —

    The identifier of the profile to be taken.

  • :profile_ids_to_be_merged (required, Array<String>) —

    The identifier of the profile to be merged into MainProfileId.

  • :field_source_profile_ids (Types::FieldSourceProfileIds) —

    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.

Returns:

See Also:



1514
1515
1516
1517
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1514

def merge_profiles(params = {}, options = {})
  req = build_request(:merge_profiles, params)
  req.send_request(options)
end

#put_integration(params = {}) ⇒ Types::PutIntegrationResponse

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

An integration can belong to only one domain.

Examples:

Request syntax with placeholder values


resp = client.put_integration({
  domain_name: "name", # required
  uri: "string1To255",
  object_type_name: "typeName", # required
  tags: {
    "TagKey" => "TagValue",
  },
  flow_definition: {
    description: "FlowDescription",
    flow_name: "FlowName", # required
    kms_arn: "KmsArn", # required
    source_flow_config: { # required
      connector_profile_name: "ConnectorProfileName",
      connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
      incremental_pull_config: {
        datetime_type_field_name: "DatetimeTypeFieldName",
      },
      source_connector_properties: { # required
        marketo: {
          object: "Object", # required
        },
        s3: {
          bucket_name: "BucketName", # required
          bucket_prefix: "BucketPrefix",
        },
        salesforce: {
          object: "Object", # required
          enable_dynamic_field_update: false,
          include_deleted_records: false,
        },
        service_now: {
          object: "Object", # required
        },
        zendesk: {
          object: "Object", # required
        },
      },
    },
    tasks: [ # required
      {
        connector_operator: {
          marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
          s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
          salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
          service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
          zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
        },
        destination_field: "DestinationField",
        source_fields: ["stringTo2048"], # required
        task_properties: {
          "VALUE" => "Property",
        },
        task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
      },
    ],
    trigger_config: { # required
      trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
      trigger_properties: {
        scheduled: {
          schedule_expression: "ScheduleExpression", # required
          data_pull_mode: "Incremental", # accepts Incremental, Complete
          schedule_start_time: Time.now,
          schedule_end_time: Time.now,
          timezone: "Timezone",
          schedule_offset: 1,
          first_execution_from: Time.now,
        },
      },
    },
  },
})

Response structure


resp.domain_name #=> String
resp.uri #=> String
resp.object_type_name #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, 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 (required, String) —

    The name of the profile object type.

  • :tags (Hash<String,String>) —

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

  • :flow_definition (Types::FlowDefinition) —

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

Returns:

See Also:



1637
1638
1639
1640
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1637

def put_integration(params = {}, options = {})
  req = build_request(:put_integration, params)
  req.send_request(options)
end

#put_profile_object(params = {}) ⇒ Types::PutProfileObjectResponse

Adds additional objects to customer profiles of a given ObjectType.

When adding a specific profile object, like a Contact Trace Record (CTR), an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional CTRs with the same phone number will be mapped to the same inferred profile.

When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

Examples:

Request syntax with placeholder values


resp = client.put_profile_object({
  object_type_name: "typeName", # required
  object: "stringifiedJson", # required
  domain_name: "name", # required
})

Response structure


resp.profile_object_unique_key #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :object_type_name (required, String) —

    The name of the profile object type.

  • :object (required, String) —

    A string that is serialized from a JSON object.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



1686
1687
1688
1689
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1686

def put_profile_object(params = {}, options = {})
  req = build_request(:put_profile_object, params)
  req.send_request(options)
end

#put_profile_object_type(params = {}) ⇒ Types::PutProfileObjectTypeResponse

Defines a ProfileObjectType.

Examples:

Request syntax with placeholder values


resp = client.put_profile_object_type({
  domain_name: "name", # required
  object_type_name: "typeName", # required
  description: "text", # required
  template_id: "name",
  expiration_days: 1,
  encryption_key: "encryptionKey",
  allow_profile_creation: false,
  fields: {
    "name" => {
      source: "text",
      target: "text",
      content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
    },
  },
  keys: {
    "name" => [
      {
        standard_identifiers: ["PROFILE"], # accepts PROFILE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
        field_names: ["name"],
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.object_type_name #=> String
resp.description #=> String
resp.template_id #=> String
resp.expiration_days #=> Integer
resp.encryption_key #=> String
resp.allow_profile_creation #=> Boolean
resp.fields #=> Hash
resp.fields["name"].source #=> String
resp.fields["name"].target #=> String
resp.fields["name"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
resp.keys #=> Hash
resp.keys["name"] #=> Array
resp.keys["name"][0].standard_identifiers #=> Array
resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
resp.keys["name"][0].field_names #=> Array
resp.keys["name"][0].field_names[0] #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :object_type_name (required, String) —

    The name of the profile object type.

  • :description (required, String) —

    Description of the profile object type.

  • :template_id (String) —

    A unique identifier for the object template.

  • :expiration_days (Integer) —

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

  • :encryption_key (String) —

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

  • :allow_profile_creation (Boolean) —

    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.

  • :fields (Hash<String,Types::ObjectTypeField>) —

    A map of the name and ObjectType field.

  • :keys (Hash<String,Array>) —

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

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



1800
1801
1802
1803
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1800

def put_profile_object_type(params = {}, options = {})
  req = build_request(:put_profile_object_type, params)
  req.send_request(options)
end

#search_profiles(params = {}) ⇒ Types::SearchProfilesResponse

Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

Examples:

Request syntax with placeholder values


resp = client.search_profiles({
  next_token: "token",
  max_results: 1,
  domain_name: "name", # required
  key_name: "name", # required
  values: ["string1To255"], # required
})

Response structure


resp.items #=> Array
resp.items[0].profile_id #=> String
resp.items[0]. #=> String
resp.items[0].additional_information #=> String
resp.items[0].party_type #=> String, one of "INDIVIDUAL", "BUSINESS", "OTHER"
resp.items[0].business_name #=> String
resp.items[0].first_name #=> String
resp.items[0].middle_name #=> String
resp.items[0].last_name #=> String
resp.items[0].birth_date #=> String
resp.items[0].gender #=> String, one of "MALE", "FEMALE", "UNSPECIFIED"
resp.items[0].phone_number #=> String
resp.items[0].mobile_phone_number #=> String
resp.items[0].home_phone_number #=> String
resp.items[0].business_phone_number #=> String
resp.items[0].email_address #=> String
resp.items[0].personal_email_address #=> String
resp.items[0].business_email_address #=> String
resp.items[0].address.address_1 #=> String
resp.items[0].address.address_2 #=> String
resp.items[0].address.address_3 #=> String
resp.items[0].address.address_4 #=> String
resp.items[0].address.city #=> String
resp.items[0].address.county #=> String
resp.items[0].address.state #=> String
resp.items[0].address.province #=> String
resp.items[0].address.country #=> String
resp.items[0].address.postal_code #=> String
resp.items[0].shipping_address.address_1 #=> String
resp.items[0].shipping_address.address_2 #=> String
resp.items[0].shipping_address.address_3 #=> String
resp.items[0].shipping_address.address_4 #=> String
resp.items[0].shipping_address.city #=> String
resp.items[0].shipping_address.county #=> String
resp.items[0].shipping_address.state #=> String
resp.items[0].shipping_address.province #=> String
resp.items[0].shipping_address.country #=> String
resp.items[0].shipping_address.postal_code #=> String
resp.items[0].mailing_address.address_1 #=> String
resp.items[0].mailing_address.address_2 #=> String
resp.items[0].mailing_address.address_3 #=> String
resp.items[0].mailing_address.address_4 #=> String
resp.items[0].mailing_address.city #=> String
resp.items[0].mailing_address.county #=> String
resp.items[0].mailing_address.state #=> String
resp.items[0].mailing_address.province #=> String
resp.items[0].mailing_address.country #=> String
resp.items[0].mailing_address.postal_code #=> String
resp.items[0].billing_address.address_1 #=> String
resp.items[0].billing_address.address_2 #=> String
resp.items[0].billing_address.address_3 #=> String
resp.items[0].billing_address.address_4 #=> String
resp.items[0].billing_address.city #=> String
resp.items[0].billing_address.county #=> String
resp.items[0].billing_address.state #=> String
resp.items[0].billing_address.province #=> String
resp.items[0].billing_address.country #=> String
resp.items[0].billing_address.postal_code #=> String
resp.items[0].attributes #=> Hash
resp.items[0].attributes["string1To255"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous SearchProfiles API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

  • :domain_name (required, String) —

    The unique name of the domain.

  • :key_name (required, String) —

    A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

  • :values (required, Array<String>) —

    A list of key values.

Returns:

See Also:



1910
1911
1912
1913
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1910

def search_profiles(params = {}, options = {})
  req = build_request(:search_profiles, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TagArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Hash<String,String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1954
1955
1956
1957
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1954

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TagArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1982
1983
1984
1985
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1982

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_domain(params = {}) ⇒ Types::UpdateDomainResponse

Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

After a domain is created, the name can’t be changed.

Examples:

Request syntax with placeholder values


resp = client.update_domain({
  domain_name: "name", # required
  default_expiration_days: 1,
  default_encryption_key: "encryptionKey",
  dead_letter_queue_url: "sqsQueueUrl",
  matching: {
    enabled: false, # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.domain_name #=> String
resp.default_expiration_days #=> Integer
resp.default_encryption_key #=> String
resp.dead_letter_queue_url #=> String
resp.matching.enabled #=> Boolean
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :default_expiration_days (Integer) —

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

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

  • :dead_letter_queue_url (String) —

    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 (Types::MatchingRequest) —

    The process of matching duplicate profiles. This process runs every Saturday at 12AM.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



2061
2062
2063
2064
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2061

def update_domain(params = {}, options = {})
  req = build_request(:update_domain, params)
  req.send_request(options)
end

#update_profile(params = {}) ⇒ Types::UpdateProfileResponse

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

Examples:

Request syntax with placeholder values


resp = client.update_profile({
  domain_name: "name", # required
  profile_id: "uuid", # required
  additional_information: "string0To1000",
  account_number: "string0To255",
  party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
  business_name: "string0To255",
  first_name: "string0To255",
  middle_name: "string0To255",
  last_name: "string0To255",
  birth_date: "string0To255",
  gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
  phone_number: "string0To255",
  mobile_phone_number: "string0To255",
  home_phone_number: "string0To255",
  business_phone_number: "string0To255",
  email_address: "string0To255",
  personal_email_address: "string0To255",
  business_email_address: "string0To255",
  address: {
    address_1: "string0To255",
    address_2: "string0To255",
    address_3: "string0To255",
    address_4: "string0To255",
    city: "string0To255",
    county: "string0To255",
    state: "string0To255",
    province: "string0To255",
    country: "string0To255",
    postal_code: "string0To255",
  },
  shipping_address: {
    address_1: "string0To255",
    address_2: "string0To255",
    address_3: "string0To255",
    address_4: "string0To255",
    city: "string0To255",
    county: "string0To255",
    state: "string0To255",
    province: "string0To255",
    country: "string0To255",
    postal_code: "string0To255",
  },
  mailing_address: {
    address_1: "string0To255",
    address_2: "string0To255",
    address_3: "string0To255",
    address_4: "string0To255",
    city: "string0To255",
    county: "string0To255",
    state: "string0To255",
    province: "string0To255",
    country: "string0To255",
    postal_code: "string0To255",
  },
  billing_address: {
    address_1: "string0To255",
    address_2: "string0To255",
    address_3: "string0To255",
    address_4: "string0To255",
    city: "string0To255",
    county: "string0To255",
    state: "string0To255",
    province: "string0To255",
    country: "string0To255",
    postal_code: "string0To255",
  },
  attributes: {
    "string1To255" => "string0To255",
  },
})

Response structure


resp.profile_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :profile_id (required, String) —

    The unique identifier of a customer profile.

  • :additional_information (String) —

    Any additional information relevant to the customer’s profile.

  • :account_number (String) —

    A unique account number that you have given to the customer.

  • :party_type (String) —

    The type of profile used to describe the customer.

  • :business_name (String) —

    The name of the customer’s business.

  • :first_name (String) —

    The customer’s first name.

  • :middle_name (String) —

    The customer’s middle name.

  • :last_name (String) —

    The customer’s last name.

  • :birth_date (String) —

    The customer’s birth date.

  • :gender (String) —

    The gender with which the customer identifies.

  • :phone_number (String) —

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

  • :mobile_phone_number (String) —

    The customer’s mobile phone number.

  • :home_phone_number (String) —

    The customer’s home phone number.

  • :business_phone_number (String) —

    The customer’s business phone number.

  • :email_address (String) —

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

  • :personal_email_address (String) —

    The customer’s personal email address.

  • :business_email_address (String) —

    The customer’s business email address.

  • :address (Types::UpdateAddress) —

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

  • :shipping_address (Types::UpdateAddress) —

    The customer’s shipping address.

  • :mailing_address (Types::UpdateAddress) —

    The customer’s mailing address.

  • :billing_address (Types::UpdateAddress) —

    The customer’s billing address.

  • :attributes (Hash<String,String>) —

    A key value pair of attributes of a customer profile.

Returns:

See Also:



2231
2232
2233
2234
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2231

def update_profile(params = {}, options = {})
  req = build_request(:update_profile, params)
  req.send_request(options)
end