Struct aws_sdk_comprehend::client::Client

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

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

impl<C, M, R> Client<C, M, R>

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub fn batch_detect_dominant_language(
    &self
) -> BatchDetectDominantLanguage<C, M, R>

Constructs a fluent builder for the BatchDetectDominantLanguage operation.

See BatchDetectDominantLanguage for more information about the operation and its arguments.

pub fn batch_detect_entities(&self) -> BatchDetectEntities<C, M, R>

Constructs a fluent builder for the BatchDetectEntities operation.

See BatchDetectEntities for more information about the operation and its arguments.

pub fn batch_detect_key_phrases(&self) -> BatchDetectKeyPhrases<C, M, R>

Constructs a fluent builder for the BatchDetectKeyPhrases operation.

See BatchDetectKeyPhrases for more information about the operation and its arguments.

pub fn batch_detect_sentiment(&self) -> BatchDetectSentiment<C, M, R>

Constructs a fluent builder for the BatchDetectSentiment operation.

See BatchDetectSentiment for more information about the operation and its arguments.

pub fn batch_detect_syntax(&self) -> BatchDetectSyntax<C, M, R>

Constructs a fluent builder for the BatchDetectSyntax operation.

See BatchDetectSyntax for more information about the operation and its arguments.

pub fn classify_document(&self) -> ClassifyDocument<C, M, R>

Constructs a fluent builder for the ClassifyDocument operation.

See ClassifyDocument for more information about the operation and its arguments.

pub fn contains_pii_entities(&self) -> ContainsPiiEntities<C, M, R>

Constructs a fluent builder for the ContainsPiiEntities operation.

See ContainsPiiEntities for more information about the operation and its arguments.

pub fn create_document_classifier(&self) -> CreateDocumentClassifier<C, M, R>

Constructs a fluent builder for the CreateDocumentClassifier operation.

See CreateDocumentClassifier for more information about the operation and its arguments.

pub fn create_endpoint(&self) -> CreateEndpoint<C, M, R>

Constructs a fluent builder for the CreateEndpoint operation.

See CreateEndpoint for more information about the operation and its arguments.

pub fn create_entity_recognizer(&self) -> CreateEntityRecognizer<C, M, R>

Constructs a fluent builder for the CreateEntityRecognizer operation.

See CreateEntityRecognizer for more information about the operation and its arguments.

pub fn delete_document_classifier(&self) -> DeleteDocumentClassifier<C, M, R>

Constructs a fluent builder for the DeleteDocumentClassifier operation.

See DeleteDocumentClassifier for more information about the operation and its arguments.

pub fn delete_endpoint(&self) -> DeleteEndpoint<C, M, R>

Constructs a fluent builder for the DeleteEndpoint operation.

See DeleteEndpoint for more information about the operation and its arguments.

pub fn delete_entity_recognizer(&self) -> DeleteEntityRecognizer<C, M, R>

Constructs a fluent builder for the DeleteEntityRecognizer operation.

See DeleteEntityRecognizer for more information about the operation and its arguments.

pub fn describe_document_classification_job(
    &self
) -> DescribeDocumentClassificationJob<C, M, R>

Constructs a fluent builder for the DescribeDocumentClassificationJob operation.

See DescribeDocumentClassificationJob for more information about the operation and its arguments.

pub fn describe_document_classifier(
    &self
) -> DescribeDocumentClassifier<C, M, R>

Constructs a fluent builder for the DescribeDocumentClassifier operation.

See DescribeDocumentClassifier for more information about the operation and its arguments.

pub fn describe_dominant_language_detection_job(
    &self
) -> DescribeDominantLanguageDetectionJob<C, M, R>

Constructs a fluent builder for the DescribeDominantLanguageDetectionJob operation.

See DescribeDominantLanguageDetectionJob for more information about the operation and its arguments.

pub fn describe_endpoint(&self) -> DescribeEndpoint<C, M, R>

