software.amazon.awssdk.services.rekognition.model

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(value="software.amazon.awssdk:codegen")
public final class CreateProjectVersionRequest
extends RekognitionRequest
implements ToCopyableBuilder<CreateProjectVersionRequest.Builder,CreateProjectVersionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateProjectVersionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateProjectVersionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
CustomizationFeatureConfig	featureConfig() Feature-specific configuration of the training job.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyId() The identifier for your AWS Key Management Service key (AWS KMS key).
OutputConfig	outputConfig() The Amazon S3 bucket location to store the results of training.
String	projectArn() The ARN of the Amazon Rekognition project that will manage the project version you want to train.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateProjectVersionRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() A set of tags (key-value pairs) that you want to attach to the project version.
TestingData	testingData() Specifies an external manifest that the service uses to test the project version.
CreateProjectVersionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TrainingData	trainingData() Specifies an external manifest that the services uses to train the project version.
String	versionDescription() A description applied to the project version being created.
String	versionName() A name for the version of the project version.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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.

toBuilder

public CreateProjectVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateProjectVersionRequest.Builder,CreateProjectVersionRequest>

Specified by:

toBuilder in class RekognitionRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo