aws_sdk_cleanroomsml/client/

create_configured_audience_model.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateConfiguredAudienceModel`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_name):<br>required: **true**<br><p>The name of the configured audience model.</p><br>
    ///   - [`audience_model_arn(impl Into<String>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::audience_model_arn) / [`set_audience_model_arn(Option<String>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_audience_model_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.</p><br>
    ///   - [`output_config(ConfiguredAudienceModelOutputConfig)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::output_config) / [`set_output_config(Option<ConfiguredAudienceModelOutputConfig>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_output_config):<br>required: **true**<br><p>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 <code>s3:PutObject</code> 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.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_description):<br>required: **false**<br><p>The description of the configured audience model.</p><br>
    ///   - [`shared_audience_metrics(SharedAudienceMetrics)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::shared_audience_metrics) / [`set_shared_audience_metrics(Option<Vec::<SharedAudienceMetrics>>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_shared_audience_metrics):<br>required: **true**<br><p>Whether audience metrics are shared.</p><br>
    ///   - [`min_matching_seed_size(i32)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::min_matching_seed_size) / [`set_min_matching_seed_size(Option<i32>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_min_matching_seed_size):<br>required: **false**<br><p>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.</p><br>
    ///   - [`audience_size_config(AudienceSizeConfig)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::audience_size_config) / [`set_audience_size_config(Option<AudienceSizeConfig>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_audience_size_config):<br>required: **false**<br><p>Configure the list of output sizes of audiences that can be created using this configured audience model. A request to <code>StartAudienceGenerationJob</code> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code> <code>AudienceSize</code> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code> <code>AudienceSize</code> to configure sizes in the range 1-100 percent.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_tags):<br>required: **false**<br><p>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.</p> <p>The following basic restrictions apply to tags:</p> <ul>  <li>   <p>Maximum number of tags per resource - 50.</p></li>  <li>   <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p></li>  <li>   <p>Maximum key length - 128 Unicode characters in UTF-8.</p></li>  <li>   <p>Maximum value length - 256 Unicode characters in UTF-8.</p></li>  <li>   <p>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: + - = . _ : / @.</p></li>  <li>   <p>Tag keys and values are case sensitive.</p></li>  <li>   <p>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.</p></li> </ul><br>
    ///   - [`child_resource_tag_on_create_policy(TagOnCreatePolicy)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::child_resource_tag_on_create_policy) / [`set_child_resource_tag_on_create_policy(Option<TagOnCreatePolicy>)`](crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::set_child_resource_tag_on_create_policy):<br>required: **false**<br><p>Configure how the service tags audience generation jobs created using this configured audience model. If you specify <code>NONE</code>, the tags from the <code>StartAudienceGenerationJob</code> request determine the tags of the audience generation job. If you specify <code>FROM_PARENT_RESOURCE</code>, the audience generation job inherits the tags from the configured audience model, by default. Tags in the <code>StartAudienceGenerationJob</code> will override the default.</p> <p>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.</p><br>
    /// - On success, responds with [`CreateConfiguredAudienceModelOutput`](crate::operation::create_configured_audience_model::CreateConfiguredAudienceModelOutput) with field(s):
    ///   - [`configured_audience_model_arn(String)`](crate::operation::create_configured_audience_model::CreateConfiguredAudienceModelOutput::configured_audience_model_arn): <p>The Amazon Resource Name (ARN) of the configured audience model.</p>
    /// - On failure, responds with [`SdkError<CreateConfiguredAudienceModelError>`](crate::operation::create_configured_audience_model::CreateConfiguredAudienceModelError)
    pub fn create_configured_audience_model(
        &self,
    ) -> crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder {
        crate::operation::create_configured_audience_model::builders::CreateConfiguredAudienceModelFluentBuilder::new(self.handle.clone())
    }
}