AWS SDK for PHP 3.x

Client: Aws\ComprehendMedical\ComprehendMedicalClient

Service ID: comprehendmedical

Version: 2018-10-30

This page describes the parameters and results for the operations of the AWS Comprehend Medical (2018-10-30), and shows how to use the Aws\ComprehendMedical\ComprehendMedicalClient object to call the described operations. This documentation is specific to the 2018-10-30 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DescribeEntitiesDetectionV2Job ( array $params = [] )
Gets the properties associated with a medical entities detection job.
DescribePHIDetectionJob ( array $params = [] )
Gets the properties associated with a protected health information (PHI) detection job.
DetectEntities ( array $params = [] )
The DetectEntities operation is deprecated.
DetectEntitiesV2 ( array $params = [] )
Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.
DetectPHI ( array $params = [] )
Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.
ListEntitiesDetectionV2Jobs ( array $params = [] )
Gets a list of medical entity detection jobs that you have submitted.
ListPHIDetectionJobs ( array $params = [] )
Gets a list of protected health information (PHI) detection jobs that you have submitted.
StartEntitiesDetectionV2Job ( array $params = [] )
Starts an asynchronous medical entity detection job for a collection of documents.
StartPHIDetectionJob ( array $params = [] )
Starts an asynchronous job to detect protected health information (PHI).
StopEntitiesDetectionV2Job ( array $params = [] )
Stops a medical entities detection job in progress.
StopPHIDetectionJob ( array $params = [] )
Stops a protected health information (PHI) detection job in progress.

Operations

DescribeEntitiesDetectionV2Job

$result = $client->describeEntitiesDetectionV2Job([/* ... */]);
$promise = $client->describeEntitiesDetectionV2JobAsync([/* ... */]);

Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

Parameter Syntax

