aws_sdk_textract/client/

get_adapter_version.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetAdapterVersion`](crate::operation::get_adapter_version::builders::GetAdapterVersionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`adapter_id(impl Into<String>)`](crate::operation::get_adapter_version::builders::GetAdapterVersionFluentBuilder::adapter_id) / [`set_adapter_id(Option<String>)`](crate::operation::get_adapter_version::builders::GetAdapterVersionFluentBuilder::set_adapter_id):<br>required: **true**<br><p>A string specifying a unique ID for the adapter version you want to retrieve information for.</p><br>
    ///   - [`adapter_version(impl Into<String>)`](crate::operation::get_adapter_version::builders::GetAdapterVersionFluentBuilder::adapter_version) / [`set_adapter_version(Option<String>)`](crate::operation::get_adapter_version::builders::GetAdapterVersionFluentBuilder::set_adapter_version):<br>required: **true**<br><p>A string specifying the adapter version you want to retrieve information for.</p><br>
    /// - On success, responds with [`GetAdapterVersionOutput`](crate::operation::get_adapter_version::GetAdapterVersionOutput) with field(s):
    ///   - [`adapter_id(Option<String>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::adapter_id): <p>A string containing a unique ID for the adapter version being retrieved.</p>
    ///   - [`adapter_version(Option<String>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::adapter_version): <p>A string containing the adapter version that has been retrieved.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::creation_time): <p>The time that the adapter version was created.</p>
    ///   - [`feature_types(Option<Vec::<FeatureType>>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::feature_types): <p>List of the targeted feature types for the requested adapter version.</p>
    ///   - [`status(Option<AdapterVersionStatus>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::status): <p>The status of the adapter version that has been requested.</p>
    ///   - [`status_message(Option<String>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::status_message): <p>A message that describes the status of the requested adapter version.</p>
    ///   - [`dataset_config(Option<AdapterVersionDatasetConfig>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::dataset_config): <p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.</p>
    ///   - [`kms_key_id(Option<String>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::kms_key_id): <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>
    ///   - [`output_config(Option<OutputConfig>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::output_config): <p>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.</p> <p><code>OutputConfig</code> 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 <code>OutputConfig</code> 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 <code>KMSKeyID</code> 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.</p> <p>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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html"> Managing AI services opt-out policy. </a></p> <p>For more information on data privacy, see the <a href="https://aws.amazon.com/compliance/data-privacy-faq/">Data Privacy FAQ</a>.</p>
    ///   - [`evaluation_metrics(Option<Vec::<AdapterVersionEvaluationMetric>>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::evaluation_metrics): <p>The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_adapter_version::GetAdapterVersionOutput::tags): <p>A set of tags (key-value pairs) that are associated with the adapter version.</p>
    /// - On failure, responds with [`SdkError<GetAdapterVersionError>`](crate::operation::get_adapter_version::GetAdapterVersionError)
    pub fn get_adapter_version(&self) -> crate::operation::get_adapter_version::builders::GetAdapterVersionFluentBuilder {
        crate::operation::get_adapter_version::builders::GetAdapterVersionFluentBuilder::new(self.handle.clone())
    }
}