Struct aws_sdk_cleanroomsml::operation::get_audience_generation_job::GetAudienceGenerationJobOutput

#[non_exhaustive]
pub struct GetAudienceGenerationJobOutput {

    pub create_time: DateTime,
    pub update_time: DateTime,
    pub audience_generation_job_arn: String,
    pub name: String,
    pub description: Option<String>,
    pub status: AudienceGenerationJobStatus,
    pub status_details: Option<StatusDetails>,
    pub configured_audience_model_arn: String,
    pub seed_audience: Option<AudienceGenerationJobDataSource>,
    pub include_seed_in_output: Option<bool>,
    pub collaboration_id: Option<String>,
    pub metrics: Option<AudienceQualityMetrics>,
    pub started_by: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

create_time: DateTime

The time at which the audience generation job was created.

update_time: DateTime

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

audience_generation_job_arn: String

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

name: String

The name of the audience generation job.

description: Option<String>

The description of the audience generation job.

status: AudienceGenerationJobStatus

The status of the audience generation job.

status_details: Option<StatusDetails>

Details about the status of the audience generation job.

configured_audience_model_arn: String

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

seed_audience: Option<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.

include_seed_in_output: Option<bool>

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.

collaboration_id: Option<String>

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

metrics: Option<AudienceQualityMetrics>

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

started_by: Option<String>

The AWS account that started this audience generation job.

tags: Option<HashMap<String, String>>

The tags that are associated to this audience generation job.

Implementations

impl GetAudienceGenerationJobOutput

pub fn create_time(&self) -> &DateTime

The time at which the audience generation job was created.

pub fn update_time(&self) -> &DateTime

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

pub fn audience_generation_job_arn(&self) -> &str

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

pub fn name(&self) -> &str

The name of the audience generation job.

pub fn description(&self) -> Option<&str>

The description of the audience generation job.

pub fn status(&self) -> &AudienceGenerationJobStatus

The status of the audience generation job.

pub fn status_details(&self) -> Option<&StatusDetails>

Details about the status of the audience generation job.

pub fn configured_audience_model_arn(&self) -> &str

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

pub fn seed_audience(&self) -> Option<&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.

pub fn include_seed_in_output(&self) -> Option<bool>

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.

pub fn collaboration_id(&self) -> Option<&str>

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

pub fn metrics(&self) -> Option<&AudienceQualityMetrics>

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

pub fn started_by(&self) -> Option<&str>

The AWS account that started this audience generation job.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tags that are associated to this audience generation job.

impl GetAudienceGenerationJobOutput

pub fn builder() -> GetAudienceGenerationJobOutputBuilder

Creates a new builder-style object to manufacture GetAudienceGenerationJobOutput.

Trait Implementations

impl Clone for GetAudienceGenerationJobOutput

fn clone(&self) -> GetAudienceGenerationJobOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetAudienceGenerationJobOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetAudienceGenerationJobOutput

fn eq(&self, other: &GetAudienceGenerationJobOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetAudienceGenerationJobOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetAudienceGenerationJobOutput