Class: Aws::CleanRoomsML::Types::GetAudienceGenerationJobResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::CleanRoomsML::Types::GetAudienceGenerationJobResponse
- Defined in:
- gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#audience_generation_job_arn ⇒ String
The Amazon Resource Name (ARN) of the audience generation job.
-
#collaboration_id ⇒ String
The identifier of the collaboration that this audience generation job is associated with.
-
#configured_audience_model_arn ⇒ String
The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
-
#create_time ⇒ Time
The time at which the audience generation job was created.
-
#description ⇒ String
The description of the audience generation job.
-
#include_seed_in_output ⇒ Boolean
Configure whether the seed users are included in the output audience.
-
#metrics ⇒ Types::AudienceQualityMetrics
The relevance scores for different audience sizes and the recall score of the generated audience.
-
#name ⇒ String
The name of the audience generation job.
-
#seed_audience ⇒ Types::AudienceGenerationJobDataSource
The seed audience that was used for this audience generation job.
-
#started_by ⇒ String
The AWS account that started this audience generation job.
-
#status ⇒ String
The status of the audience generation job.
-
#status_details ⇒ Types::StatusDetails
Details about the status of the audience generation job.
-
#tags ⇒ Hash<String,String>
The tags that are associated to this audience generation job.
-
#update_time ⇒ Time
The most recent time at which the audience generation job was updated.
Instance Attribute Details
#audience_generation_job_arn ⇒ String
The Amazon Resource Name (ARN) of the audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#collaboration_id ⇒ String
The identifier of the collaboration that this audience generation job is associated with.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#configured_audience_model_arn ⇒ String
The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#create_time ⇒ Time
The time at which the audience generation job was created.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#include_seed_in_output ⇒ Boolean
Configure whether the seed users are included in the output
audience. By default, Clean Rooms ML removes seed users from the
output audience. If you specify TRUE
, the seed users will appear
first in the output. Clean Rooms ML does not explicitly reveal
whether a user was in the seed, but the recipient of the audience
will know that the first minimumSeedSize
count of users are from
the seed.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#metrics ⇒ Types::AudienceQualityMetrics
The relevance scores for different audience sizes and the recall score of the generated audience.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#seed_audience ⇒ Types::AudienceGenerationJobDataSource
The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#started_by ⇒ String
The AWS account that started this audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The status of the audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#status_details ⇒ Types::StatusDetails
Details about the status of the audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
The tags that are associated to this audience generation job.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |
#update_time ⇒ Time
The most recent time at which the audience generation job was updated.
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 897 class GetAudienceGenerationJobResponse < Struct.new( :audience_generation_job_arn, :collaboration_id, :configured_audience_model_arn, :create_time, :description, :include_seed_in_output, :metrics, :name, :seed_audience, :started_by, :status, :status_details, :tags, :update_time) SENSITIVE = [] include Aws::Structure end |