Package software.amazon.awssdk.services.rekognition.model

Interface CreateProjectVersionRequest.Builder

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

  • Method Details

    • projectArn

      CreateProjectVersionRequest.Builder projectArn(String projectArn)

      The ARN of the Amazon Rekognition project that will manage the project version you want to train.

      Parameters:
      projectArn - The ARN of the Amazon Rekognition project that will manage the project version you want to train.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionName

      CreateProjectVersionRequest.Builder versionName(String versionName)

      A name for the version of the project version. This value must be unique.

      Parameters:
      versionName - A name for the version of the project version. This value must be unique.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputConfig

      CreateProjectVersionRequest.Builder outputConfig(OutputConfig outputConfig)

      The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the bucket.

      Parameters:
      outputConfig - The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputConfig

      default CreateProjectVersionRequest.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)

      The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the bucket.

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

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

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

    • trainingData

      CreateProjectVersionRequest.Builder trainingData(TrainingData trainingData)

      Specifies an external manifest that the services uses to train the project version. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

      Parameters:
      trainingData - Specifies an external manifest that the services uses to train the project version. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingData

      default CreateProjectVersionRequest.Builder trainingData(Consumer<TrainingData.Builder> trainingData)

      Specifies an external manifest that the services uses to train the project version. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

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

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

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

    • testingData

      CreateProjectVersionRequest.Builder testingData(TestingData testingData)

      Specifies an external manifest that the service uses to test the project version. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

      Parameters:
      testingData - Specifies an external manifest that the service uses to test the project version. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • testingData

      default CreateProjectVersionRequest.Builder testingData(Consumer<TestingData.Builder> testingData)

      Specifies an external manifest that the service uses to test the project version. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

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

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

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

    • tags

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

      A set of tags (key-value pairs) that you want to attach to the project version.

      Parameters:
      tags - A set of tags (key-value pairs) that you want to attach to the project version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateProjectVersionRequest.Builder kmsKeyId(String kmsKeyId)

      The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

      If you choose to use your own KMS key, you need the following permissions on the KMS key.

      • kms:CreateGrant

      • kms:DescribeKey

      • kms:GenerateDataKey

      • kms:Decrypt

      If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

      Parameters:
      kmsKeyId - The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig ).

      If you choose to use your own KMS key, you need the following permissions on the KMS key.

      • kms:CreateGrant

      • kms:DescribeKey

      • kms:GenerateDataKey

      • kms:Decrypt

      If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

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

    • versionDescription

      CreateProjectVersionRequest.Builder versionDescription(String versionDescription)

      A description applied to the project version being created.

      Parameters:
      versionDescription - A description applied to the project version being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureConfig

      CreateProjectVersionRequest.Builder featureConfig(CustomizationFeatureConfig featureConfig)

      Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.

      Parameters:
      featureConfig - Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • featureConfig

      default CreateProjectVersionRequest.Builder featureConfig(Consumer<CustomizationFeatureConfig.Builder> featureConfig)

      Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.

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

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

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

    • overrideConfiguration

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

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