@aws-sdk/client-comprehendmedical

Description

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

<p>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 <a href="https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html">Guidelines and quotas</a> in the <i>Amazon Comprehend Medical Developer Guide</i>.</p>

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-comprehendmedical
yarn add @aws-sdk/client-comprehendmedical
pnpm add @aws-sdk/client-comprehendmedical

Getting Started

Import

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:

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

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

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new ComprehendMedicalClient({ region: "REGION" });

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

Supported Message Protocols

This client supports multiple protocols.

The default for this client is AWS JSON (RPC) 1.1.

We have selected this default based on our evaluation of the performance characteristics of this protocol format in JavaScript. You don't need to change it, but you have the option to do so, for example to support existing integrations or tests. Selecting a non-default protocol changes the format of the data sent over the network, but does not affect how you interact with the client using JavaScript objects.

Install the @aws-sdk/config package to access alternate protocols.

See AWS Protocols for more information.

AWS JSON (RPC) 1.1

This protocol uses JSON payloads.

import { AwsJson1_1Protocol } from "@aws-sdk/config/protocol";

const client = new ComprehendMedicalClient({
  protocol: AwsJson1_1Protocol
});

Smithy RPC v2 CBOR

This protocol uses CBOR payloads.

import { AwsSmithyRpcV2CborProtocol } from "@aws-sdk/config/protocol";

const client = new ComprehendMedicalClient({
  protocol: AwsSmithyRpcV2CborProtocol
});

Async/await

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

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

Promises

You can also use Promise chaining.

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

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

ComprehendMedical extends ComprehendMedicalClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (ComprehendMedicalClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { ComprehendMedical } from "@aws-sdk/client-comprehendmedical";

const client = new 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 (not recommended).
client.listPHIDetectionJobs(params, (err, data) => {
  // process err and data.
});

Troubleshooting

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

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 GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the 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)

<details> <summary> DescribeEntitiesDetectionV2Job </summary>