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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :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)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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. Takes effect only when disable_clock_skew_correction is not set.

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

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

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::CustomerProfiles::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CustomerProfiles::EndpointParameters.

  • :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_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_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. 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.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



478
479
480
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 478

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 Record 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. 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 (required, Array<String>) —

    A list of key values.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



533
534
535
536
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 533

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

#associate_stream_for_segments(params = {}) ⇒ Struct

Associates an Amazon Kinesis data stream to receive segment membership events for a given domain. This is a domain-level configuration that applies to all segment subscriptions within the domain. A domain can have only one associated stream at a time.

Examples:

Request syntax with placeholder values


resp = client.associate_stream_for_segments({
  domain_name: "name", # required
  destination_arn: "DestinationArnString", # required
  destination_role_arn: "DestinationRoleArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :destination_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Kinesis data stream to deliver segment membership events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.

  • :destination_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting AWS Key Management Service (KMS) and Amazon Kinesis operations. The role must grant the following Amazon Kinesis permissions to deliver segment membership events to the stream:

    • kinesis:PutRecord

    • kinesis:PutRecords

    • kinesis:DescribeStream

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



578
579
580
581
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 578

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

#batch_get_calculated_attribute_for_profile(params = {}) ⇒ Types::BatchGetCalculatedAttributeForProfileResponse

Fetch the possible attribute values given the attribute name.

Examples:

Request syntax with placeholder values


resp = client.batch_get_calculated_attribute_for_profile({
  calculated_attribute_name: "typeName", # required
  domain_name: "name", # required
  profile_ids: ["uuid"], # required
  condition_overrides: {
    range: {
      start: 1, # required
      end: 1,
      unit: "DAYS", # required, accepts DAYS
    },
  },
})

Response structure


resp.errors #=> Array
resp.errors[0].code #=> String
resp.errors[0].message #=> String
resp.errors[0].profile_id #=> String
resp.calculated_attribute_values #=> Array
resp.calculated_attribute_values[0].calculated_attribute_name #=> String
resp.calculated_attribute_values[0].display_name #=> String
resp.calculated_attribute_values[0].is_data_partial #=> String
resp.calculated_attribute_values[0].profile_id #=> String
resp.calculated_attribute_values[0].value #=> String
resp.calculated_attribute_values[0].last_object_timestamp #=> Time
resp.condition_overrides.range.start #=> Integer
resp.condition_overrides.range.end #=> Integer
resp.condition_overrides.range.unit #=> String, one of "DAYS"

Parameters:

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

    ({})

Options Hash (params):

  • :calculated_attribute_name (required, String) —

    The unique name of the calculated attribute.

  • :domain_name (required, String) —

    The unique name of the domain.

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

    List of unique identifiers for customer profiles to retrieve.

  • :condition_overrides (Types::ConditionOverrides) —

    Overrides the condition block within the original calculated attribute definition.

Returns:

See Also:



640
641
642
643
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 640

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

#batch_get_profile(params = {}) ⇒ Types::BatchGetProfileResponse

Get a batch of profiles.

Examples:

Request syntax with placeholder values


resp = client.batch_get_profile({
  domain_name: "name", # required
  profile_ids: ["uuid"], # required
})

Response structure


resp.errors #=> Array
resp.errors[0].code #=> String
resp.errors[0].message #=> String
resp.errors[0].profile_id #=> String
resp.profiles #=> Array
resp.profiles[0].profile_id #=> String
resp.profiles[0]. #=> String
resp.profiles[0].additional_information #=> String
resp.profiles[0].party_type #=> String, one of "INDIVIDUAL", "BUSINESS", "OTHER"
resp.profiles[0].business_name #=> String
resp.profiles[0].first_name #=> String
resp.profiles[0].middle_name #=> String
resp.profiles[0].last_name #=> String
resp.profiles[0].birth_date #=> String
resp.profiles[0].gender #=> String, one of "MALE", "FEMALE", "UNSPECIFIED"
resp.profiles[0].phone_number #=> String
resp.profiles[0].mobile_phone_number #=> String
resp.profiles[0].home_phone_number #=> String
resp.profiles[0].business_phone_number #=> String
resp.profiles[0].email_address #=> String
resp.profiles[0].personal_email_address #=> String
resp.profiles[0].business_email_address #=> String
resp.profiles[0].address.address_1 #=> String
resp.profiles[0].address.address_2 #=> String
resp.profiles[0].address.address_3 #=> String
resp.profiles[0].address.address_4 #=> String
resp.profiles[0].address.city #=> String
resp.profiles[0].address.county #=> String
resp.profiles[0].address.state #=> String
resp.profiles[0].address.province #=> String
resp.profiles[0].address.country #=> String
resp.profiles[0].address.postal_code #=> String
resp.profiles[0].shipping_address.address_1 #=> String
resp.profiles[0].shipping_address.address_2 #=> String
resp.profiles[0].shipping_address.address_3 #=> String
resp.profiles[0].shipping_address.address_4 #=> String
resp.profiles[0].shipping_address.city #=> String
resp.profiles[0].shipping_address.county #=> String
resp.profiles[0].shipping_address.state #=> String
resp.profiles[0].shipping_address.province #=> String
resp.profiles[0].shipping_address.country #=> String
resp.profiles[0].shipping_address.postal_code #=> String
resp.profiles[0].mailing_address.address_1 #=> String
resp.profiles[0].mailing_address.address_2 #=> String
resp.profiles[0].mailing_address.address_3 #=> String
resp.profiles[0].mailing_address.address_4 #=> String
resp.profiles[0].mailing_address.city #=> String
resp.profiles[0].mailing_address.county #=> String
resp.profiles[0].mailing_address.state #=> String
resp.profiles[0].mailing_address.province #=> String
resp.profiles[0].mailing_address.country #=> String
resp.profiles[0].mailing_address.postal_code #=> String
resp.profiles[0].billing_address.address_1 #=> String
resp.profiles[0].billing_address.address_2 #=> String
resp.profiles[0].billing_address.address_3 #=> String
resp.profiles[0].billing_address.address_4 #=> String
resp.profiles[0].billing_address.city #=> String
resp.profiles[0].billing_address.county #=> String
resp.profiles[0].billing_address.state #=> String
resp.profiles[0].billing_address.province #=> String
resp.profiles[0].billing_address.country #=> String
resp.profiles[0].billing_address.postal_code #=> String
resp.profiles[0].attributes #=> Hash
resp.profiles[0].attributes["string1To255"] #=> String
resp.profiles[0].found_by_items #=> Array
resp.profiles[0].found_by_items[0].key_name #=> String
resp.profiles[0].found_by_items[0].values #=> Array
resp.profiles[0].found_by_items[0].values[0] #=> String
resp.profiles[0].party_type_string #=> String
resp.profiles[0].gender_string #=> String
resp.profiles[0].profile_type #=> String, one of "ACCOUNT_PROFILE", "PROFILE"
resp.profiles[0].engagement_preferences.phone #=> Array
resp.profiles[0].engagement_preferences.phone[0].key_name #=> String
resp.profiles[0].engagement_preferences.phone[0].key_value #=> String
resp.profiles[0].engagement_preferences.phone[0].profile_id #=> String
resp.profiles[0].engagement_preferences.phone[0].contact_type #=> String, one of "PhoneNumber", "MobilePhoneNumber", "HomePhoneNumber", "BusinessPhoneNumber", "EmailAddress", "PersonalEmailAddress", "BusinessEmailAddress"
resp.profiles[0].engagement_preferences.email #=> Array
resp.profiles[0].engagement_preferences.email[0].key_name #=> String
resp.profiles[0].engagement_preferences.email[0].key_value #=> String
resp.profiles[0].engagement_preferences.email[0].profile_id #=> String
resp.profiles[0].engagement_preferences.email[0].contact_type #=> String, one of "PhoneNumber", "MobilePhoneNumber", "HomePhoneNumber", "BusinessPhoneNumber", "EmailAddress", "PersonalEmailAddress", "BusinessEmailAddress"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

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

    List of unique identifiers for customer profiles to retrieve.

Returns:

See Also:



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

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

#batch_put_profile_object(params = {}) ⇒ Types::BatchPutProfileObjectResponse

Adds multiple profile objects to a domain of a given ObjectType in a single API call.

When adding a specific profile object, like a Contact Record, 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 Contact Records 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.

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

Examples:

Request syntax with placeholder values


resp = client.batch_put_profile_object({
  domain_name: "name", # required
  object_type_name: "typeName", # required
  items: [ # required
    {
      id: "name", # required
      object: "stringifiedJson", # required
    },
  ],
})

Response structure


resp.successful #=> Array
resp.successful[0].id #=> String
resp.successful[0].profile_object_unique_key #=> String
resp.failed #=> Array
resp.failed[0].id #=> String
resp.failed[0].code #=> Integer
resp.failed[0].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.

  • :items (required, Array<Types::BatchPutProfileObjectRequestItem>) —

    A list of items to add to the domain.

Returns:

See Also:



815
816
817
818
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 815

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

#create_calculated_attribute_definition(params = {}) ⇒ Types::CreateCalculatedAttributeDefinitionResponse

Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType.

Examples:

Request syntax with placeholder values


resp = client.create_calculated_attribute_definition({
  domain_name: "name", # required
  calculated_attribute_name: "typeName", # required
  display_name: "displayName",
  description: "sensitiveText",
  attribute_details: { # required
    attributes: [ # required
      {
        name: "attributeName", # required
      },
    ],
    expression: "string1To255", # required
  },
  conditions: {
    range: {
      value: 1,
      unit: "DAYS", # accepts DAYS
      value_range: {
        start: 1, # required
        end: 1, # required
      },
      timestamp_source: "string1To255",
      timestamp_format: "string1To255",
    },
    object_count: 1,
    threshold: {
      value: "string1To255", # required
      operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
    },
  },
  filter: {
    include: "ALL", # required, accepts ALL, ANY, NONE
    groups: [ # required
      {
        type: "ALL", # required, accepts ALL, ANY, NONE
        dimensions: [ # required
          {
            attributes: { # required
              "attributeName" => {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL
                values: ["string1To255"], # required
              },
            },
          },
        ],
      },
    ],
  },
  statistic: "FIRST_OCCURRENCE", # required, accepts FIRST_OCCURRENCE, LAST_OCCURRENCE, COUNT, SUM, MINIMUM, MAXIMUM, AVERAGE, MAX_OCCURRENCE, RECENT_OCCURRENCES
  use_historical_data: false,
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.calculated_attribute_name #=> String
resp.display_name #=> String
resp.description #=> String
resp.attribute_details.attributes #=> Array
resp.attribute_details.attributes[0].name #=> String
resp.attribute_details.expression #=> String
resp.conditions.range.value #=> Integer
resp.conditions.range.unit #=> String, one of "DAYS"
resp.conditions.range.value_range.start #=> Integer
resp.conditions.range.value_range.end #=> Integer
resp.conditions.range.timestamp_source #=> String
resp.conditions.range.timestamp_format #=> String
resp.conditions.object_count #=> Integer
resp.conditions.threshold.value #=> String
resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
resp.data.filter.include #=> String, one of "ALL", "ANY", "NONE"
resp.data.filter.groups #=> Array
resp.data.filter.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.data.filter.groups[0].dimensions #=> Array
resp.data.filter.groups[0].dimensions[0].attributes #=> Hash
resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL"
resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values #=> Array
resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values[0] #=> String
resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE", "RECENT_OCCURRENCES"
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.use_historical_data #=> Boolean
resp.status #=> String, one of "PREPARING", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.readiness.progress_percentage #=> Integer
resp.readiness.message #=> String
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.

  • :calculated_attribute_name (required, String) —

    The unique name of the calculated attribute.

  • :display_name (String) —

    The display name of the calculated attribute.

  • :description (String) —

    The description of the calculated attribute.

  • :attribute_details (required, Types::AttributeDetails) —

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

  • :conditions (Types::Conditions) —

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

  • :filter (Types::Filter) —

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

  • :statistic (required, String) —

    The aggregation operation to perform for the calculated attribute.

  • :use_historical_data (Boolean) —

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

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

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

Returns:

See Also:



978
979
980
981
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 978

def create_calculated_attribute_definition(params = {}, options = {})
  req = build_request(:create_calculated_attribute_definition, 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 Connect Customer instance can be associated with only one domain. Multiple Connect Customer instances can be associated with one domain.

Use this API or UpdateDomain to enable identity resolution: set Matching to true.

To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.

It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see Enable Customer Profiles.

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
    job_schedule: {
      day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
      time: "JobScheduleTime", # required
    },
    auto_merging: {
      enabled: false, # required
      consolidation: {
        matching_attributes_list: [ # required
          ["string1To255"],
        ],
      },
      conflict_resolution: {
        conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
        source_name: "string1To255",
      },
      min_allowed_confidence_score_for_merging: 1.0,
    },
    exporting_config: {
      s3_exporting: {
        s3_bucket_name: "s3BucketName", # required
        s3_key_name: "s3KeyNameCustomerOutputConfig",
      },
    },
  },
  rule_based_matching: {
    enabled: false, # required
    matching_rules: [
      {
        rule: ["string1To255"], # required
      },
    ],
    max_allowed_rule_level_for_merging: 1,
    max_allowed_rule_level_for_matching: 1,
    attribute_types_selector: {
      attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
      address: ["string1To255"],
      phone_number: ["string1To255"],
      email_address: ["string1To255"],
    },
    conflict_resolution: {
      conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
      source_name: "string1To255",
    },
    exporting_config: {
      s3_exporting: {
        s3_bucket_name: "s3BucketName", # required
        s3_key_name: "s3KeyNameCustomerOutputConfig",
      },
    },
  },
  data_store: {
    enabled: false,
  },
  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.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.matching.job_schedule.time #=> String
resp.matching.auto_merging.enabled #=> Boolean
resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
resp.matching.auto_merging.conflict_resolution.source_name #=> String
resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
resp.rule_based_matching.enabled #=> Boolean
resp.rule_based_matching.matching_rules #=> Array
resp.rule_based_matching.matching_rules[0].rule #=> Array
resp.rule_based_matching.matching_rules[0].rule[0] #=> String
resp.rule_based_matching.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE"
resp.rule_based_matching.max_allowed_rule_level_for_merging #=> Integer
resp.rule_based_matching.max_allowed_rule_level_for_matching #=> Integer
resp.rule_based_matching.attribute_types_selector.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.rule_based_matching.attribute_types_selector.address #=> Array
resp.rule_based_matching.attribute_types_selector.address[0] #=> String
resp.rule_based_matching.attribute_types_selector.phone_number #=> Array
resp.rule_based_matching.attribute_types_selector.phone_number[0] #=> String
resp.rule_based_matching.attribute_types_selector.email_address #=> Array
resp.rule_based_matching.attribute_types_selector.email_address[0] #=> String
resp.rule_based_matching.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
resp.rule_based_matching.conflict_resolution.source_name #=> String
resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
resp.data_store.enabled #=> Boolean
resp.data_store.readiness.progress_percentage #=> Integer
resp.data_store.readiness.message #=> 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.

  • :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. 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 (Types::RuleBasedMatchingRequest) —

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

  • :data_store (Types::DataStoreRequest) —

    Set to true to enabled data store for this domain.

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

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

Returns:

See Also:



1193
1194
1195
1196
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1193

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

#create_domain_layout(params = {}) ⇒ Types::CreateDomainLayoutResponse

Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Examples:

Request syntax with placeholder values


resp = client.create_domain_layout({
  domain_name: "name", # required
  layout_definition_name: "name", # required
  description: "sensitiveText", # required
  display_name: "displayName", # required
  is_default: false,
  layout_type: "PROFILE_EXPLORER", # required, accepts PROFILE_EXPLORER
  layout: "sensitiveString1To2000000", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.layout_definition_name #=> String
resp.description #=> String
resp.display_name #=> String
resp.is_default #=> Boolean
resp.layout_type #=> String, one of "PROFILE_EXPLORER"
resp.layout #=> String
resp.version #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :layout_definition_name (required, String) —

    The unique name of the layout.

  • :description (required, String) —

    The description of the layout

  • :display_name (required, String) —

    The display name of the layout

  • :is_default (Boolean) —

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

  • :layout_type (required, String) —

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

  • :layout (required, String) —

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

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

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

Returns:

See Also:



1276
1277
1278
1279
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1276

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

#create_event_stream(params = {}) ⇒ Types::CreateEventStreamResponse

Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer Customer Profiles.

Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain

Examples:

Request syntax with placeholder values


resp = client.create_event_stream({
  domain_name: "name", # required
  uri: "string1To255", # required
  event_stream_name: "name", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.event_stream_arn #=> String
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 StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name

  • :event_stream_name (required, String) —

    The name of the event stream.

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

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

Returns:

See Also:



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

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

#create_event_trigger(params = {}) ⇒ Types::CreateEventTriggerResponse

Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data.

Each event stream can be associated with only one integration in the same region and AWS account as the event stream.

Examples:

Request syntax with placeholder values


resp = client.create_event_trigger({
  domain_name: "name", # required
  event_trigger_name: "name", # required
  object_type_name: "typeName", # required
  description: "sensitiveText",
  event_trigger_conditions: [ # required
    {
      event_trigger_dimensions: [ # required
        {
          object_attributes: [ # required
            {
              source: "text",
              field_name: "fieldName",
              comparison_operator: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL, BEFORE, AFTER, ON, BETWEEN, NOT_BETWEEN
              values: ["string1To255"], # required
            },
          ],
        },
      ],
      logical_operator: "ANY", # required, accepts ANY, ALL, NONE
    },
  ],
  segment_filter: "name",
  event_trigger_limits: {
    event_expiration: 1,
    periods: [
      {
        unit: "MINUTES", # required, accepts MINUTES, HOURS, DAYS, WEEKS, MONTHS
        value: 1, # required
        max_invocations_per_profile: 1,
        unlimited: false,
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.event_trigger_name #=> String
resp.object_type_name #=> String
resp.description #=> String
resp.event_trigger_conditions #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].source #=> String
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].field_name #=> String
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].comparison_operator #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL", "BEFORE", "AFTER", "ON", "BETWEEN", "NOT_BETWEEN"
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].values #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].values[0] #=> String
resp.event_trigger_conditions[0].logical_operator #=> String, one of "ANY", "ALL", "NONE"
resp.segment_filter #=> String
resp.event_trigger_limits.event_expiration #=> Integer
resp.event_trigger_limits.periods #=> Array
resp.event_trigger_limits.periods[0].unit #=> String, one of "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS"
resp.event_trigger_limits.periods[0].value #=> Integer
resp.event_trigger_limits.periods[0].max_invocations_per_profile #=> Integer
resp.event_trigger_limits.periods[0].unlimited #=> 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.

  • :event_trigger_name (required, String) —

    The unique name of the event trigger.

  • :object_type_name (required, String) —

    The unique name of the object type.

  • :description (String) —

    The description of the event trigger.

  • :event_trigger_conditions (required, Array<Types::EventTriggerCondition>) —

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

  • :segment_filter (String) —

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

  • :event_trigger_limits (Types::EventTriggerLimits) —

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

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

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

Returns:

See Also:



1450
1451
1452
1453
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1450

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

#create_integration_workflow(params = {}) ⇒ Types::CreateIntegrationWorkflowResponse

Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.

Examples:

Request syntax with placeholder values


resp = client.create_integration_workflow({
  domain_name: "name", # required
  workflow_type: "APPFLOW_INTEGRATION", # required, accepts APPFLOW_INTEGRATION
  integration_config: { # required
    appflow_integration: {
      flow_definition: { # required
        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,
            },
          },
        },
      },
      batches: [
        {
          start_time: Time.now, # required
          end_time: Time.now, # required
        },
      ],
    },
  },
  object_type_name: "typeName", # required
  role_arn: "RoleArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.workflow_id #=> String
resp.message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :workflow_type (required, String) —

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

  • :integration_config (required, Types::IntegrationConfig) —

    Configuration data for integration workflow.

  • :object_type_name (required, String) —

    The name of the profile object type.

  • :role_arn (required, String) —

    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 (Hash<String,String>) —

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

Returns:

See Also:



1580
1581
1582
1583
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1580

def create_integration_workflow(params = {}, options = {})
  req = build_request(:create_integration_workflow, 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: "sensitiveString1To255",
  additional_information: "sensitiveString1To1000",
  party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
  business_name: "sensitiveString1To255",
  first_name: "sensitiveString1To255",
  middle_name: "sensitiveString1To255",
  last_name: "sensitiveString1To255",
  birth_date: "sensitiveString1To255",
  gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
  phone_number: "sensitiveString1To255",
  mobile_phone_number: "sensitiveString1To255",
  home_phone_number: "sensitiveString1To255",
  business_phone_number: "sensitiveString1To255",
  email_address: "sensitiveString1To255",
  personal_email_address: "sensitiveString1To255",
  business_email_address: "sensitiveString1To255",
  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",
  },
  party_type_string: "sensitiveString1To255",
  gender_string: "sensitiveString1To255",
  profile_type: "ACCOUNT_PROFILE", # accepts ACCOUNT_PROFILE, PROFILE
  engagement_preferences: {
    phone: [
      {
        key_name: "name",
        key_value: "string1To255",
        profile_id: "uuid",
        contact_type: "PhoneNumber", # accepts PhoneNumber, MobilePhoneNumber, HomePhoneNumber, BusinessPhoneNumber, EmailAddress, PersonalEmailAddress, BusinessEmailAddress
      },
    ],
    email: [
      {
        key_name: "name",
        key_value: "string1To255",
        profile_id: "uuid",
        contact_type: "PhoneNumber", # accepts PhoneNumber, MobilePhoneNumber, HomePhoneNumber, BusinessPhoneNumber, EmailAddress, PersonalEmailAddress, BusinessEmailAddress
      },
    ],
  },
})

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

    An account number that you have assigned 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.

  • :party_type_string (String) —

    An alternative to PartyType which accepts any string as input.

  • :gender_string (String) —

    An alternative to Gender which accepts any string as input.

  • :profile_type (String) —

    The type of the profile.

  • :engagement_preferences (Types::EngagementPreferences) —

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

Returns:

See Also:



1777
1778
1779
1780
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1777

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

#create_recommender(params = {}) ⇒ Types::CreateRecommenderResponse

Creates a recommender

Examples:

Request syntax with placeholder values


resp = client.create_recommender({
  domain_name: "name", # required
  recommender_name: "name", # required
  recommender_recipe_name: "recommended-for-you", # required, accepts recommended-for-you, similar-items, frequently-paired-items, popular-items, trending-now, personalized-ranking
  recommender_config: {
    events_config: {
      event_parameters_list: [ # required
        {
          event_type: "EventParametersEventTypeString", # required
          event_value_threshold: 1.0,
          event_weight: 1.0,
        },
      ],
    },
    training_frequency: 1,
    inference_config: {
      min_provisioned_tps: 1,
    },
    included_columns: {
      "String" => ["text"],
    },
    excluded_columns: {
      "String" => ["text"],
    },
    diversity_config: {
      diversity_columns: [
        {
          name: "text", # required
          cap_type: "PERCENTAGE", # required, accepts PERCENTAGE, VALUE
          target: "DiversityTargetExpression", # required
        },
      ],
    },
  },
  description: "sensitiveText",
  recommender_schema_name: "name",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.recommender_arn #=> String
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.

  • :recommender_name (required, String) —

    The name of the recommender.

  • :recommender_recipe_name (required, String) —

    The name of the recommeder recipe.

  • :recommender_config (Types::RecommenderConfig) —

    The recommender configuration.

  • :description (String) —

    The description of the domain object type.

  • :recommender_schema_name (String) —

    The name of the recommender schema to use for this recommender. If not specified, the default schema is used.

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

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

Returns:

See Also:



1864
1865
1866
1867
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1864

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

#create_recommender_filter(params = {}) ⇒ Types::CreateRecommenderFilterResponse

Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.

Examples:

Request syntax with placeholder values


resp = client.create_recommender_filter({
  domain_name: "name", # required
  recommender_filter_name: "RecommenderFilterName", # required
  recommender_filter_expression: "RecommenderFilterExpression", # required
  recommender_schema_name: "name",
  description: "sensitiveText",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.recommender_filter_arn #=> String
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.

  • :recommender_filter_name (required, String) —

    The name of the recommender filter. The name must be unique within the domain.

  • :recommender_filter_expression (required, String) —

    The filter expression that defines which items to include or exclude from recommendations.

  • :recommender_schema_name (String) —

    The name of the recommender schema to use for this recommender filter. If not specified, the default schema is used.

  • :description (String) —

    A description of the recommender filter.

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

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

Returns:

See Also:



1921
1922
1923
1924
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1921

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

#create_recommender_schema(params = {}) ⇒ Types::CreateRecommenderSchemaResponse

Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.

Examples:

Request syntax with placeholder values


resp = client.create_recommender_schema({
  domain_name: "name", # required
  recommender_schema_name: "name", # required
  fields: { # required
    "String" => [
      {
        target_field_name: "text", # required
        content_type: "STRING", # accepts STRING, NUMBER
        feature_type: "TEXTUAL", # accepts TEXTUAL, CATEGORICAL
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.recommender_schema_arn #=> String
resp.recommender_schema_name #=> String
resp.fields #=> Hash
resp.fields["String"] #=> Array
resp.fields["String"][0].target_field_name #=> String
resp.fields["String"][0].content_type #=> String, one of "STRING", "NUMBER"
resp.fields["String"][0].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
resp.created_at #=> Time
resp.status #=> String, one of "ACTIVE", "DELETING"
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.

  • :recommender_schema_name (required, String) —

    The name of the recommender schema. The name must be unique within the domain.

  • :fields (required, Hash<String,Array>) —

    A map of dataset type to column definitions that specifies which data columns to include in the schema. The _webAnalytics and _catalogItem keys are supported.

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

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

Returns:

See Also:



1991
1992
1993
1994
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 1991

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

#create_segment_definition(params = {}) ⇒ Types::CreateSegmentDefinitionResponse

Creates a segment definition associated to the given domain.

Examples:

Request syntax with placeholder values


resp = client.create_segment_definition({
  domain_name: "name", # required
  segment_definition_name: "name", # required
  display_name: "string1To255", # required
  description: "sensitiveString1To4000",
  segment_groups: {
    groups: [
      {
        dimensions: [
          {
            profile_attributes: {
              account_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              additional_information: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To1000"], # required
              },
              first_name: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              last_name: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              middle_name: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              gender_string: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              party_type_string: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              birth_date: {
                dimension_type: "BEFORE", # required, accepts BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON
                values: ["String"], # required
              },
              phone_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              business_name: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              business_phone_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              home_phone_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              mobile_phone_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              email_address: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              personal_email_address: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              business_email_address: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              address: {
                city: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                country: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                county: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                postal_code: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                province: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                state: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
              },
              shipping_address: {
                city: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                country: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                county: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                postal_code: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                province: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                state: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
              },
              mailing_address: {
                city: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                country: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                county: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                postal_code: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                province: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                state: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
              },
              billing_address: {
                city: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                country: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                county: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                postal_code: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                province: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                state: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
              },
              attributes: {
                "string1To255" => {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL, LIST_CONTAINS, LIST_CONTAINS_ALL
                  values: ["string1To255"], # required
                },
              },
              profile_type: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE
                values: ["ACCOUNT_PROFILE"], # required, accepts ACCOUNT_PROFILE, PROFILE
              },
            },
            calculated_attributes: {
              "typeName" => {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL, LIST_CONTAINS, LIST_CONTAINS_ALL
                values: ["string1To255"], # required
                condition_overrides: {
                  range: {
                    start: 1, # required
                    end: 1,
                    unit: "DAYS", # required, accepts DAYS
                  },
                },
              },
            },
          },
        ],
        source_segments: [
          {
            segment_definition_name: "name",
          },
        ],
        source_type: "ALL", # accepts ALL, ANY, NONE
        type: "ALL", # accepts ALL, ANY, NONE
      },
    ],
    include: "ALL", # accepts ALL, ANY, NONE
  },
  segment_sql_query: "sensitiveString1To50000",
  segment_sort: {
    attributes: [ # required
      {
        name: "fieldName", # required
        data_type: "STRING", # accepts STRING, NUMBER, DATE
        order: "ASC", # required, accepts ASC, DESC
        type: "PROFILE", # accepts PROFILE, CALCULATED
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.segment_definition_name #=> String
resp.display_name #=> String
resp.description #=> String
resp.created_at #=> Time
resp.segment_definition_arn #=> String
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.

  • :segment_definition_name (required, String) —

    The unique name of the segment definition.

  • :display_name (required, String) —

    The display name of the segment definition.

  • :description (String) —

    The description of the segment definition.

  • :segment_groups (Types::SegmentGroup) —

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

  • :segment_sql_query (String) —

    The segment SQL query.

  • :segment_sort (Types::SegmentSort) —

    The segment sort.

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

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

Returns:

See Also:



2280
2281
2282
2283
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2280

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

#create_segment_estimate(params = {}) ⇒ Types::CreateSegmentEstimateResponse

Creates a segment estimate query.

Examples:

Request syntax with placeholder values


resp = client.create_segment_estimate({
  domain_name: "name", # required
  segment_query: {
    groups: [
      {
        dimensions: [
          {
            profile_attributes: {
              account_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              additional_information: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To1000"], # required
              },
              first_name: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              last_name: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              middle_name: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              gender_string: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              party_type_string: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              birth_date: {
                dimension_type: "BEFORE", # required, accepts BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON
                values: ["String"], # required
              },
              phone_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              business_name: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              business_phone_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              home_phone_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              mobile_phone_number: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              email_address: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              personal_email_address: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              business_email_address: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                values: ["string1To255"], # required
              },
              address: {
                city: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                country: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                county: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                postal_code: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                province: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                state: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
              },
              shipping_address: {
                city: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                country: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                county: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                postal_code: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                province: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                state: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
              },
              mailing_address: {
                city: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                country: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                county: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                postal_code: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                province: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                state: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
              },
              billing_address: {
                city: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                country: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                county: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                postal_code: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                province: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
                state: {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH
                  values: ["string1To255"], # required
                },
              },
              attributes: {
                "string1To255" => {
                  dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL, LIST_CONTAINS, LIST_CONTAINS_ALL
                  values: ["string1To255"], # required
                },
              },
              profile_type: {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE
                values: ["ACCOUNT_PROFILE"], # required, accepts ACCOUNT_PROFILE, PROFILE
              },
            },
            calculated_attributes: {
              "typeName" => {
                dimension_type: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, BEFORE, AFTER, BETWEEN, NOT_BETWEEN, ON, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL, LIST_CONTAINS, LIST_CONTAINS_ALL
                values: ["string1To255"], # required
                condition_overrides: {
                  range: {
                    start: 1, # required
                    end: 1,
                    unit: "DAYS", # required, accepts DAYS
                  },
                },
              },
            },
          },
        ],
        source_segments: [
          {
            segment_definition_name: "name",
          },
        ],
        source_type: "ALL", # accepts ALL, ANY, NONE
        type: "ALL", # accepts ALL, ANY, NONE
      },
    ],
    include: "ALL", # accepts ALL, ANY, NONE
  },
  segment_sql_query: "sensitiveString1To50000",
})

Response structure


resp.domain_name #=> String
resp.estimate_id #=> String
resp.status_code #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :segment_query (Types::SegmentGroupStructure) —

    The segment query for calculating a segment estimate.

  • :segment_sql_query (String) —

    The segment SQL query.

Returns:

See Also:



2530
2531
2532
2533
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2530

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

#create_segment_snapshot(params = {}) ⇒ Types::CreateSegmentSnapshotResponse

Triggers a job to export a segment to a specified destination.

Examples:

Request syntax with placeholder values


resp = client.create_segment_snapshot({
  domain_name: "name", # required
  segment_definition_name: "name", # required
  data_format: "CSV", # required, accepts CSV, JSONL, ORC
  encryption_key: "encryptionKey",
  role_arn: "RoleArn",
  destination_uri: "string1To255",
})

Response structure


resp.snapshot_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :segment_definition_name (required, String) —

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

  • :data_format (required, String) —

    The format in which the segment will be exported.

  • :encryption_key (String) —

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

  • :role_arn (String) —

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

  • :destination_uri (String) —

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

Returns:

See Also:



2583
2584
2585
2586
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2583

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

#create_upload_job(params = {}) ⇒ Types::CreateUploadJobResponse

Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.

Examples:

Request syntax with placeholder values


resp = client.create_upload_job({
  domain_name: "name", # required
  display_name: "string1To255", # required
  fields: { # required
    "fieldName" => {
      source: "text",
      target: "text",
      content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
    },
  },
  unique_key: "text", # required
  data_expiry: 1,
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

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

  • :display_name (required, String) —

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

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

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

  • :unique_key (required, String) —

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

  • :data_expiry (Integer) —

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

Returns:

See Also:



2639
2640
2641
2642
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2639

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

#delete_calculated_attribute_definition(params = {}) ⇒ Struct

Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :calculated_attribute_name (required, String) —

    The unique name of the calculated attribute.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2669
2670
2671
2672
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2669

def delete_calculated_attribute_definition(params = {}, options = {})
  req = build_request(:delete_calculated_attribute_definition, 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:



2698
2699
2700
2701
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2698

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

#delete_domain_layout(params = {}) ⇒ Types::DeleteDomainLayoutResponse

Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Examples:

Request syntax with placeholder values


resp = client.delete_domain_layout({
  domain_name: "name", # required
  layout_definition_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.

  • :layout_definition_name (required, String) —

    The unique name of the layout.

Returns:

See Also:



2731
2732
2733
2734
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2731

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

#delete_domain_object_type(params = {}) ⇒ Struct

Delete a DomainObjectType for the given Domain and ObjectType name.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :object_type_name (required, String) —

    The unique name of the domain object type.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2757
2758
2759
2760
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2757

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

#delete_event_stream(params = {}) ⇒ Struct

Disables and deletes the specified event stream.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :event_stream_name (required, String) —

    The name of the event stream

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2783
2784
2785
2786
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2783

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

#delete_event_trigger(params = {}) ⇒ Types::DeleteEventTriggerResponse

Disable and deletes the Event Trigger.

You cannot delete an Event Trigger with an active Integration associated.

Examples:

Request syntax with placeholder values


resp = client.delete_event_trigger({
  domain_name: "name", # required
  event_trigger_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.

  • :event_trigger_name (required, String) —

    The unique name of the event trigger.

Returns:

See Also:



2820
2821
2822
2823
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2820

def delete_event_trigger(params = {}, options = {})
  req = build_request(:delete_event_trigger, 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:



2852
2853
2854
2855
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2852

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:



2885
2886
2887
2888
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2885

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:



2925
2926
2927
2928
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2925

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:



2966
2967
2968
2969
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 2966

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:



3002
3003
3004
3005
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3002

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

#delete_recommender(params = {}) ⇒ Struct

Deletes a recommender.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :recommender_name (required, String) —

    The recommender name.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3028
3029
3030
3031
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3028

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

#delete_recommender_filter(params = {}) ⇒ Types::DeleteRecommenderFilterResponse

Deletes a recommender filter from a domain.

Examples:

Request syntax with placeholder values


resp = client.delete_recommender_filter({
  domain_name: "name", # required
  recommender_filter_name: "RecommenderFilterName", # required
})

Response structure


resp.message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :recommender_filter_name (required, String) —

    The name of the recommender filter to delete.

Returns:

See Also:



3060
3061
3062
3063
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3060

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

#delete_recommender_schema(params = {}) ⇒ Struct

Deletes a recommender schema from a domain.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :recommender_schema_name (required, String) —

    The name of the recommender schema to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3086
3087
3088
3089
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3086

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

#delete_segment_definition(params = {}) ⇒ Types::DeleteSegmentDefinitionResponse

Deletes a segment definition from the domain.

Examples:

Request syntax with placeholder values


resp = client.delete_segment_definition({
  domain_name: "name", # required
  segment_definition_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.

  • :segment_definition_name (required, String) —

    The unique name of the segment definition.

Returns:

See Also:



3118
3119
3120
3121
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3118

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

#delete_segment_subscription(params = {}) ⇒ Types::DeleteSegmentSubscriptionResponse

Deletes a segment subscription for membership events. All active event notifications for this segment are stopped.

Examples:

Request syntax with placeholder values


resp = client.delete_segment_subscription({
  domain_name: "name", # required
  segment_definition_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.

  • :segment_definition_name (required, String) —

    The unique name of the segment definition.

Returns:

See Also:



3151
3152
3153
3154
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3151

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

#delete_workflow(params = {}) ⇒ Struct

Deletes the specified workflow and all its corresponding resources. This is an async process.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :workflow_id (required, String) —

    Unique identifier for the workflow.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3178
3179
3180
3181
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3178

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

#detect_profile_object_type(params = {}) ⇒ Types::DetectProfileObjectTypeResponse

The process of detecting profile object type mapping by using given objects.

Examples:

Request syntax with placeholder values


resp = client.detect_profile_object_type({
  objects: ["stringifiedJson"], # required
  domain_name: "name", # required
})

Response structure


resp.detected_profile_object_types #=> Array
resp.detected_profile_object_types[0].source_last_updated_timestamp_format #=> String
resp.detected_profile_object_types[0].fields #=> Hash
resp.detected_profile_object_types[0].fields["fieldName"].source #=> String
resp.detected_profile_object_types[0].fields["fieldName"].target #=> String
resp.detected_profile_object_types[0].fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
resp.detected_profile_object_types[0].keys #=> Hash
resp.detected_profile_object_types[0].keys["name"] #=> Array
resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers #=> Array
resp.detected_profile_object_types[0].keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "DEVICE", "WEB_ANALYTICS", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
resp.detected_profile_object_types[0].keys["name"][0].field_names #=> Array
resp.detected_profile_object_types[0].keys["name"][0].field_names[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    A string that is serialized from a JSON object.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



3222
3223
3224
3225
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3222

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

#disassociate_stream_for_segments(params = {}) ⇒ Types::DisassociateStreamForSegmentsResponse

Disassociates the Amazon Kinesis data stream configured for segment membership events. All active segment subscriptions delivering events to this stream are eventually stopped.

Examples:

Request syntax with placeholder values


resp = client.disassociate_stream_for_segments({
  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:



3252
3253
3254
3255
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3252

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

#get_auto_merging_preview(params = {}) ⇒ Types::GetAutoMergingPreviewResponse

Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.

You can't view which profiles are matched and would be merged.

We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName), there may be a large number of matches. This increases the chances of erroneous merges.

Examples:

Request syntax with placeholder values


resp = client.get_auto_merging_preview({
  domain_name: "name", # required
  consolidation: { # required
    matching_attributes_list: [ # required
      ["string1To255"],
    ],
  },
  conflict_resolution: { # required
    conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
    source_name: "string1To255",
  },
  min_allowed_confidence_score_for_merging: 1.0,
})

Response structure


resp.domain_name #=> String
resp.number_of_matches_in_sample #=> Integer
resp.number_of_profiles_in_sample #=> Integer
resp.number_of_profiles_will_be_merged #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :consolidation (required, Types::Consolidation) —

    A list of matching attributes that represent matching criteria.

  • :conflict_resolution (required, Types::ConflictResolution) —

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

  • :min_allowed_confidence_score_for_merging (Float) —

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

Returns:

See Also:



3322
3323
3324
3325
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3322

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

#get_calculated_attribute_definition(params = {}) ⇒ Types::GetCalculatedAttributeDefinitionResponse

Provides more information on a calculated attribute definition for Customer Profiles.

Examples:

Request syntax with placeholder values


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

Response structure


resp.calculated_attribute_name #=> String
resp.display_name #=> String
resp.description #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE", "RECENT_OCCURRENCES"
resp.data.filter.include #=> String, one of "ALL", "ANY", "NONE"
resp.data.filter.groups #=> Array
resp.data.filter.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.data.filter.groups[0].dimensions #=> Array
resp.data.filter.groups[0].dimensions[0].attributes #=> Hash
resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL"
resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values #=> Array
resp.data.filter.groups[0].dimensions[0].attributes["attributeName"].values[0] #=> String
resp.conditions.range.value #=> Integer
resp.conditions.range.unit #=> String, one of "DAYS"
resp.conditions.range.value_range.start #=> Integer
resp.conditions.range.value_range.end #=> Integer
resp.conditions.range.timestamp_source #=> String
resp.conditions.range.timestamp_format #=> String
resp.conditions.object_count #=> Integer
resp.conditions.threshold.value #=> String
resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
resp.attribute_details.attributes #=> Array
resp.attribute_details.attributes[0].name #=> String
resp.attribute_details.expression #=> String
resp.use_historical_data #=> Boolean
resp.status #=> String, one of "PREPARING", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.readiness.progress_percentage #=> Integer
resp.readiness.message #=> String
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.

  • :calculated_attribute_name (required, String) —

    The unique name of the calculated attribute.

Returns:

See Also:



3398
3399
3400
3401
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3398

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

#get_calculated_attribute_for_profile(params = {}) ⇒ Types::GetCalculatedAttributeForProfileResponse

Retrieve a calculated attribute for a customer profile.

Examples:

Request syntax with placeholder values


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

Response structure


resp.calculated_attribute_name #=> String
resp.display_name #=> String
resp.is_data_partial #=> String
resp.value #=> String
resp.last_object_timestamp #=> Time

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.

  • :calculated_attribute_name (required, String) —

    The unique name of the calculated attribute.

Returns:

See Also:



3442
3443
3444
3445
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3442

def get_calculated_attribute_for_profile(params = {}, options = {})
  req = build_request(:get_calculated_attribute_for_profile, 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.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.matching.job_schedule.time #=> String
resp.matching.auto_merging.enabled #=> Boolean
resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
resp.matching.auto_merging.conflict_resolution.source_name #=> String
resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
resp.rule_based_matching.enabled #=> Boolean
resp.rule_based_matching.matching_rules #=> Array
resp.rule_based_matching.matching_rules[0].rule #=> Array
resp.rule_based_matching.matching_rules[0].rule[0] #=> String
resp.rule_based_matching.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE"
resp.rule_based_matching.max_allowed_rule_level_for_merging #=> Integer
resp.rule_based_matching.max_allowed_rule_level_for_matching #=> Integer
resp.rule_based_matching.attribute_types_selector.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.rule_based_matching.attribute_types_selector.address #=> Array
resp.rule_based_matching.attribute_types_selector.address[0] #=> String
resp.rule_based_matching.attribute_types_selector.phone_number #=> Array
resp.rule_based_matching.attribute_types_selector.phone_number[0] #=> String
resp.rule_based_matching.attribute_types_selector.email_address #=> Array
resp.rule_based_matching.attribute_types_selector.email_address[0] #=> String
resp.rule_based_matching.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
resp.rule_based_matching.conflict_resolution.source_name #=> String
resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
resp.data_store.enabled #=> Boolean
resp.data_store.readiness.progress_percentage #=> Integer
resp.data_store.readiness.message #=> 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.

Returns:

See Also:



3524
3525
3526
3527
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3524

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

#get_domain_layout(params = {}) ⇒ Types::GetDomainLayoutResponse

Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Examples:

Request syntax with placeholder values


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

Response structure


resp.layout_definition_name #=> String
resp.description #=> String
resp.display_name #=> String
resp.is_default #=> Boolean
resp.layout_type #=> String, one of "PROFILE_EXPLORER"
resp.layout #=> String
resp.version #=> 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.

  • :layout_definition_name (required, String) —

    The unique name of the layout.

Returns:

See Also:



3576
3577
3578
3579
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3576

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

#get_domain_object_type(params = {}) ⇒ Types::GetDomainObjectTypeResponse

Return a DomainObjectType for the input Domain and ObjectType names.

Examples:

Request syntax with placeholder values


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

Response structure


resp.object_type_name #=> String
resp.description #=> String
resp.encryption_key #=> String
resp.fields #=> Hash
resp.fields["DomainObjectTypeFieldName"].source #=> String
resp.fields["DomainObjectTypeFieldName"].target #=> String
resp.fields["DomainObjectTypeFieldName"].content_type #=> String, one of "STRING", "NUMBER"
resp.fields["DomainObjectTypeFieldName"].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
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 unique name of the domain object type.

Returns:

See Also:



3625
3626
3627
3628
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3625

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

#get_event_stream(params = {}) ⇒ Types::GetEventStreamResponse

Returns information about the specified event stream in a specific domain.

Examples:

Request syntax with placeholder values


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

Response structure


resp.domain_name #=> String
resp.event_stream_arn #=> String
resp.created_at #=> Time
resp.state #=> String, one of "RUNNING", "STOPPED"
resp.stopped_since #=> Time
resp.destination_details.uri #=> String
resp.destination_details.status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.destination_details.unhealthy_since #=> Time
resp.destination_details.message #=> String
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.

  • :event_stream_name (required, String) —

    The name of the event stream provided during create operations.

Returns:

See Also:



3674
3675
3676
3677
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3674

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

#get_event_trigger(params = {}) ⇒ Types::GetEventTriggerResponse

Get a specific Event Trigger from the domain.

Examples:

Request syntax with placeholder values


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

Response structure


resp.event_trigger_name #=> String
resp.object_type_name #=> String
resp.description #=> String
resp.event_trigger_conditions #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].source #=> String
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].field_name #=> String
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].comparison_operator #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL", "BEFORE", "AFTER", "ON", "BETWEEN", "NOT_BETWEEN"
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].values #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].values[0] #=> String
resp.event_trigger_conditions[0].logical_operator #=> String, one of "ANY", "ALL", "NONE"
resp.segment_filter #=> String
resp.event_trigger_limits.event_expiration #=> Integer
resp.event_trigger_limits.periods #=> Array
resp.event_trigger_limits.periods[0].unit #=> String, one of "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS"
resp.event_trigger_limits.periods[0].value #=> Integer
resp.event_trigger_limits.periods[0].max_invocations_per_profile #=> Integer
resp.event_trigger_limits.periods[0].unlimited #=> 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.

  • :event_trigger_name (required, String) —

    The unique name of the event trigger.

Returns:

See Also:



3736
3737
3738
3739
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3736

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

#get_identity_resolution_job(params = {}) ⇒ Types::GetIdentityResolutionJobResponse

Returns information about an Identity Resolution Job in a specific domain.

Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.

Examples:

Request syntax with placeholder values


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

Response structure


resp.domain_name #=> String
resp.job_id #=> String
resp.status #=> String, one of "PENDING", "PREPROCESSING", "FIND_MATCHING", "MERGING", "COMPLETED", "PARTIAL_SUCCESS", "FAILED"
resp.message #=> String
resp.job_start_time #=> Time
resp.job_end_time #=> Time
resp.last_updated_at #=> Time
resp.job_expiration_time #=> Time
resp.auto_merging.enabled #=> Boolean
resp.auto_merging.consolidation.matching_attributes_list #=> Array
resp.auto_merging.consolidation.matching_attributes_list[0] #=> Array
resp.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
resp.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
resp.auto_merging.conflict_resolution.source_name #=> String
resp.auto_merging.min_allowed_confidence_score_for_merging #=> Float
resp.exporting_location.s3_exporting.s3_bucket_name #=> String
resp.exporting_location.s3_exporting.s3_key_name #=> String
resp.job_stats.number_of_profiles_reviewed #=> Integer
resp.job_stats.number_of_matches_found #=> Integer
resp.job_stats.number_of_merges_done #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :job_id (required, String) —

    The unique identifier of the Identity Resolution Job.

Returns:

See Also:



3806
3807
3808
3809
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3806

def get_identity_resolution_job(params = {}, options = {})
  req = build_request(:get_identity_resolution_job, 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
resp.object_type_names #=> Hash
resp.object_type_names["string1To255"] #=> String
resp.workflow_id #=> String
resp.is_unstructured #=> Boolean
resp.role_arn #=> String
resp.event_trigger_names #=> Array
resp.event_trigger_names[0] #=> String
resp.scope #=> String, one of "PROFILE", "DOMAIN"

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:



3863
3864
3865
3866
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3863

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

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

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.

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.

Amazon Connect uses the following profile attributes to identify matches:

  • PhoneNumber

  • HomePhoneNumber

  • BusinessPhoneNumber

  • MobilePhoneNumber

  • EmailAddress

  • PersonalEmailAddress

  • BusinessEmailAddress

  • FullName

For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

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
resp.matches[0].confidence_score #=> Float

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:



3958
3959
3960
3961
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 3958

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

#get_object_type_attribute_statistics(params = {}) ⇒ Types::GetObjectTypeAttributeStatisticsResponse

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics.

You'll receive null values in two scenarios:

During the first period after enabling data vault (unless a calculation cycle occurs, which happens once daily).

For attributes that don't contain numeric values.

Examples:

Request syntax with placeholder values


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

Response structure


resp.statistics.maximum #=> Float
resp.statistics.minimum #=> Float
resp.statistics.average #=> Float
resp.statistics.standard_deviation #=> Float
resp.statistics.percentiles.p5 #=> Float
resp.statistics.percentiles.p25 #=> Float
resp.statistics.percentiles.p50 #=> Float
resp.statistics.percentiles.p75 #=> Float
resp.statistics.percentiles.p95 #=> Float
resp.calculated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :object_type_name (required, String) —

    The unique name of the domain object type.

  • :attribute_name (required, String) —

    The attribute name.

Returns:

See Also:



4019
4020
4021
4022
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4019

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

#get_profile_history_record(params = {}) ⇒ Types::GetProfileHistoryRecordResponse

Returns a history record for a specific profile, for a specific domain.

Examples:

Request syntax with placeholder values


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

Response structure


resp.id #=> String
resp.object_type_name #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.action_type #=> String, one of "ADDED_PROFILE_KEY", "DELETED_PROFILE_KEY", "CREATED", "UPDATED", "INGESTED", "DELETED_BY_CUSTOMER", "EXPIRED", "MERGED", "DELETED_BY_MERGE"
resp.profile_object_unique_key #=> String
resp.content #=> String
resp.performed_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

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

  • :profile_id (required, String) —

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

  • :id (required, String) —

    The unique identifier of the profile history record to return.

Returns:

See Also:



4072
4073
4074
4075
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4072

def get_profile_history_record(params = {}, options = {})
  req = build_request(:get_profile_history_record, 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.source_last_updated_timestamp_format #=> String
resp.max_available_profile_object_count #=> Integer
resp.max_profile_object_count #=> Integer
resp.source_priority #=> Integer
resp.fields #=> Hash
resp.fields["fieldName"].source #=> String
resp.fields["fieldName"].target #=> String
resp.fields["fieldName"].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", "ASSET", "CASE", "DEVICE", "WEB_ANALYTICS", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "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:



4141
4142
4143
4144
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4141

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.default_max_profile_object_count #=> Integer
resp.default_max_profile_object_count_effective_after #=> Time
resp.store_only #=> Boolean
resp.allow_profile_creation #=> Boolean
resp.source_last_updated_timestamp_format #=> String
resp.fields #=> Hash
resp.fields["fieldName"].source #=> String
resp.fields["fieldName"].target #=> String
resp.fields["fieldName"].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", "ASSET", "CASE", "DEVICE", "WEB_ANALYTICS", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "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:



4201
4202
4203
4204
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4201

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

#get_profile_recommendations(params = {}) ⇒ Types::GetProfileRecommendationsResponse

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

Examples:

Request syntax with placeholder values


resp = client.get_profile_recommendations({
  domain_name: "name", # required
  profile_id: "uuid", # required
  recommender_name: "name", # required
  context: {
    "ContextKey" => "string1To255",
  },
  recommender_filters: [
    {
      name: "name",
      values: {
        "RecommenderFilterAttributeName" => "RecommenderFilterAttributeValue",
      },
    },
  ],
  recommender_promotional_filters: [
    {
      name: "name",
      values: {
        "RecommenderFilterAttributeName" => "RecommenderFilterAttributeValue",
      },
      promotion_name: "name",
      percent_promoted_items: 1,
    },
  ],
  candidate_ids: ["string1To255"],
  max_results: 1,
  metadata_config: {
    metadata_columns: ["MetadataColumnName"],
  },
  diversity_config: {
    enabled: false, # required
    values: {
      "DiversityPlaceholderName" => 1,
    },
  },
})

Response structure


resp.recommendations #=> Array
resp.recommendations[0].catalog_item.id #=> String
resp.recommendations[0].catalog_item.name #=> String
resp.recommendations[0].catalog_item.code #=> String
resp.recommendations[0].catalog_item.type #=> String
resp.recommendations[0].catalog_item.category #=> String
resp.recommendations[0].catalog_item.description #=> String
resp.recommendations[0].catalog_item.additional_information #=> String
resp.recommendations[0].catalog_item.image_link #=> String
resp.recommendations[0].catalog_item.link #=> String
resp.recommendations[0].catalog_item.created_at #=> Time
resp.recommendations[0].catalog_item.updated_at #=> Time
resp.recommendations[0].catalog_item.price #=> String
resp.recommendations[0].catalog_item.attributes #=> Hash
resp.recommendations[0].catalog_item.attributes["string1To255"] #=> String
resp.recommendations[0].score #=> Float

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 the profile for which to retrieve recommendations.

  • :recommender_name (required, String) —

    The unique name of the recommender.

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

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

  • :recommender_filters (Array<Types::RecommenderFilter>) —

    A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

  • :recommender_promotional_filters (Array<Types::RecommenderPromotionalFilter>) —

    A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

  • :candidate_ids (Array<String>) —

    A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

  • :max_results (Integer) —

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

  • :metadata_config (Types::MetadataConfig) —

    Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

  • :diversity_config (Types::RecommendationDiversityConfig) —

    Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

Returns:

See Also:



4320
4321
4322
4323
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4320

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

#get_recommender(params = {}) ⇒ Types::GetRecommenderResponse

Retrieves a recommender.

Examples:

Request syntax with placeholder values


resp = client.get_recommender({
  domain_name: "name", # required
  recommender_name: "name", # required
  training_metrics_count: 1,
})

Response structure


resp.recommender_name #=> String
resp.recommender_recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now", "personalized-ranking"
resp.recommender_schema_name #=> String
resp.recommender_config.events_config.event_parameters_list #=> Array
resp.recommender_config.events_config.event_parameters_list[0].event_type #=> String
resp.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
resp.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
resp.recommender_config.training_frequency #=> Integer
resp.recommender_config.inference_config.min_provisioned_tps #=> Integer
resp.recommender_config.included_columns #=> Hash
resp.recommender_config.included_columns["String"] #=> Array
resp.recommender_config.included_columns["String"][0] #=> String
resp.recommender_config.excluded_columns #=> Hash
resp.recommender_config.excluded_columns["String"] #=> Array
resp.recommender_config.excluded_columns["String"][0] #=> String
resp.recommender_config.diversity_config.diversity_columns #=> Array
resp.recommender_config.diversity_config.diversity_columns[0].name #=> String
resp.recommender_config.diversity_config.diversity_columns[0].cap_type #=> String, one of "PERCENTAGE", "VALUE"
resp.recommender_config.diversity_config.diversity_columns[0].target #=> String
resp.description #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
resp.last_updated_at #=> Time
resp.created_at #=> Time
resp.failure_reason #=> String
resp.latest_recommender_update.recommender_config.events_config.event_parameters_list #=> Array
resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_type #=> String
resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
resp.latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
resp.latest_recommender_update.recommender_config.training_frequency #=> Integer
resp.latest_recommender_update.recommender_config.inference_config.min_provisioned_tps #=> Integer
resp.latest_recommender_update.recommender_config.included_columns #=> Hash
resp.latest_recommender_update.recommender_config.included_columns["String"] #=> Array
resp.latest_recommender_update.recommender_config.included_columns["String"][0] #=> String
resp.latest_recommender_update.recommender_config.excluded_columns #=> Hash
resp.latest_recommender_update.recommender_config.excluded_columns["String"] #=> Array
resp.latest_recommender_update.recommender_config.excluded_columns["String"][0] #=> String
resp.latest_recommender_update.recommender_config.diversity_config.diversity_columns #=> Array
resp.latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].name #=> String
resp.latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].cap_type #=> String, one of "PERCENTAGE", "VALUE"
resp.latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].target #=> String
resp.latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
resp.latest_recommender_update.created_at #=> Time
resp.latest_recommender_update.last_updated_at #=> Time
resp.latest_recommender_update.failure_reason #=> String
resp.latest_recommender_update.recommender_version_name #=> String
resp.active_recommender_version_name #=> String
resp.training_metrics #=> Array
resp.training_metrics[0].time #=> Time
resp.training_metrics[0].metrics #=> Hash
resp.training_metrics[0].metrics["TrainingMetricName"] #=> Float
resp.training_metrics[0].recommender_version_name #=> String
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.

  • :recommender_name (required, String) —

    The name of the recommender.

  • :training_metrics_count (Integer) —

    The number of training metrics to retrieve for the recommender.

Returns:

See Also:



4420
4421
4422
4423
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4420

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

#get_recommender_filter(params = {}) ⇒ Types::GetRecommenderFilterResponse

Retrieves information about a specific recommender filter in a domain.

Examples:

Request syntax with placeholder values


resp = client.get_recommender_filter({
  domain_name: "name", # required
  recommender_filter_name: "RecommenderFilterName", # required
})

Response structure


resp.recommender_filter_name #=> String
resp.recommender_filter_expression #=> String
resp.recommender_schema_name #=> String
resp.created_at #=> Time
resp.status #=> String, one of "ACTIVE", "PENDING", "IN_PROGRESS", "FAILED", "DELETING"
resp.description #=> String
resp.failure_reason #=> String
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.

  • :recommender_filter_name (required, String) —

    The name of the recommender filter to retrieve.

Returns:

See Also:



4467
4468
4469
4470
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4467

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

#get_recommender_schema(params = {}) ⇒ Types::GetRecommenderSchemaResponse

Retrieves information about a specific recommender schema in a domain.

Examples:

Request syntax with placeholder values


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

Response structure


resp.recommender_schema_name #=> String
resp.fields #=> Hash
resp.fields["String"] #=> Array
resp.fields["String"][0].target_field_name #=> String
resp.fields["String"][0].content_type #=> String, one of "STRING", "NUMBER"
resp.fields["String"][0].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
resp.created_at #=> Time
resp.status #=> String, one of "ACTIVE", "DELETING"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :recommender_schema_name (required, String) —

    The name of the recommender schema to retrieve.

Returns:

See Also:



4509
4510
4511
4512
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4509

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

#get_segment_definition(params = {}) ⇒ Types::GetSegmentDefinitionResponse

Gets a segment definition from the domain.

Examples:

Request syntax with placeholder values


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

Response structure


resp.segment_definition_name #=> String
resp.display_name #=> String
resp.description #=> String
resp.segment_groups.groups #=> Array
resp.segment_groups.groups[0].dimensions #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes..dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes..values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes..values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.additional_information.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.additional_information.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.additional_information.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.first_name.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.first_name.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.first_name.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.last_name.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.last_name.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.last_name.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.middle_name.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.middle_name.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.middle_name.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.gender_string.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.gender_string.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.gender_string.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.party_type_string.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.party_type_string.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.party_type_string.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.birth_date.dimension_type #=> String, one of "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.birth_date.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.birth_date.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.phone_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.phone_number.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.phone_number.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_name.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_name.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_name.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_phone_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_phone_number.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_phone_number.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.home_phone_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.home_phone_number.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.home_phone_number.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mobile_phone_number.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mobile_phone_number.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mobile_phone_number.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.email_address.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.email_address.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.email_address.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.personal_email_address.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.personal_email_address.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.personal_email_address.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_email_address.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_email_address.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.business_email_address.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.city.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.city.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.city.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.country.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.country.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.county.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.county.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.county.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.postal_code.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.postal_code.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.postal_code.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.province.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.province.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.province.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.state.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.state.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.address.state.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.city.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.city.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.city.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.country.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.country.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.county.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.county.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.county.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.postal_code.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.postal_code.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.postal_code.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.province.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.province.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.province.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.state.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.state.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.shipping_address.state.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.city.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.city.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.city.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.country.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.country.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.county.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.county.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.county.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.postal_code.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.postal_code.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.postal_code.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.province.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.province.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.province.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.state.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.state.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.mailing_address.state.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.city.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.city.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.city.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.country.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.country.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.country.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.county.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.county.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.county.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.postal_code.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.postal_code.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.postal_code.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.province.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.province.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.province.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.state.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.state.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.billing_address.state.values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes #=> Hash
resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["string1To255"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL", "LIST_CONTAINS", "LIST_CONTAINS_ALL"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["string1To255"].values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.attributes["string1To255"].values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].profile_attributes.profile_type.dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE"
resp.segment_groups.groups[0].dimensions[0].profile_attributes.profile_type.values #=> Array
resp.segment_groups.groups[0].dimensions[0].profile_attributes.profile_type.values[0] #=> String, one of "ACCOUNT_PROFILE", "PROFILE"
resp.segment_groups.groups[0].dimensions[0].calculated_attributes #=> Hash
resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].dimension_type #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "NOT_BETWEEN", "ON", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL", "LIST_CONTAINS", "LIST_CONTAINS_ALL"
resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].values #=> Array
resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].values[0] #=> String
resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].condition_overrides.range.start #=> Integer
resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].condition_overrides.range.end #=> Integer
resp.segment_groups.groups[0].dimensions[0].calculated_attributes["typeName"].condition_overrides.range.unit #=> String, one of "DAYS"
resp.segment_groups.groups[0].source_segments #=> Array
resp.segment_groups.groups[0].source_segments[0].segment_definition_name #=> String
resp.segment_groups.groups[0].source_type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_groups.groups[0].type #=> String, one of "ALL", "ANY", "NONE"
resp.segment_groups.include #=> String, one of "ALL", "ANY", "NONE"
resp.segment_sort.attributes #=> Array
resp.segment_sort.attributes[0].name #=> String
resp.segment_sort.attributes[0].data_type #=> String, one of "STRING", "NUMBER", "DATE"
resp.segment_sort.attributes[0].order #=> String, one of "ASC", "DESC"
resp.segment_sort.attributes[0].type #=> String, one of "PROFILE", "CALCULATED"
resp.segment_definition_arn #=> String
resp.created_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.segment_sql_query #=> String
resp.segment_type #=> String, one of "CLASSIC", "ENHANCED"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :segment_definition_name (required, String) —

    The unique name of the segment definition.

Returns:

See Also:



4704
4705
4706
4707
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4704

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

#get_segment_estimate(params = {}) ⇒ Types::GetSegmentEstimateResponse

Gets the result of a segment estimate query.

Examples:

Request syntax with placeholder values


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

Response structure


resp.domain_name #=> String
resp.estimate_id #=> String
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED"
resp.estimate #=> String
resp.message #=> String
resp.status_code #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :estimate_id (required, String) —

    The query Id passed by a previous CreateSegmentEstimate operation.

Returns:

See Also:



4746
4747
4748
4749
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4746

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

#get_segment_membership(params = {}) ⇒ Types::GetSegmentMembershipResponse

Determines if the given profiles are within a segment.

Examples:

Request syntax with placeholder values


resp = client.get_segment_membership({
  domain_name: "name", # required
  segment_definition_name: "name", # required
  profile_ids: ["uuid"], # required
})

Response structure


resp.segment_definition_name #=> String
resp.profiles #=> Array
resp.profiles[0].profile_id #=> String
resp.profiles[0].query_result #=> String, one of "PRESENT", "ABSENT"
resp.profiles[0].profile.profile_id #=> String
resp.profiles[0].profile. #=> String
resp.profiles[0].profile.additional_information #=> String
resp.profiles[0].profile.party_type #=> String, one of "INDIVIDUAL", "BUSINESS", "OTHER"
resp.profiles[0].profile.business_name #=> String
resp.profiles[0].profile.first_name #=> String
resp.profiles[0].profile.middle_name #=> String
resp.profiles[0].profile.last_name #=> String
resp.profiles[0].profile.birth_date #=> String
resp.profiles[0].profile.gender #=> String, one of "MALE", "FEMALE", "UNSPECIFIED"
resp.profiles[0].profile.phone_number #=> String
resp.profiles[0].profile.mobile_phone_number #=> String
resp.profiles[0].profile.home_phone_number #=> String
resp.profiles[0].profile.business_phone_number #=> String
resp.profiles[0].profile.email_address #=> String
resp.profiles[0].profile.personal_email_address #=> String
resp.profiles[0].profile.business_email_address #=> String
resp.profiles[0].profile.address.address_1 #=> String
resp.profiles[0].profile.address.address_2 #=> String
resp.profiles[0].profile.address.address_3 #=> String
resp.profiles[0].profile.address.address_4 #=> String
resp.profiles[0].profile.address.city #=> String
resp.profiles[0].profile.address.county #=> String
resp.profiles[0].profile.address.state #=> String
resp.profiles[0].profile.address.province #=> String
resp.profiles[0].profile.address.country #=> String
resp.profiles[0].profile.address.postal_code #=> String
resp.profiles[0].profile.shipping_address.address_1 #=> String
resp.profiles[0].profile.shipping_address.address_2 #=> String
resp.profiles[0].profile.shipping_address.address_3 #=> String
resp.profiles[0].profile.shipping_address.address_4 #=> String
resp.profiles[0].profile.shipping_address.city #=> String
resp.profiles[0].profile.shipping_address.county #=> String
resp.profiles[0].profile.shipping_address.state #=> String
resp.profiles[0].profile.shipping_address.province #=> String
resp.profiles[0].profile.shipping_address.country #=> String
resp.profiles[0].profile.shipping_address.postal_code #=> String
resp.profiles[0].profile.mailing_address.address_1 #=> String
resp.profiles[0].profile.mailing_address.address_2 #=> String
resp.profiles[0].profile.mailing_address.address_3 #=> String
resp.profiles[0].profile.mailing_address.address_4 #=> String
resp.profiles[0].profile.mailing_address.city #=> String
resp.profiles[0].profile.mailing_address.county #=> String
resp.profiles[0].profile.mailing_address.state #=> String
resp.profiles[0].profile.mailing_address.province #=> String
resp.profiles[0].profile.mailing_address.country #=> String
resp.profiles[0].profile.mailing_address.postal_code #=> String
resp.profiles[0].profile.billing_address.address_1 #=> String
resp.profiles[0].profile.billing_address.address_2 #=> String
resp.profiles[0].profile.billing_address.address_3 #=> String
resp.profiles[0].profile.billing_address.address_4 #=> String
resp.profiles[0].profile.billing_address.city #=> String
resp.profiles[0].profile.billing_address.county #=> String
resp.profiles[0].profile.billing_address.state #=> String
resp.profiles[0].profile.billing_address.province #=> String
resp.profiles[0].profile.billing_address.country #=> String
resp.profiles[0].profile.billing_address.postal_code #=> String
resp.profiles[0].profile.attributes #=> Hash
resp.profiles[0].profile.attributes["string1To255"] #=> String
resp.profiles[0].profile.found_by_items #=> Array
resp.profiles[0].profile.found_by_items[0].key_name #=> String
resp.profiles[0].profile.found_by_items[0].values #=> Array
resp.profiles[0].profile.found_by_items[0].values[0] #=> String
resp.profiles[0].profile.party_type_string #=> String
resp.profiles[0].profile.gender_string #=> String
resp.profiles[0].profile.profile_type #=> String, one of "ACCOUNT_PROFILE", "PROFILE"
resp.profiles[0].profile.engagement_preferences.phone #=> Array
resp.profiles[0].profile.engagement_preferences.phone[0].key_name #=> String
resp.profiles[0].profile.engagement_preferences.phone[0].key_value #=> String
resp.profiles[0].profile.engagement_preferences.phone[0].profile_id #=> String
resp.profiles[0].profile.engagement_preferences.phone[0].contact_type #=> String, one of "PhoneNumber", "MobilePhoneNumber", "HomePhoneNumber", "BusinessPhoneNumber", "EmailAddress", "PersonalEmailAddress", "BusinessEmailAddress"
resp.profiles[0].profile.engagement_preferences.email #=> Array
resp.profiles[0].profile.engagement_preferences.email[0].key_name #=> String
resp.profiles[0].profile.engagement_preferences.email[0].key_value #=> String
resp.profiles[0].profile.engagement_preferences.email[0].profile_id #=> String
resp.profiles[0].profile.engagement_preferences.email[0].contact_type #=> String, one of "PhoneNumber", "MobilePhoneNumber", "HomePhoneNumber", "BusinessPhoneNumber", "EmailAddress", "PersonalEmailAddress", "BusinessEmailAddress"
resp.failures #=> Array
resp.failures[0].profile_id #=> String
resp.failures[0].message #=> String
resp.failures[0].status #=> Integer
resp.last_computed_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :segment_definition_name (required, String) —

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

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

    The list of profile IDs to query for.

Returns:

See Also:



4870
4871
4872
4873
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4870

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

#get_segment_snapshot(params = {}) ⇒ Types::GetSegmentSnapshotResponse

Retrieve the latest status of a segment snapshot.

Examples:

Request syntax with placeholder values


resp = client.get_segment_snapshot({
  domain_name: "name", # required
  segment_definition_name: "name", # required
  snapshot_id: "uuid", # required
})

Response structure


resp.snapshot_id #=> String
resp.status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED"
resp.status_message #=> String
resp.data_format #=> String, one of "CSV", "JSONL", "ORC"
resp.encryption_key #=> String
resp.role_arn #=> String
resp.destination_uri #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique identifier of the domain.

  • :segment_definition_name (required, String) —

    The unique name of the segment definition.

  • :snapshot_id (required, String) —

    The unique identifier of the segment snapshot.

Returns:

See Also:



4918
4919
4920
4921
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4918

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

#get_segment_subscription(params = {}) ⇒ Types::GetSegmentSubscriptionResponse

Returns the current subscription configuration, execution schedule, and status for segment membership events.

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> String, one of "STARTING", "RUNNING", "STOPPED", "FAILED"
resp.message #=> String
resp.schedule_configuration.interval #=> Integer
resp.schedule_configuration.unit #=> String, one of "HOURLY"
resp.scheduled_executions.next_executed_at #=> Time
resp.scheduled_executions.last_executed_at #=> Time
resp.started_at #=> Time
resp.last_updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :segment_definition_name (required, String) —

    The unique name of the segment definition.

Returns:

See Also:



4963
4964
4965
4966
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 4963

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

#get_similar_profiles(params = {}) ⇒ Types::GetSimilarProfilesResponse

Returns a set of profiles that belong to the same matching group using the matchId or profileId. You can also specify the type of matching that you want for finding similar profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_similar_profiles({
  next_token: "token",
  max_results: 1,
  domain_name: "name", # required
  match_type: "RULE_BASED_MATCHING", # required, accepts RULE_BASED_MATCHING, ML_BASED_MATCHING
  search_key: "string1To255", # required
  search_value: "string1To255", # required
})

Response structure


resp.profile_ids #=> Array
resp.profile_ids[0] #=> String
resp.match_id #=> String
resp.match_type #=> String, one of "RULE_BASED_MATCHING", "ML_BASED_MATCHING"
resp.rule_level #=> Integer
resp.confidence_score #=> Float
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous GetSimilarProfiles API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

  • :domain_name (required, String) —

    The unique name of the domain.

  • :match_type (required, String) —

    Specify the type of matching to get similar profiles for.

  • :search_key (required, String) —

    The string indicating the search key to be used.

  • :search_value (required, String) —

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

Returns:

See Also:



5027
5028
5029
5030
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5027

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

#get_stream_for_segments(params = {}) ⇒ Types::GetStreamForSegmentsResponse

Returns information about the segment membership event stream configured for a specific domain, including the stream state and associated segments.

Examples:

Request syntax with placeholder values


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

Response structure


resp.associated_at #=> Time
resp.associated_segments #=> Array
resp.associated_segments[0].segment_name #=> String
resp.associated_segments[0].status #=> String, one of "STARTING", "RUNNING", "STOPPED", "FAILED"
resp.associated_segments[0].message #=> String
resp.domain_name #=> String
resp.destination_arn #=> String
resp.destination_role_arn #=> String
resp.state #=> String, one of "RUNNING", "UNHEALTHY", "STOPPED"
resp.disassociated_at #=> Time
resp.failure_reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



5074
5075
5076
5077
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5074

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

#get_upload_job(params = {}) ⇒ Types::GetUploadJobResponse

This API retrieves the details of a specific upload job.

Examples:

Request syntax with placeholder values


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

Response structure


resp.job_id #=> String
resp.display_name #=> String
resp.status #=> String, one of "CREATED", "IN_PROGRESS", "PARTIALLY_SUCCEEDED", "SUCCEEDED", "FAILED", "STOPPED"
resp.status_reason #=> String, one of "VALIDATION_FAILURE", "INTERNAL_FAILURE"
resp.created_at #=> Time
resp.completed_at #=> Time
resp.fields #=> Hash
resp.fields["fieldName"].source #=> String
resp.fields["fieldName"].target #=> String
resp.fields["fieldName"].content_type #=> String, one of "STRING", "NUMBER", "PHONE_NUMBER", "EMAIL_ADDRESS", "NAME"
resp.unique_key #=> String
resp.results_summary.updated_records #=> Integer
resp.results_summary.created_records #=> Integer
resp.results_summary.failed_records #=> Integer
resp.data_expiry #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain containing the upload job.

  • :job_id (required, String) —

    The unique identifier of the upload job to retrieve.

Returns:

See Also:



5129
5130
5131
5132
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5129

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

#get_upload_job_path(params = {}) ⇒ Types::GetUploadJobPathResponse

This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.

Examples:

Request syntax with placeholder values


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

Response structure


resp.url #=> String
resp.client_token #=> String
resp.valid_until #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain containing the upload job.

  • :job_id (required, String) —

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

Returns:

See Also:



5167
5168
5169
5170
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5167

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

#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse

Get details of specified workflow.

Examples:

Request syntax with placeholder values


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

Response structure


resp.workflow_id #=> String
resp.workflow_type #=> String, one of "APPFLOW_INTEGRATION"
resp.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
resp.error_description #=> String
resp.start_date #=> Time
resp.last_updated_at #=> Time
resp.attributes.appflow_integration.source_connector_type #=> String, one of "Salesforce", "Marketo", "Zendesk", "Servicenow", "S3"
resp.attributes.appflow_integration.connector_profile_name #=> String
resp.attributes.appflow_integration.role_arn #=> String
resp.metrics.appflow_integration.records_processed #=> Integer
resp.metrics.appflow_integration.steps_completed #=> Integer
resp.metrics.appflow_integration.total_steps #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :workflow_id (required, String) —

    Unique identifier for the workflow.

Returns:

See Also:



5217
5218
5219
5220
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5217

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

#get_workflow_steps(params = {}) ⇒ Types::GetWorkflowStepsResponse

Get granular list of steps in workflow.

Examples:

Request syntax with placeholder values


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

Response structure


resp.workflow_id #=> String
resp.workflow_type #=> String, one of "APPFLOW_INTEGRATION"
resp.items #=> Array
resp.items[0].appflow_integration.flow_name #=> String
resp.items[0].appflow_integration.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
resp.items[0].appflow_integration.execution_message #=> String
resp.items[0].appflow_integration.records_processed #=> Integer
resp.items[0].appflow_integration.batch_records_start_time #=> String
resp.items[0].appflow_integration.batch_records_end_time #=> String
resp.items[0].appflow_integration.created_at #=> Time
resp.items[0].appflow_integration.last_updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :workflow_id (required, String) —

    Unique identifier for the workflow.

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

Returns:

See Also:



5273
5274
5275
5276
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5273

def get_workflow_steps(params = {}, options = {})
  req = build_request(:get_workflow_steps, 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,
  include_hidden: false,
})

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.items[0].object_type_names #=> Hash
resp.items[0].object_type_names["string1To255"] #=> String
resp.items[0].workflow_id #=> String
resp.items[0].is_unstructured #=> Boolean
resp.items[0].role_arn #=> String
resp.items[0].event_trigger_names #=> Array
resp.items[0].event_trigger_names[0] #=> String
resp.items[0].scope #=> String, one of "PROFILE", "DOMAIN"
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.

  • :include_hidden (Boolean) —

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

Returns:

See Also:



5333
5334
5335
5336
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5333

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

#list_calculated_attribute_definitions(params = {}) ⇒ Types::ListCalculatedAttributeDefinitionsResponse

Lists calculated attribute definitions for Customer Profiles

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0].calculated_attribute_name #=> String
resp.items[0].display_name #=> String
resp.items[0].description #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
resp.items[0].use_historical_data #=> Boolean
resp.items[0].status #=> String, one of "PREPARING", "IN_PROGRESS", "COMPLETED", "FAILED"
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 call to ListCalculatedAttributeDefinitions.

  • :max_results (Integer) —

    The maximum number of calculated attribute definitions returned per page.

Returns:

See Also:



5382
5383
5384
5385
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5382

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

#list_calculated_attributes_for_profile(params = {}) ⇒ Types::ListCalculatedAttributesForProfileResponse

Retrieve a list of calculated attributes for a customer profile.

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0].calculated_attribute_name #=> String
resp.items[0].display_name #=> String
resp.items[0].is_data_partial #=> String
resp.items[0].value #=> String
resp.items[0].last_object_timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous call to ListCalculatedAttributesForProfile.

  • :max_results (Integer) —

    The maximum number of calculated attributes returned per page.

  • :domain_name (required, String) —

    The unique name of the domain.

  • :profile_id (required, String) —

    The unique identifier of a customer profile.

Returns:

See Also:



5430
5431
5432
5433
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5430

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

#list_domain_layouts(params = {}) ⇒ Types::ListDomainLayoutsResponse

Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0].layout_definition_name #=> String
resp.items[0].description #=> String
resp.items[0].display_name #=> String
resp.items[0].is_default #=> Boolean
resp.items[0].layout_type #=> String, one of "PROFILE_EXPLORER"
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
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:



5481
5482
5483
5484
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5481

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

#list_domain_object_types(params = {}) ⇒ Types::ListDomainObjectTypesResponse

List all DomainObjectType(s) in a Customer Profiles domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

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.

  • :max_results (Integer) —

    The maximum number of domain object types returned per page.

  • :next_token (String) —

    The pagination token from the previous call to ListDomainObjectTypes.

Returns:

See Also:



5527
5528
5529
5530
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5527

def list_domain_object_types(params = {}, options = {})
  req = build_request(:list_domain_object_types, 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:



5567
5568
5569
5570
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5567

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

#list_event_streams(params = {}) ⇒ Types::ListEventStreamsResponse

Returns a list of all the event streams in a specific domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0].domain_name #=> String
resp.items[0].event_stream_name #=> String
resp.items[0].event_stream_arn #=> String
resp.items[0].state #=> String, one of "RUNNING", "STOPPED"
resp.items[0].stopped_since #=> Time
resp.items[0].destination_summary.uri #=> String
resp.items[0].destination_summary.status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.items[0].destination_summary.unhealthy_since #=> 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:



5617
5618
5619
5620
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5617

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

#list_event_triggers(params = {}) ⇒ Types::ListEventTriggersResponse

List all Event Triggers under a domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_event_triggers({
  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].event_trigger_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) —

    The pagination token to use with ListEventTriggers.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



5664
5665
5666
5667
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5664

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

#list_identity_resolution_jobs(params = {}) ⇒ Types::ListIdentityResolutionJobsResponse

Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.

Examples:

Request syntax with placeholder values


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

Response structure


resp.identity_resolution_jobs_list #=> Array
resp.identity_resolution_jobs_list[0].domain_name #=> String
resp.identity_resolution_jobs_list[0].job_id #=> String
resp.identity_resolution_jobs_list[0].status #=> String, one of "PENDING", "PREPROCESSING", "FIND_MATCHING", "MERGING", "COMPLETED", "PARTIAL_SUCCESS", "FAILED"
resp.identity_resolution_jobs_list[0].job_start_time #=> Time
resp.identity_resolution_jobs_list[0].job_end_time #=> Time
resp.identity_resolution_jobs_list[0].job_stats.number_of_profiles_reviewed #=> Integer
resp.identity_resolution_jobs_list[0].job_stats.number_of_matches_found #=> Integer
resp.identity_resolution_jobs_list[0].job_stats.number_of_merges_done #=> Integer
resp.identity_resolution_jobs_list[0].exporting_location.s3_exporting.s3_bucket_name #=> String
resp.identity_resolution_jobs_list[0].exporting_location.s3_exporting.s3_key_name #=> String
resp.identity_resolution_jobs_list[0].message #=> 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 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.

Returns:

See Also:



5716
5717
5718
5719
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5716

def list_identity_resolution_jobs(params = {}, options = {})
  req = build_request(:list_identity_resolution_jobs, 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,
  include_hidden: false,
})

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.items[0].object_type_names #=> Hash
resp.items[0].object_type_names["string1To255"] #=> String
resp.items[0].workflow_id #=> String
resp.items[0].is_unstructured #=> Boolean
resp.items[0].role_arn #=> String
resp.items[0].event_trigger_names #=> Array
resp.items[0].event_trigger_names[0] #=> String
resp.items[0].scope #=> String, one of "PROFILE", "DOMAIN"
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.

  • :include_hidden (Boolean) —

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

Returns:

See Also:



5774
5775
5776
5777
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5774

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

#list_object_type_attribute_values(params = {}) ⇒ Types::ListObjectTypeAttributeValuesResponse

The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.

Examples:

Request syntax with placeholder values


resp = client.list_object_type_attribute_values({
  next_token: "token",
  max_results: 1,
  domain_name: "name", # required
  object_type_name: "typeName", # required
  attribute_name: "string1To1000", # required
})

Response structure


resp.items #=> Array
resp.items[0].value #=> String
resp.items[0].last_updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous call.

  • :max_results (Integer) —

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

  • :domain_name (required, String) —

    The unique name of the domain.

  • :object_type_name (required, String) —

    The unique name of the domain object type.

  • :attribute_name (required, String) —

    The attribute name.

Returns:

See Also:



5829
5830
5831
5832
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5829

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

#list_object_type_attributes(params = {}) ⇒ Types::ListObjectTypeAttributesResponse

Fetch the possible attribute values given the attribute name.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0].attribute_name #=> String
resp.items[0].last_updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

  • :domain_name (required, String) —

    The unique identifier of the domain.

  • :object_type_name (required, String) —

    The name of the profile object type.

Returns:

See Also:



5875
5876
5877
5878
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5875

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

#list_profile_attribute_values(params = {}) ⇒ Types::ProfileAttributeValuesResponse

Fetch the possible attribute values given the attribute name.

Examples:

Request syntax with placeholder values


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

Response structure


resp.domain_name #=> String
resp.attribute_name #=> String
resp.items #=> Array
resp.items[0].value #=> String
resp.status_code #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique identifier of the domain.

  • :attribute_name (required, String) —

    The attribute name.

Returns:

See Also:



5914
5915
5916
5917
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5914

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

#list_profile_history_records(params = {}) ⇒ Types::ListProfileHistoryRecordsResponse

Returns a list of history records for a specific profile, for a specific domain.

Examples:

Request syntax with placeholder values


resp = client.list_profile_history_records({
  domain_name: "name", # required
  profile_id: "uuid", # required
  object_type_name: "typeName",
  next_token: "token",
  max_results: 1,
  action_type: "ADDED_PROFILE_KEY", # accepts ADDED_PROFILE_KEY, DELETED_PROFILE_KEY, CREATED, UPDATED, INGESTED, DELETED_BY_CUSTOMER, EXPIRED, MERGED, DELETED_BY_MERGE
  performed_by: "string1To255",
})

Response structure


resp.profile_history_records #=> Array
resp.profile_history_records[0].id #=> String
resp.profile_history_records[0].object_type_name #=> String
resp.profile_history_records[0].created_at #=> Time
resp.profile_history_records[0].last_updated_at #=> Time
resp.profile_history_records[0].action_type #=> String, one of "ADDED_PROFILE_KEY", "DELETED_PROFILE_KEY", "CREATED", "UPDATED", "INGESTED", "DELETED_BY_CUSTOMER", "EXPIRED", "MERGED", "DELETED_BY_MERGE"
resp.profile_history_records[0].profile_object_unique_key #=> String
resp.profile_history_records[0].performed_by #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

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

  • :profile_id (required, String) —

    The identifier of the profile to be taken.

  • :object_type_name (String) —

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

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

  • :action_type (String) —

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

  • :performed_by (String) —

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

Returns:

See Also:



5984
5985
5986
5987
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 5984

def list_profile_history_records(params = {}, options = {})
  req = build_request(:list_profile_history_records, 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:



6022
6023
6024
6025
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6022

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].max_profile_object_count #=> Integer
resp.items[0].max_available_profile_object_count #=> Integer
resp.items[0].source_priority #=> Integer
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:



6069
6070
6071
6072
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6069

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
  object_filter: {
    key_name: "name", # required
    values: ["string1To255"], # 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.

  • :object_filter (Types::ObjectFilter) —

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

Returns:

See Also:



6127
6128
6129
6130
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6127

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

#list_recommender_filters(params = {}) ⇒ Types::ListRecommenderFiltersResponse

Returns a list of recommender filters in the specified domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.recommender_filters #=> Array
resp.recommender_filters[0].recommender_filter_name #=> String
resp.recommender_filters[0].recommender_schema_name #=> String
resp.recommender_filters[0].recommender_filter_expression #=> String
resp.recommender_filters[0].created_at #=> Time
resp.recommender_filters[0].description #=> String
resp.recommender_filters[0].status #=> String, one of "ACTIVE", "PENDING", "IN_PROGRESS", "FAILED", "DELETING"
resp.recommender_filters[0].failure_reason #=> String
resp.recommender_filters[0].tags #=> Hash
resp.recommender_filters[0].tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



6178
6179
6180
6181
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6178

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

#list_recommender_recipes(params = {}) ⇒ Types::ListRecommenderRecipesResponse

Returns a list of available recommender recipes that can be used to create recommenders.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.recommender_recipes #=> Array
resp.recommender_recipes[0].name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now", "personalized-ranking"
resp.recommender_recipes[0].description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



6219
6220
6221
6222
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6219

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

#list_recommender_schemas(params = {}) ⇒ Types::ListRecommenderSchemasResponse

Returns a list of recommender schemas in the specified domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.recommender_schemas #=> Array
resp.recommender_schemas[0].recommender_schema_name #=> String
resp.recommender_schemas[0].fields #=> Hash
resp.recommender_schemas[0].fields["String"] #=> Array
resp.recommender_schemas[0].fields["String"][0].target_field_name #=> String
resp.recommender_schemas[0].fields["String"][0].content_type #=> String, one of "STRING", "NUMBER"
resp.recommender_schemas[0].fields["String"][0].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
resp.recommender_schemas[0].created_at #=> Time
resp.recommender_schemas[0].status #=> String, one of "ACTIVE", "DELETING"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



6269
6270
6271
6272
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6269

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

#list_recommenders(params = {}) ⇒ Types::ListRecommendersResponse

Returns a list of recommenders in the specified domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.recommenders #=> Array
resp.recommenders[0].recommender_name #=> String
resp.recommenders[0].recipe_name #=> String, one of "recommended-for-you", "similar-items", "frequently-paired-items", "popular-items", "trending-now", "personalized-ranking"
resp.recommenders[0].recommender_schema_name #=> String
resp.recommenders[0].recommender_config.events_config.event_parameters_list #=> Array
resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_type #=> String
resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
resp.recommenders[0].recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
resp.recommenders[0].recommender_config.training_frequency #=> Integer
resp.recommenders[0].recommender_config.inference_config.min_provisioned_tps #=> Integer
resp.recommenders[0].recommender_config.included_columns #=> Hash
resp.recommenders[0].recommender_config.included_columns["String"] #=> Array
resp.recommenders[0].recommender_config.included_columns["String"][0] #=> String
resp.recommenders[0].recommender_config.excluded_columns #=> Hash
resp.recommenders[0].recommender_config.excluded_columns["String"] #=> Array
resp.recommenders[0].recommender_config.excluded_columns["String"][0] #=> String
resp.recommenders[0].recommender_config.diversity_config.diversity_columns #=> Array
resp.recommenders[0].recommender_config.diversity_config.diversity_columns[0].name #=> String
resp.recommenders[0].recommender_config.diversity_config.diversity_columns[0].cap_type #=> String, one of "PERCENTAGE", "VALUE"
resp.recommenders[0].recommender_config.diversity_config.diversity_columns[0].target #=> String
resp.recommenders[0].created_at #=> Time
resp.recommenders[0].description #=> String
resp.recommenders[0].status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
resp.recommenders[0].last_updated_at #=> Time
resp.recommenders[0].tags #=> Hash
resp.recommenders[0].tags["TagKey"] #=> String
resp.recommenders[0].failure_reason #=> String
resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list #=> Array
resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_type #=> String
resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
resp.recommenders[0].latest_recommender_update.recommender_config.events_config.event_parameters_list[0].event_weight #=> Float
resp.recommenders[0].latest_recommender_update.recommender_config.training_frequency #=> Integer
resp.recommenders[0].latest_recommender_update.recommender_config.inference_config.min_provisioned_tps #=> Integer
resp.recommenders[0].latest_recommender_update.recommender_config.included_columns #=> Hash
resp.recommenders[0].latest_recommender_update.recommender_config.included_columns["String"] #=> Array
resp.recommenders[0].latest_recommender_update.recommender_config.included_columns["String"][0] #=> String
resp.recommenders[0].latest_recommender_update.recommender_config.excluded_columns #=> Hash
resp.recommenders[0].latest_recommender_update.recommender_config.excluded_columns["String"] #=> Array
resp.recommenders[0].latest_recommender_update.recommender_config.excluded_columns["String"][0] #=> String
resp.recommenders[0].latest_recommender_update.recommender_config.diversity_config.diversity_columns #=> Array
resp.recommenders[0].latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].name #=> String
resp.recommenders[0].latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].cap_type #=> String, one of "PERCENTAGE", "VALUE"
resp.recommenders[0].latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].target #=> String
resp.recommenders[0].latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
resp.recommenders[0].latest_recommender_update.created_at #=> Time
resp.recommenders[0].latest_recommender_update.last_updated_at #=> Time
resp.recommenders[0].latest_recommender_update.failure_reason #=> String
resp.recommenders[0].latest_recommender_update.recommender_version_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



6358
6359
6360
6361
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6358

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

#list_rule_based_matches(params = {}) ⇒ Types::ListRuleBasedMatchesResponse

Returns a set of MatchIds that belong to the given domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.match_ids #=> Array
resp.match_ids[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous ListRuleBasedMatches API call.

  • :max_results (Integer) —

    The maximum number of MatchIds returned per page.

  • :domain_name (required, String) —

    The unique name of the domain.

Returns:

See Also:



6400
6401
6402
6403
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6400

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

#list_segment_definitions(params = {}) ⇒ Types::ListSegmentDefinitionsResponse

Lists all segment definitions under a domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].segment_definition_name #=> String
resp.items[0].display_name #=> String
resp.items[0].description #=> String
resp.items[0].segment_definition_arn #=> String
resp.items[0].created_at #=> Time
resp.items[0].tags #=> Hash
resp.items[0].tags["TagKey"] #=> String
resp.items[0].segment_type #=> String, one of "CLASSIC", "ENHANCED"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique identifier of the domain.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

  • :next_token (String) —

    The pagination token from the previous call.

Returns:

See Also:



6448
6449
6450
6451
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6448

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

#list_segment_subscription_events(params = {}) ⇒ Types::ListSegmentSubscriptionEventsResponse

Returns the most recent membership events for a segment. Each event represents a profile that entered or exited the segment.

This operation is paginated.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.events #=> Array
resp.events[0].profile_id #=> String
resp.events[0].updated_at #=> Time
resp.events[0].event_type #=> String, one of "LIVE", "SCHEDULE"
resp.events[0].event #=> String, one of "JOINED", "LEFT"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :segment_definition_name (required, String) —

    The unique name of the segment definition.

  • :max_results (Integer) —

    The maximum number of events to return per page.

  • :next_token (String) —

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

Returns:

See Also:



6500
6501
6502
6503
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6500

def list_segment_subscription_events(params = {}, options = {})
  req = build_request(:list_segment_subscription_events, 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:



6531
6532
6533
6534
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6531

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

#list_upload_jobs(params = {}) ⇒ Types::ListUploadJobsResponse

This API retrieves a list of upload jobs for the specified domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.items #=> Array
resp.items[0].job_id #=> String
resp.items[0].display_name #=> String
resp.items[0].status #=> String, one of "CREATED", "IN_PROGRESS", "PARTIALLY_SUCCEEDED", "SUCCEEDED", "FAILED", "STOPPED"
resp.items[0].status_reason #=> String, one of "VALIDATION_FAILURE", "INTERNAL_FAILURE"
resp.items[0].created_at #=> Time
resp.items[0].completed_at #=> Time
resp.items[0].data_expiry #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

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

  • :max_results (Integer) —

    The maximum number of upload jobs to return per page.

  • :next_token (String) —

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

Returns:

See Also:



6579
6580
6581
6582
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6579

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

#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse

Query to list all workflows.

Examples:

Request syntax with placeholder values


resp = client.list_workflows({
  domain_name: "name", # required
  workflow_type: "APPFLOW_INTEGRATION", # accepts APPFLOW_INTEGRATION
  status: "NOT_STARTED", # accepts NOT_STARTED, IN_PROGRESS, COMPLETE, FAILED, SPLIT, RETRY, CANCELLED
  query_start_date: Time.now,
  query_end_date: Time.now,
  next_token: "token",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].workflow_type #=> String, one of "APPFLOW_INTEGRATION"
resp.items[0].workflow_id #=> String
resp.items[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED", "SPLIT", "RETRY", "CANCELLED"
resp.items[0].status_description #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :workflow_type (String) —

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

  • :status (String) —

    Status of workflow execution.

  • :query_start_date (Time, DateTime, Date, Integer, String) —

    Retrieve workflows started after timestamp.

  • :query_end_date (Time, DateTime, Date, Integer, String) —

    Retrieve workflows ended after timestamp.

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

Returns:

See Also:



6642
6643
6644
6645
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6642

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

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

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",
    },
    profile_type: "uuid",
    engagement_preferences: "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:



6744
6745
6746
6747
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6744

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

#put_domain_object_type(params = {}) ⇒ Types::PutDomainObjectTypeResponse

Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.

Examples:

Request syntax with placeholder values


resp = client.put_domain_object_type({
  domain_name: "name", # required
  object_type_name: "typeName", # required
  description: "sensitiveString1To10000",
  encryption_key: "encryptionKey",
  fields: { # required
    "DomainObjectTypeFieldName" => {
      source: "text", # required
      target: "text", # required
      content_type: "STRING", # accepts STRING, NUMBER
      feature_type: "TEXTUAL", # accepts TEXTUAL, CATEGORICAL
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.object_type_name #=> String
resp.description #=> String
resp.encryption_key #=> String
resp.fields #=> Hash
resp.fields["DomainObjectTypeFieldName"].source #=> String
resp.fields["DomainObjectTypeFieldName"].target #=> String
resp.fields["DomainObjectTypeFieldName"].content_type #=> String, one of "STRING", "NUMBER"
resp.fields["DomainObjectTypeFieldName"].feature_type #=> String, one of "TEXTUAL", "CATEGORICAL"
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 unique name of the domain object type.

  • :description (String) —

    The description of the domain object type.

  • :encryption_key (String) —

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

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

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

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

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

Returns:

See Also:



6822
6823
6824
6825
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6822

def put_domain_object_type(params = {}, options = {})
  req = build_request(:put_domain_object_type, 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.

To add or remove tags on an existing Integration, see TagResource / UntagResource.

Examples:

Request syntax with placeholder values


resp = client.put_integration({
  domain_name: "name", # required
  uri: "string1To255",
  object_type_name: "typeName",
  object_type_names: {
    "string1To255" => "typeName",
  },
  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,
        },
      },
    },
  },
  role_arn: "RoleArn",
  event_trigger_names: ["name"],
  scope: "PROFILE", # accepts PROFILE, DOMAIN
})

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
resp.object_type_names #=> Hash
resp.object_type_names["string1To255"] #=> String
resp.workflow_id #=> String
resp.is_unstructured #=> Boolean
resp.role_arn #=> String
resp.event_trigger_names #=> Array
resp.event_trigger_names[0] #=> String
resp.scope #=> String, one of "PROFILE", "DOMAIN"

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

    The name of the profile object type.

  • :object_type_names (Hash<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.

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

  • :role_arn (String) —

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

  • :event_trigger_names (Array<String>) —

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

  • :scope (String) —

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

Returns:

See Also:



6995
6996
6997
6998
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 6995

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 Record, 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 Contact Records 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:



7044
7045
7046
7047
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7044

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.

To add or remove tags on an existing ObjectType, see TagResource/UntagResource.

Examples:

Request syntax with placeholder values


resp = client.put_profile_object_type({
  domain_name: "name", # required
  object_type_name: "typeName", # required
  description: "sensitiveText", # required
  template_id: "name",
  expiration_days: 1,
  encryption_key: "encryptionKey",
  allow_profile_creation: false,
  source_last_updated_timestamp_format: "string1To255",
  max_profile_object_count: 1,
  source_priority: 1,
  fields: {
    "fieldName" => {
      source: "text",
      target: "text",
      content_type: "STRING", # accepts STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME
    },
  },
  keys: {
    "name" => [
      {
        standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, DEVICE, WEB_ANALYTICS, ORDER, COMMUNICATION_RECORD, AIR_PREFERENCE, HOTEL_PREFERENCE, AIR_BOOKING, AIR_SEGMENT, HOTEL_RESERVATION, HOTEL_STAY_REVENUE, LOYALTY, LOYALTY_TRANSACTION, LOYALTY_PROMOTION, 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.source_last_updated_timestamp_format #=> String
resp.max_profile_object_count #=> Integer
resp.max_available_profile_object_count #=> Integer
resp.source_priority #=> Integer
resp.fields #=> Hash
resp.fields["fieldName"].source #=> String
resp.fields["fieldName"].target #=> String
resp.fields["fieldName"].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", "ASSET", "CASE", "DEVICE", "WEB_ANALYTICS", "ORDER", "COMMUNICATION_RECORD", "AIR_PREFERENCE", "HOTEL_PREFERENCE", "AIR_BOOKING", "AIR_SEGMENT", "HOTEL_RESERVATION", "HOTEL_STAY_REVENUE", "LOYALTY", "LOYALTY_TRANSACTION", "LOYALTY_PROMOTION", "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. 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 (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.

  • :source_last_updated_timestamp_format (String) —

    The format of your sourceLastUpdatedTimestamp that was previously set up.

  • :max_profile_object_count (Integer) —

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

  • :source_priority (Integer) —

    An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority.

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



7197
7198
7199
7200
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7197

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

#put_segment_subscription(params = {}) ⇒ Types::PutSegmentSubscriptionResponse

Creates or updates a segment subscription for membership events. When a subscription is created, an initial snapshot is taken and the system begins monitoring for membership changes.

You can optionally set a schedule configuration interval to control how often membership snapshots are run. The interval can be from 1 to 24 hours. If not set, the interval defaults to 24 hours. Scheduled snapshots run on a best-effort basis. If a scheduled snapshot takes longer than the configured interval, the next scheduled run does not start until the in-progress snapshot completes, so a run might be delayed or skipped and is not guaranteed to occur at exactly the requested time.

For Classic segments, membership events are generated from these scheduled snapshots and also in near real-time as profile attribute changes occur. For SQL segments, membership events are generated only from the scheduled snapshots.

Examples:

Request syntax with placeholder values


resp = client.put_segment_subscription({
  domain_name: "name", # required
  segment_definition_name: "name", # required
  schedule_configuration: {
    interval: 1, # required
    unit: "HOURLY", # accepts HOURLY
  },
})

Response structure


resp.status #=> String, one of "STARTING", "RUNNING", "STOPPED", "FAILED"
resp.schedule_configuration.interval #=> Integer
resp.schedule_configuration.unit #=> String, one of "HOURLY"
resp.started_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :segment_definition_name (required, String) —

    The unique name of the segment definition.

  • :schedule_configuration (Types::ScheduleConfiguration) —

    The optional schedule configuration that controls how often membership snapshots are run. If not provided, the subscription defaults to a 24-hour interval.

Returns:

See Also:



7259
7260
7261
7262
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7259

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

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

Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.

This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.

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
  additional_search_keys: [
    {
      key_name: "name", # required
      values: ["string1To255"], # required
    },
  ],
  logical_operator: "AND", # accepts AND, OR
})

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.items[0].found_by_items #=> Array
resp.items[0].found_by_items[0].key_name #=> String
resp.items[0].found_by_items[0].values #=> Array
resp.items[0].found_by_items[0].values[0] #=> String
resp.items[0].party_type_string #=> String
resp.items[0].gender_string #=> String
resp.items[0].profile_type #=> String, one of "ACCOUNT_PROFILE", "PROFILE"
resp.items[0].engagement_preferences.phone #=> Array
resp.items[0].engagement_preferences.phone[0].key_name #=> String
resp.items[0].engagement_preferences.phone[0].key_value #=> String
resp.items[0].engagement_preferences.phone[0].profile_id #=> String
resp.items[0].engagement_preferences.phone[0].contact_type #=> String, one of "PhoneNumber", "MobilePhoneNumber", "HomePhoneNumber", "BusinessPhoneNumber", "EmailAddress", "PersonalEmailAddress", "BusinessEmailAddress"
resp.items[0].engagement_preferences.email #=> Array
resp.items[0].engagement_preferences.email[0].key_name #=> String
resp.items[0].engagement_preferences.email[0].key_value #=> String
resp.items[0].engagement_preferences.email[0].profile_id #=> String
resp.items[0].engagement_preferences.email[0].contact_type #=> String, one of "PhoneNumber", "MobilePhoneNumber", "HomePhoneNumber", "BusinessPhoneNumber", "EmailAddress", "PersonalEmailAddress", "BusinessEmailAddress"
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.

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

  • :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, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

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

    A list of key values.

  • :additional_search_keys (Array<Types::AdditionalSearchKey>) —

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

    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.

Returns:

See Also:



7430
7431
7432
7433
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7430

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

#search_recommendations(params = {}) ⇒ Types::SearchRecommendationsResponse

Retrieves recommendations for a profile in a specific domain. The profile is identified using a search key, which consists of a KeyName and a KeyValues list. The KeyName can be a predefined key (for example, _profileId, _phone, _email) or a custom-defined key.

The search key must match exactly one profile. If no profile matches the search key, the operation returns a ResourceNotFoundException. If more than one profile matches the search key, the operation returns a BadRequestException. You can use the SearchProfiles API to review the matching profiles.

Examples:

Request syntax with placeholder values


resp = client.search_recommendations({
  domain_name: "name", # required
  key_name: "name", # required
  key_values: ["string1To255"], # required
  recommender: { # required
    name: "name", # required
    filters: [
      {
        name: "name",
        values: {
          "RecommenderFilterAttributeName" => "RecommenderFilterAttributeValue",
        },
      },
    ],
    promotional_filters: [
      {
        name: "name",
        values: {
          "RecommenderFilterAttributeName" => "RecommenderFilterAttributeValue",
        },
        promotion_name: "name",
        percent_promoted_items: 1,
      },
    ],
  },
  candidate_ids: ["string1To255"],
  context: {
    "ContextKey" => "string1To255",
  },
  diversity: {
    enabled: false, # required
    values: {
      "DiversityPlaceholderName" => 1,
    },
  },
  metadata: {
    columns: ["MetadataColumnName"],
  },
  max_recommendations: 1,
})

Response structure


resp.profile_id #=> String
resp.recommendations #=> Array
resp.recommendations[0].catalog_item.id #=> String
resp.recommendations[0].catalog_item.name #=> String
resp.recommendations[0].catalog_item.code #=> String
resp.recommendations[0].catalog_item.type #=> String
resp.recommendations[0].catalog_item.category #=> String
resp.recommendations[0].catalog_item.description #=> String
resp.recommendations[0].catalog_item.additional_information #=> String
resp.recommendations[0].catalog_item.image_link #=> String
resp.recommendations[0].catalog_item.link #=> String
resp.recommendations[0].catalog_item.created_at #=> Time
resp.recommendations[0].catalog_item.updated_at #=> Time
resp.recommendations[0].catalog_item.price #=> String
resp.recommendations[0].catalog_item.attributes #=> Hash
resp.recommendations[0].catalog_item.attributes["string1To255"] #=> String
resp.recommendations[0].score #=> Float

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :key_name (required, String) —

    A searchable identifier of a customer profile. You can use a predefined key, such as _profileId, _phone, or _email, or a custom-defined key.

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

    A list of key values. Provide one value for each field of the search key.

  • :recommender (required, Types::Recommender) —

    The recommender used to generate the recommendations.

  • :candidate_ids (Array<String>) —

    A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

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

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

  • :diversity (Types::RecommendationDiversityConfig) —

    Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

  • :metadata (Types::RecommendationMetadata) —

    Configuration for metadata to include in recommendation responses.

  • :max_recommendations (Integer) —

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

Returns:

See Also:



7556
7557
7558
7559
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7556

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

#start_recommender(params = {}) ⇒ Struct

Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :recommender_name (required, String) —

    The name of the recommender to start.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7583
7584
7585
7586
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7583

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

#start_upload_job(params = {}) ⇒ Struct

This API starts the processing of an upload job to ingest profile data.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

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

  • :job_id (required, String) —

    The unique identifier of the upload job to start.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7610
7611
7612
7613
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7610

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

#stop_recommender(params = {}) ⇒ Struct

Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :recommender_name (required, String) —

    The name of the recommender to stop.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7638
7639
7640
7641
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7638

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

#stop_upload_job(params = {}) ⇒ Struct

This API stops the processing of an upload job.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

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

  • :job_id (required, String) —

    The unique identifier of the upload job to stop.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7664
7665
7666
7667
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7664

def stop_upload_job(params = {}, options = {})
  req = build_request(:stop_upload_job, 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:



7708
7709
7710
7711
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7708

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:



7736
7737
7738
7739
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7736

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

#update_calculated_attribute_definition(params = {}) ⇒ Types::UpdateCalculatedAttributeDefinitionResponse

Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.

Examples:

Request syntax with placeholder values


resp = client.update_calculated_attribute_definition({
  domain_name: "name", # required
  calculated_attribute_name: "typeName", # required
  display_name: "displayName",
  description: "sensitiveText",
  conditions: {
    range: {
      value: 1,
      unit: "DAYS", # accepts DAYS
      value_range: {
        start: 1, # required
        end: 1, # required
      },
      timestamp_source: "string1To255",
      timestamp_format: "string1To255",
    },
    object_count: 1,
    threshold: {
      value: "string1To255", # required
      operator: "EQUAL_TO", # required, accepts EQUAL_TO, GREATER_THAN, LESS_THAN, NOT_EQUAL_TO
    },
  },
})

Response structure


resp.calculated_attribute_name #=> String
resp.display_name #=> String
resp.description #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.statistic #=> String, one of "FIRST_OCCURRENCE", "LAST_OCCURRENCE", "COUNT", "SUM", "MINIMUM", "MAXIMUM", "AVERAGE", "MAX_OCCURRENCE", "RECENT_OCCURRENCES"
resp.conditions.range.value #=> Integer
resp.conditions.range.unit #=> String, one of "DAYS"
resp.conditions.range.value_range.start #=> Integer
resp.conditions.range.value_range.end #=> Integer
resp.conditions.range.timestamp_source #=> String
resp.conditions.range.timestamp_format #=> String
resp.conditions.object_count #=> Integer
resp.conditions.threshold.value #=> String
resp.conditions.threshold.operator #=> String, one of "EQUAL_TO", "GREATER_THAN", "LESS_THAN", "NOT_EQUAL_TO"
resp.attribute_details.attributes #=> Array
resp.attribute_details.attributes[0].name #=> String
resp.attribute_details.expression #=> String
resp.use_historical_data #=> Boolean
resp.status #=> String, one of "PREPARING", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.readiness.progress_percentage #=> Integer
resp.readiness.message #=> String
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.

  • :calculated_attribute_name (required, String) —

    The unique name of the calculated attribute.

  • :display_name (String) —

    The display name of the calculated attribute.

  • :description (String) —

    The description of the calculated attribute.

  • :conditions (Types::Conditions) —

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

Returns:

See Also:



7834
7835
7836
7837
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 7834

def update_calculated_attribute_definition(params = {}, options = {})
  req = build_request(:update_calculated_attribute_definition, 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.

Use this API or CreateDomain to enable identity resolution: set Matching to true.

To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.

To add or remove tags on an existing Domain, see TagResource/UntagResource.

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
    job_schedule: {
      day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
      time: "JobScheduleTime", # required
    },
    auto_merging: {
      enabled: false, # required
      consolidation: {
        matching_attributes_list: [ # required
          ["string1To255"],
        ],
      },
      conflict_resolution: {
        conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
        source_name: "string1To255",
      },
      min_allowed_confidence_score_for_merging: 1.0,
    },
    exporting_config: {
      s3_exporting: {
        s3_bucket_name: "s3BucketName", # required
        s3_key_name: "s3KeyNameCustomerOutputConfig",
      },
    },
  },
  rule_based_matching: {
    enabled: false, # required
    matching_rules: [
      {
        rule: ["string1To255"], # required
      },
    ],
    max_allowed_rule_level_for_merging: 1,
    max_allowed_rule_level_for_matching: 1,
    attribute_types_selector: {
      attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
      address: ["string1To255"],
      phone_number: ["string1To255"],
      email_address: ["string1To255"],
    },
    conflict_resolution: {
      conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
      source_name: "string1To255",
    },
    exporting_config: {
      s3_exporting: {
        s3_bucket_name: "s3BucketName", # required
        s3_key_name: "s3KeyNameCustomerOutputConfig",
      },
    },
  },
  data_store: {
    enabled: false,
  },
  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.matching.job_schedule.day_of_the_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
resp.matching.job_schedule.time #=> String
resp.matching.auto_merging.enabled #=> Boolean
resp.matching.auto_merging.consolidation.matching_attributes_list #=> Array
resp.matching.auto_merging.consolidation.matching_attributes_list[0] #=> Array
resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
resp.matching.auto_merging.conflict_resolution.source_name #=> String
resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
resp.rule_based_matching.enabled #=> Boolean
resp.rule_based_matching.matching_rules #=> Array
resp.rule_based_matching.matching_rules[0].rule #=> Array
resp.rule_based_matching.matching_rules[0].rule[0] #=> String
resp.rule_based_matching.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE"
resp.rule_based_matching.max_allowed_rule_level_for_merging #=> Integer
resp.rule_based_matching.max_allowed_rule_level_for_matching #=> Integer
resp.rule_based_matching.attribute_types_selector.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.rule_based_matching.attribute_types_selector.address #=> Array
resp.rule_based_matching.attribute_types_selector.address[0] #=> String
resp.rule_based_matching.attribute_types_selector.phone_number #=> Array
resp.rule_based_matching.attribute_types_selector.phone_number[0] #=> String
resp.rule_based_matching.attribute_types_selector.email_address #=> Array
resp.rule_based_matching.attribute_types_selector.email_address[0] #=> String
resp.rule_based_matching.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
resp.rule_based_matching.conflict_resolution.source_name #=> String
resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
resp.data_store.enabled #=> Boolean
resp.data_store.readiness.progress_percentage #=> Integer
resp.data_store.readiness.message #=> 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.

  • :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. 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 (Types::RuleBasedMatchingRequest) —

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

  • :data_store (Types::DataStoreRequest) —

    Set to true to enabled data store for this domain.

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

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

Returns:

See Also:



8041
8042
8043
8044
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 8041

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

#update_domain_layout(params = {}) ⇒ Types::UpdateDomainLayoutResponse

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Examples:

Request syntax with placeholder values


resp = client.update_domain_layout({
  domain_name: "name", # required
  layout_definition_name: "name", # required
  description: "sensitiveText",
  display_name: "displayName",
  is_default: false,
  layout_type: "PROFILE_EXPLORER", # accepts PROFILE_EXPLORER
  layout: "sensitiveString1To2000000",
})

Response structure


resp.layout_definition_name #=> String
resp.description #=> String
resp.display_name #=> String
resp.is_default #=> Boolean
resp.layout_type #=> String, one of "PROFILE_EXPLORER"
resp.layout #=> String
resp.version #=> 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.

  • :layout_definition_name (required, String) —

    The unique name of the layout.

  • :description (String) —

    The description of the layout

  • :display_name (String) —

    The display name of the layout

  • :is_default (Boolean) —

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

  • :layout_type (String) —

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

  • :layout (String) —

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

Returns:

See Also:



8118
8119
8120
8121
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 8118

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

#update_event_trigger(params = {}) ⇒ Types::UpdateEventTriggerResponse

Update the properties of an Event Trigger.

Examples:

Request syntax with placeholder values


resp = client.update_event_trigger({
  domain_name: "name", # required
  event_trigger_name: "name", # required
  object_type_name: "typeName",
  description: "sensitiveText",
  event_trigger_conditions: [
    {
      event_trigger_dimensions: [ # required
        {
          object_attributes: [ # required
            {
              source: "text",
              field_name: "fieldName",
              comparison_operator: "INCLUSIVE", # required, accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEGINS_WITH, ENDS_WITH, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, EQUAL, BEFORE, AFTER, ON, BETWEEN, NOT_BETWEEN
              values: ["string1To255"], # required
            },
          ],
        },
      ],
      logical_operator: "ANY", # required, accepts ANY, ALL, NONE
    },
  ],
  segment_filter: "name",
  event_trigger_limits: {
    event_expiration: 1,
    periods: [
      {
        unit: "MINUTES", # required, accepts MINUTES, HOURS, DAYS, WEEKS, MONTHS
        value: 1, # required
        max_invocations_per_profile: 1,
        unlimited: false,
      },
    ],
  },
})

Response structure


resp.event_trigger_name #=> String
resp.object_type_name #=> String
resp.description #=> String
resp.event_trigger_conditions #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].source #=> String
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].field_name #=> String
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].comparison_operator #=> String, one of "INCLUSIVE", "EXCLUSIVE", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL", "EQUAL", "BEFORE", "AFTER", "ON", "BETWEEN", "NOT_BETWEEN"
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].values #=> Array
resp.event_trigger_conditions[0].event_trigger_dimensions[0].object_attributes[0].values[0] #=> String
resp.event_trigger_conditions[0].logical_operator #=> String, one of "ANY", "ALL", "NONE"
resp.segment_filter #=> String
resp.event_trigger_limits.event_expiration #=> Integer
resp.event_trigger_limits.periods #=> Array
resp.event_trigger_limits.periods[0].unit #=> String, one of "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS"
resp.event_trigger_limits.periods[0].value #=> Integer
resp.event_trigger_limits.periods[0].max_invocations_per_profile #=> Integer
resp.event_trigger_limits.periods[0].unlimited #=> 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.

  • :event_trigger_name (required, String) —

    The unique name of the event trigger.

  • :object_type_name (String) —

    The unique name of the object type.

  • :description (String) —

    The description of the event trigger.

  • :event_trigger_conditions (Array<Types::EventTriggerCondition>) —

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

  • :segment_filter (String) —

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

  • :event_trigger_limits (Types::EventTriggerLimits) —

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

Returns:

See Also:



8230
8231
8232
8233
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 8230

def update_event_trigger(params = {}, options = {})
  req = build_request(:update_event_trigger, 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: "sensitiveString0To1000",
  account_number: "sensitiveString0To255",
  party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
  business_name: "sensitiveString0To255",
  first_name: "sensitiveString0To255",
  middle_name: "sensitiveString0To255",
  last_name: "sensitiveString0To255",
  birth_date: "sensitiveString0To255",
  gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
  phone_number: "sensitiveString0To255",
  mobile_phone_number: "sensitiveString0To255",
  home_phone_number: "sensitiveString0To255",
  business_phone_number: "sensitiveString0To255",
  email_address: "sensitiveString0To255",
  personal_email_address: "sensitiveString0To255",
  business_email_address: "sensitiveString0To255",
  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",
  },
  party_type_string: "sensitiveString0To255",
  gender_string: "sensitiveString0To255",
  profile_type: "ACCOUNT_PROFILE", # accepts ACCOUNT_PROFILE, PROFILE
  engagement_preferences: {
    phone: [
      {
        key_name: "name",
        key_value: "string1To255",
        profile_id: "uuid",
        contact_type: "PhoneNumber", # accepts PhoneNumber, MobilePhoneNumber, HomePhoneNumber, BusinessPhoneNumber, EmailAddress, PersonalEmailAddress, BusinessEmailAddress
      },
    ],
    email: [
      {
        key_name: "name",
        key_value: "string1To255",
        profile_id: "uuid",
        contact_type: "PhoneNumber", # accepts PhoneNumber, MobilePhoneNumber, HomePhoneNumber, BusinessPhoneNumber, EmailAddress, PersonalEmailAddress, BusinessEmailAddress
      },
    ],
  },
})

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

    An account number that you have assigned 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.

  • :party_type_string (String) —

    An alternative to PartyType which accepts any string as input.

  • :gender_string (String) —

    An alternative to Gender which accepts any string as input.

  • :profile_type (String) —

    Determines the type of the profile.

  • :engagement_preferences (Types::EngagementPreferences) —

    Object that defines users preferred methods of engagement.

Returns:

See Also:



8433
8434
8435
8436
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 8433

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

#update_recommender(params = {}) ⇒ Types::UpdateRecommenderResponse

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

Examples:

Request syntax with placeholder values


resp = client.update_recommender({
  domain_name: "name", # required
  recommender_name: "name", # required
  description: "sensitiveText",
  recommender_config: {
    events_config: {
      event_parameters_list: [ # required
        {
          event_type: "EventParametersEventTypeString", # required
          event_value_threshold: 1.0,
          event_weight: 1.0,
        },
      ],
    },
    training_frequency: 1,
    inference_config: {
      min_provisioned_tps: 1,
    },
    included_columns: {
      "String" => ["text"],
    },
    excluded_columns: {
      "String" => ["text"],
    },
    diversity_config: {
      diversity_columns: [
        {
          name: "text", # required
          cap_type: "PERCENTAGE", # required, accepts PERCENTAGE, VALUE
          target: "DiversityTargetExpression", # required
        },
      ],
    },
  },
  recommender_version_name: "RecommenderVersionName",
})

Response structure


resp.recommender_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The unique name of the domain.

  • :recommender_name (required, String) —

    The name of the recommender to update.

  • :description (String) —

    The new description to assign to the recommender.

  • :recommender_config (Types::RecommenderConfig) —

    The new configuration settings to apply to the recommender, including updated parameters and settings that define its behavior.

  • :recommender_version_name (String) —

    The name of a specific recommender version to activate as part of this update (for example, to roll back to a previously trained version).

Returns:

See Also:



8509
8510
8511
8512
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/client.rb', line 8509

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