Struct GetAdapterVersionOutput

#[non_exhaustive]
pub struct GetAdapterVersionOutput {
    pub adapter_id: Option<String>,
    pub adapter_version: Option<String>,
    pub creation_time: Option<DateTime>,
    pub feature_types: Option<Vec<FeatureType>>,
    pub status: Option<AdapterVersionStatus>,
    pub status_message: Option<String>,
    pub dataset_config: Option<AdapterVersionDatasetConfig>,
    pub kms_key_id: Option<String>,
    pub output_config: Option<OutputConfig>,
    pub evaluation_metrics: Option<Vec<AdapterVersionEvaluationMetric>>,
    pub tags: Option<HashMap<String, String>>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

adapter_id: Option<String>

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

adapter_version: Option<String>

A string containing the adapter version that has been retrieved.

creation_time: Option<DateTime>

The time that the adapter version was created.

feature_types: Option<Vec<FeatureType>>

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

status: Option<AdapterVersionStatus>

The status of the adapter version that has been requested.

status_message: Option<String>

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

dataset_config: Option<AdapterVersionDatasetConfig>

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

kms_key_id: Option<String>

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

output_config: Option<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.

evaluation_metrics: Option<Vec<AdapterVersionEvaluationMetric>>

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

tags: Option<HashMap<String, String>>

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

Implementations

impl GetAdapterVersionOutput

pub fn adapter_id(&self) -> Option<&str>

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

pub fn adapter_version(&self) -> Option<&str>

A string containing the adapter version that has been retrieved.

pub fn creation_time(&self) -> Option<&DateTime>

The time that the adapter version was created.

pub fn feature_types(&self) -> &[FeatureType]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .feature_types.is_none().

pub fn status(&self) -> Option<&AdapterVersionStatus>

The status of the adapter version that has been requested.

pub fn status_message(&self) -> Option<&str>

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

pub fn dataset_config(&self) -> Option<&AdapterVersionDatasetConfig>

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

pub fn kms_key_id(&self) -> Option<&str>

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

pub fn output_config(&self) -> Option<&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.

pub fn evaluation_metrics(&self) -> &[AdapterVersionEvaluationMetric]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .evaluation_metrics.is_none().

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

impl GetAdapterVersionOutput

pub fn builder() -> GetAdapterVersionOutputBuilder

Creates a new builder-style object to manufacture GetAdapterVersionOutput.

Trait Implementations

impl Clone for GetAdapterVersionOutput

fn clone(&self) -> GetAdapterVersionOutput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetAdapterVersionOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetAdapterVersionOutput

fn eq(&self, other: &GetAdapterVersionOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetAdapterVersionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetAdapterVersionOutput