Class: Aws::CustomerProfiles::Types::ListProfileObjectsRequest

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 ListProfileObjectsRequest data as a hash:

{
  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
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

The unique name of the domain.

Returns:

  • (String)


3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3163

class ListProfileObjectsRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :object_type_name,
  :profile_id,
  :object_filter)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of objects returned per page.

Returns:

  • (Integer)


3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3163

class ListProfileObjectsRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :object_type_name,
  :profile_id,
  :object_filter)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The pagination token from the previous call to ListProfileObjects.

Returns:

  • (String)


3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3163

class ListProfileObjectsRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :object_type_name,
  :profile_id,
  :object_filter)
  SENSITIVE = []
  include Aws::Structure
end

#object_filterTypes::ObjectFilter

Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

Returns:



3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3163

class ListProfileObjectsRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :object_type_name,
  :profile_id,
  :object_filter)
  SENSITIVE = []
  include Aws::Structure
end

#object_type_nameString

The name of the profile object type.

Returns:

  • (String)


3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3163

class ListProfileObjectsRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :object_type_name,
  :profile_id,
  :object_filter)
  SENSITIVE = []
  include Aws::Structure
end

#profile_idString

The unique identifier of a customer profile.

Returns:

  • (String)


3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3163

class ListProfileObjectsRequest < Struct.new(
  :next_token,
  :max_results,
  :domain_name,
  :object_type_name,
  :profile_id,
  :object_filter)
  SENSITIVE = []
  include Aws::Structure
end