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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_name ⇒ String

The unique name of the domain.

Returns:

  • (String) 


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2519

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.

Returns:

  • (String) 


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2519

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.

Returns:

  • (Integer) 


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2519

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.

Returns:

  • (String) 


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2519

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.

Returns:

  • (String) 


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2519

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.

Returns:

  • (String) 


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2519

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