Class: Aws::CustomerProfiles::Types::PutProfileObjectTypeRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:description, :fields, :keys]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_profile_creation ⇒ Boolean

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

Returns:

  • (Boolean) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#description ⇒ String

Description of the profile object type.

Returns:

  • (String) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#domain_name ⇒ String

The unique name of the domain.

Returns:

  • (String) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#encryption_key ⇒ String

The customer-provided key to encrypt the profile object that will be created in this profile object type.

Returns:

  • (String) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#expiration_days ⇒ Integer

The number of days until the data in the object expires.

Returns:

  • (Integer) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#fields ⇒ Hash<String,Types::ObjectTypeField>

A map of the name and ObjectType field.

Returns:



4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#keys ⇒ Hash<String,Array<Types::ObjectTypeKey>>

A list of unique keys that can be used to map data to the profile.

Returns:



4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#max_profile_object_count ⇒ Integer

The amount of profile object max count assigned to the object type

Returns:

  • (Integer) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#object_type_name ⇒ String

The name of the profile object type.

Returns:

  • (String) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#source_last_updated_timestamp_format ⇒ String

The format of your sourceLastUpdatedTimestamp that was previously set up.

Returns:

  • (String) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

  • (Hash<String,String>) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end

#template_id ⇒ String

A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a BadRequestException. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a BadRequestException.

Returns:

  • (String) 


4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4373

class PutProfileObjectTypeRequest < Struct.new(
  :domain_name,
  :object_type_name,
  :description,
  :template_id,
  :expiration_days,
  :encryption_key,
  :allow_profile_creation,
  :source_last_updated_timestamp_format,
  :max_profile_object_count,
  :fields,
  :keys,
  :tags)
  SENSITIVE = [:description, :fields, :keys]
  include Aws::Structure
end