Class CreateProjectVersionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rekognition.model.RekognitionRequest
software.amazon.awssdk.services.rekognition.model.CreateProjectVersionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateProjectVersionRequest.Builder,CreateProjectVersionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateProjectVersionRequest extends RekognitionRequest implements ToCopyableBuilder<CreateProjectVersionRequest.Builder,CreateProjectVersionRequest>

  • Method Details

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

    • toBuilder

      public CreateProjectVersionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateProjectVersionRequest.Builder,CreateProjectVersionRequest>
      Specified by:
      toBuilder in class RekognitionRequest
      Returns:
      a builder for type T

    • builder

      public static CreateProjectVersionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateProjectVersionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.