Class DocumentClassifierOutputDataConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocumentClassifierOutputDataConfig.Builder,
DocumentClassifierOutputDataConfig>
Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native document model.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon S3 prefix for the data lake location of the flywheel statistics.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
kmsKeyId()
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.final String
s3Uri()
When you use theOutputDataConfig
object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files.static Class
<? extends DocumentClassifierOutputDataConfig.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
s3Uri
When you use the
OutputDataConfig
object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The
S3Uri
field contains the location of the output file, calledoutput.tar.gz
. It is a compressed archive that contains the confusion matrix.- Returns:
- When you use the
OutputDataConfig
object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The
S3Uri
field contains the location of the output file, calledoutput.tar.gz
. It is a compressed archive that contains the confusion matrix.
-
kmsKeyId
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
-
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
KMS Key Alias:
"alias/ExampleAlias"
-
ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
- Returns:
- ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
the output results from an analysis job. The KmsKeyId can be one of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
-
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
KMS Key Alias:
"alias/ExampleAlias"
-
ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
-
-
-
flywheelStatsS3Prefix
The Amazon S3 prefix for the data lake location of the flywheel statistics.
- Returns:
- The Amazon S3 prefix for the data lake location of the flywheel statistics.
-
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 interfaceToCopyableBuilder<DocumentClassifierOutputDataConfig.Builder,
DocumentClassifierOutputDataConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DocumentClassifierOutputDataConfig.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-