Struct aws_sdk_comprehendmedical::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

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

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

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

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

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

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

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

Using the Client

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

let result = client.describe_entities_detection_v2_job()
    .job_id("example")
    .send()
    .await;

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

Implementations

impl Client

pub fn describe_entities_detection_v2_job( &self ) -> DescribeEntitiesDetectionV2JobFluentBuilder

Constructs a fluent builder for the DescribeEntitiesDetectionV2Job operation.

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

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

    
    
• On success, responds with DescribeEntitiesDetectionV2JobOutput with field(s):
  • comprehend_medical_async_job_properties(Option<ComprehendMedicalAsyncJobProperties>):

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

• On failure, responds with SdkError<DescribeEntitiesDetectionV2JobError>

impl Client

pub fn describe_icd10_cm_inference_job( &self ) -> DescribeICD10CMInferenceJobFluentBuilder

Constructs a fluent builder for the DescribeICD10CMInferenceJob operation.

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

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

    
    
• On success, responds with DescribeIcd10CmInferenceJobOutput with field(s):
  • comprehend_medical_async_job_properties(Option<ComprehendMedicalAsyncJobProperties>):

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

• On failure, responds with SdkError<DescribeICD10CMInferenceJobError>

impl Client

pub fn describe_phi_detection_job(&self) -> DescribePHIDetectionJobFluentBuilder

Constructs a fluent builder for the DescribePHIDetectionJob operation.

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

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

    
    
• On success, responds with DescribePhiDetectionJobOutput with field(s):
  • comprehend_medical_async_job_properties(Option<ComprehendMedicalAsyncJobProperties>):

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

• On failure, responds with SdkError<DescribePHIDetectionJobError>

impl Client

pub fn describe_rx_norm_inference_job( &self ) -> DescribeRxNormInferenceJobFluentBuilder

Constructs a fluent builder for the DescribeRxNormInferenceJob operation.

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

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

    
    
• On success, responds with DescribeRxNormInferenceJobOutput with field(s):
  • comprehend_medical_async_job_properties(Option<ComprehendMedicalAsyncJobProperties>):

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

• On failure, responds with SdkError<DescribeRxNormInferenceJobError>

impl Client

pub fn describe_snomedct_inference_job( &self ) -> DescribeSNOMEDCTInferenceJobFluentBuilder

Constructs a fluent builder for the DescribeSNOMEDCTInferenceJob operation.

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

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

    
    
• On success, responds with DescribeSnomedctInferenceJobOutput with field(s):
  • comprehend_medical_async_job_properties(Option<ComprehendMedicalAsyncJobProperties>):

    Provides information about a detection job.

• On failure, responds with SdkError<DescribeSNOMEDCTInferenceJobError>

impl Client

pub fn detect_entities(&self) -> DetectEntitiesFluentBuilder

👎Deprecated: This operation is deprecated, use DetectEntitiesV2 instead.

Constructs a fluent builder for the DetectEntities operation.

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

    A UTF-8 text string containing the clinical content being examined for entities.

    
    
