Interface StartAudienceGenerationJobRequest.Builder

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

  • Method Details

    • name

      StartAudienceGenerationJobRequest.Builder name(String name)

      The name of the audience generation job.

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

    • configuredAudienceModelArn

      StartAudienceGenerationJobRequest.Builder configuredAudienceModelArn(String configuredAudienceModelArn)

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

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

    • seedAudience

      StartAudienceGenerationJobRequest.Builder seedAudience(AudienceGenerationJobDataSource seedAudience)

      The seed audience that is used to generate the audience.

      Parameters:
      seedAudience - The seed audience that is used to generate the audience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • seedAudience

      default StartAudienceGenerationJobRequest.Builder seedAudience(Consumer<AudienceGenerationJobDataSource.Builder> seedAudience)

      The seed audience that is used to generate the audience.

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

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

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

    • includeSeedInOutput

      StartAudienceGenerationJobRequest.Builder includeSeedInOutput(Boolean includeSeedInOutput)

      Whether the seed audience is included in the audience generation output.

      Parameters:
      includeSeedInOutput - Whether the seed audience is included in the audience generation output.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • collaborationId

      StartAudienceGenerationJobRequest.Builder collaborationId(String collaborationId)

      The identifier of the collaboration that contains the audience generation job.

      Parameters:
      collaborationId - The identifier of the collaboration that contains the audience generation job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StartAudienceGenerationJobRequest.Builder description(String description)

      The description of the audience generation job.

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

    • tags

      StartAudienceGenerationJobRequest.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

      StartAudienceGenerationJobRequest.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

      StartAudienceGenerationJobRequest.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.