Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Comprehend

Client for invoking operations on Amazon Comprehend. Each operation on Amazon Comprehend is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_comprehend::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_comprehend::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchDetectEntities operation has a Client::batch_detect_entities, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_detect_entities()
    .language_code("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_detect_dominant_language( &self, ) -> BatchDetectDominantLanguageFluentBuilder

Constructs a fluent builder for the BatchDetectDominantLanguage operation.

• The fluent builder is configurable:
  • text_list(impl Into<String>) / set_text_list(Option<Vec::<String>>):
    required: true
    

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.

    
    
• On success, responds with BatchDetectDominantLanguageOutput with field(s):
  • result_list(Vec::<BatchDetectDominantLanguageItemResult>):

    A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

  • error_list(Vec::<BatchItemError>):

    A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

• On failure, responds with SdkError<BatchDetectDominantLanguageError>

impl Client

pub fn batch_detect_entities(&self) -> BatchDetectEntitiesFluentBuilder

Constructs a fluent builder for the BatchDetectEntities operation.

• The fluent builder is configurable:
  • text_list(impl Into<String>) / set_text_list(Option<Vec::<String>>):
    required: true
    

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    
    
• On success, responds with BatchDetectEntitiesOutput with field(s):
  • result_list(Vec::<BatchDetectEntitiesItemResult>):

    A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

  • error_list(Vec::<BatchItemError>):

    A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

• On failure, responds with SdkError<BatchDetectEntitiesError>

impl Client

pub fn batch_detect_key_phrases(&self) -> BatchDetectKeyPhrasesFluentBuilder

Constructs a fluent builder for the BatchDetectKeyPhrases operation.

• The fluent builder is configurable:
  • text_list(impl Into<String>) / set_text_list(Option<Vec::<String>>):
    required: true
    

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    
    
• On success, responds with BatchDetectKeyPhrasesOutput with field(s):
  • result_list(Vec::<BatchDetectKeyPhrasesItemResult>):

    A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

  • error_list(Vec::<BatchItemError>):

    A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

• On failure, responds with SdkError<BatchDetectKeyPhrasesError>

impl Client

pub fn batch_detect_sentiment(&self) -> BatchDetectSentimentFluentBuilder

Constructs a fluent builder for the BatchDetectSentiment operation.

• The fluent builder is configurable:
  • text_list(impl Into<String>) / set_text_list(Option<Vec::<String>>):
    required: true
    

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    
    
• On success, responds with BatchDetectSentimentOutput with field(s):
  • result_list(Vec::<BatchDetectSentimentItemResult>):

    A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

  • error_list(Vec::<BatchItemError>):

    A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

• On failure, responds with SdkError<BatchDetectSentimentError>

impl Client

pub fn batch_detect_syntax(&self) -> BatchDetectSyntaxFluentBuilder

Constructs a fluent builder for the BatchDetectSyntax operation.

• The fluent builder is configurable:
  • text_list(impl Into<String>) / set_text_list(Option<Vec::<String>>):
    required: true
    

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.

    
    
  • language_code(SyntaxLanguageCode) / set_language_code(Option<SyntaxLanguageCode>):
    required: true
    

    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.

    
    
• On success, responds with BatchDetectSyntaxOutput with field(s):
  • result_list(Vec::<BatchDetectSyntaxItemResult>):

    A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

  • error_list(Vec::<BatchItemError>):

    A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

• On failure, responds with SdkError<BatchDetectSyntaxError>

impl Client

pub fn batch_detect_targeted_sentiment( &self, ) -> BatchDetectTargetedSentimentFluentBuilder

Constructs a fluent builder for the BatchDetectTargetedSentiment operation.

• The fluent builder is configurable:
  • text_list(impl Into<String>) / set_text_list(Option<Vec::<String>>):
    required: true
    

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. Currently, English is the only supported language.

    
    
• On success, responds with BatchDetectTargetedSentimentOutput with field(s):
  • result_list(Vec::<BatchDetectTargetedSentimentItemResult>):

    A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

  • error_list(Vec::<BatchItemError>):

    List of errors that the operation can return.

• On failure, responds with SdkError<BatchDetectTargetedSentimentError>

impl Client

pub fn classify_document(&self) -> ClassifyDocumentFluentBuilder

Constructs a fluent builder for the ClassifyDocument operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: false
    

    The document text to be analyzed. If you enter text using this parameter, do not use the Bytes parameter.

    
    
  • endpoint_arn(impl Into<String>) / set_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the endpoint.

    For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide

    For custom classification, you create an endpoint for your custom model. For more information, see Using Amazon Comprehend endpoints.

    
    
  • bytes(Blob) / set_bytes(Option<Blob>):
    required: false
    

    Use the Bytes parameter to input a text, PDF, Word or image file.

    When you classify a document using a custom model, you can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

    To classify a document using the prompt safety classifier, use the Text parameter for input.

    Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you.

    The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

    If you use the Bytes parameter, do not use the Text parameter.

    
    
  • document_reader_config(DocumentReaderConfig) / set_document_reader_config(Option<DocumentReaderConfig>):
    required: false
    

    Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

    
    
• On success, responds with ClassifyDocumentOutput with field(s):
  • classes(Option<Vec::<DocumentClass>>):

    The classes used by the document being analyzed. These are used for models trained in multi-class mode. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

    For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.

  • labels(Option<Vec::<DocumentLabel>>):

    The labels used in the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

  • document_metadata(Option<DocumentMetadata>):

    Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

  • document_type(Option<Vec::<DocumentTypeListItem>>):

    The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

  • errors(Option<Vec::<ErrorsListItem>>):

    Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

  • warnings(Option<Vec::<WarningsListItem>>):

    Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

    The field is empty if the system generated no warnings.

• On failure, responds with SdkError<ClassifyDocumentError>

impl Client

pub fn contains_pii_entities(&self) -> ContainsPiiEntitiesFluentBuilder

Constructs a fluent builder for the ContainsPiiEntities operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    A UTF-8 text string. The maximum string size is 100 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents.

    
    
• On success, responds with ContainsPiiEntitiesOutput with field(s):
  • labels(Option<Vec::<EntityLabel>>):

    The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.

• On failure, responds with SdkError<ContainsPiiEntitiesError>

impl Client

pub fn create_dataset(&self) -> CreateDatasetFluentBuilder

Constructs a fluent builder for the CreateDataset operation.

• The fluent builder is configurable:
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.

    
    
  • dataset_name(impl Into<String>) / set_dataset_name(Option<String>):
    required: true
    

    Name of the dataset.

    
    
  • dataset_type(DatasetType) / set_dataset_type(Option<DatasetType>):
    required: false
    

    The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Description of the dataset.

    
    
  • input_data_config(DatasetInputDataConfig) / set_input_data_config(Option<DatasetInputDataConfig>):
    required: true
    

    Information about the input data configuration. The type of input data varies based on the format of the input and whether the data is for a classifier model or an entity recognition model.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags for the dataset.

    
    
• On success, responds with CreateDatasetOutput with field(s):
  • dataset_arn(Option<String>):

    The ARN of the dataset.

• On failure, responds with SdkError<CreateDatasetError>

impl Client

pub fn create_document_classifier( &self, ) -> CreateDocumentClassifierFluentBuilder

Constructs a fluent builder for the CreateDocumentClassifier operation.

• The fluent builder is configurable:
  • document_classifier_name(impl Into<String>) / set_document_classifier_name(Option<String>):
    required: true
    

    The name of the document classifier.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    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 Amazon Web Services account/Amazon Web Services Region.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the document classifier. 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.

    
    
  • input_data_config(DocumentClassifierInputDataConfig) / set_input_data_config(Option<DocumentClassifierInputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(DocumentClassifierOutputDataConfig) / set_output_data_config(Option<DocumentClassifierOutputDataConfig>):
    required: false
    

    Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native document model.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the Amazon Web Services 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

    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.

    
    
  • mode(DocumentClassifierMode) / set_mode(Option<DocumentClassifierMode>):
    required: false
    

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

    
    
  • model_kms_key_id(impl Into<String>) / set_model_kms_key_id(Option<String>):
    required: false
    

    ID for the 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”

    
    
  • model_policy(impl Into<String>) / set_model_policy(Option<String>):
    required: false
    

    The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services 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”]}’

    
    
