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

Interface CreateAudienceModelRequest.Builder

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

  • Method Details

    • description

      CreateAudienceModelRequest.Builder description(String description)

      The description of the audience model.

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

    • kmsKeyArn

      CreateAudienceModelRequest.Builder kmsKeyArn(String kmsKeyArn)

      The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.

      Parameters:
      kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateAudienceModelRequest.Builder name(String name)

      The name of the audience model resource.

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

    • tags

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

    • trainingDataEndTime

      CreateAudienceModelRequest.Builder trainingDataEndTime(Instant trainingDataEndTime)

      The end date and time of the training window.

      Parameters:
      trainingDataEndTime - The end date and time of the training window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingDataStartTime

      CreateAudienceModelRequest.Builder trainingDataStartTime(Instant trainingDataStartTime)

      The start date and time of the training window.

      Parameters:
      trainingDataStartTime - The start date and time of the training window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingDatasetArn

      CreateAudienceModelRequest.Builder trainingDatasetArn(String trainingDatasetArn)

      The Amazon Resource Name (ARN) of the training dataset for this audience model.

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

    • overrideConfiguration

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

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