Class: Aws::CustomerProfiles::Types::GetSimilarProfilesRequest

Inherits:

Struct

• Object
• Struct
• Aws::CustomerProfiles::Types::GetSimilarProfilesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-customerprofiles/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain_name ⇒ String

  The unique name of the domain.

• #match_type ⇒ String

  Specify the type of matching to get similar profiles for.

• #max_results ⇒ Integer

  The maximum number of objects returned per page.

• #next_token ⇒ String

  The pagination token from the previous GetSimilarProfiles API call.

• #search_key ⇒ String

  The string indicating the search key to be used.

• #search_value ⇒ String

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

Instance Attribute Details

#domain_name ⇒ String

The unique name of the domain.

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5601

class GetSimilarProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :match_type,
  :search_key,
  :search_value)
  SENSITIVE = []
  include Aws::Structure
end

#match_type ⇒ String

Specify the type of matching to get similar profiles for.

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5601

class GetSimilarProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :match_type,
  :search_key,
  :search_value)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of objects returned per page.

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5601

class GetSimilarProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :match_type,
  :search_key,
  :search_value)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The pagination token from the previous GetSimilarProfiles API call.

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5601

class GetSimilarProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :match_type,
  :search_key,
  :search_value)
  SENSITIVE = []
  include Aws::Structure
end

#search_key ⇒ String

The string indicating the search key to be used.

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5601

class GetSimilarProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :match_type,
  :search_key,
  :search_value)
  SENSITIVE = []
  include Aws::Structure
end

#search_value ⇒ String

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

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5601

class GetSimilarProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :match_type,
  :search_key,
  :search_value)
  SENSITIVE = []
  include Aws::Structure
end