• On success, responds with CreateDocumentClassifierOutput with field(s):
  • document_classifier_arn(Option<String>):

    The Amazon Resource Name (ARN) that identifies the document classifier.

• On failure, responds with SdkError<CreateDocumentClassifierError>

impl Client

pub fn create_endpoint(&self) -> CreateEndpointFluentBuilder

Constructs a fluent builder for the CreateEndpoint operation.

• The fluent builder is configurable:
  • endpoint_name(impl Into<String>) / set_endpoint_name(Option<String>):
    required: true
    

    This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

    
    
  • model_arn(impl Into<String>) / set_model_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.

    
    
  • desired_inference_units(i32) / set_desired_inference_units(Option<i32>):
    required: true
    

    The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with “Sales” as the key might be added to an endpoint to indicate its use by the sales department.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

    
    
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.

    
    
• On success, responds with CreateEndpointOutput with field(s):
  • endpoint_arn(Option<String>):

    The Amazon Resource Number (ARN) of the endpoint being created.

  • model_arn(Option<String>):

    The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

• On failure, responds with SdkError<CreateEndpointError>

impl Client

pub fn create_entity_recognizer(&self) -> CreateEntityRecognizerFluentBuilder

Constructs a fluent builder for the CreateEntityRecognizer operation.

• The fluent builder is configurable:
  • recognizer_name(impl Into<String>) / set_recognizer_name(Option<String>):
    required: true
    

    The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/Region.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

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

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the entity recognizer. 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.

    
    
  • input_data_config(EntityRecognizerInputDataConfig) / set_input_data_config(Option<EntityRecognizerInputDataConfig>):
    required: true
    

    Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same Region as the entity recognizer being created.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    You can specify any of the following languages: English (“en”), Spanish (“es”), French (“fr”), Italian (“it”), German (“de”), or Portuguese (“pt”). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the Amazon Web Services 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

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

    
    
  • model_kms_key_id(impl Into<String>) / set_model_kms_key_id(Option<String>):
    required: false
    

    ID for the 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”

    
    
  • model_policy(impl Into<String>) / set_model_policy(Option<String>):
    required: false
    

    The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.

    Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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”]}’

    
    
• On success, responds with CreateEntityRecognizerOutput with field(s):
  • entity_recognizer_arn(Option<String>):

    The Amazon Resource Name (ARN) that identifies the entity recognizer.

• On failure, responds with SdkError<CreateEntityRecognizerError>

impl Client

pub fn create_flywheel(&self) -> CreateFlywheelFluentBuilder

Constructs a fluent builder for the CreateFlywheel operation.

• The fluent builder is configurable:
  • flywheel_name(impl Into<String>) / set_flywheel_name(Option<String>):
    required: true
    

    Name for the flywheel.

    
    
  • active_model_arn(impl Into<String>) / set_active_model_arn(Option<String>):
    required: false
    

    To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

    
    
  • task_config(TaskConfig) / set_task_config(Option<TaskConfig>):
    required: false
    

    Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.

    
    
  • model_type(ModelType) / set_model_type(Option<ModelType>):
    required: false
    

    The model type. You need to set ModelType if you are creating a flywheel for a new model.

    
    
  • data_lake_s3_uri(impl Into<String>) / set_data_lake_s3_uri(Option<String>):
    required: true
    

    Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.

    
    
  • data_security_config(DataSecurityConfig) / set_data_security_config(Option<DataSecurityConfig>):
    required: false
    

    Data security configurations.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to associate with this flywheel.

    
    
• On success, responds with CreateFlywheelOutput with field(s):
  • flywheel_arn(Option<String>):

    The Amazon Resource Number (ARN) of the flywheel.

  • active_model_arn(Option<String>):

    The Amazon Resource Number (ARN) of the active model version.

• On failure, responds with SdkError<CreateFlywheelError>

impl Client

pub fn delete_document_classifier( &self, ) -> DeleteDocumentClassifierFluentBuilder

Constructs a fluent builder for the DeleteDocumentClassifier operation.

• The fluent builder is configurable:
  • document_classifier_arn(impl Into<String>) / set_document_classifier_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the document classifier.

    
    
• On success, responds with DeleteDocumentClassifierOutput
• On failure, responds with SdkError<DeleteDocumentClassifierError>

impl Client

pub fn delete_endpoint(&self) -> DeleteEndpointFluentBuilder

Constructs a fluent builder for the DeleteEndpoint operation.

• The fluent builder is configurable:
  • endpoint_arn(impl Into<String>) / set_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the endpoint being deleted.

    
    
• On success, responds with DeleteEndpointOutput
• On failure, responds with SdkError<DeleteEndpointError>

impl Client

pub fn delete_entity_recognizer(&self) -> DeleteEntityRecognizerFluentBuilder

Constructs a fluent builder for the DeleteEntityRecognizer operation.

• The fluent builder is configurable:
  • entity_recognizer_arn(impl Into<String>) / set_entity_recognizer_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the entity recognizer.

    
    
• On success, responds with DeleteEntityRecognizerOutput
• On failure, responds with SdkError<DeleteEntityRecognizerError>

impl Client

pub fn delete_flywheel(&self) -> DeleteFlywheelFluentBuilder

Constructs a fluent builder for the DeleteFlywheel operation.

• The fluent builder is configurable:
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the flywheel to delete.

    
    
• On success, responds with DeleteFlywheelOutput
• On failure, responds with SdkError<DeleteFlywheelError>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.

    
    
  • policy_revision_id(impl Into<String>) / set_policy_revision_id(Option<String>):
    required: false
    

    The revision ID of the policy to delete.

    
    
• On success, responds with DeleteResourcePolicyOutput
• On failure, responds with SdkError<DeleteResourcePolicyError>

impl Client

pub fn describe_dataset(&self) -> DescribeDatasetFluentBuilder

Constructs a fluent builder for the DescribeDataset operation.

• The fluent builder is configurable:
  • dataset_arn(impl Into<String>) / set_dataset_arn(Option<String>):
    required: true
    

    The ARN of the dataset.

    
    
• On success, responds with DescribeDatasetOutput with field(s):
  • dataset_properties(Option<DatasetProperties>):

    The dataset properties.

• On failure, responds with SdkError<DescribeDatasetError>

impl Client

pub fn describe_document_classification_job( &self, ) -> DescribeDocumentClassificationJobFluentBuilder

Constructs a fluent builder for the DescribeDocumentClassificationJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier that Amazon Comprehend generated for the job. The StartDocumentClassificationJob operation returns this identifier in its response.

    
    
• On success, responds with DescribeDocumentClassificationJobOutput with field(s):
  • document_classification_job_properties(Option<DocumentClassificationJobProperties>):

    An object that describes the properties associated with the document classification job.

• On failure, responds with SdkError<DescribeDocumentClassificationJobError>

impl Client

pub fn describe_document_classifier( &self, ) -> DescribeDocumentClassifierFluentBuilder

Constructs a fluent builder for the DescribeDocumentClassifier operation.

• The fluent builder is configurable:
  • document_classifier_arn(impl Into<String>) / set_document_classifier_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the document classifier. The CreateDocumentClassifier operation returns this identifier in its response.

    
    
• On success, responds with DescribeDocumentClassifierOutput with field(s):
  • document_classifier_properties(Option<DocumentClassifierProperties>):

    An object that contains the properties associated with a document classifier.

• On failure, responds with SdkError<DescribeDocumentClassifierError>

impl Client

pub fn describe_dominant_language_detection_job( &self, ) -> DescribeDominantLanguageDetectionJobFluentBuilder

Constructs a fluent builder for the DescribeDominantLanguageDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier that Amazon Comprehend generated for the job. The StartDominantLanguageDetectionJob operation returns this identifier in its response.

    
    
• On success, responds with DescribeDominantLanguageDetectionJobOutput with field(s):
  • dominant_language_detection_job_properties(Option<DominantLanguageDetectionJobProperties>):

    An object that contains the properties associated with a dominant language detection job.

• On failure, responds with SdkError<DescribeDominantLanguageDetectionJobError>

impl Client

pub fn describe_endpoint(&self) -> DescribeEndpointFluentBuilder

Constructs a fluent builder for the DescribeEndpoint operation.

• The fluent builder is configurable:
  • endpoint_arn(impl Into<String>) / set_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the endpoint being described.

    
    
• On success, responds with DescribeEndpointOutput with field(s):
  • endpoint_properties(Option<EndpointProperties>):

    Describes information associated with the specific endpoint.

• On failure, responds with SdkError<DescribeEndpointError>

impl Client

pub fn describe_entities_detection_job( &self, ) -> DescribeEntitiesDetectionJobFluentBuilder

Constructs a fluent builder for the DescribeEntitiesDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob operation returns this identifier in its response.

    
    
• On success, responds with DescribeEntitiesDetectionJobOutput with field(s):
  • entities_detection_job_properties(Option<EntitiesDetectionJobProperties>):

    An object that contains the properties associated with an entities detection job.

• On failure, responds with SdkError<DescribeEntitiesDetectionJobError>

impl Client

pub fn describe_entity_recognizer( &self, ) -> DescribeEntityRecognizerFluentBuilder

Constructs a fluent builder for the DescribeEntityRecognizer operation.

• The fluent builder is configurable:
  • entity_recognizer_arn(impl Into<String>) / set_entity_recognizer_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the entity recognizer.

    
    
• On success, responds with DescribeEntityRecognizerOutput with field(s):
  • entity_recognizer_properties(Option<EntityRecognizerProperties>):

    Describes information associated with an entity recognizer.

• On failure, responds with SdkError<DescribeEntityRecognizerError>

impl Client

pub fn describe_events_detection_job( &self, ) -> DescribeEventsDetectionJobFluentBuilder

Constructs a fluent builder for the DescribeEventsDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the events detection job.

    
    
• On success, responds with DescribeEventsDetectionJobOutput with field(s):
  • events_detection_job_properties(Option<EventsDetectionJobProperties>):

    An object that contains the properties associated with an event detection job.

• On failure, responds with SdkError<DescribeEventsDetectionJobError>

impl Client

pub fn describe_flywheel(&self) -> DescribeFlywheelFluentBuilder

Constructs a fluent builder for the DescribeFlywheel operation.

• The fluent builder is configurable:
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the flywheel.

    
    
• On success, responds with DescribeFlywheelOutput with field(s):
  • flywheel_properties(Option<FlywheelProperties>):

    The flywheel properties.

• On failure, responds with SdkError<DescribeFlywheelError>

impl Client

pub fn describe_flywheel_iteration( &self, ) -> DescribeFlywheelIterationFluentBuilder

Constructs a fluent builder for the DescribeFlywheelIteration operation.

• The fluent builder is configurable:
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: true
    
    
    
  • flywheel_iteration_id(impl Into<String>) / set_flywheel_iteration_id(Option<String>):
    required: true
    
    
    
• On success, responds with DescribeFlywheelIterationOutput with field(s):
  • flywheel_iteration_properties(Option<FlywheelIterationProperties>):

    The configuration properties of a flywheel iteration.

• On failure, responds with SdkError<DescribeFlywheelIterationError>

impl Client

pub fn describe_key_phrases_detection_job( &self, ) -> DescribeKeyPhrasesDetectionJobFluentBuilder

Constructs a fluent builder for the DescribeKeyPhrasesDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob operation returns this identifier in its response.

    
    
• On success, responds with DescribeKeyPhrasesDetectionJobOutput with field(s):
  • key_phrases_detection_job_properties(Option<KeyPhrasesDetectionJobProperties>):

    An object that contains the properties associated with a key phrases detection job.

• On failure, responds with SdkError<DescribeKeyPhrasesDetectionJobError>

impl Client

pub fn describe_pii_entities_detection_job( &self, ) -> DescribePiiEntitiesDetectionJobFluentBuilder

Constructs a fluent builder for the DescribePiiEntitiesDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

    
    
• On success, responds with DescribePiiEntitiesDetectionJobOutput with field(s):
  • pii_entities_detection_job_properties(Option<PiiEntitiesDetectionJobProperties>):

    Provides information about a PII entities detection job.

• On failure, responds with SdkError<DescribePiiEntitiesDetectionJobError>

impl Client

pub fn describe_resource_policy(&self) -> DescribeResourcePolicyFluentBuilder

Constructs a fluent builder for the DescribeResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the custom model version that has the resource policy.

    
    
• On success, responds with DescribeResourcePolicyOutput with field(s):
  • resource_policy(Option<String>):

    The JSON body of the resource-based policy.

  • creation_time(Option<DateTime>):

    The time at which the policy was created.

  • last_modified_time(Option<DateTime>):

    The time at which the policy was last modified.

  • policy_revision_id(Option<String>):

    The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.

• On failure, responds with SdkError<DescribeResourcePolicyError>

impl Client

pub fn describe_sentiment_detection_job( &self, ) -> DescribeSentimentDetectionJobFluentBuilder

Constructs a fluent builder for the DescribeSentimentDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

    
    
• On success, responds with DescribeSentimentDetectionJobOutput with field(s):
  • sentiment_detection_job_properties(Option<SentimentDetectionJobProperties>):

    An object that contains the properties associated with a sentiment detection job.

• On failure, responds with SdkError<DescribeSentimentDetectionJobError>

impl Client

pub fn describe_targeted_sentiment_detection_job( &self, ) -> DescribeTargetedSentimentDetectionJobFluentBuilder

Constructs a fluent builder for the DescribeTargetedSentimentDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier that Amazon Comprehend generated for the job. The StartTargetedSentimentDetectionJob operation returns this identifier in its response.

    
    
• On success, responds with DescribeTargetedSentimentDetectionJobOutput with field(s):
  • targeted_sentiment_detection_job_properties(Option<TargetedSentimentDetectionJobProperties>):

    An object that contains the properties associated with a targeted sentiment detection job.

• On failure, responds with SdkError<DescribeTargetedSentimentDetectionJobError>

impl Client

pub fn describe_topics_detection_job( &self, ) -> DescribeTopicsDetectionJobFluentBuilder

Constructs a fluent builder for the DescribeTopicsDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier assigned by the user to the detection job.

    
    
• On success, responds with DescribeTopicsDetectionJobOutput with field(s):
  • topics_detection_job_properties(Option<TopicsDetectionJobProperties>):

    The list of properties for the requested job.

• On failure, responds with SdkError<DescribeTopicsDetectionJobError>

impl Client

pub fn detect_dominant_language(&self) -> DetectDominantLanguageFluentBuilder

Constructs a fluent builder for the DetectDominantLanguage operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.

    
    
• On success, responds with DetectDominantLanguageOutput with field(s):
  • languages(Option<Vec::<DominantLanguage>>):

    Array of languages that Amazon Comprehend detected in the input text. The array is sorted in descending order of the score (the dominant language is always the first element in the array).

    For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

• On failure, responds with SdkError<DetectDominantLanguageError>

impl Client

pub fn detect_entities(&self) -> DetectEntitiesFluentBuilder

Constructs a fluent builder for the DetectEntities operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: false
    

    A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the Bytes parameter.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: false
    

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

    All input documents must be in the same language.

    
    
  • endpoint_arn(impl Into<String>) / set_endpoint_arn(Option<String>):
    required: false
    

    The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

    If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

    For information about endpoints, see Managing endpoints.

    
    
  • bytes(Blob) / set_bytes(Option<Blob>):
    required: false
    

    This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the Text field.

    Use the Bytes parameter to input a text, PDF, Word or image file. Using a plain-text file in the Bytes parameter is equivelent to using the Text parameter (the Entities field in the response is identical).

    You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

    Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.

    The maximum length of this field depends on the input document type. For details, see Inputs for real-time custom analysis in the Comprehend Developer Guide.

    If you use the Bytes parameter, do not use the Text parameter.

    
    
  • document_reader_config(DocumentReaderConfig) / set_document_reader_config(Option<DocumentReaderConfig>):
    required: false
    

    Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

    
    
• On success, responds with DetectEntitiesOutput with field(s):
  • entities(Option<Vec::<Entity>>):

    A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

    If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

  • document_metadata(Option<DocumentMetadata>):

    Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.

  • document_type(Option<Vec::<DocumentTypeListItem>>):

    The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.

  • blocks(Option<Vec::<Block>>):

    Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

    The Block content for a Word input document does not include a Geometry field.

    The Block field is not present in the response for plain-text inputs.

  • errors(Option<Vec::<ErrorsListItem>>):

    Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

• On failure, responds with SdkError<DetectEntitiesError>

impl Client

pub fn detect_key_phrases(&self) -> DetectKeyPhrasesFluentBuilder

Constructs a fluent builder for the DetectKeyPhrases operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    
    
• On success, responds with DetectKeyPhrasesOutput with field(s):
  • key_phrases(Option<Vec::<KeyPhrase>>):

    A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

• On failure, responds with SdkError<DetectKeyPhrasesError>

impl Client

pub fn detect_pii_entities(&self) -> DetectPiiEntitiesFluentBuilder

Constructs a fluent builder for the DetectPiiEntities operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    A UTF-8 text string. The maximum string size is 100 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input text. Enter the language code for English (en) or Spanish (es).

    
    
• On success, responds with DetectPiiEntitiesOutput with field(s):
  • entities(Option<Vec::<PiiEntity>>):

    A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

• On failure, responds with SdkError<DetectPiiEntitiesError>

impl Client

pub fn detect_sentiment(&self) -> DetectSentimentFluentBuilder

Constructs a fluent builder for the DetectSentiment operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    A UTF-8 text string. The maximum string size is 5 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    
    
• On success, responds with DetectSentimentOutput with field(s):
  • sentiment(Option<SentimentType>):

    The inferred sentiment that Amazon Comprehend has the highest level of confidence in.

  • sentiment_score(Option<SentimentScore>):

    An object that lists the sentiments, and their corresponding confidence levels.

• On failure, responds with SdkError<DetectSentimentError>

impl Client

pub fn detect_syntax(&self) -> DetectSyntaxFluentBuilder

Constructs a fluent builder for the DetectSyntax operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    A UTF-8 string. The maximum string size is 5 KB.

    
    
  • language_code(SyntaxLanguageCode) / set_language_code(Option<SyntaxLanguageCode>):
    required: true
    

    The language code 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”).

    
    
• On success, responds with DetectSyntaxOutput with field(s):
  • syntax_tokens(Option<Vec::<SyntaxToken>>):

    A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see Syntax in the Comprehend Developer Guide.

• On failure, responds with SdkError<DetectSyntaxError>

impl Client

pub fn detect_targeted_sentiment(&self) -> DetectTargetedSentimentFluentBuilder

Constructs a fluent builder for the DetectTargetedSentiment operation.

