Struct aws_sdk_comprehend::client::fluent_builders::CreateDocumentClassifier

pub struct CreateDocumentClassifier { /* private fields */ }

Fluent builder constructing a request to CreateDocumentClassifier.

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

Implementations

impl CreateDocumentClassifier

pub async fn send(
    self
) -> Result<CreateDocumentClassifierOutput, SdkError<CreateDocumentClassifierError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn document_classifier_name(self, input: impl Into<String>) -> Self

The name of the document classifier.

pub fn set_document_classifier_name(self, input: Option<String>) -> Self

The name of the document classifier.

pub fn version_name(self, input: impl Into<String>) -> Self

The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.

pub fn set_version_name(self, input: Option<String>) -> Self

The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.

pub fn data_access_role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

pub fn set_data_access_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

pub fn input_data_config(self, input: DocumentClassifierInputDataConfig) -> Self

Specifies the format and location of the input data for the job.

pub fn set_input_data_config(
    self,
    input: Option<DocumentClassifierInputDataConfig>
) -> Self

Specifies the format and location of the input data for the job.

pub fn output_data_config(
    self,
    input: DocumentClassifierOutputDataConfig
) -> Self

Enables the addition of output results configuration parameters for custom classifier jobs.

pub fn set_output_data_config(
    self,
    input: Option<DocumentClassifierOutputDataConfig>
) -> Self

Enables the addition of output results configuration parameters for custom classifier jobs.

pub fn client_request_token(self, input: impl Into<String>) -> Self

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

pub fn set_client_request_token(self, input: Option<String>) -> Self

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

pub fn language_code(self, input: LanguageCode) -> Self

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

pub fn set_language_code(self, input: Option<LanguageCode>) -> Self

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

pub fn volume_kms_key_id(self, input: impl Into<String>) -> Self

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

pub fn set_volume_kms_key_id(self, input: Option<String>) -> Self

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

pub fn vpc_config(self, input: VpcConfig) -> Self

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

pub fn mode(self, input: DocumentClassifierMode) -> Self

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

pub fn set_mode(self, input: Option<DocumentClassifierMode>) -> Self

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

pub fn model_kms_key_id(self, input: impl Into<String>) -> Self

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either 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"

pub fn set_model_kms_key_id(self, input: Option<String>) -> Self

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either 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"

pub fn model_policy(self, input: impl Into<String>) -> Self

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

pub fn set_model_policy(self, input: Option<String>) -> Self

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Trait Implementations

impl Clone for CreateDocumentClassifier

fn clone(&self) -> CreateDocumentClassifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDocumentClassifier

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

Formats the value using the given formatter.