Class CreateProjectVersionRequest

    • Method Detail

      • projectArn

        public final String projectArn()

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

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

        public final String versionName()

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

        Returns:
        A name for the version of the project version. This value must be unique.
      • outputConfig

        public final 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.

        Returns:
        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.
      • trainingData

        public final 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.

        Returns:
        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.
      • testingData

        public final 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.

        Returns:
        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.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final Map<String,​String> tags()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

        public final 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.

        Returns:
        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.

      • versionDescription

        public final String versionDescription()

        A description applied to the project version being created.

        Returns:
        A description applied to the project version being created.
      • featureConfig

        public final 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.

        Returns:
        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.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object