Class: Aws::CleanRoomsML::Types::GetAudienceGenerationJobResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audience_generation_job_arnString

The Amazon Resource Name (ARN) of the audience generation job.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#collaboration_idString

The identifier of the collaboration that this audience generation job is associated with.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#configured_audience_model_arnString

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

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#create_timeTime

The time at which the audience generation job was created.

Returns:

  • (Time)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the audience generation job.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#include_seed_in_outputBoolean

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.

Returns:

  • (Boolean)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#metricsTypes::AudienceQualityMetrics

The relevance scores for different audience sizes and the recall score of the generated audience.



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the audience generation job.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#protected_query_identifierString

The unique identifier of the protected query for this audience generation job.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#seed_audienceTypes::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.



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#started_byString

The AWS account that started this audience generation job.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the audience generation job.

Returns:

  • (String)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#status_detailsTypes::StatusDetails

Details about the status of the audience generation job.



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags that are associated to this audience generation job.

Returns:

  • (Hash<String,String>)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#update_timeTime

The most recent time at which the audience generation job was updated.

Returns:

  • (Time)


1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'lib/aws-sdk-cleanroomsml/types.rb', line 1944

class GetAudienceGenerationJobResponse < Struct.new(
  :create_time,
  :update_time,
  :audience_generation_job_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_audience_model_arn,
  :seed_audience,
  :include_seed_in_output,
  :collaboration_id,
  :metrics,
  :started_by,
  :tags,
  :protected_query_identifier)
  SENSITIVE = []
  include Aws::Structure
end