Serialized Form (AWS Java SDK for AWS Comprehend Medical 1.11.665 API)

Package com.amazonaws.services.comprehendmedical.model
- Class com.amazonaws.services.comprehendmedical.model.Attribute extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of attribute.
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
    - relationshipScore
```
Float relationshipScore
```
      The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
    - id
```
Integer id
```
      The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    - beginOffset
```
Integer beginOffset
```
      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
```
Integer endOffset
```
      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.
    - text
```
String text
```
      The segment of input text extracted as this attribute.
    - traits
```
List<E> traits
```
      Contextual information for this attribute.
- Class com.amazonaws.services.comprehendmedical.model.AWSComprehendMedicalException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehendmedical.model.ComprehendMedicalAsyncJobFilter extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      Filters on the name of the job.
    - jobStatus
```
String jobStatus
```
      Filters the list of jobs based on job status. Returns only jobs with the specified status.
    - submitTimeBefore
```
Date submitTimeBefore
```
      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.
    - submitTimeAfter
```
Date submitTimeAfter
```
      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.
- Class com.amazonaws.services.comprehendmedical.model.ComprehendMedicalAsyncJobProperties extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier assigned to the detection job.
    - jobName
```
String jobName
```
      The name that you assigned to the detection job.
    - jobStatus
```
String jobStatus
```
      The current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.
    - message
```
String message
```
      A description of the status of a job.
    - submitTime
```
Date submitTime
```
      The time that the detection job was submitted for processing.
    - endTime
```
Date endTime
```
      The time that the detection job completed.
    - expirationTime
```
Date expirationTime
```
      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
```
InputDataConfig inputDataConfig
```
      The input data configuration that you supplied when you created the detection job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      The output data configuration that you supplied when you created the detection job.
    - languageCode
```
String languageCode
```
      The language code of the input documents.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.
    - manifestFilePath
```
String manifestFilePath
```
      The path to the file that describes the results of a batch job.
    - kMSKey
```
String kMSKey
```
      The AWS Key Management Service key, if any, used to encrypt the output files.
    - modelVersion
```
String modelVersion
```
      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.
- Class com.amazonaws.services.comprehendmedical.model.DescribeEntitiesDetectionV2JobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier that Amazon Comprehend Medical generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.
- Class com.amazonaws.services.comprehendmedical.model.DescribeEntitiesDetectionV2JobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - comprehendMedicalAsyncJobProperties
```
ComprehendMedicalAsyncJobProperties comprehendMedicalAsyncJobProperties
```
      An object that contains the properties associated with a detection job.
- Class com.amazonaws.services.comprehendmedical.model.DescribePHIDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.
- Class com.amazonaws.services.comprehendmedical.model.DescribePHIDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - comprehendMedicalAsyncJobProperties
```
ComprehendMedicalAsyncJobProperties comprehendMedicalAsyncJobProperties
```
      An object that contains the properties associated with a detection job.
- Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.
- Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      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.
    - unmappedAttributes
```
List<E> unmappedAttributes
```
      Attributes extracted from the input text that we were unable to relate to an entity.
    - paginationToken
```
String paginationToken
```
      If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
    - modelVersion
```
String modelVersion
```
      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.
- Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesV2Request extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.
- Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesV2Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      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.
    - unmappedAttributes
```
List<E> unmappedAttributes
```
      Attributes extracted from the input text that couldn't be related to an entity.
    - paginationToken
```
String paginationToken
```
      If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.
    - modelVersion
```
String modelVersion
```
      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.
- Class com.amazonaws.services.comprehendmedical.model.DetectPHIRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - text
```
String text
```
      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.
- Class com.amazonaws.services.comprehendmedical.model.DetectPHIResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - entities
```
List<E> entities
```
      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.
    - paginationToken
```
String paginationToken
```
      If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
    - modelVersion
```
String modelVersion
```
      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.
- Class com.amazonaws.services.comprehendmedical.model.Entity extends Object implements Serializable
  - Serialized Fields
    - id
```
Integer id
```
      The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
    - beginOffset
```
Integer beginOffset
```
      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.
    - endOffset
```
Integer endOffset
```
      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.
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
    - text
```
String text
```
      The segment of input text extracted as this entity.
    - category
```
String category
```
      The category of the entity.
    - type
```
String type
```
      Describes the specific type of entity with category of entities.
    - traits
```
List<E> traits
```
      Contextual information for the entity
    - attributes
```
List<E> attributes
```
      The extracted attributes that relate to this entity.
- Class com.amazonaws.services.comprehendmedical.model.InputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Bucket
```
String s3Bucket
```
      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
```
String s3Key
```
      The path to the input data files in the S3 bucket.