• The fluent builder is configurable:
  • text(impl Into<String>) / set_text(Option<String>):
    required: true
    

    A UTF-8 text string. The maximum string length is 5 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. Currently, English is the only supported language.

    
    
• On success, responds with DetectTargetedSentimentOutput with field(s):
  • entities(Option<Vec::<TargetedSentimentEntity>>):

    Targeted sentiment analysis for each of the entities identified in the input text.

• On failure, responds with SdkError<DetectTargetedSentimentError>

impl Client

pub fn detect_toxic_content(&self) -> DetectToxicContentFluentBuilder

Constructs a fluent builder for the DetectToxicContent operation.

• The fluent builder is configurable:
  • text_segments(TextSegment) / set_text_segments(Option<Vec::<TextSegment>>):
    required: true
    

    A list of up to 10 text strings. Each string has a maximum size of 1 KB, and the maximum size of the list is 10 KB.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input text. Currently, English is the only supported language.

    
    
• On success, responds with DetectToxicContentOutput with field(s):
  • result_list(Option<Vec::<ToxicLabels>>):

    Results of the content moderation analysis. Each entry in the results list contains a list of toxic content types identified in the text, along with a confidence score for each content type. The results list also includes a toxicity score for each entry in the results list.

• On failure, responds with SdkError<DetectToxicContentError>

impl Client

pub fn import_model(&self) -> ImportModelFluentBuilder

Constructs a fluent builder for the ImportModel operation.

• The fluent builder is configurable:
  • source_model_arn(impl Into<String>) / set_source_model_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the custom model to import.

    
    
  • model_name(impl Into<String>) / set_model_name(Option<String>):
    required: false
    

    The name to assign to the custom model that is created in Amazon Comprehend by this import.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: false
    

    The version name given to the custom model that is created by this import. 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/Region.

    
    
  • model_kms_key_id(impl Into<String>) / set_model_kms_key_id(Option<String>):
    required: false
    

    ID for the 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”

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the custom model that is created by this import. 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.

    
    
• On success, responds with ImportModelOutput with field(s):
  • model_arn(Option<String>):

    The Amazon Resource Name (ARN) of the custom model being imported.

• On failure, responds with SdkError<ImportModelError>

impl Client

pub fn list_datasets(&self) -> ListDatasetsFluentBuilder

Constructs a fluent builder for the ListDatasets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the flywheel.

    
    
  • filter(DatasetFilter) / set_filter(Option<DatasetFilter>):
    required: false
    

    Filters the datasets to be returned in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of results to return in a response. The default is 100.

    
    
• On success, responds with ListDatasetsOutput with field(s):
  • dataset_properties_list(Option<Vec::<DatasetProperties>>):

    The dataset properties list.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListDatasetsError>

impl Client

pub fn list_document_classification_jobs( &self, ) -> ListDocumentClassificationJobsFluentBuilder

Constructs a fluent builder for the ListDocumentClassificationJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(DocumentClassificationJobFilter) / set_filter(Option<DocumentClassificationJobFilter>):
    required: false
    

    Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListDocumentClassificationJobsOutput with field(s):
  • document_classification_job_properties_list(Option<Vec::<DocumentClassificationJobProperties>>):

    A list containing the properties of each job returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListDocumentClassificationJobsError>

impl Client

pub fn list_document_classifier_summaries( &self, ) -> ListDocumentClassifierSummariesFluentBuilder

Constructs a fluent builder for the ListDocumentClassifierSummaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return on each page. The default is 100.

    
    
• On success, responds with ListDocumentClassifierSummariesOutput with field(s):
  • document_classifier_summaries_list(Option<Vec::<DocumentClassifierSummary>>):

    The list of summaries of document classifiers.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListDocumentClassifierSummariesError>

impl Client

pub fn list_document_classifiers(&self) -> ListDocumentClassifiersFluentBuilder

Constructs a fluent builder for the ListDocumentClassifiers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(DocumentClassifierFilter) / set_filter(Option<DocumentClassifierFilter>):
    required: false
    

    Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListDocumentClassifiersOutput with field(s):
  • document_classifier_properties_list(Option<Vec::<DocumentClassifierProperties>>):

    A list containing the properties of each job returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListDocumentClassifiersError>

impl Client

pub fn list_dominant_language_detection_jobs( &self, ) -> ListDominantLanguageDetectionJobsFluentBuilder

Constructs a fluent builder for the ListDominantLanguageDetectionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(DominantLanguageDetectionJobFilter) / set_filter(Option<DominantLanguageDetectionJobFilter>):
    required: false
    

    Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListDominantLanguageDetectionJobsOutput with field(s):
  • dominant_language_detection_job_properties_list(Option<Vec::<DominantLanguageDetectionJobProperties>>):

    A list containing the properties of each job that is returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListDominantLanguageDetectionJobsError>

impl Client

pub fn list_endpoints(&self) -> ListEndpointsFluentBuilder

Constructs a fluent builder for the ListEndpoints operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(EndpointFilter) / set_filter(Option<EndpointFilter>):
    required: false
    

    Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListEndpointsOutput with field(s):
  • endpoint_properties_list(Option<Vec::<EndpointProperties>>):

    Displays a list of endpoint properties being retrieved by the service in response to the request.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListEndpointsError>

impl Client

pub fn list_entities_detection_jobs( &self, ) -> ListEntitiesDetectionJobsFluentBuilder

Constructs a fluent builder for the ListEntitiesDetectionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(EntitiesDetectionJobFilter) / set_filter(Option<EntitiesDetectionJobFilter>):
    required: false
    

    Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListEntitiesDetectionJobsOutput with field(s):
  • entities_detection_job_properties_list(Option<Vec::<EntitiesDetectionJobProperties>>):

    A list containing the properties of each job that is returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListEntitiesDetectionJobsError>

impl Client

pub fn list_entity_recognizer_summaries( &self, ) -> ListEntityRecognizerSummariesFluentBuilder

Constructs a fluent builder for the ListEntityRecognizerSummaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return on each page. The default is 100.

    
    
• On success, responds with ListEntityRecognizerSummariesOutput with field(s):
  • entity_recognizer_summaries_list(Option<Vec::<EntityRecognizerSummary>>):

    The list entity recognizer summaries.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListEntityRecognizerSummariesError>

impl Client

pub fn list_entity_recognizers(&self) -> ListEntityRecognizersFluentBuilder

Constructs a fluent builder for the ListEntityRecognizers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(EntityRecognizerFilter) / set_filter(Option<EntityRecognizerFilter>):
    required: false
    

    Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return on each page. The default is 100.

    
    
• On success, responds with ListEntityRecognizersOutput with field(s):
  • entity_recognizer_properties_list(Option<Vec::<EntityRecognizerProperties>>):

    The list of properties of an entity recognizer.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListEntityRecognizersError>

impl Client

pub fn list_events_detection_jobs(&self) -> ListEventsDetectionJobsFluentBuilder

