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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

The unique name of the domain.

Returns:

  • (String)


5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5064

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

#match_typeString

Specify the type of matching to get similar profiles for.

Returns:

  • (String)


5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5064

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

#max_resultsInteger

The maximum number of objects returned per page.

Returns:

  • (Integer)


5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5064

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

#next_tokenString

The pagination token from the previous GetSimilarProfiles API call.

Returns:

  • (String)


5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5064

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

#search_keyString

The string indicating the search key to be used.

Returns:

  • (String)


5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5064

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

#search_valueString

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

Returns:

  • (String)


5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 5064

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