Skip to content
AWS for Query.Farm

aws.textract.get_adapter_version

Example SQL Queries

SELECT * FROM
aws.textract.get_adapter_version
WHERE
"adapter_id" = 'VALUE'
AND "adapter_version" = 'VALUE';

Description

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

Table Definition

Column NameColumn Data Type
adapter_id Required Input Column

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

VARCHAR
adapter_version Required Input Column

A string containing the adapter version that has been retrieved.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
creation_time

The time that the adapter version was created.

TIMESTAMP_S
dataset_config

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

STRUCT(
    "manifest_s3_object" STRUCT(
        "bucket" VARCHAR,
        "name" VARCHAR,
        "version" VARCHAR
    )
)
Show child fields
dataset_config.manifest_s3_object

The S3 bucket name and file name that identifies the document.

The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

Show child fields
dataset_config.manifest_s3_object.bucket

The name of the S3 bucket. Note that the # character is not valid in the file name.

dataset_config.manifest_s3_object.name

The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.

dataset_config.manifest_s3_object.version

If the bucket has versioning enabled, you can specify the object version.

evaluation_metrics

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

STRUCT(
    "baseline" STRUCT(
        "f1_score" DOUBLE,
        "precision" DOUBLE,
        "recall" DOUBLE
    ),
    "adapter_version" STRUCT(
        "f1_score" DOUBLE,
        "precision" DOUBLE,
        "recall" DOUBLE
    ),
    "feature_type" VARCHAR
)[]
Show child fields
evaluation_metrics[]
Show child fields
evaluation_metrics[].adapter_version

The F1 score, precision, and recall metrics for the baseline model.

Show child fields
evaluation_metrics[].adapter_version.f1_score

The F1 score for an adapter version.

evaluation_metrics[].adapter_version.precision

The Precision score for an adapter version.

evaluation_metrics[].adapter_version.recall

The Recall score for an adapter version.

evaluation_metrics[].baseline

The F1 score, precision, and recall metrics for the baseline model.

Show child fields
evaluation_metrics[].baseline.f1_score

The F1 score for an adapter version.

evaluation_metrics[].baseline.precision

The Precision score for an adapter version.

evaluation_metrics[].baseline.recall

The Recall score for an adapter version.

evaluation_metrics[].feature_type

Indicates the feature type being analyzed by a given adapter version.

feature_types

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

VARCHAR[]
Show child fields
feature_types[]
kms_key_id

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

VARCHAR
output_config

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.

STRUCT(
    "s3_bucket" VARCHAR,
    "s3_prefix" VARCHAR
)
Show child fields
output_config.s3_bucket

The name of the bucket your output will go to.

output_config.s3_prefix

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

status

The status of the adapter version that has been requested.

VARCHAR
status_message

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

VARCHAR
tags

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

MAP(VARCHAR, VARCHAR)