Constructs a fluent builder for the ListEventsDetectionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(EventsDetectionJobFilter) / set_filter(Option<EventsDetectionJobFilter>):
    required: false
    

    Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page.

    
    
• On success, responds with ListEventsDetectionJobsOutput with field(s):
  • events_detection_job_properties_list(Option<Vec::<EventsDetectionJobProperties>>):

    A list containing the properties of each job that is returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListEventsDetectionJobsError>

impl Client

pub fn list_flywheel_iteration_history( &self, ) -> ListFlywheelIterationHistoryFluentBuilder

Constructs a fluent builder for the ListFlywheelIterationHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: true
    

    The ARN of the flywheel.

    
    
  • filter(FlywheelIterationFilter) / set_filter(Option<FlywheelIterationFilter>):
    required: false
    

    Filter the flywheel iteration history based on creation time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Next token

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of iteration history results to return

    
    
• On success, responds with ListFlywheelIterationHistoryOutput with field(s):
  • flywheel_iteration_properties_list(Option<Vec::<FlywheelIterationProperties>>):

    List of flywheel iteration properties

  • next_token(Option<String>):

    Next token

• On failure, responds with SdkError<ListFlywheelIterationHistoryError>

impl Client

pub fn list_flywheels(&self) -> ListFlywheelsFluentBuilder

Constructs a fluent builder for the ListFlywheels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(FlywheelFilter) / set_filter(Option<FlywheelFilter>):
    required: false
    

    Filters the flywheels that are returned. You can filter flywheels on their status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of results to return in a response. The default is 100.

    
    
• On success, responds with ListFlywheelsOutput with field(s):
  • flywheel_summary_list(Option<Vec::<FlywheelSummary>>):

    A list of flywheel properties retrieved by the service in response to the request.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListFlywheelsError>

impl Client

pub fn list_key_phrases_detection_jobs( &self, ) -> ListKeyPhrasesDetectionJobsFluentBuilder

Constructs a fluent builder for the ListKeyPhrasesDetectionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(KeyPhrasesDetectionJobFilter) / set_filter(Option<KeyPhrasesDetectionJobFilter>):
    required: false
    

    Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListKeyPhrasesDetectionJobsOutput with field(s):
  • key_phrases_detection_job_properties_list(Option<Vec::<KeyPhrasesDetectionJobProperties>>):

    A list containing the properties of each job that is returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListKeyPhrasesDetectionJobsError>

impl Client

pub fn list_pii_entities_detection_jobs( &self, ) -> ListPiiEntitiesDetectionJobsFluentBuilder

Constructs a fluent builder for the ListPiiEntitiesDetectionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(PiiEntitiesDetectionJobFilter) / set_filter(Option<PiiEntitiesDetectionJobFilter>):
    required: false
    

    Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page.

    
    
• On success, responds with ListPiiEntitiesDetectionJobsOutput with field(s):
  • pii_entities_detection_job_properties_list(Option<Vec::<PiiEntitiesDetectionJobProperties>>):

    A list containing the properties of each job that is returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListPiiEntitiesDetectionJobsError>

impl Client

pub fn list_sentiment_detection_jobs( &self, ) -> ListSentimentDetectionJobsFluentBuilder

Constructs a fluent builder for the ListSentimentDetectionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(SentimentDetectionJobFilter) / set_filter(Option<SentimentDetectionJobFilter>):
    required: false
    

    Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListSentimentDetectionJobsOutput with field(s):
  • sentiment_detection_job_properties_list(Option<Vec::<SentimentDetectionJobProperties>>):

    A list containing the properties of each job that is returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListSentimentDetectionJobsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

  • tags(Option<Vec::<Tag>>):

    Tags associated with the Amazon Comprehend resource being queried. 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.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_targeted_sentiment_detection_jobs( &self, ) -> ListTargetedSentimentDetectionJobsFluentBuilder

Constructs a fluent builder for the ListTargetedSentimentDetectionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(TargetedSentimentDetectionJobFilter) / set_filter(Option<TargetedSentimentDetectionJobFilter>):
    required: false
    

    Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListTargetedSentimentDetectionJobsOutput with field(s):
  • targeted_sentiment_detection_job_properties_list(Option<Vec::<TargetedSentimentDetectionJobProperties>>):

    A list containing the properties of each job that is returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListTargetedSentimentDetectionJobsError>

impl Client

pub fn list_topics_detection_jobs(&self) -> ListTopicsDetectionJobsFluentBuilder

Constructs a fluent builder for the ListTopicsDetectionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filter(TopicsDetectionJobFilter) / set_filter(Option<TopicsDetectionJobFilter>):
    required: false
    

    Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Identifies the next page of results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in each page. The default is 100.

    
    
• On success, responds with ListTopicsDetectionJobsOutput with field(s):
  • topics_detection_job_properties_list(Option<Vec::<TopicsDetectionJobProperties>>):

    A list containing the properties of each job that is returned.

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListTopicsDetectionJobsError>

impl Client

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the custom model to attach the policy to.

    
    
  • resource_policy(impl Into<String>) / set_resource_policy(Option<String>):
    required: true
    

    The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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”]}’

    
    
  • policy_revision_id(impl Into<String>) / set_policy_revision_id(Option<String>):
    required: false
    

    The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don’t use this parameter. Amazon Comprehend creates the revision ID for you.

    
    
• On success, responds with PutResourcePolicyOutput with field(s):
  • policy_revision_id(Option<String>):

    The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.

• On failure, responds with SdkError<PutResourcePolicyError>

impl Client

pub fn start_document_classification_job( &self, ) -> StartDocumentClassificationJobFluentBuilder

Constructs a fluent builder for the StartDocumentClassificationJob operation.

• The fluent builder is configurable:
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The identifier of the job.

    
    
  • document_classifier_arn(impl Into<String>) / set_document_classifier_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the document classifier to use to process the job.

    
    
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Specifies where to send the output files.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

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

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the Amazon Web Services 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the document classification job. A tag is a key-value pair that adds 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.

    
    
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

    
    
• On success, responds with StartDocumentClassificationJobOutput with field(s):
  • job_id(Option<String>):

    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeDocumentClassificationJob operation.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :document-classification-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the job:

    • SUBMITTED - The job has been received and queued for processing.

    • IN_PROGRESS - Amazon Comprehend is processing the job.

    • COMPLETED - The job was successfully completed and the output is available.

    • FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob operation.

    • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

    • STOPPED - The job was successfully stopped without completing.

  • document_classifier_arn(Option<String>):

    The ARN of the custom classification model.

• On failure, responds with SdkError<StartDocumentClassificationJobError>

impl Client

pub fn start_dominant_language_detection_job( &self, ) -> StartDominantLanguageDetectionJobFluentBuilder

Constructs a fluent builder for the StartDominantLanguageDetectionJob operation.

