Package software.amazon.awssdk.services.cleanroomsml.model

Interface CreateConfiguredAudienceModelRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CleanRoomsMlRequest.Builder, CopyableBuilder<CreateConfiguredAudienceModelRequest.Builder,CreateConfiguredAudienceModelRequest>, SdkBuilder<CreateConfiguredAudienceModelRequest.Builder,CreateConfiguredAudienceModelRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateConfiguredAudienceModelRequest
public static interface CreateConfiguredAudienceModelRequest.Builder extends CleanRoomsMlRequest.Builder, SdkPojo, CopyableBuilder<CreateConfiguredAudienceModelRequest.Builder,CreateConfiguredAudienceModelRequest>

  • Method Details

    • audienceModelArn

      CreateConfiguredAudienceModelRequest.Builder audienceModelArn(String audienceModelArn)

      The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

      Parameters:
      audienceModelArn - The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • audienceSizeConfig

      CreateConfiguredAudienceModelRequest.Builder audienceSizeConfig(AudienceSizeConfig audienceSizeConfig)

      Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

      Parameters:
      audienceSizeConfig - Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • audienceSizeConfig

      default CreateConfiguredAudienceModelRequest.Builder audienceSizeConfig(Consumer<AudienceSizeConfig.Builder> audienceSizeConfig)

      Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

      This is a convenience method that creates an instance of the AudienceSizeConfig.Builder avoiding the need to create one manually via AudienceSizeConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to audienceSizeConfig(AudienceSizeConfig).

      Parameters:
      audienceSizeConfig - a consumer that will call methods on AudienceSizeConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • childResourceTagOnCreatePolicy

      CreateConfiguredAudienceModelRequest.Builder childResourceTagOnCreatePolicy(String childResourceTagOnCreatePolicy)

      Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

      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.

      Parameters:
      childResourceTagOnCreatePolicy - Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • childResourceTagOnCreatePolicy

      CreateConfiguredAudienceModelRequest.Builder childResourceTagOnCreatePolicy(TagOnCreatePolicy childResourceTagOnCreatePolicy)

      Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

      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.

      Parameters:
      childResourceTagOnCreatePolicy - Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateConfiguredAudienceModelRequest.Builder description(String description)

      The description of the configured audience model.

      Parameters:
      description - The description of the configured audience model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minMatchingSeedSize

      CreateConfiguredAudienceModelRequest.Builder minMatchingSeedSize(Integer minMatchingSeedSize)

      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.

      Parameters:
      minMatchingSeedSize - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateConfiguredAudienceModelRequest.Builder name(String name)

      The name of the configured audience model.

      Parameters:
      name - The name of the configured audience model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputConfig

      CreateConfiguredAudienceModelRequest.Builder outputConfig(ConfiguredAudienceModelOutputConfig outputConfig)

      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 s3:PutObject 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.

      Parameters:
      outputConfig - 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 s3:PutObject 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputConfig

      default CreateConfiguredAudienceModelRequest.Builder outputConfig(Consumer<ConfiguredAudienceModelOutputConfig.Builder> outputConfig)

      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 s3:PutObject 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.

      This is a convenience method that creates an instance of the ConfiguredAudienceModelOutputConfig.Builder avoiding the need to create one manually via ConfiguredAudienceModelOutputConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputConfig(ConfiguredAudienceModelOutputConfig).

      Parameters:
      outputConfig - a consumer that will call methods on ConfiguredAudienceModelOutputConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sharedAudienceMetricsWithStrings

      CreateConfiguredAudienceModelRequest.Builder sharedAudienceMetricsWithStrings(Collection<String> sharedAudienceMetrics)

      Whether audience metrics are shared.

      Parameters:
      sharedAudienceMetrics - Whether audience metrics are shared.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sharedAudienceMetricsWithStrings

      CreateConfiguredAudienceModelRequest.Builder sharedAudienceMetricsWithStrings(String... sharedAudienceMetrics)

      Whether audience metrics are shared.

      Parameters:
      sharedAudienceMetrics - Whether audience metrics are shared.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sharedAudienceMetrics

      CreateConfiguredAudienceModelRequest.Builder sharedAudienceMetrics(Collection<SharedAudienceMetrics> sharedAudienceMetrics)

      Whether audience metrics are shared.

      Parameters:
      sharedAudienceMetrics - Whether audience metrics are shared.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sharedAudienceMetrics

      CreateConfiguredAudienceModelRequest.Builder sharedAudienceMetrics(SharedAudienceMetrics... sharedAudienceMetrics)

      Whether audience metrics are shared.

      Parameters:
      sharedAudienceMetrics - Whether audience metrics are shared.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateConfiguredAudienceModelRequest.Builder tags(Map<String,String> tags)

      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.

      Parameters:
      tags - 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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateConfiguredAudienceModelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateConfiguredAudienceModelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.