- Class com.amazonaws.services.comprehendmedical.model.InternalServerException extends AWSComprehendMedicalException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehendmedical.model.InvalidEncodingException extends AWSComprehendMedicalException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehendmedical.model.InvalidRequestException extends AWSComprehendMedicalException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehendmedical.model.ListEntitiesDetectionV2JobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
ComprehendMedicalAsyncJobFilter filter
```
      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.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehendmedical.model.ListEntitiesDetectionV2JobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - comprehendMedicalAsyncJobPropertiesList
```
List<E> comprehendMedicalAsyncJobPropertiesList
```
      A list containing the properties of each job returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehendmedical.model.ListPHIDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filter
```
ComprehendMedicalAsyncJobFilter filter
```
      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.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in each page. The default is 100.
- Class com.amazonaws.services.comprehendmedical.model.ListPHIDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - comprehendMedicalAsyncJobPropertiesList
```
List<E> comprehendMedicalAsyncJobPropertiesList
```
      A list containing the properties of each job returned.
    - nextToken
```
String nextToken
```
      Identifies the next page of results to return.
- Class com.amazonaws.services.comprehendmedical.model.OutputDataConfig extends Object implements Serializable
  - Serialized Fields
    - s3Bucket
```
String s3Bucket
```
      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
```
String s3Key
```
      The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
- Class com.amazonaws.services.comprehendmedical.model.ResourceNotFoundException extends AWSComprehendMedicalException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehendmedical.model.ServiceUnavailableException extends AWSComprehendMedicalException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehendmedical.model.StartEntitiesDetectionV2JobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      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.
    - jobName
```
String jobName
```
      The identifier of the job.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
    - kMSKey
```
String kMSKey
```
      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
```
String languageCode
```
      The language of the input documents. All documents must be in the same language.
- Class com.amazonaws.services.comprehendmedical.model.StartEntitiesDetectionV2JobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of a job, use this identifier with the DescribeEntitiesDetectionV2Job operation.
- Class com.amazonaws.services.comprehendmedical.model.StartPHIDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - inputDataConfig
```
InputDataConfig inputDataConfig
```
      Specifies the format and location of the input data for the job.
    - outputDataConfig
```
OutputDataConfig outputDataConfig
```
      Specifies where to send the output files.
    - dataAccessRoleArn
```
String dataAccessRoleArn
```
      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.
    - jobName
```
String jobName
```
      The identifier of the job.
    - clientRequestToken
```
String clientRequestToken
```
      A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
    - kMSKey
```
String kMSKey
```
      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
```
String languageCode
```
      The language of the input documents. All documents must be in the same language.
- Class com.amazonaws.services.comprehendmedical.model.StartPHIDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier generated for the job. To get the status of a job, use this identifier with the DescribePHIDetectionJob operation.
- Class com.amazonaws.services.comprehendmedical.model.StopEntitiesDetectionV2JobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the medical entities job to stop.
- Class com.amazonaws.services.comprehendmedical.model.StopEntitiesDetectionV2JobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the medical entities detection job that was stopped.
- Class com.amazonaws.services.comprehendmedical.model.StopPHIDetectionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the PHI detection job to stop.
- Class com.amazonaws.services.comprehendmedical.model.StopPHIDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The identifier of the PHI detection job that was stopped.
- Class com.amazonaws.services.comprehendmedical.model.TextSizeLimitExceededException extends AWSComprehendMedicalException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehendmedical.model.TooManyRequestsException extends AWSComprehendMedicalException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.comprehendmedical.model.Trait extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Provides a name or contextual description about the trait.
    - score
```
Float score
```
      The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.
- Class com.amazonaws.services.comprehendmedical.model.UnmappedAttribute extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of the attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".
    - attribute
```
Attribute attribute
```
      The specific attribute that has been extracted but not mapped to an entity.
- Class com.amazonaws.services.comprehendmedical.model.ValidationException extends AWSComprehendMedicalException implements Serializable
  
  serialVersionUID:
  
  1L

Serialized Form

Package com.amazonaws.services.comprehendmedical.model

Class com.amazonaws.services.comprehendmedical.model.Attribute extends Object implements Serializable

Serialized Fields

type

score

relationshipScore

id

beginOffset

endOffset

text

traits

Class com.amazonaws.services.comprehendmedical.model.AWSComprehendMedicalException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.comprehendmedical.model.ComprehendMedicalAsyncJobFilter extends Object implements Serializable

Serialized Fields

jobName

jobStatus

submitTimeBefore

submitTimeAfter

Class com.amazonaws.services.comprehendmedical.model.ComprehendMedicalAsyncJobProperties extends Object implements Serializable

Serialized Fields

jobId

jobName

jobStatus

message

submitTime

endTime

expirationTime

inputDataConfig

outputDataConfig

languageCode

dataAccessRoleArn

manifestFilePath

kMSKey

modelVersion

Class com.amazonaws.services.comprehendmedical.model.DescribeEntitiesDetectionV2JobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

Class com.amazonaws.services.comprehendmedical.model.DescribeEntitiesDetectionV2JobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

comprehendMedicalAsyncJobProperties

Class com.amazonaws.services.comprehendmedical.model.DescribePHIDetectionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobId

Class com.amazonaws.services.comprehendmedical.model.DescribePHIDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

comprehendMedicalAsyncJobProperties

Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

entities

unmappedAttributes

paginationToken

modelVersion

Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesV2Request extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesV2Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

entities

unmappedAttributes

paginationToken

modelVersion

Class com.amazonaws.services.comprehendmedical.model.DetectPHIRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

Class com.amazonaws.services.comprehendmedical.model.DetectPHIResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

entities

paginationToken

modelVersion

Class com.amazonaws.services.comprehendmedical.model.Entity extends Object implements Serializable

Serialized Fields

id

beginOffset

endOffset

score

text