Class: Aws::CleanRoomsML::Types::CreateConfiguredAudienceModelRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cleanroomsml/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audience_model_arn ⇒ String

The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

Returns:

  • (String) 


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end

#audience_size_config ⇒ Types::AudienceSizeConfig

Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an ‘audienceSize` selected from this list. You can use the `ABSOLUTE` AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the `Percentage` AudienceSize to configure sizes in the range 1-100 percent.

Returns:



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end

#child_resource_tag_on_create_policy ⇒ String

Configure how the service tags audience generation jobs created using this configured audience model. If you specify ‘NONE`, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify `FROM_PARENT_RESOURCE`, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller’s account.

Returns:

  • (String) 


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the configured audience model.

Returns:

  • (String) 


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end

#min_matching_seed_size ⇒ Integer

The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.

Returns:

  • (Integer) 


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the configured audience model.

Returns:

  • (String) 


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::ConfiguredAudienceModelOutputConfig

Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have ‘s3:PutObject` permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.

Returns:



1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end

#shared_audience_metrics ⇒ Array<String>

Whether audience metrics are shared.

Returns:

  • (Array<String>) 


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

Returns:

  • (Hash<String,String>) 


1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1158

class CreateConfiguredAudienceModelRequest < Struct.new(
  :name,
  :audience_model_arn,
  :output_config,
  :description,
  :shared_audience_metrics,
  :min_matching_seed_size,
  :audience_size_config,
  :tags,
  :child_resource_tag_on_create_policy)
  SENSITIVE = []
  include Aws::Structure
end