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

Client for AWS Comprehend Medical

Client for invoking operations on AWS Comprehend Medical. Each operation on AWS Comprehend Medical 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_comprehendmedical::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_comprehendmedical::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_comprehendmedical::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the DescribeEntitiesDetectionV2Job operation.

Constructs a fluent builder for the DescribeICD10CMInferenceJob operation.

Constructs a fluent builder for the DescribePHIDetectionJob operation.

Constructs a fluent builder for the DescribeRxNormInferenceJob operation.

Constructs a fluent builder for the DescribeSNOMEDCTInferenceJob operation.

Constructs a fluent builder for the DetectEntities operation.

  • The fluent builder is configurable:
  • On success, responds with DetectEntitiesOutput with field(s):
    • entities(Option<Vec<Entity>>):

      The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical; has in the detection and analysis. Attributes and traits of the entity are also returned.

    • unmapped_attributes(Option<Vec<UnmappedAttribute>>):

      Attributes extracted from the input text that we were unable to relate to an entity.

    • pagination_token(Option<String>):

      If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.

    • model_version(Option<String>):

      The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

  • On failure, responds with SdkError<DetectEntitiesError>

Constructs a fluent builder for the DetectEntitiesV2 operation.

  • The fluent builder is configurable:
  • On success, responds with DetectEntitiesV2Output with field(s):
    • entities(Option<Vec<Entity>>):

      The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

    • unmapped_attributes(Option<Vec<UnmappedAttribute>>):

      Attributes extracted from the input text that couldn’t be related to an entity.

    • pagination_token(Option<String>):

      If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

    • model_version(Option<String>):

      The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

  • On failure, responds with SdkError<DetectEntitiesV2Error>

Constructs a fluent builder for the DetectPHI operation.

  • The fluent builder is configurable:
  • On success, responds with DetectPhiOutput with field(s):
    • entities(Option<Vec<Entity>>):

      The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical; has in its detection.

    • pagination_token(Option<String>):

      If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.

    • model_version(Option<String>):

      The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

  • On failure, responds with SdkError<DetectPHIError>

Constructs a fluent builder for the InferICD10CM operation.

Constructs a fluent builder for the InferRxNorm operation.

Constructs a fluent builder for the InferSNOMEDCT operation.

Constructs a fluent builder for the ListEntitiesDetectionV2Jobs operation.

Constructs a fluent builder for the ListICD10CMInferenceJobs operation.

Constructs a fluent builder for the ListPHIDetectionJobs operation.

Constructs a fluent builder for the ListRxNormInferenceJobs operation.

Constructs a fluent builder for the ListSNOMEDCTInferenceJobs operation.

Constructs a fluent builder for the StartEntitiesDetectionV2Job operation.

Constructs a fluent builder for the StartICD10CMInferenceJob operation.

Constructs a fluent builder for the StartPHIDetectionJob operation.

Constructs a fluent builder for the StartRxNormInferenceJob operation.

Constructs a fluent builder for the StartSNOMEDCTInferenceJob operation.

Constructs a fluent builder for the StopEntitiesDetectionV2Job operation.

Constructs a fluent builder for the StopICD10CMInferenceJob operation.

Constructs a fluent builder for the StopPHIDetectionJob operation.

Constructs a fluent builder for the StopRxNormInferenceJob operation.

Constructs a fluent builder for the StopSNOMEDCTInferenceJob operation.

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

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more