Constructs a fluent builder for the DescribeEndpoint operation.

See DescribeEndpoint for more information about the operation and its arguments.

pub fn describe_entities_detection_job(
    &self
) -> DescribeEntitiesDetectionJob<C, M, R>

Constructs a fluent builder for the DescribeEntitiesDetectionJob operation.

See DescribeEntitiesDetectionJob for more information about the operation and its arguments.

pub fn describe_entity_recognizer(&self) -> DescribeEntityRecognizer<C, M, R>

Constructs a fluent builder for the DescribeEntityRecognizer operation.

See DescribeEntityRecognizer for more information about the operation and its arguments.

pub fn describe_events_detection_job(
    &self
) -> DescribeEventsDetectionJob<C, M, R>

Constructs a fluent builder for the DescribeEventsDetectionJob operation.

See DescribeEventsDetectionJob for more information about the operation and its arguments.

pub fn describe_key_phrases_detection_job(
    &self
) -> DescribeKeyPhrasesDetectionJob<C, M, R>

Constructs a fluent builder for the DescribeKeyPhrasesDetectionJob operation.

See DescribeKeyPhrasesDetectionJob for more information about the operation and its arguments.

pub fn describe_pii_entities_detection_job(
    &self
) -> DescribePiiEntitiesDetectionJob<C, M, R>

Constructs a fluent builder for the DescribePiiEntitiesDetectionJob operation.

See DescribePiiEntitiesDetectionJob for more information about the operation and its arguments.

pub fn describe_sentiment_detection_job(
    &self
) -> DescribeSentimentDetectionJob<C, M, R>

Constructs a fluent builder for the DescribeSentimentDetectionJob operation.

See DescribeSentimentDetectionJob for more information about the operation and its arguments.

pub fn describe_topics_detection_job(
    &self
) -> DescribeTopicsDetectionJob<C, M, R>

Constructs a fluent builder for the DescribeTopicsDetectionJob operation.

See DescribeTopicsDetectionJob for more information about the operation and its arguments.

pub fn detect_dominant_language(&self) -> DetectDominantLanguage<C, M, R>

Constructs a fluent builder for the DetectDominantLanguage operation.

See DetectDominantLanguage for more information about the operation and its arguments.

pub fn detect_entities(&self) -> DetectEntities<C, M, R>

Constructs a fluent builder for the DetectEntities operation.

See DetectEntities for more information about the operation and its arguments.

pub fn detect_key_phrases(&self) -> DetectKeyPhrases<C, M, R>

Constructs a fluent builder for the DetectKeyPhrases operation.

See DetectKeyPhrases for more information about the operation and its arguments.

pub fn detect_pii_entities(&self) -> DetectPiiEntities<C, M, R>

Constructs a fluent builder for the DetectPiiEntities operation.

See DetectPiiEntities for more information about the operation and its arguments.

pub fn detect_sentiment(&self) -> DetectSentiment<C, M, R>

Constructs a fluent builder for the DetectSentiment operation.

See DetectSentiment for more information about the operation and its arguments.

pub fn detect_syntax(&self) -> DetectSyntax<C, M, R>

Constructs a fluent builder for the DetectSyntax operation.

See DetectSyntax for more information about the operation and its arguments.

pub fn list_document_classification_jobs(
    &self
) -> ListDocumentClassificationJobs<C, M, R>

Constructs a fluent builder for the ListDocumentClassificationJobs operation.

See ListDocumentClassificationJobs for more information about the operation and its arguments.

pub fn list_document_classifiers(&self) -> ListDocumentClassifiers<C, M, R>

Constructs a fluent builder for the ListDocumentClassifiers operation.

See ListDocumentClassifiers for more information about the operation and its arguments.

pub fn list_document_classifier_summaries(
    &self
) -> ListDocumentClassifierSummaries<C, M, R>

