Class: Aws::CleanRoomsML::Types::StartAudienceGenerationJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::CleanRoomsML::Types::StartAudienceGenerationJobRequest

Defined in:

gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #collaboration_id ⇒ String

  The identifier of the collaboration that contains the audience generation job.

• #configured_audience_model_arn ⇒ String

  The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.

• #description ⇒ String

  The description of the audience generation job.

• #include_seed_in_output ⇒ Boolean

  Whether the seed audience is included in the audience generation output.

• #name ⇒ String

  The name of the audience generation job.

• #seed_audience ⇒ Types::AudienceGenerationJobDataSource

  The seed audience that is used to generate the audience.

• #tags ⇒ Hash<String,String>

  The optional metadata that you apply to the resource to help you categorize and organize them.

Instance Attribute Details

#collaboration_id ⇒ String

The identifier of the collaboration that contains the audience generation job.

Returns:

• (String)

# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 1641

class StartAudienceGenerationJobRequest < Struct.new(
  :collaboration_id,
  :configured_audience_model_arn,
  :description,
  :include_seed_in_output,
  :name,
  :seed_audience,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#configured_audience_model_arn ⇒ String

The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.

Returns:

• (String)

# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 1641

class StartAudienceGenerationJobRequest < Struct.new(
  :collaboration_id,
  :configured_audience_model_arn,
  :description,
  :include_seed_in_output,
  :name,
  :seed_audience,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the audience generation job.

Returns:

• (String)

# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 1641

class StartAudienceGenerationJobRequest < Struct.new(
  :collaboration_id,
  :configured_audience_model_arn,
  :description,
  :include_seed_in_output,
  :name,
  :seed_audience,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#include_seed_in_output ⇒ Boolean

Whether the seed audience is included in the audience generation output.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 1641

class StartAudienceGenerationJobRequest < Struct.new(
  :collaboration_id,
  :configured_audience_model_arn,
  :description,
  :include_seed_in_output,
  :name,
  :seed_audience,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the audience generation job.

Returns:

• (String)

# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 1641

class StartAudienceGenerationJobRequest < Struct.new(
  :collaboration_id,
  :configured_audience_model_arn,
  :description,
  :include_seed_in_output,
  :name,
  :seed_audience,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#seed_audience ⇒ Types::AudienceGenerationJobDataSource

The seed audience that is used to generate the audience.

Returns:

• (Types::AudienceGenerationJobDataSource)

# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 1641

class StartAudienceGenerationJobRequest < Struct.new(
  :collaboration_id,
  :configured_audience_model_arn,
  :description,
  :include_seed_in_output,
  :name,
  :seed_audience,
  :tags)
  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>)

# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 1641

class StartAudienceGenerationJobRequest < Struct.new(
  :collaboration_id,
  :configured_audience_model_arn,
  :description,
  :include_seed_in_output,
  :name,
  :seed_audience,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end