• The fluent builder is configurable:
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Specifies where to send the output files.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    An identifier for the job.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the Amazon Web Services 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the dominant language detection job. A tag is a key-value pair that adds 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.

    
    
• On success, responds with StartDominantLanguageDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier generated for the job. To get the status of a job, use this identifier with the operation.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :dominant-language-detection-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the job.

    • SUBMITTED - The job has been received and is queued for processing.

    • IN_PROGRESS - Amazon Comprehend is processing the job.

    • COMPLETED - The job was successfully completed and the output is available.

    • FAILED - The job did not complete. To get details, use the operation.

• On failure, responds with SdkError<StartDominantLanguageDetectionJobError>

impl Client

pub fn start_entities_detection_job( &self, ) -> StartEntitiesDetectionJobFluentBuilder

Constructs a fluent builder for the StartEntitiesDetectionJob operation.

• The fluent builder is configurable:
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Specifies where to send the output files.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The identifier of the job.

    
    
  • entity_recognizer_arn(impl Into<String>) / set_entity_recognizer_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the Amazon Web Services 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the entities detection job. A tag is a key-value pair that adds 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.

    
    
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

    
    
• On success, responds with StartEntitiesDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier generated for the job. To get the status of job, use this identifier with the operation.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :entities-detection-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the job.

    • SUBMITTED - The job has been received and is queued for processing.

    • IN_PROGRESS - Amazon Comprehend is processing the job.

    • COMPLETED - The job was successfully completed and the output is available.

    • FAILED - The job did not complete. To get details, use the operation.

    • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

    • STOPPED - The job was successfully stopped without completing.

  • entity_recognizer_arn(Option<String>):

    The ARN of the custom entity recognition model.

• On failure, responds with SdkError<StartEntitiesDetectionJobError>

impl Client

pub fn start_events_detection_job(&self) -> StartEventsDetectionJobFluentBuilder

Constructs a fluent builder for the StartEventsDetectionJob operation.

• The fluent builder is configurable:
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Specifies where to send the output files.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

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

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The identifier of the events detection job.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language code of the input documents.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • target_event_types(impl Into<String>) / set_target_event_types(Option<Vec::<String>>):
    required: true
    

    The types of events to detect in the input documents.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the events detection job. A tag is a key-value pair that adds 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.

    
    
• On success, responds with StartEventsDetectionJobOutput with field(s):
  • job_id(Option<String>):

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

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :events-detection-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the events detection job.

• On failure, responds with SdkError<StartEventsDetectionJobError>

impl Client

pub fn start_flywheel_iteration(&self) -> StartFlywheelIterationFluentBuilder

Constructs a fluent builder for the StartFlywheelIteration operation.

• The fluent builder is configurable:
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: true
    

    The ARN of the flywheel.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with StartFlywheelIterationOutput with field(s):
  • flywheel_arn(Option<String>):

  • flywheel_iteration_id(Option<String>):

• On failure, responds with SdkError<StartFlywheelIterationError>

impl Client

pub fn start_key_phrases_detection_job( &self, ) -> StartKeyPhrasesDetectionJobFluentBuilder

Constructs a fluent builder for the StartKeyPhrasesDetectionJob operation.

• The fluent builder is configurable:
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Specifies where to send the output files.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The identifier of the job.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the Amazon Web Services 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the key phrases detection job. A tag is a key-value pair that adds 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.

    
    
• On success, responds with StartKeyPhrasesDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier generated for the job. To get the status of a job, use this identifier with the operation.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :key-phrases-detection-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the job.

    • SUBMITTED - The job has been received and is queued for processing.

    • IN_PROGRESS - Amazon Comprehend is processing the job.

    • COMPLETED - The job was successfully completed and the output is available.

    • FAILED - The job did not complete. To get details, use the operation.

• On failure, responds with SdkError<StartKeyPhrasesDetectionJobError>

impl Client

pub fn start_pii_entities_detection_job( &self, ) -> StartPiiEntitiesDetectionJobFluentBuilder

Constructs a fluent builder for the StartPiiEntitiesDetectionJob operation.

• The fluent builder is configurable:
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

    The input properties for a PII entities detection job.

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Provides configuration parameters for the output of PII entity detection jobs.

    
    
  • mode(PiiEntitiesDetectionMode) / set_mode(Option<PiiEntitiesDetectionMode>):
    required: true
    

    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

    
    
  • redaction_config(RedactionConfig) / set_redaction_config(Option<RedactionConfig>):
    required: false
    

    Provides configuration parameters for PII entity redaction.

    This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

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

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The identifier of the job.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. Enter the language code for English (en) or Spanish (es).

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the PII entities detection job. A tag is a key-value pair that adds 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.

    
    
• On success, responds with StartPiiEntitiesDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier generated for the job.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :pii-entities-detection-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the job.

• On failure, responds with SdkError<StartPiiEntitiesDetectionJobError>

impl Client

pub fn start_sentiment_detection_job( &self, ) -> StartSentimentDetectionJobFluentBuilder

Constructs a fluent builder for the StartSentimentDetectionJob operation.

• The fluent builder is configurable:
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Specifies where to send the output files.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The identifier of the job.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the Amazon Web Services 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the sentiment detection job. A tag is a key-value pair that adds 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.

    
    
• On success, responds with StartSentimentDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier generated for the job. To get the status of a job, use this identifier with the operation.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :sentiment-detection-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the job.

    • SUBMITTED - The job has been received and is queued for processing.

    • IN_PROGRESS - Amazon Comprehend is processing the job.

    • COMPLETED - The job was successfully completed and the output is available.

    • FAILED - The job did not complete. To get details, use the operation.

• On failure, responds with SdkError<StartSentimentDetectionJobError>

impl Client

pub fn start_targeted_sentiment_detection_job( &self, ) -> StartTargetedSentimentDetectionJobFluentBuilder

Constructs a fluent builder for the StartTargetedSentimentDetectionJob operation.

• The fluent builder is configurable:
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

    The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Specifies where to send the output files.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The identifier of the job.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: true
    

    The language of the input documents. Currently, English is the only supported language.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

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

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds 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.

    
    
• On success, responds with StartTargetedSentimentDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier generated for the job. To get the status of a job, use this identifier with the DescribeTargetedSentimentDetectionJob operation.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :targeted-sentiment-detection-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the job.

    • SUBMITTED - The job has been received and is queued for processing.

    • IN_PROGRESS - Amazon Comprehend is processing the job.

    • COMPLETED - The job was successfully completed and the output is available.

    • FAILED - The job did not complete. To get details, use the DescribeTargetedSentimentDetectionJob operation.

• On failure, responds with SdkError<StartTargetedSentimentDetectionJobError>

impl Client

pub fn start_topics_detection_job(&self) -> StartTopicsDetectionJobFluentBuilder

