Struct aws_sdk_comprehend::Client
source · [−]pub struct Client { /* private fields */ }Expand description
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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_comprehend::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_comprehend::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_comprehend::Client::from_conf(config);Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn batch_detect_dominant_language(&self) -> BatchDetectDominantLanguage
pub fn batch_detect_dominant_language(&self) -> BatchDetectDominantLanguage
Constructs a fluent builder for the BatchDetectDominantLanguage operation.
- The fluent builder is configurable:
text_list(Vec<String>)/set_text_list(Option<Vec<String>>):A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
- On success, responds with
BatchDetectDominantLanguageOutputwith field(s):result_list(Option<Vec<BatchDetectDominantLanguageItemResult>>):A list of objects containing the results of the operation. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If all of the documents contain an error, theResultListis empty.error_list(Option<Vec<BatchItemError>>):A list containing one object for each document that contained an error. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If there are no errors in the batch, theErrorListis empty.
- On failure, responds with
SdkError<BatchDetectDominantLanguageError>
sourcepub fn batch_detect_entities(&self) -> BatchDetectEntities
pub fn batch_detect_entities(&self) -> BatchDetectEntities
Constructs a fluent builder for the BatchDetectEntities operation.
- The fluent builder is configurable:
text_list(Vec<String>)/set_text_list(Option<Vec<String>>):A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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
BatchDetectEntitiesOutputwith field(s):result_list(Option<Vec<BatchDetectEntitiesItemResult>>):A list of objects containing the results of the operation. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If all of the documents contain an error, theResultListis empty.error_list(Option<Vec<BatchItemError>>):A list containing one object for each document that contained an error. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If there are no errors in the batch, theErrorListis empty.
- On failure, responds with
SdkError<BatchDetectEntitiesError>
sourcepub fn batch_detect_key_phrases(&self) -> BatchDetectKeyPhrases
pub fn batch_detect_key_phrases(&self) -> BatchDetectKeyPhrases
Constructs a fluent builder for the BatchDetectKeyPhrases operation.
- The fluent builder is configurable:
text_list(Vec<String>)/set_text_list(Option<Vec<String>>):A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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
BatchDetectKeyPhrasesOutputwith field(s):result_list(Option<Vec<BatchDetectKeyPhrasesItemResult>>):A list of objects containing the results of the operation. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If all of the documents contain an error, theResultListis empty.error_list(Option<Vec<BatchItemError>>):A list containing one object for each document that contained an error. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If there are no errors in the batch, theErrorListis empty.
- On failure, responds with
SdkError<BatchDetectKeyPhrasesError>
sourcepub fn batch_detect_sentiment(&self) -> BatchDetectSentiment
pub fn batch_detect_sentiment(&self) -> BatchDetectSentiment
Constructs a fluent builder for the BatchDetectSentiment operation.
- The fluent builder is configurable:
text_list(Vec<String>)/set_text_list(Option<Vec<String>>):A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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
BatchDetectSentimentOutputwith field(s):result_list(Option<Vec<BatchDetectSentimentItemResult>>):A list of objects containing the results of the operation. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If all of the documents contain an error, theResultListis empty.error_list(Option<Vec<BatchItemError>>):A list containing one object for each document that contained an error. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If there are no errors in the batch, theErrorListis empty.
- On failure, responds with
SdkError<BatchDetectSentimentError>
sourcepub fn batch_detect_syntax(&self) -> BatchDetectSyntax
pub fn batch_detect_syntax(&self) -> BatchDetectSyntax
Constructs a fluent builder for the BatchDetectSyntax operation.
- The fluent builder is configurable:
text_list(Vec<String>)/set_text_list(Option<Vec<String>>):A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
language_code(SyntaxLanguageCode)/set_language_code(Option<SyntaxLanguageCode>):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
BatchDetectSyntaxOutputwith field(s):result_list(Option<Vec<BatchDetectSyntaxItemResult>>):A list of objects containing the results of the operation. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If all of the documents contain an error, theResultListis empty.error_list(Option<Vec<BatchItemError>>):A list containing one object for each document that contained an error. The results are sorted in ascending order by the
Indexfield and match the order of the documents in the input list. If there are no errors in the batch, theErrorListis empty.
- On failure, responds with
SdkError<BatchDetectSyntaxError>
sourcepub fn classify_document(&self) -> ClassifyDocument
pub fn classify_document(&self) -> ClassifyDocument
Constructs a fluent builder for the ClassifyDocument operation.
- The fluent builder is configurable:
text(impl Into<String>)/set_text(Option<String>):The document text to be analyzed.
endpoint_arn(impl Into<String>)/set_endpoint_arn(Option<String>):The Amazon Resource Number (ARN) of the endpoint.
- On success, responds with
ClassifyDocumentOutputwith field(s):classes(Option<Vec<DocumentClass>>):The classes used by the document being analyzed. These are used for multi-class trained models. 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.
labels(Option<Vec<DocumentLabel>>):The labels used 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.
- On failure, responds with
SdkError<ClassifyDocumentError>
sourcepub fn contains_pii_entities(&self) -> ContainsPiiEntities
pub fn contains_pii_entities(&self) -> ContainsPiiEntities
Constructs a fluent builder for the ContainsPiiEntities operation.
- The fluent builder is configurable:
text(impl Into<String>)/set_text(Option<String>):Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):The language of the input documents.
- On success, responds with
ContainsPiiEntitiesOutputwith 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>
sourcepub fn create_document_classifier(&self) -> CreateDocumentClassifier
pub fn create_document_classifier(&self) -> CreateDocumentClassifier
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>):The name of the document classifier.
version_name(impl Into<String>)/set_version_name(Option<String>):The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.
input_data_config(DocumentClassifierInputDataConfig)/set_input_data_config(Option<DocumentClassifierInputDataConfig>):Specifies the format and location of the input data for the job.
output_data_config(DocumentClassifierOutputDataConfig)/set_output_data_config(Option<DocumentClassifierOutputDataConfig>):Enables the addition of output results configuration parameters for custom classifier jobs.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):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>):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.
volume_kms_key_id(impl Into<String>)/set_volume_kms_key_id(Option<String>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
vpc_config(VpcConfig)/set_vpc_config(Option<VpcConfig>):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>):Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
model_kms_key_id(impl Into<String>)/set_model_kms_key_id(Option<String>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
model_policy(impl Into<String>)/set_model_policy(Option<String>):The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.
Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
“{"attribute": "value", "attribute": ["value"]}”To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
‘{“attribute”: “value”, “attribute”: [“value”]}’
- On success, responds with
CreateDocumentClassifierOutputwith field(s):document_classifier_arn(Option<String>):The Amazon Resource Name (ARN) that identifies the document classifier.
- On failure, responds with
SdkError<CreateDocumentClassifierError>
sourcepub fn create_endpoint(&self) -> CreateEndpoint
pub fn create_endpoint(&self) -> CreateEndpoint
Constructs a fluent builder for the CreateEndpoint operation.
- The fluent builder is configurable:
endpoint_name(impl Into<String>)/set_endpoint_name(Option<String>):This is the descriptive suffix that becomes part of the
EndpointArnused for all subsequent requests to this resource.model_arn(impl Into<String>)/set_model_arn(Option<String>):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>):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>):An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a
ResourceInUseException.tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags associated with the endpoint being created. 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>):The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
- On success, responds with
CreateEndpointOutputwith field(s):endpoint_arn(Option<String>):The Amazon Resource Number (ARN) of the endpoint being created.
- On failure, responds with
SdkError<CreateEndpointError>
sourcepub fn create_entity_recognizer(&self) -> CreateEntityRecognizer
pub fn create_entity_recognizer(&self) -> CreateEntityRecognizer
Constructs a fluent builder for the CreateEntityRecognizer operation.
- The fluent builder is configurable:
recognizer_name(impl Into<String>)/set_recognizer_name(Option<String>):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>):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/ AWS Region.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with “Sales” as the key might be added to a resource to indicate its use by the sales department.
input_data_config(EntityRecognizerInputDataConfig)/set_input_data_config(Option<EntityRecognizerInputDataConfig>):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>):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>):You can specify any of the following languages supported by Amazon Comprehend: English (“en”), Spanish (“es”), French (“fr”), Italian (“it”), German (“de”), or Portuguese (“pt”). All documents must be in the same language.
volume_kms_key_id(impl Into<String>)/set_volume_kms_key_id(Option<String>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
vpc_config(VpcConfig)/set_vpc_config(Option<VpcConfig>):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>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
model_policy(impl Into<String>)/set_model_policy(Option<String>):The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another AWS 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
CreateEntityRecognizerOutputwith field(s):entity_recognizer_arn(Option<String>):The Amazon Resource Name (ARN) that identifies the entity recognizer.
- On failure, responds with
SdkError<CreateEntityRecognizerError>
sourcepub fn delete_document_classifier(&self) -> DeleteDocumentClassifier
pub fn delete_document_classifier(&self) -> DeleteDocumentClassifier
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>):The Amazon Resource Name (ARN) that identifies the document classifier.
- On success, responds with
DeleteDocumentClassifierOutput - On failure, responds with
SdkError<DeleteDocumentClassifierError>
sourcepub fn delete_endpoint(&self) -> DeleteEndpoint
pub fn delete_endpoint(&self) -> DeleteEndpoint
Constructs a fluent builder for the DeleteEndpoint operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)/set_endpoint_arn(Option<String>):The Amazon Resource Number (ARN) of the endpoint being deleted.
- On success, responds with
DeleteEndpointOutput - On failure, responds with
SdkError<DeleteEndpointError>
sourcepub fn delete_entity_recognizer(&self) -> DeleteEntityRecognizer
pub fn delete_entity_recognizer(&self) -> DeleteEntityRecognizer
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>):The Amazon Resource Name (ARN) that identifies the entity recognizer.
- On success, responds with
DeleteEntityRecognizerOutput - On failure, responds with
SdkError<DeleteEntityRecognizerError>
sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicy
pub fn delete_resource_policy(&self) -> DeleteResourcePolicy
Constructs a fluent builder for the DeleteResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):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>):The revision ID of the policy to delete.
- On success, responds with
DeleteResourcePolicyOutput - On failure, responds with
SdkError<DeleteResourcePolicyError>
sourcepub fn describe_document_classification_job(
&self
) -> DescribeDocumentClassificationJob
pub fn describe_document_classification_job(
&self
) -> DescribeDocumentClassificationJob
Constructs a fluent builder for the DescribeDocumentClassificationJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- On success, responds with
DescribeDocumentClassificationJobOutputwith 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>
sourcepub fn describe_document_classifier(&self) -> DescribeDocumentClassifier
pub fn describe_document_classifier(&self) -> DescribeDocumentClassifier
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>):The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.
- On success, responds with
DescribeDocumentClassifierOutputwith field(s):document_classifier_properties(Option<DocumentClassifierProperties>):An object that contains the properties associated with a document classifier.
- On failure, responds with
SdkError<DescribeDocumentClassifierError>
sourcepub fn describe_dominant_language_detection_job(
&self
) -> DescribeDominantLanguageDetectionJob
pub fn describe_dominant_language_detection_job(
&self
) -> DescribeDominantLanguageDetectionJob
Constructs a fluent builder for the DescribeDominantLanguageDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- On success, responds with
DescribeDominantLanguageDetectionJobOutputwith 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>
sourcepub fn describe_endpoint(&self) -> DescribeEndpoint
pub fn describe_endpoint(&self) -> DescribeEndpoint
Constructs a fluent builder for the DescribeEndpoint operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)/set_endpoint_arn(Option<String>):The Amazon Resource Number (ARN) of the endpoint being described.
- On success, responds with
DescribeEndpointOutputwith field(s):endpoint_properties(Option<EndpointProperties>):Describes information associated with the specific endpoint.
- On failure, responds with
SdkError<DescribeEndpointError>
sourcepub fn describe_entities_detection_job(&self) -> DescribeEntitiesDetectionJob
pub fn describe_entities_detection_job(&self) -> DescribeEntitiesDetectionJob
Constructs a fluent builder for the DescribeEntitiesDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- On success, responds with
DescribeEntitiesDetectionJobOutputwith 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>
sourcepub fn describe_entity_recognizer(&self) -> DescribeEntityRecognizer
pub fn describe_entity_recognizer(&self) -> DescribeEntityRecognizer
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>):The Amazon Resource Name (ARN) that identifies the entity recognizer.
- On success, responds with
DescribeEntityRecognizerOutputwith field(s):entity_recognizer_properties(Option<EntityRecognizerProperties>):Describes information associated with an entity recognizer.
- On failure, responds with
SdkError<DescribeEntityRecognizerError>
sourcepub fn describe_events_detection_job(&self) -> DescribeEventsDetectionJob
pub fn describe_events_detection_job(&self) -> DescribeEventsDetectionJob
Constructs a fluent builder for the DescribeEventsDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier of the events detection job.
- On success, responds with
DescribeEventsDetectionJobOutputwith 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>
sourcepub fn describe_key_phrases_detection_job(
&self
) -> DescribeKeyPhrasesDetectionJob
pub fn describe_key_phrases_detection_job(
&self
) -> DescribeKeyPhrasesDetectionJob
Constructs a fluent builder for the DescribeKeyPhrasesDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- On success, responds with
DescribeKeyPhrasesDetectionJobOutputwith 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>
sourcepub fn describe_pii_entities_detection_job(
&self
) -> DescribePiiEntitiesDetectionJob
pub fn describe_pii_entities_detection_job(
&self
) -> DescribePiiEntitiesDetectionJob
Constructs a fluent builder for the DescribePiiEntitiesDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- On success, responds with
DescribePiiEntitiesDetectionJobOutputwith field(s):pii_entities_detection_job_properties(Option<PiiEntitiesDetectionJobProperties>):Provides information about a PII entities detection job.
- On failure, responds with
SdkError<DescribePiiEntitiesDetectionJobError>
sourcepub fn describe_resource_policy(&self) -> DescribeResourcePolicy
pub fn describe_resource_policy(&self) -> DescribeResourcePolicy
Constructs a fluent builder for the DescribeResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the policy to describe.
- On success, responds with
DescribeResourcePolicyOutputwith 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>
sourcepub fn describe_sentiment_detection_job(&self) -> DescribeSentimentDetectionJob
pub fn describe_sentiment_detection_job(&self) -> DescribeSentimentDetectionJob
Constructs a fluent builder for the DescribeSentimentDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- On success, responds with
DescribeSentimentDetectionJobOutputwith 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>
sourcepub fn describe_targeted_sentiment_detection_job(
&self
) -> DescribeTargetedSentimentDetectionJob
pub fn describe_targeted_sentiment_detection_job(
&self
) -> DescribeTargetedSentimentDetectionJob
Constructs a fluent builder for the DescribeTargetedSentimentDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
- On success, responds with
DescribeTargetedSentimentDetectionJobOutputwith 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>
sourcepub fn describe_topics_detection_job(&self) -> DescribeTopicsDetectionJob
pub fn describe_topics_detection_job(&self) -> DescribeTopicsDetectionJob
Constructs a fluent builder for the DescribeTopicsDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier assigned by the user to the detection job.
- On success, responds with
DescribeTopicsDetectionJobOutputwith field(s):topics_detection_job_properties(Option<TopicsDetectionJobProperties>):The list of properties for the requested job.
- On failure, responds with
SdkError<DescribeTopicsDetectionJobError>
sourcepub fn detect_dominant_language(&self) -> DetectDominantLanguage
pub fn detect_dominant_language(&self) -> DetectDominantLanguage
Constructs a fluent builder for the DetectDominantLanguage operation.
- The fluent builder is configurable:
text(impl Into<String>)/set_text(Option<String>):A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
- On success, responds with
DetectDominantLanguageOutputwith field(s):languages(Option<Vec<DominantLanguage>>):The languages that Amazon Comprehend detected in the input text. 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>
sourcepub fn detect_entities(&self) -> DetectEntities
pub fn detect_entities(&self) -> DetectEntities
Constructs a fluent builder for the DetectEntities operation.
- The fluent builder is configurable:
text(impl Into<String>)/set_text(Option<String>):A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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.
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.
endpoint_arn(impl Into<String>)/set_endpoint_arn(Option<String>):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.
- On success, responds with
DetectEntitiesOutputwith 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
how-entities.
- On failure, responds with
SdkError<DetectEntitiesError>
sourcepub fn detect_key_phrases(&self) -> DetectKeyPhrases
pub fn detect_key_phrases(&self) -> DetectKeyPhrases
Constructs a fluent builder for the DetectKeyPhrases operation.
- The fluent builder is configurable:
text(impl Into<String>)/set_text(Option<String>):A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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
DetectKeyPhrasesOutputwith 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>
sourcepub fn detect_pii_entities(&self) -> DetectPiiEntities
pub fn detect_pii_entities(&self) -> DetectPiiEntities
Constructs a fluent builder for the DetectPiiEntities operation.
- The fluent builder is configurable:
text(impl Into<String>)/set_text(Option<String>):A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):The language of the input documents.
- On success, responds with
DetectPiiEntitiesOutputwith 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>
sourcepub fn detect_sentiment(&self) -> DetectSentiment
pub fn detect_sentiment(&self) -> DetectSentiment
Constructs a fluent builder for the DetectSentiment operation.
- The fluent builder is configurable:
text(impl Into<String>)/set_text(Option<String>):A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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
DetectSentimentOutputwith 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>
sourcepub fn detect_syntax(&self) -> DetectSyntax
pub fn detect_syntax(&self) -> DetectSyntax
Constructs a fluent builder for the DetectSyntax operation.
- The fluent builder is configurable:
text(impl Into<String>)/set_text(Option<String>):A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.
language_code(SyntaxLanguageCode)/set_language_code(Option<SyntaxLanguageCode>):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
DetectSyntaxOutputwith 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
how-syntax.
- On failure, responds with
SdkError<DetectSyntaxError>
sourcepub fn import_model(&self) -> ImportModel
pub fn import_model(&self) -> ImportModel
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>):The Amazon Resource Name (ARN) of the custom model to import.
model_name(impl Into<String>)/set_model_name(Option<String>):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>):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/AWS Region.
model_kms_key_id(impl Into<String>)/set_model_kms_key_id(Option<String>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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
ImportModelOutputwith field(s):model_arn(Option<String>):The Amazon Resource Name (ARN) of the custom model being imported.
- On failure, responds with
SdkError<ImportModelError>
sourcepub fn list_document_classification_jobs(
&self
) -> ListDocumentClassificationJobs
pub fn list_document_classification_jobs(
&self
) -> ListDocumentClassificationJobs
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListDocumentClassificationJobsOutputwith 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>
sourcepub fn list_document_classifiers(&self) -> ListDocumentClassifiers
pub fn list_document_classifiers(&self) -> ListDocumentClassifiers
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListDocumentClassifiersOutputwith 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>
sourcepub fn list_document_classifier_summaries(
&self
) -> ListDocumentClassifierSummaries
pub fn list_document_classifier_summaries(
&self
) -> ListDocumentClassifierSummaries
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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return on each page. The default is 100.
- On success, responds with
ListDocumentClassifierSummariesOutputwith 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>
sourcepub fn list_dominant_language_detection_jobs(
&self
) -> ListDominantLanguageDetectionJobs
pub fn list_dominant_language_detection_jobs(
&self
) -> ListDominantLanguageDetectionJobs
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListDominantLanguageDetectionJobsOutputwith 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>
sourcepub fn list_endpoints(&self) -> ListEndpoints
pub fn list_endpoints(&self) -> ListEndpoints
Constructs a fluent builder for the ListEndpoints operation.
- The fluent builder is configurable:
filter(EndpointFilter)/set_filter(Option<EndpointFilter>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListEndpointsOutputwith 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>
sourcepub fn list_entities_detection_jobs(&self) -> ListEntitiesDetectionJobs
pub fn list_entities_detection_jobs(&self) -> ListEntitiesDetectionJobs
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListEntitiesDetectionJobsOutputwith 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>
sourcepub fn list_entity_recognizers(&self) -> ListEntityRecognizers
pub fn list_entity_recognizers(&self) -> ListEntityRecognizers
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>):Filters the list of entities returned. You can filter on
Status,SubmitTimeBefore, orSubmitTimeAfter. You can only set one filter at a time.next_token(impl Into<String>)/set_next_token(Option<String>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return on each page. The default is 100.
- On success, responds with
ListEntityRecognizersOutputwith 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>
sourcepub fn list_entity_recognizer_summaries(&self) -> ListEntityRecognizerSummaries
pub fn list_entity_recognizer_summaries(&self) -> ListEntityRecognizerSummaries
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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return on each page. The default is 100.
- On success, responds with
ListEntityRecognizerSummariesOutputwith field(s):entity_recognizer_summaries_list(Option<Vec<EntityRecognizerSummary>>):The list entity recognizer summaries.
next_token(Option<String>):The list entity recognizer summaries.
- On failure, responds with
SdkError<ListEntityRecognizerSummariesError>
sourcepub fn list_events_detection_jobs(&self) -> ListEventsDetectionJobs
pub fn list_events_detection_jobs(&self) -> ListEventsDetectionJobs
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page.
- On success, responds with
ListEventsDetectionJobsOutputwith 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>
sourcepub fn list_key_phrases_detection_jobs(&self) -> ListKeyPhrasesDetectionJobs
pub fn list_key_phrases_detection_jobs(&self) -> ListKeyPhrasesDetectionJobs
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListKeyPhrasesDetectionJobsOutputwith 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>
sourcepub fn list_pii_entities_detection_jobs(&self) -> ListPiiEntitiesDetectionJobs
pub fn list_pii_entities_detection_jobs(&self) -> ListPiiEntitiesDetectionJobs
Constructs a fluent builder for the ListPiiEntitiesDetectionJobs operation.
- The fluent builder is configurable:
filter(PiiEntitiesDetectionJobFilter)/set_filter(Option<PiiEntitiesDetectionJobFilter>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page.
- On success, responds with
ListPiiEntitiesDetectionJobsOutputwith 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>
sourcepub fn list_sentiment_detection_jobs(&self) -> ListSentimentDetectionJobs
pub fn list_sentiment_detection_jobs(&self) -> ListSentimentDetectionJobs
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListSentimentDetectionJobsOutputwith 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>
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
- On success, responds with
ListTagsForResourceOutputwith 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>
sourcepub fn list_targeted_sentiment_detection_jobs(
&self
) -> ListTargetedSentimentDetectionJobs
pub fn list_targeted_sentiment_detection_jobs(
&self
) -> ListTargetedSentimentDetectionJobs
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListTargetedSentimentDetectionJobsOutputwith 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>
sourcepub fn list_topics_detection_jobs(&self) -> ListTopicsDetectionJobs
pub fn list_topics_detection_jobs(&self) -> ListTopicsDetectionJobs
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>):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>):Identifies the next page of results to return.
max_results(i32)/set_max_results(Option<i32>):The maximum number of results to return in each page. The default is 100.
- On success, responds with
ListTopicsDetectionJobsOutputwith 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>
sourcepub fn put_resource_policy(&self) -> PutResourcePolicy
pub fn put_resource_policy(&self) -> PutResourcePolicy
Constructs a fluent builder for the PutResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the custom model to attach the policy to.
resource_policy(impl Into<String>)/set_resource_policy(Option<String>):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>):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
PutResourcePolicyOutputwith 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>
sourcepub fn start_document_classification_job(
&self
) -> StartDocumentClassificationJob
pub fn start_document_classification_job(
&self
) -> StartDocumentClassificationJob
Constructs a fluent builder for the StartDocumentClassificationJob operation.
- The fluent builder is configurable:
job_name(impl Into<String>)/set_job_name(Option<String>):The identifier of the job.
document_classifier_arn(impl Into<String>)/set_document_classifier_arn(Option<String>):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>):Specifies the format and location of the input data for the job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Specifies where to send the output files.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):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>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
vpc_config(VpcConfig)/set_vpc_config(Option<VpcConfig>):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(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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.
- On success, responds with
StartDocumentClassificationJobOutputwith field(s):job_id(Option<String>):The identifier generated for the job. To get the status of the job, use this identifier with the 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 AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_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 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.
-
- On failure, responds with
SdkError<StartDocumentClassificationJobError>
sourcepub fn start_dominant_language_detection_job(
&self
) -> StartDominantLanguageDetectionJob
pub fn start_dominant_language_detection_job(
&self
) -> StartDominantLanguageDetectionJob
Constructs a fluent builder for the StartDominantLanguageDetectionJob operation.
- The fluent builder is configurable:
input_data_config(InputDataConfig)/set_input_data_config(Option<InputDataConfig>):Specifies the format and location of the input data for the job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Specifies where to send the output files.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
job_name(impl Into<String>)/set_job_name(Option<String>):An identifier for the job.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):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>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
vpc_config(VpcConfig)/set_vpc_config(Option<VpcConfig>):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(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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
StartDominantLanguageDetectionJobOutputwith 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 AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_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>
sourcepub fn start_entities_detection_job(&self) -> StartEntitiesDetectionJob
pub fn start_entities_detection_job(&self) -> StartEntitiesDetectionJob
Constructs a fluent builder for the StartEntitiesDetectionJob operation.
- The fluent builder is configurable:
input_data_config(InputDataConfig)/set_input_data_config(Option<InputDataConfig>):Specifies the format and location of the input data for the job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Specifies where to send the output files.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
job_name(impl Into<String>)/set_job_name(Option<String>):The identifier of the job.
entity_recognizer_arn(impl Into<String>)/set_entity_recognizer_arn(Option<String>):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>):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>):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>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
vpc_config(VpcConfig)/set_vpc_config(Option<VpcConfig>):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(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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.
- On success, responds with
StartEntitiesDetectionJobOutputwith 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 AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_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.
-
- On failure, responds with
SdkError<StartEntitiesDetectionJobError>
sourcepub fn start_events_detection_job(&self) -> StartEventsDetectionJob
pub fn start_events_detection_job(&self) -> StartEventsDetectionJob
Constructs a fluent builder for the StartEventsDetectionJob operation.
- The fluent builder is configurable:
input_data_config(InputDataConfig)/set_input_data_config(Option<InputDataConfig>):Specifies the format and location of the input data for the job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Specifies where to send the output files.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
job_name(impl Into<String>)/set_job_name(Option<String>):The identifier of the events detection job.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):The language code of the input documents.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):An unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.
target_event_types(Vec<String>)/set_target_event_types(Option<Vec<String>>):The types of events to detect in the input documents.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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
StartEventsDetectionJobOutputwith 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 AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_status(Option<JobStatus>):The status of the events detection job.
- On failure, responds with
SdkError<StartEventsDetectionJobError>
sourcepub fn start_key_phrases_detection_job(&self) -> StartKeyPhrasesDetectionJob
pub fn start_key_phrases_detection_job(&self) -> StartKeyPhrasesDetectionJob
Constructs a fluent builder for the StartKeyPhrasesDetectionJob operation.
- The fluent builder is configurable:
input_data_config(InputDataConfig)/set_input_data_config(Option<InputDataConfig>):Specifies the format and location of the input data for the job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Specifies where to send the output files.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
job_name(impl Into<String>)/set_job_name(Option<String>):The identifier of the job.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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>):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>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
vpc_config(VpcConfig)/set_vpc_config(Option<VpcConfig>):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(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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
StartKeyPhrasesDetectionJobOutputwith 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 AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_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>
sourcepub fn start_pii_entities_detection_job(&self) -> StartPiiEntitiesDetectionJob
pub fn start_pii_entities_detection_job(&self) -> StartPiiEntitiesDetectionJob
Constructs a fluent builder for the StartPiiEntitiesDetectionJob operation.
- The fluent builder is configurable:
input_data_config(InputDataConfig)/set_input_data_config(Option<InputDataConfig>):The input properties for a PII entities detection job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Provides configuration parameters for the output of PII entity detection jobs.
mode(PiiEntitiesDetectionMode)/set_mode(Option<PiiEntitiesDetectionMode>):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>):Provides configuration parameters for PII entity redaction.
This parameter is required if you set the
Modeparameter toONLY_REDACTION. In that case, you must provide aRedactionConfigdefinition that includes thePiiEntityTypesparameter.data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
job_name(impl Into<String>)/set_job_name(Option<String>):The identifier of the job.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):The language of the input documents.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend generates one.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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
StartPiiEntitiesDetectionJobOutputwith 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 AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_status(Option<JobStatus>):The status of the job.
- On failure, responds with
SdkError<StartPiiEntitiesDetectionJobError>
sourcepub fn start_sentiment_detection_job(&self) -> StartSentimentDetectionJob
pub fn start_sentiment_detection_job(&self) -> StartSentimentDetectionJob
Constructs a fluent builder for the StartSentimentDetectionJob operation.
- The fluent builder is configurable:
input_data_config(InputDataConfig)/set_input_data_config(Option<InputDataConfig>):Specifies the format and location of the input data for the job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Specifies where to send the output files.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
job_name(impl Into<String>)/set_job_name(Option<String>):The identifier of the job.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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>):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>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
vpc_config(VpcConfig)/set_vpc_config(Option<VpcConfig>):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(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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
StartSentimentDetectionJobOutputwith 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 AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_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>
sourcepub fn start_targeted_sentiment_detection_job(
&self
) -> StartTargetedSentimentDetectionJob
pub fn start_targeted_sentiment_detection_job(
&self
) -> StartTargetedSentimentDetectionJob
Constructs a fluent builder for the StartTargetedSentimentDetectionJob operation.
- The fluent builder is configurable:
input_data_config(InputDataConfig)/set_input_data_config(Option<InputDataConfig>):The input properties for an inference job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Specifies where to send the output files.
data_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (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>):The identifier of the job.
language_code(LanguageCode)/set_language_code(Option<LanguageCode>):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>):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>):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>):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(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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
StartTargetedSentimentDetectionJobOutputwith 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 targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_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<StartTargetedSentimentDetectionJobError>
sourcepub fn start_topics_detection_job(&self) -> StartTopicsDetectionJob
pub fn start_topics_detection_job(&self) -> StartTopicsDetectionJob
Constructs a fluent builder for the StartTopicsDetectionJob operation.
- The fluent builder is configurable:
input_data_config(InputDataConfig)/set_input_data_config(Option<InputDataConfig>):Specifies the format and location of the input data for the job.
output_data_config(OutputDataConfig)/set_output_data_config(Option<OutputDataConfig>):Specifies where to send the output files. The output is a compressed archive with two files,
topic-terms.csvthat lists the terms associated with each topic, anddoc-topics.csvthat lists the documents associated with each topicdata_access_role_arn(impl Into<String>)/set_data_access_role_arn(Option<String>):The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
job_name(impl Into<String>)/set_job_name(Option<String>):The identifier of the job.
number_of_topics(i32)/set_number_of_topics(Option<i32>):The number of topics to detect.
client_request_token(impl Into<String>)/set_client_request_token(Option<String>):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>):ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
“1234abcd-12ab-34cd-56ef-1234567890ab” -
Amazon Resource Name (ARN) of a KMS Key:
“arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab”
-
vpc_config(VpcConfig)/set_vpc_config(Option<VpcConfig>):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(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags to be associated 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
StartTopicsDetectionJobOutputwith field(s):job_id(Option<String>):The identifier generated for the job. To get the status of the job, use this identifier with the
DescribeTopicDetectionJoboperation.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 AWS account, 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/1234abcd12ab34cd56ef1234567890abjob_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
DescribeTopicDetectionJoboperation.
-
- On failure, responds with
SdkError<StartTopicsDetectionJobError>
sourcepub fn stop_dominant_language_detection_job(
&self
) -> StopDominantLanguageDetectionJob
pub fn stop_dominant_language_detection_job(
&self
) -> StopDominantLanguageDetectionJob
Constructs a fluent builder for the StopDominantLanguageDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier of the dominant language detection job to stop.
- On success, responds with
StopDominantLanguageDetectionJobOutputwith field(s):job_id(Option<String>):The identifier of the dominant language detection job to stop.
job_status(Option<JobStatus>):Either
STOP_REQUESTEDif the job is currently running, orSTOPPEDif the job was previously stopped with theStopDominantLanguageDetectionJoboperation.
- On failure, responds with
SdkError<StopDominantLanguageDetectionJobError>
sourcepub fn stop_entities_detection_job(&self) -> StopEntitiesDetectionJob
pub fn stop_entities_detection_job(&self) -> StopEntitiesDetectionJob
Constructs a fluent builder for the StopEntitiesDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier of the entities detection job to stop.
- On success, responds with
StopEntitiesDetectionJobOutputwith field(s):job_id(Option<String>):The identifier of the entities detection job to stop.
job_status(Option<JobStatus>):Either
STOP_REQUESTEDif the job is currently running, orSTOPPEDif the job was previously stopped with theStopEntitiesDetectionJoboperation.
- On failure, responds with
SdkError<StopEntitiesDetectionJobError>
sourcepub fn stop_events_detection_job(&self) -> StopEventsDetectionJob
pub fn stop_events_detection_job(&self) -> StopEventsDetectionJob
Constructs a fluent builder for the StopEventsDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier of the events detection job to stop.
- On success, responds with
StopEventsDetectionJobOutputwith 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>
sourcepub fn stop_key_phrases_detection_job(&self) -> StopKeyPhrasesDetectionJob
pub fn stop_key_phrases_detection_job(&self) -> StopKeyPhrasesDetectionJob
Constructs a fluent builder for the StopKeyPhrasesDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier of the key phrases detection job to stop.
- On success, responds with
StopKeyPhrasesDetectionJobOutputwith field(s):job_id(Option<String>):The identifier of the key phrases detection job to stop.
job_status(Option<JobStatus>):Either
STOP_REQUESTEDif the job is currently running, orSTOPPEDif the job was previously stopped with theStopKeyPhrasesDetectionJoboperation.
- On failure, responds with
SdkError<StopKeyPhrasesDetectionJobError>
sourcepub fn stop_pii_entities_detection_job(&self) -> StopPiiEntitiesDetectionJob
pub fn stop_pii_entities_detection_job(&self) -> StopPiiEntitiesDetectionJob
Constructs a fluent builder for the StopPiiEntitiesDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier of the PII entities detection job to stop.
- On success, responds with
StopPiiEntitiesDetectionJobOutputwith 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>
sourcepub fn stop_sentiment_detection_job(&self) -> StopSentimentDetectionJob
pub fn stop_sentiment_detection_job(&self) -> StopSentimentDetectionJob
Constructs a fluent builder for the StopSentimentDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier of the sentiment detection job to stop.
- On success, responds with
StopSentimentDetectionJobOutputwith field(s):job_id(Option<String>):The identifier of the sentiment detection job to stop.
job_status(Option<JobStatus>):Either
STOP_REQUESTEDif the job is currently running, orSTOPPEDif the job was previously stopped with theStopSentimentDetectionJoboperation.
- On failure, responds with
SdkError<StopSentimentDetectionJobError>
sourcepub fn stop_targeted_sentiment_detection_job(
&self
) -> StopTargetedSentimentDetectionJob
pub fn stop_targeted_sentiment_detection_job(
&self
) -> StopTargetedSentimentDetectionJob
Constructs a fluent builder for the StopTargetedSentimentDetectionJob operation.
- The fluent builder is configurable:
job_id(impl Into<String>)/set_job_id(Option<String>):The identifier of the targeted sentiment detection job to stop.
- On success, responds with
StopTargetedSentimentDetectionJobOutputwith field(s):job_id(Option<String>):The identifier of the targeted sentiment detection job to stop.
job_status(Option<JobStatus>):Either
STOP_REQUESTEDif the job is currently running, orSTOPPEDif the job was previously stopped with theStopSentimentDetectionJoboperation.
- On failure, responds with
SdkError<StopTargetedSentimentDetectionJobError>
sourcepub fn stop_training_document_classifier(
&self
) -> StopTrainingDocumentClassifier
pub fn stop_training_document_classifier(
&self
) -> StopTrainingDocumentClassifier
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>):The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
- On success, responds with
StopTrainingDocumentClassifierOutput - On failure, responds with
SdkError<StopTrainingDocumentClassifierError>
sourcepub fn stop_training_entity_recognizer(&self) -> StopTrainingEntityRecognizer
pub fn stop_training_entity_recognizer(&self) -> StopTrainingEntityRecognizer
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>):The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.
- On success, responds with
StopTrainingEntityRecognizerOutput - On failure, responds with
SdkError<StopTrainingEntityRecognizerError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):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>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.
tag_keys(Vec<String>)/set_tag_keys(Option<Vec<String>>):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>
sourcepub fn update_endpoint(&self) -> UpdateEndpoint
pub fn update_endpoint(&self) -> UpdateEndpoint
Constructs a fluent builder for the UpdateEndpoint operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)/set_endpoint_arn(Option<String>):The Amazon Resource Number (ARN) of the endpoint being updated.
desired_model_arn(impl Into<String>)/set_desired_model_arn(Option<String>):The ARN of the new model to use when updating an existing endpoint.
desired_inference_units(i32)/set_desired_inference_units(Option<i32>):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>):Data access role ARN to use in case the new model is encrypted with a customer CMK.
- On success, responds with
UpdateEndpointOutput - On failure, responds with
SdkError<UpdateEndpointError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more