Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, seeGuidelines and quotas in theAmazon Comprehend Medical Developer Guide.

§Getting Started

Examples are available for many services and operations, check out theexamples folder in GitHub.

The SDK provides one crate per AWS service. You must addTokioas a dependency within your Rust project to execute asynchronous code. To addaws-sdk-comprehendmedical toyour project, add the following to yourCargo.toml file:

[dependencies]aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }aws-sdk-comprehendmedical = "1.64.0"tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

useaws_sdk_comprehendmedicalascomprehendmedical;#[::tokio::main]async fnmain() ->Result<(), comprehendmedical::Error> {letconfig = aws_config::load_from_env().await;letclient = aws_sdk_comprehendmedical::Client::new(&config);// ... make some calls with the clientOk(())}

See theclient documentationfor information on what calls can be made, and the inputs and outputs for each of those calls.

§Using the SDK

Until the SDK is released, we will be adding information about using the SDK to theDeveloper Guide. Feel free to suggestadditional sections for the guide by opening an issue and describing what you are trying to do.

§Getting Help

• GitHub discussions - For ideas, RFCs & general questions
• GitHub issues - For bug reports & feature requests
• Generated Docs (latest version)
• Usage examples

§Crate Organization

The entry point for most customers will beClient, which exposes one method for each APIoffered by AWS Comprehend Medical. The return value of each of these methods is a “fluent builder”,where the different inputs for that API are added by builder-style function call chaining,followed by callingsend() to get aFuture that will result ineither a successful output or aSdkError.

Some of these API inputs may be structs or enums to provide more complex structured information.These structs and enums live intypes. There are some simpler types forrepresenting data such as date times or binary blobs that live inprimitives.

All types required to configure a client via theConfig struct liveinconfig.

Theoperation module has a submodule for every API, and in each submoduleis the input, output, and error type for that API, as well as builders to construct each of those.

There is a top-levelError type that encompasses all the errors that theclient can return. Any other error type can be converted to thisError type via theFrom trait.

The other modules within this crate are not required for normal usage.