Class: Aws::CustomerProfiles::Types::SearchProfilesRequest

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

Overview

Note:

When making an API call, you may pass SearchProfilesRequest data as a hash:

{
  next_token: "token",
  max_results: 1,
  domain_name: "name", # required
  key_name: "name", # required
  values: ["string1To255"], # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

The unique name of the domain.

Returns:

  • (String)


4420
4421
4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4420

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :key_name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#key_nameString

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.

Returns:

  • (String)


4420
4421
4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4420

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :key_name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of objects returned per page.

Returns:

  • (Integer)


4420
4421
4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4420

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :key_name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The pagination token from the previous SearchProfiles API call.

Returns:

  • (String)


4420
4421
4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4420

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :key_name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#valuesArray<String>

A list of key values.

Returns:

  • (Array<String>)


4420
4421
4422
4423
4424
4425
4426
4427
4428
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4420

class SearchProfilesRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :key_name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end