Interface CreateTrainingDatasetRequest.Builder

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

  • Method Details

    • name

      CreateTrainingDatasetRequest.Builder name(String name)

      The name of the training dataset. This name must be unique in your account and region.

      Parameters:
      name - The name of the training dataset. This name must be unique in your account and region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateTrainingDatasetRequest.Builder roleArn(String roleArn)

      The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.

      Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.

      Parameters:
      roleArn - The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.

      Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.

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

    • trainingData

      CreateTrainingDatasetRequest.Builder trainingData(Collection<Dataset> trainingData)

      An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.

      Parameters:
      trainingData - An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingData

      CreateTrainingDatasetRequest.Builder trainingData(Dataset... trainingData)

      An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.

      Parameters:
      trainingData - An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingData

      CreateTrainingDatasetRequest.Builder trainingData(Consumer<Dataset.Builder>... trainingData)

      An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trainingData(List<Dataset>).

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

    • tags

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

    • description

      CreateTrainingDatasetRequest.Builder description(String description)

      The description of the training dataset.

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

    • overrideConfiguration

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

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