$result = $client->describeEntitiesDetectionV2Job([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

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

Result Syntax

[
    'ComprehendMedicalAsyncJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'InputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'KMSKey' => '<string>',
        'LanguageCode' => 'en',
        'ManifestFilePath' => '<string>',
        'Message' => '<string>',
        'ModelVersion' => '<string>',
        'OutputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
    ],
]

Result Details

Members

ComprehendMedicalAsyncJobProperties

Type: ComprehendMedicalAsyncJobProperties structure

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

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

DescribePHIDetectionJob

$result = $client->describePHIDetectionJob([/* ... */]);
$promise = $client->describePHIDetectionJobAsync([/* ... */]);

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

Parameter Syntax

$result = $client->describePHIDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

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

Result Syntax

[
    'ComprehendMedicalAsyncJobProperties' => [
        'DataAccessRoleArn' => '<string>',
        'EndTime' => <DateTime>,
        'ExpirationTime' => <DateTime>,
        'InputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'KMSKey' => '<string>',
        'LanguageCode' => 'en',
        'ManifestFilePath' => '<string>',
        'Message' => '<string>',
        'ModelVersion' => '<string>',
        'OutputDataConfig' => [
            'S3Bucket' => '<string>',
            'S3Key' => '<string>',
        ],
        'SubmitTime' => <DateTime>,
    ],
]

Result Details

Members

ComprehendMedicalAsyncJobProperties

Type: ComprehendMedicalAsyncJobProperties structure

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

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

DetectEntities

$result = $client->detectEntities([/* ... */]);
$promise = $client->detectEntitiesAsync([/* ... */]);

The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .

Parameter Syntax

$result = $client->detectEntities([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.

Result Syntax

[
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY',
            'EndOffset' => <integer>,
            'Id' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
    'UnmappedAttributes' => [
        [
            'Attribute' => [
                'BeginOffset' => <integer>,
                'EndOffset' => <integer>,
                'Id' => <integer>,
                'RelationshipScore' => <float>,
                'Score' => <float>,
                'Text' => '<string>',
                'Traits' => [
                    [
                        'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
                        'Score' => <float>,
                    ],
                    // ...
                ],
                'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
            ],
            'Type' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY',
        ],
        // ...
    ],
]

Result Details

Members

Entities

Required: Yes
Type: Array of Entity structures

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.

ModelVersion

Required: Yes
Type: 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.

PaginationToken

Type: string

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

UnmappedAttributes

Type: Array of UnmappedAttribute structures

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

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
TextSizeLimitExceededException:
The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

DetectEntitiesV2

$result = $client->detectEntitiesV2([/* ... */]);
$promise = $client->detectEntitiesV2Async([/* ... */]);

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types. It does not return the Quality or Quantity entities.

Parameter Syntax

$result = $client->detectEntitiesV2([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.

Result Syntax

[
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY',
            'EndOffset' => <integer>,
            'Id' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
    'UnmappedAttributes' => [
        [
            'Attribute' => [
                'BeginOffset' => <integer>,
                'EndOffset' => <integer>,
                'Id' => <integer>,
                'RelationshipScore' => <float>,
                'Score' => <float>,
                'Text' => '<string>',
                'Traits' => [
                    [
                        'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
                        'Score' => <float>,
                    ],
                    // ...
                ],
                'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
            ],
            'Type' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY',
        ],
        // ...
    ],
]

Result Details

Members

Entities

Required: Yes
Type: Array of Entity structures

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.

ModelVersion

Required: Yes
Type: 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.

PaginationToken

Type: string

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

UnmappedAttributes

Type: Array of UnmappedAttribute structures

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

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
TextSizeLimitExceededException:
The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

DetectPHI

$result = $client->detectPHI([/* ... */]);
$promise = $client->detectPHIAsync([/* ... */]);

Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.

Parameter Syntax

$result = $client->detectPHI([
    'Text' => '<string>', // REQUIRED
]);

Parameter Details

Members

Text

Required: Yes
Type: string

A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.

Result Syntax

[
    'Entities' => [
        [
            'Attributes' => [
                [
                    'BeginOffset' => <integer>,
                    'EndOffset' => <integer>,
                    'Id' => <integer>,
                    'RelationshipScore' => <float>,
                    'Score' => <float>,
                    'Text' => '<string>',
                    'Traits' => [
                        [
                            'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
                            'Score' => <float>,
                        ],
                        // ...
                    ],
                    'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
                ],
                // ...
            ],
            'BeginOffset' => <integer>,
            'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY',
            'EndOffset' => <integer>,
            'Id' => <integer>,
            'Score' => <float>,
            'Text' => '<string>',
            'Traits' => [
                [
                    'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
                    'Score' => <float>,
                ],
                // ...
            ],
            'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
        ],
        // ...
    ],
    'ModelVersion' => '<string>',
    'PaginationToken' => '<string>',
]

Result Details

Members

Entities

Required: Yes
Type: Array of Entity structures

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.

ModelVersion

Required: Yes
Type: 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.

PaginationToken

Type: string

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

Errors

InternalServerException:
An internal server error occurred. Retry your request.
ServiceUnavailableException:
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
TextSizeLimitExceededException:
The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

ListEntitiesDetectionV2Jobs

$result = $client->listEntitiesDetectionV2Jobs([/* ... */]);
$promise = $client->listEntitiesDetectionV2JobsAsync([/* ... */]);

Gets a list of medical entity detection jobs that you have submitted.

Parameter Syntax

$result = $client->listEntitiesDetectionV2Jobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filter

Type: ComprehendMedicalAsyncJobFilter structure

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.

MaxResults

Type: int

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

NextToken

Type: string

Identifies the next page of results to return.

Result Syntax

[
    'ComprehendMedicalAsyncJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'InputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
            'KMSKey' => '<string>',
            'LanguageCode' => 'en',
            'ManifestFilePath' => '<string>',
            'Message' => '<string>',
            'ModelVersion' => '<string>',
            'OutputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComprehendMedicalAsyncJobPropertiesList

Type: Array of ComprehendMedicalAsyncJobProperties structures

A list containing the properties of each job returned.

NextToken

Type: string

Identifies the next page of results to return.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ValidationException:
The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
InternalServerException:
An internal server error occurred. Retry your request.

ListPHIDetectionJobs

$result = $client->listPHIDetectionJobs([/* ... */]);
$promise = $client->listPHIDetectionJobsAsync([/* ... */]);

Gets a list of protected health information (PHI) detection jobs that you have submitted.

Parameter Syntax

$result = $client->listPHIDetectionJobs([
    'Filter' => [
        'JobName' => '<string>',
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
        'SubmitTimeAfter' => <integer || string || DateTime>,
        'SubmitTimeBefore' => <integer || string || DateTime>,
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filter

Type: ComprehendMedicalAsyncJobFilter structure

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.

MaxResults

Type: int

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

NextToken

Type: string

Identifies the next page of results to return.

Result Syntax

[
    'ComprehendMedicalAsyncJobPropertiesList' => [
        [
            'DataAccessRoleArn' => '<string>',
            'EndTime' => <DateTime>,
            'ExpirationTime' => <DateTime>,
            'InputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|PARTIAL_SUCCESS|FAILED|STOP_REQUESTED|STOPPED',
            'KMSKey' => '<string>',
            'LanguageCode' => 'en',
            'ManifestFilePath' => '<string>',
            'Message' => '<string>',
            'ModelVersion' => '<string>',
            'OutputDataConfig' => [
                'S3Bucket' => '<string>',
                'S3Key' => '<string>',
            ],
            'SubmitTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ComprehendMedicalAsyncJobPropertiesList

Type: Array of ComprehendMedicalAsyncJobProperties structures

A list containing the properties of each job returned.

NextToken

Type: string

Identifies the next page of results to return.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ValidationException:
The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
InternalServerException:
An internal server error occurred. Retry your request.

StartEntitiesDetectionV2Job

$result = $client->startEntitiesDetectionV2Job([/* ... */]);
$promise = $client->startEntitiesDetectionV2JobAsync([/* ... */]);

Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.

Parameter Syntax

$result = $client->startEntitiesDetectionV2Job([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'JobName' => '<string>',
    'KMSKey' => '<string>',
    'LanguageCode' => 'en', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

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

DataAccessRoleArn

Required: Yes
Type: string

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.

InputDataConfig

Required: Yes
Type: InputDataConfig structure

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

JobName

Type: string

The identifier of the job.

KMSKey

Type: string

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.

LanguageCode

Required: Yes
Type: string

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

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

Specifies where to send the output files.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

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

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StartPHIDetectionJob

$result = $client->startPHIDetectionJob([/* ... */]);
$promise = $client->startPHIDetectionJobAsync([/* ... */]);

Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.

Parameter Syntax

$result = $client->startPHIDetectionJob([
    'ClientRequestToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
    'JobName' => '<string>',
    'KMSKey' => '<string>',
    'LanguageCode' => 'en', // REQUIRED
    'OutputDataConfig' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members

ClientRequestToken

Type: string

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

DataAccessRoleArn

Required: Yes
Type: string

InputDataConfig

Required: Yes
Type: InputDataConfig structure

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

JobName

Type: string

The identifier of the job.

KMSKey

Type: string

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.

LanguageCode

Required: Yes
Type: string

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

OutputDataConfig

Required: Yes
Type: OutputDataConfig structure

Specifies where to send the output files.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

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

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StopEntitiesDetectionV2Job

$result = $client->stopEntitiesDetectionV2Job([/* ... */]);
$promise = $client->stopEntitiesDetectionV2JobAsync([/* ... */]);

Stops a medical entities detection job in progress.

Parameter Syntax

$result = $client->stopEntitiesDetectionV2Job([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier of the medical entities job to stop.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

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

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

StopPHIDetectionJob

$result = $client->stopPHIDetectionJob([/* ... */]);
$promise = $client->stopPHIDetectionJobAsync([/* ... */]);

Stops a protected health information (PHI) detection job in progress.

Parameter Syntax

$result = $client->stopPHIDetectionJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

JobId

Required: Yes
Type: string

The identifier of the PHI detection job to stop.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members

JobId

Type: string

The identifier of the PHI detection job that was stopped.

Errors

InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
ResourceNotFoundException:
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
InternalServerException:
An internal server error occurred. Retry your request.

Shapes

Attribute

Description

An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

Members

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

RelationshipScore

Type: float

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

Text

Type: string

The segment of input text extracted as this attribute.

Traits

Type: Array of Trait structures

Contextual information for this attribute.

Type

Type: string

The type of attribute.

ComprehendMedicalAsyncJobFilter

Description

Provides information for filtering a list of detection jobs.

Members

JobName

Type: string

Filters on the name of the job.

JobStatus

Type: string

Filters the list of jobs based on job status. Returns only jobs with the specified status.

SubmitTimeAfter

Type: timestamp (string|DateTime or anything parsable by strtotime)

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

SubmitTimeBefore

Type: timestamp (string|DateTime or anything parsable by strtotime)

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

ComprehendMedicalAsyncJobProperties

Description

Provides information about a detection job.

Members

DataAccessRoleArn

Type: string

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the detection job completed.

ExpirationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

InputDataConfig

Type: InputDataConfig structure

The input data configuration that you supplied when you created the detection job.

JobId

Type: string

The identifier assigned to the detection job.

JobName

Type: string

The name that you assigned to the detection job.

JobStatus

Type: string

The current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.

KMSKey

Type: string

The AWS Key Management Service key, if any, used to encrypt the output files.

LanguageCode

Type: string

The language code of the input documents.

ManifestFilePath

Type: string

The path to the file that describes the results of a batch job.

Message

Type: string

A description of the status of a job.

ModelVersion

Type: 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.

OutputDataConfig

Type: OutputDataConfig structure

The output data configuration that you supplied when you created the detection job.

SubmitTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the detection job was submitted for processing.

Entity

Description

Provides information about an extracted medical entity.

Members

Attributes

Type: Array of Attribute structures

The extracted attributes that relate to this entity.

BeginOffset

Type: int

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Category

Type: string

The category of the entity.

EndOffset

Type: int

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

Id

Type: int

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

Text

Type: string

The segment of input text extracted as this entity.

Traits

Type: Array of Trait structures

Contextual information for the entity

Type

Type: string

Describes the specific type of entity with category of entities.

InputDataConfig

Description

The input properties for an entities detection job

Members

S3Bucket

Required: Yes
Type: string

The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.

Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.

S3Key

Type: string

Required: Yes
Type: string

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.

S3Key

Type: string

Type: string

Provides a name or contextual description about the trait.

Score

Type: float

The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.

UnmappedAttribute

Description

An attribute that we extracted, but were unable to relate to an entity.

Members

Attribute

Type: Attribute structure

The specific attribute that has been extracted but not mapped to an entity.

Type

Type: string

The type of the attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".

ValidationException

Description

The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.

Members

Message

Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Comprehend Medical 2018-10-30

Operation Summary

Operations

DescribeEntitiesDetectionV2Job

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribePHIDetectionJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DetectEntities

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DetectEntitiesV2

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DetectPHI

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListEntitiesDetectionV2Jobs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListPHIDetectionJobs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StartEntitiesDetectionV2Job

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StartPHIDetectionJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members