• On success, responds with DetectEntitiesOutput with field(s):
  • entities(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 Amazon 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(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>

impl Client

pub fn detect_entities_v2(&self) -> DetectEntitiesV2FluentBuilder

Constructs a fluent builder for the DetectEntitiesV2 operation.

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

    A UTF-8 string containing the clinical content being examined for entities.

    
    
• On success, responds with DetectEntitiesV2Output with field(s):
  • entities(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(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>

impl Client

pub fn detect_phi(&self) -> DetectPHIFluentBuilder

Constructs a fluent builder for the DetectPHI operation.

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

    A UTF-8 text string containing the clinical content being examined for PHI entities.

    
    
• On success, responds with DetectPhiOutput with field(s):
  • entities(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 Amazon 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(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>

impl Client

pub fn infer_icd10_cm(&self) -> InferICD10CMFluentBuilder

Constructs a fluent builder for the InferICD10CM operation.

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

    The input text used for analysis.

    
    
• On success, responds with InferIcd10CmOutput with field(s):
  • entities(Vec::<Icd10CmEntity>):

    The medical conditions detected in the text linked to ICD-10-CM concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.

  • pagination_token(Option<String>):

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

  • model_version(Option<String>):

    The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

• On failure, responds with SdkError<InferICD10CMError>

impl Client

pub fn infer_rx_norm(&self) -> InferRxNormFluentBuilder

Constructs a fluent builder for the InferRxNorm operation.

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

    The input text used for analysis.

    
    
• On success, responds with InferRxNormOutput with field(s):
  • entities(Vec::<RxNormEntity>):

    The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.

  • pagination_token(Option<String>):

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

  • model_version(Option<String>):

    The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

• On failure, responds with SdkError<InferRxNormError>

impl Client

pub fn infer_snomedct(&self) -> InferSNOMEDCTFluentBuilder

Constructs a fluent builder for the InferSNOMEDCT operation.

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

    The input text to be analyzed using InferSNOMEDCT.

    
    
• On success, responds with InferSnomedctOutput with field(s):
  • entities(Vec::<SnomedctEntity>):

    The collection of medical concept 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 Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

  • pagination_token(Option<String>):

    If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.

  • model_version(Option<String>):

    The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

  • snomedct_details(Option<SnomedctDetails>):

    The details of the SNOMED-CT revision, including the edition, language, and version date.

  • characters(Option<Characters>):

    The number of characters in the input request documentation.

• On failure, responds with SdkError<InferSNOMEDCTError>

impl Client

pub fn list_entities_detection_v2_jobs( &self ) -> ListEntitiesDetectionV2JobsFluentBuilder

Constructs a fluent builder for the ListEntitiesDetectionV2Jobs operation.

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

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

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

    Identifies the next page of results to return.

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

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

    
    
• On success, responds with ListEntitiesDetectionV2JobsOutput with field(s):
  • comprehend_medical_async_job_properties_list(Option<Vec::<ComprehendMedicalAsyncJobProperties>>):

    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<ListEntitiesDetectionV2JobsError>

impl Client

pub fn list_icd10_cm_inference_jobs( &self ) -> ListICD10CMInferenceJobsFluentBuilder

Constructs a fluent builder for the ListICD10CMInferenceJobs operation.

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

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

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

    Identifies the next page of results to return.

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

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

    
    
• On success, responds with ListIcd10CmInferenceJobsOutput with field(s):
  • comprehend_medical_async_job_properties_list(Option<Vec::<ComprehendMedicalAsyncJobProperties>>):

    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<ListICD10CMInferenceJobsError>

impl Client

pub fn list_phi_detection_jobs(&self) -> ListPHIDetectionJobsFluentBuilder

Constructs a fluent builder for the ListPHIDetectionJobs operation.

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

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

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

    Identifies the next page of results to return.

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

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

    
    
• On success, responds with ListPhiDetectionJobsOutput with field(s):
  • comprehend_medical_async_job_properties_list(Option<Vec::<ComprehendMedicalAsyncJobProperties>>):

    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<ListPHIDetectionJobsError>

impl Client

pub fn list_rx_norm_inference_jobs( &self ) -> ListRxNormInferenceJobsFluentBuilder

Constructs a fluent builder for the ListRxNormInferenceJobs operation.

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

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

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

    Identifies the next page of results to return.

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

    Identifies the next page of results to return.

    
    
• On success, responds with ListRxNormInferenceJobsOutput with field(s):
  • comprehend_medical_async_job_properties_list(Option<Vec::<ComprehendMedicalAsyncJobProperties>>):

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

  • next_token(Option<String>):

    Identifies the next page of results to return.

• On failure, responds with SdkError<ListRxNormInferenceJobsError>

impl Client

pub fn list_snomedct_inference_jobs( &self ) -> ListSNOMEDCTInferenceJobsFluentBuilder

Constructs a fluent builder for the ListSNOMEDCTInferenceJobs operation.

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

    Provides information for filtering a list of detection jobs.

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

    Identifies the next page of InferSNOMEDCT results to return.

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

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

    
    
• On success, responds with ListSnomedctInferenceJobsOutput with field(s):
  • comprehend_medical_async_job_properties_list(Option<Vec::<ComprehendMedicalAsyncJobProperties>>):

    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<ListSNOMEDCTInferenceJobsError>

impl Client

pub fn start_entities_detection_v2_job( &self ) -> StartEntitiesDetectionV2JobFluentBuilder

Constructs a fluent builder for the StartEntitiesDetectionV2Job operation.

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

    The input configuration that specifies the format and location of the input data for the job.

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

    The output configuration that specifies where to send the output files.

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

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

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

    The identifier of the job.

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

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

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

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

    The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).

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

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

• On failure, responds with SdkError<StartEntitiesDetectionV2JobError>

impl Client

pub fn start_icd10_cm_inference_job( &self ) -> StartICD10CMInferenceJobFluentBuilder

Constructs a fluent builder for the StartICD10CMInferenceJob operation.

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

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

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

    Specifies where to send the output files.

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

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

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

    The identifier of the job.

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

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

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

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

    The language of the input documents. All documents must be in the same language.

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

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

• On failure, responds with SdkError<StartICD10CMInferenceJobError>

impl Client

pub fn start_phi_detection_job(&self) -> StartPHIDetectionJobFluentBuilder

Constructs a fluent builder for the StartPHIDetectionJob operation.

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

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

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

    Specifies where to send the output files.

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

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

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

    The identifier of the job.

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

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

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

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

    The language of the input documents. All documents must be in the same language.

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

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

• On failure, responds with SdkError<StartPHIDetectionJobError>

impl Client

pub fn start_rx_norm_inference_job( &self ) -> StartRxNormInferenceJobFluentBuilder

Constructs a fluent builder for the StartRxNormInferenceJob operation.

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

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

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

    Specifies where to send the output files.

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

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

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

    The identifier of the job.

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

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

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

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

    The language of the input documents. All documents must be in the same language.

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

    The identifier of the job.

• On failure, responds with SdkError<StartRxNormInferenceJobError>

impl Client

pub fn start_snomedct_inference_job( &self ) -> StartSNOMEDCTInferenceJobFluentBuilder

Constructs a fluent builder for the StartSNOMEDCTInferenceJob operation.

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

    The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed.

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

    The output properties for a detection job.

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

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

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

    The user generated name the asynchronous InferSNOMEDCT job.

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

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

    
    
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):
    required: false
    

    An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.

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

    The language of the input documents. All documents must be in the same language.

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

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

• On failure, responds with SdkError<StartSNOMEDCTInferenceJobError>

impl Client

pub fn stop_entities_detection_v2_job( &self ) -> StopEntitiesDetectionV2JobFluentBuilder

Constructs a fluent builder for the StopEntitiesDetectionV2Job operation.

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

    The identifier of the medical entities job to stop.

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

    The identifier of the medical entities detection job that was stopped.

• On failure, responds with SdkError<StopEntitiesDetectionV2JobError>

impl Client

pub fn stop_icd10_cm_inference_job( &self ) -> StopICD10CMInferenceJobFluentBuilder

Constructs a fluent builder for the StopICD10CMInferenceJob operation.

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

    The identifier of the job.

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

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

• On failure, responds with SdkError<StopICD10CMInferenceJobError>

impl Client

pub fn stop_phi_detection_job(&self) -> StopPHIDetectionJobFluentBuilder

Constructs a fluent builder for the StopPHIDetectionJob operation.

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

    The identifier of the PHI detection job to stop.

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

    The identifier of the PHI detection job that was stopped.

• On failure, responds with SdkError<StopPHIDetectionJobError>

impl Client

pub fn stop_rx_norm_inference_job(&self) -> StopRxNormInferenceJobFluentBuilder

Constructs a fluent builder for the StopRxNormInferenceJob operation.

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

    The identifier of the job.

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

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

• On failure, responds with SdkError<StopRxNormInferenceJobError>

impl Client

pub fn stop_snomedct_inference_job( &self ) -> StopSNOMEDCTInferenceJobFluentBuilder

Constructs a fluent builder for the StopSNOMEDCTInferenceJob operation.

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

    The job id of the asynchronous InferSNOMEDCT job to be stopped.

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

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

• On failure, responds with SdkError<StopSNOMEDCTInferenceJobError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

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

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

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

Creates a new client from an SDK Config.

Panics

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.