Interface GetAdapterVersionCommandOutput

The output of GetAdapterVersionCommand.

interface GetAdapterVersionCommandOutput {
    $metadata: ResponseMetadata;
    AdapterId?: string;
    AdapterVersion?: string;
    CreationTime?: Date;
    DatasetConfig?: AdapterVersionDatasetConfig;
    EvaluationMetrics?: AdapterVersionEvaluationMetric[];
    FeatureTypes?: FeatureType[];
    KMSKeyId?: string;
    OutputConfig?: OutputConfig;
    Status?: AdapterVersionStatus;
    StatusMessage?: string;
    Tags?: Record<string, string>;
}

Hierarchy (view full)

Properties

$metadata AdapterId? AdapterVersion? CreationTime? DatasetConfig? EvaluationMetrics? FeatureTypes? KMSKeyId? OutputConfig? Status? StatusMessage? Tags?

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional AdapterId

AdapterId?: string

A string containing a unique ID for the adapter version being retrieved.

Optional AdapterVersion

AdapterVersion?: string

A string containing the adapter version that has been retrieved.

Optional CreationTime

CreationTime?: Date

The time that the adapter version was created.

Optional DatasetConfig

DatasetConfig?: AdapterVersionDatasetConfig

Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.

Optional EvaluationMetrics

EvaluationMetrics?: AdapterVersionEvaluationMetric[]

The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.

Optional FeatureTypes

FeatureTypes?: FeatureType[]

List of the targeted feature types for the requested adapter version.

Optional KMSKeyId

KMSKeyId?: string

The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

Optional OutputConfig

OutputConfig?: OutputConfig

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.

Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.

For more information on data privacy, see the Data Privacy FAQ.

Optional Status

Status?: AdapterVersionStatus

The status of the adapter version that has been requested.

Optional StatusMessage

StatusMessage?: string

A message that describes the status of the requested adapter version.

Optional Tags

Tags?: Record<string, string>

A set of tags (key-value pairs) that are associated with the adapter version.

Settings

Member Visibility

Theme

On This Page