@aws-sdk/client-comprehendmedical

Description

AWS SDK for JavaScript ComprehendMedical Client for Node.js, Browser and React Native.

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, see Guidelines and quotas in the Amazon Comprehend Medical Developer Guide.

Installing

To install this package, simply type add or install @aws-sdk/client-comprehendmedical
using your favorite package manager:
- npm install @aws-sdk/client-comprehendmedical
- yarn add @aws-sdk/client-comprehendmedical
- pnpm add @aws-sdk/client-comprehendmedical

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ComprehendMedicalClient and
the commands you need, for example ListPHIDetectionJobsCommand:

``js
// ES5 example
const { ComprehendMedicalClient, ListPHIDetectionJobsCommand } = require("@aws-sdk/client-comprehendmedical");
`

`ts
// ES6+ example
import { ComprehendMedicalClient, ListPHIDetectionJobsCommand } from "@aws-sdk/client-comprehendmedical";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new ComprehendMedicalClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListPHIDetectionJobsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-comprehendmedical";
const client = new AWS.ComprehendMedical({ region: "REGION" });

// async/await.
try {
const data = await client.listPHIDetectionJobs(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listPHIDetectionJobs(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listPHIDetectionJobs(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-comprehendmedical` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

DescribeEntitiesDetectionV2Job

Command API Reference / Input / Output

DescribeICD10CMInferenceJob

Command API Reference / Input / Output

DescribePHIDetectionJob

Command API Reference / Input / Output

DescribeRxNormInferenceJob

Command API Reference / Input / Output

DescribeSNOMEDCTInferenceJob

Command API Reference / Input / Output

DetectEntities

Command API Reference / Input / Output

DetectEntitiesV2

Command API Reference / Input / Output

DetectPHI

Command API Reference / Input / Output

InferICD10CM

Command API Reference / Input / Output

InferRxNorm

Command API Reference / Input / Output

InferSNOMEDCT

Command API Reference / Input / Output

ListEntitiesDetectionV2Jobs

Command API Reference / Input / Output

ListICD10CMInferenceJobs

Command API Reference / Input / Output

ListPHIDetectionJobs

Command API Reference / Input / Output

ListRxNormInferenceJobs

Command API Reference / Input / Output

ListSNOMEDCTInferenceJobs

Command API Reference / Input / Output

StartEntitiesDetectionV2Job

Command API Reference / Input / Output

StartICD10CMInferenceJob

Command API Reference / Input / Output

StartPHIDetectionJob

Command API Reference / Input / Output

StartRxNormInferenceJob

Command API Reference / Input / Output

StartSNOMEDCTInferenceJob

Command API Reference / Input / Output

StopEntitiesDetectionV2Job

Command API Reference / Input / Output

StopICD10CMInferenceJob

Command API Reference / Input / Output

StopPHIDetectionJob

Command API Reference / Input / Output

StopRxNormInferenceJob

Command API Reference / Input / Output

StopSNOMEDCTInferenceJob

Command API Reference / Input / Output