Constructs a fluent builder for the StartTopicsDetectionJob operation.

• The fluent builder is configurable:
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The identifier of the job.

    
    
  • number_of_topics(i32) / set_number_of_topics(Option<i32>):
    required: false
    

    The number of topics to detect.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

    
    
  • volume_kms_key_id(impl Into<String>) / set_volume_kms_key_id(Option<String>):
    required: false
    

    ID for the Amazon Web Services 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”

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Tags to associate with the topics detection job. A tag is a key-value pair that adds 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.

    
    
• On success, responds with StartTopicsDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

  • job_arn(Option<String>):

    The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn: :comprehend: : :topics-detection-job/

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

  • job_status(Option<JobStatus>):

    The status of the job:

    • SUBMITTED - The job has been received and is queued for processing.

    • IN_PROGRESS - Amazon Comprehend is processing the job.

    • COMPLETED - The job was successfully completed and the output is available.

    • FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

• On failure, responds with SdkError<StartTopicsDetectionJobError>

impl Client

pub fn stop_dominant_language_detection_job( &self, ) -> StopDominantLanguageDetectionJobFluentBuilder

Constructs a fluent builder for the StopDominantLanguageDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the dominant language detection job to stop.

    
    
• On success, responds with StopDominantLanguageDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier of the dominant language detection job to stop.

  • job_status(Option<JobStatus>):

    Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.

• On failure, responds with SdkError<StopDominantLanguageDetectionJobError>

impl Client

pub fn stop_entities_detection_job( &self, ) -> StopEntitiesDetectionJobFluentBuilder

Constructs a fluent builder for the StopEntitiesDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the entities detection job to stop.

    
    
• On success, responds with StopEntitiesDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier of the entities detection job to stop.

  • job_status(Option<JobStatus>):

    Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

• On failure, responds with SdkError<StopEntitiesDetectionJobError>

impl Client

pub fn stop_events_detection_job(&self) -> StopEventsDetectionJobFluentBuilder

Constructs a fluent builder for the StopEventsDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the events detection job to stop.

    
    
• On success, responds with StopEventsDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier of the events detection job to stop.

  • job_status(Option<JobStatus>):

    The status of the events detection job.

• On failure, responds with SdkError<StopEventsDetectionJobError>

impl Client

pub fn stop_key_phrases_detection_job( &self, ) -> StopKeyPhrasesDetectionJobFluentBuilder

Constructs a fluent builder for the StopKeyPhrasesDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the key phrases detection job to stop.

    
    
• On success, responds with StopKeyPhrasesDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier of the key phrases detection job to stop.

  • job_status(Option<JobStatus>):

    Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.

• On failure, responds with SdkError<StopKeyPhrasesDetectionJobError>

impl Client

pub fn stop_pii_entities_detection_job( &self, ) -> StopPiiEntitiesDetectionJobFluentBuilder

Constructs a fluent builder for the StopPiiEntitiesDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the PII entities detection job to stop.

    
    
• On success, responds with StopPiiEntitiesDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier of the PII entities detection job to stop.

  • job_status(Option<JobStatus>):

    The status of the PII entities detection job.

• On failure, responds with SdkError<StopPiiEntitiesDetectionJobError>

impl Client

pub fn stop_sentiment_detection_job( &self, ) -> StopSentimentDetectionJobFluentBuilder

Constructs a fluent builder for the StopSentimentDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the sentiment detection job to stop.

    
    
• On success, responds with StopSentimentDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier of the sentiment detection job to stop.

  • job_status(Option<JobStatus>):

    Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

• On failure, responds with SdkError<StopSentimentDetectionJobError>

impl Client

pub fn stop_targeted_sentiment_detection_job( &self, ) -> StopTargetedSentimentDetectionJobFluentBuilder

Constructs a fluent builder for the StopTargetedSentimentDetectionJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the targeted sentiment detection job to stop.

    
    
• On success, responds with StopTargetedSentimentDetectionJobOutput with field(s):
  • job_id(Option<String>):

    The identifier of the targeted sentiment detection job to stop.

  • job_status(Option<JobStatus>):

    Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

• On failure, responds with SdkError<StopTargetedSentimentDetectionJobError>

impl Client

pub fn stop_training_document_classifier( &self, ) -> StopTrainingDocumentClassifierFluentBuilder

Constructs a fluent builder for the StopTrainingDocumentClassifier operation.

• The fluent builder is configurable:
  • document_classifier_arn(impl Into<String>) / set_document_classifier_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

    
    
• On success, responds with StopTrainingDocumentClassifierOutput
• On failure, responds with SdkError<StopTrainingDocumentClassifierError>

impl Client

pub fn stop_training_entity_recognizer( &self, ) -> StopTrainingEntityRecognizerFluentBuilder

Constructs a fluent builder for the StopTrainingEntityRecognizer operation.

• The fluent builder is configurable:
  • entity_recognizer_arn(impl Into<String>) / set_entity_recognizer_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.

    
    
• On success, responds with StopTrainingEntityRecognizerOutput
• On failure, responds with SdkError<StopTrainingEntityRecognizerError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_endpoint(&self) -> UpdateEndpointFluentBuilder

Constructs a fluent builder for the UpdateEndpoint operation.

• The fluent builder is configurable:
  • endpoint_arn(impl Into<String>) / set_endpoint_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the endpoint being updated.

    
    
  • desired_model_arn(impl Into<String>) / set_desired_model_arn(Option<String>):
    required: false
    

    The ARN of the new model to use when updating an existing endpoint.

    
    
  • desired_inference_units(i32) / set_desired_inference_units(Option<i32>):
    required: false
    

    The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

    
    
  • desired_data_access_role_arn(impl Into<String>) / set_desired_data_access_role_arn(Option<String>):
    required: false
    

    Data access role ARN to use in case the new model is encrypted with a customer CMK.

    
    
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the flywheel

    
    
• On success, responds with UpdateEndpointOutput with field(s):
  • desired_model_arn(Option<String>):

    The Amazon Resource Number (ARN) of the new model.

• On failure, responds with SdkError<UpdateEndpointError>

impl Client

pub fn update_flywheel(&self) -> UpdateFlywheelFluentBuilder

Constructs a fluent builder for the UpdateFlywheel operation.

• The fluent builder is configurable:
  • flywheel_arn(impl Into<String>) / set_flywheel_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the flywheel to update.

    
    
  • active_model_arn(impl Into<String>) / set_active_model_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the active model version.

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

    
    
  • data_security_config(UpdateDataSecurityConfig) / set_data_security_config(Option<UpdateDataSecurityConfig>):
    required: false
    

    Flywheel data security configuration.

    
    
• On success, responds with UpdateFlywheelOutput with field(s):
  • flywheel_properties(Option<FlywheelProperties>):

    The flywheel properties.

• On failure, responds with SdkError<UpdateFlywheelError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.