Constructs a fluent builder for the ListDocumentClassifierSummaries operation.

See ListDocumentClassifierSummaries for more information about the operation and its arguments.

pub fn list_dominant_language_detection_jobs(
    &self
) -> ListDominantLanguageDetectionJobs<C, M, R>

Constructs a fluent builder for the ListDominantLanguageDetectionJobs operation.

See ListDominantLanguageDetectionJobs for more information about the operation and its arguments.

pub fn list_endpoints(&self) -> ListEndpoints<C, M, R>

Constructs a fluent builder for the ListEndpoints operation.

See ListEndpoints for more information about the operation and its arguments.

pub fn list_entities_detection_jobs(&self) -> ListEntitiesDetectionJobs<C, M, R>

Constructs a fluent builder for the ListEntitiesDetectionJobs operation.

See ListEntitiesDetectionJobs for more information about the operation and its arguments.

pub fn list_entity_recognizers(&self) -> ListEntityRecognizers<C, M, R>

Constructs a fluent builder for the ListEntityRecognizers operation.

See ListEntityRecognizers for more information about the operation and its arguments.

pub fn list_entity_recognizer_summaries(
    &self
) -> ListEntityRecognizerSummaries<C, M, R>

Constructs a fluent builder for the ListEntityRecognizerSummaries operation.

See ListEntityRecognizerSummaries for more information about the operation and its arguments.

pub fn list_events_detection_jobs(&self) -> ListEventsDetectionJobs<C, M, R>

Constructs a fluent builder for the ListEventsDetectionJobs operation.

See ListEventsDetectionJobs for more information about the operation and its arguments.

pub fn list_key_phrases_detection_jobs(
    &self
) -> ListKeyPhrasesDetectionJobs<C, M, R>

Constructs a fluent builder for the ListKeyPhrasesDetectionJobs operation.

See ListKeyPhrasesDetectionJobs for more information about the operation and its arguments.

pub fn list_pii_entities_detection_jobs(
    &self
) -> ListPiiEntitiesDetectionJobs<C, M, R>

Constructs a fluent builder for the ListPiiEntitiesDetectionJobs operation.

See ListPiiEntitiesDetectionJobs for more information about the operation and its arguments.

pub fn list_sentiment_detection_jobs(
    &self
) -> ListSentimentDetectionJobs<C, M, R>

Constructs a fluent builder for the ListSentimentDetectionJobs operation.

See ListSentimentDetectionJobs for more information about the operation and its arguments.

pub fn list_tags_for_resource(&self) -> ListTagsForResource<C, M, R>

Constructs a fluent builder for the ListTagsForResource operation.

See ListTagsForResource for more information about the operation and its arguments.

pub fn list_topics_detection_jobs(&self) -> ListTopicsDetectionJobs<C, M, R>

Constructs a fluent builder for the ListTopicsDetectionJobs operation.

See ListTopicsDetectionJobs for more information about the operation and its arguments.

pub fn start_document_classification_job(
    &self
) -> StartDocumentClassificationJob<C, M, R>

Constructs a fluent builder for the StartDocumentClassificationJob operation.

See StartDocumentClassificationJob for more information about the operation and its arguments.

pub fn start_dominant_language_detection_job(
    &self
) -> StartDominantLanguageDetectionJob<C, M, R>

Constructs a fluent builder for the StartDominantLanguageDetectionJob operation.

See StartDominantLanguageDetectionJob for more information about the operation and its arguments.

pub fn start_entities_detection_job(&self) -> StartEntitiesDetectionJob<C, M, R>

Constructs a fluent builder for the StartEntitiesDetectionJob operation.

See StartEntitiesDetectionJob for more information about the operation and its arguments.

pub fn start_events_detection_job(&self) -> StartEventsDetectionJob<C, M, R>

Constructs a fluent builder for the StartEventsDetectionJob operation.

See StartEventsDetectionJob for more information about the operation and its arguments.

