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)
<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 (AWS KMS) customer master key (CMK).
OutputConfig	outputConfig() The Amazon S3 bucket location to store the results of training.
String	projectArn() The ARN of the Amazon Rekognition Custom Labels project that manages the model that 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 model.
TestingData	testingData() The dataset to use for testing.
CreateProjectVersionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TrainingData	trainingData() The dataset to use for training.
String	versionName() A name for the version of the model.

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 Custom Labels project that manages the model that you want to train.

Returns:

The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

versionName

public final String versionName()

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

Returns:

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

outputConfig

public final OutputConfig outputConfig()

The Amazon S3 bucket location to store the results of training. The S3 bucket can be in any AWS account as long as the caller has s3:PutObject permissions on the S3 bucket.

Returns:

The Amazon S3 bucket location to store the results of training. The S3 bucket can be in any AWS account as long as the caller has s3:PutObject permissions on the S3 bucket.

trainingData

public final TrainingData trainingData()

The dataset to use for training.

Returns:

The dataset to use for training.

testingData

public final TestingData testingData()

The dataset to use for testing.

Returns:

The dataset to use for testing.

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

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

kmsKeyId

public final String kmsKeyId()

The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK, an alias for your CMK, or an alias ARN. The key is used to encrypt training and test images copied into the service for model training. 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 CMK, you need the following permissions on the CMK.

• 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 (AWS KMS) customer master key (CMK). You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK, an alias for your CMK, or an alias ARN. The key is used to encrypt training and test images copied into the service for model training. 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 CMK, you need the following permissions on the CMK.

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

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