pub fn start_key_phrases_detection_job(
    &self
) -> StartKeyPhrasesDetectionJob<C, M, R>

Constructs a fluent builder for the StartKeyPhrasesDetectionJob operation.

See StartKeyPhrasesDetectionJob for more information about the operation and its arguments.

pub fn start_pii_entities_detection_job(
    &self
) -> StartPiiEntitiesDetectionJob<C, M, R>

Constructs a fluent builder for the StartPiiEntitiesDetectionJob operation.

See StartPiiEntitiesDetectionJob for more information about the operation and its arguments.

pub fn start_sentiment_detection_job(
    &self
) -> StartSentimentDetectionJob<C, M, R>

Constructs a fluent builder for the StartSentimentDetectionJob operation.

See StartSentimentDetectionJob for more information about the operation and its arguments.

pub fn start_topics_detection_job(&self) -> StartTopicsDetectionJob<C, M, R>

Constructs a fluent builder for the StartTopicsDetectionJob operation.

See StartTopicsDetectionJob for more information about the operation and its arguments.

pub fn stop_dominant_language_detection_job(
    &self
) -> StopDominantLanguageDetectionJob<C, M, R>

Constructs a fluent builder for the StopDominantLanguageDetectionJob operation.

See StopDominantLanguageDetectionJob for more information about the operation and its arguments.

pub fn stop_entities_detection_job(&self) -> StopEntitiesDetectionJob<C, M, R>

Constructs a fluent builder for the StopEntitiesDetectionJob operation.

See StopEntitiesDetectionJob for more information about the operation and its arguments.

pub fn stop_events_detection_job(&self) -> StopEventsDetectionJob<C, M, R>

Constructs a fluent builder for the StopEventsDetectionJob operation.

See StopEventsDetectionJob for more information about the operation and its arguments.

pub fn stop_key_phrases_detection_job(
    &self
) -> StopKeyPhrasesDetectionJob<C, M, R>

Constructs a fluent builder for the StopKeyPhrasesDetectionJob operation.

See StopKeyPhrasesDetectionJob for more information about the operation and its arguments.

pub fn stop_pii_entities_detection_job(
    &self
) -> StopPiiEntitiesDetectionJob<C, M, R>

Constructs a fluent builder for the StopPiiEntitiesDetectionJob operation.

See StopPiiEntitiesDetectionJob for more information about the operation and its arguments.

pub fn stop_sentiment_detection_job(&self) -> StopSentimentDetectionJob<C, M, R>

Constructs a fluent builder for the StopSentimentDetectionJob operation.

See StopSentimentDetectionJob for more information about the operation and its arguments.

pub fn stop_training_document_classifier(
    &self
) -> StopTrainingDocumentClassifier<C, M, R>

Constructs a fluent builder for the StopTrainingDocumentClassifier operation.

See StopTrainingDocumentClassifier for more information about the operation and its arguments.

pub fn stop_training_entity_recognizer(
    &self
) -> StopTrainingEntityRecognizer<C, M, R>

Constructs a fluent builder for the StopTrainingEntityRecognizer operation.

See StopTrainingEntityRecognizer for more information about the operation and its arguments.

pub fn tag_resource(&self) -> TagResource<C, M, R>

Constructs a fluent builder for the TagResource operation.

See TagResource for more information about the operation and its arguments.

pub fn untag_resource(&self) -> UntagResource<C, M, R>

Constructs a fluent builder for the UntagResource operation.

See UntagResource for more information about the operation and its arguments.

pub fn update_endpoint(&self) -> UpdateEndpoint<C, M, R>

Constructs a fluent builder for the UpdateEndpoint operation.

See UpdateEndpoint for more information about the operation and its arguments.

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl<C, M, R> Clone for Client<C, M, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

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

Formats the value using the given formatter.

impl<C, M, R> From<Client<C, M, R>> for Client<C, M, R>

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.