Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Waiters
- Operations
- DescribeEntitiesDetectionV2Job
- DescribePHIDetectionJob
- ListICD10CMInferenceJobs
- InferICD10CM
- InferRxNorm
- StartICD10CMInferenceJob
- StartRxNormInferenceJob
- ListPHIDetectionJobs
- DescribeICD10CMInferenceJob
- StartPHIDetectionJob
- StopEntitiesDetectionV2Job
- DescribeRxNormInferenceJob
- StopICD10CMInferenceJob
- ListEntitiesDetectionV2Jobs
- StopRxNormInferenceJob
- DetectPHI
- DetectEntitiesV2
- StopPHIDetectionJob
- StartEntitiesDetectionV2Job
- ListRxNormInferenceJobs
- Types
- AttributeName
- EntitySubType
- EntityType
- ICD10CMAttributeType
- ICD10CMEntityCategory
- ICD10CMEntityType
- ICD10CMRelationshipType
- ICD10CMTraitName
- JobStatus
- LanguageCode
- RelationshipType
- RxNormAttributeType
- RxNormEntityCategory
- RxNormEntityType
- RxNormTraitName
- Attribute
- ComprehendMedicalAsyncJobFilter
- ComprehendMedicalAsyncJobProperties
- Entity
- ICD10CMAttribute
- ICD10CMConcept
- ICD10CMEntity
- ICD10CMTrait
- InputDataConfig
- OutputDataConfig
- RxNormAttribute
- RxNormConcept
- RxNormEntity
- RxNormTrait
- Trait
- UnmappedAttribute
Derived from API version 2018-10-30
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEncodingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data DescribeEntitiesDetectionV2Job = DescribeEntitiesDetectionV2Job' Text
- newDescribeEntitiesDetectionV2Job :: Text -> DescribeEntitiesDetectionV2Job
- data DescribeEntitiesDetectionV2JobResponse = DescribeEntitiesDetectionV2JobResponse' (Maybe ComprehendMedicalAsyncJobProperties) Int
- newDescribeEntitiesDetectionV2JobResponse :: Int -> DescribeEntitiesDetectionV2JobResponse
- data DescribePHIDetectionJob = DescribePHIDetectionJob' Text
- newDescribePHIDetectionJob :: Text -> DescribePHIDetectionJob
- data DescribePHIDetectionJobResponse = DescribePHIDetectionJobResponse' (Maybe ComprehendMedicalAsyncJobProperties) Int
- newDescribePHIDetectionJobResponse :: Int -> DescribePHIDetectionJobResponse
- data ListICD10CMInferenceJobs = ListICD10CMInferenceJobs' (Maybe Text) (Maybe ComprehendMedicalAsyncJobFilter) (Maybe Natural)
- newListICD10CMInferenceJobs :: ListICD10CMInferenceJobs
- data ListICD10CMInferenceJobsResponse = ListICD10CMInferenceJobsResponse' (Maybe Text) (Maybe [ComprehendMedicalAsyncJobProperties]) Int
- newListICD10CMInferenceJobsResponse :: Int -> ListICD10CMInferenceJobsResponse
- data InferICD10CM = InferICD10CM' Text
- newInferICD10CM :: Text -> InferICD10CM
- data InferICD10CMResponse = InferICD10CMResponse' (Maybe Text) (Maybe Text) Int [ICD10CMEntity]
- newInferICD10CMResponse :: Int -> InferICD10CMResponse
- data InferRxNorm = InferRxNorm' Text
- newInferRxNorm :: Text -> InferRxNorm
- data InferRxNormResponse = InferRxNormResponse' (Maybe Text) (Maybe Text) Int [RxNormEntity]
- newInferRxNormResponse :: Int -> InferRxNormResponse
- data StartICD10CMInferenceJob = StartICD10CMInferenceJob' (Maybe Text) (Maybe Text) (Maybe Text) InputDataConfig OutputDataConfig Text LanguageCode
- newStartICD10CMInferenceJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartICD10CMInferenceJob
- data StartICD10CMInferenceJobResponse = StartICD10CMInferenceJobResponse' (Maybe Text) Int
- newStartICD10CMInferenceJobResponse :: Int -> StartICD10CMInferenceJobResponse
- data StartRxNormInferenceJob = StartRxNormInferenceJob' (Maybe Text) (Maybe Text) (Maybe Text) InputDataConfig OutputDataConfig Text LanguageCode
- newStartRxNormInferenceJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartRxNormInferenceJob
- data StartRxNormInferenceJobResponse = StartRxNormInferenceJobResponse' (Maybe Text) Int
- newStartRxNormInferenceJobResponse :: Int -> StartRxNormInferenceJobResponse
- data ListPHIDetectionJobs = ListPHIDetectionJobs' (Maybe Text) (Maybe ComprehendMedicalAsyncJobFilter) (Maybe Natural)
- newListPHIDetectionJobs :: ListPHIDetectionJobs
- data ListPHIDetectionJobsResponse = ListPHIDetectionJobsResponse' (Maybe Text) (Maybe [ComprehendMedicalAsyncJobProperties]) Int
- newListPHIDetectionJobsResponse :: Int -> ListPHIDetectionJobsResponse
- data DescribeICD10CMInferenceJob = DescribeICD10CMInferenceJob' Text
- newDescribeICD10CMInferenceJob :: Text -> DescribeICD10CMInferenceJob
- data DescribeICD10CMInferenceJobResponse = DescribeICD10CMInferenceJobResponse' (Maybe ComprehendMedicalAsyncJobProperties) Int
- newDescribeICD10CMInferenceJobResponse :: Int -> DescribeICD10CMInferenceJobResponse
- data StartPHIDetectionJob = StartPHIDetectionJob' (Maybe Text) (Maybe Text) (Maybe Text) InputDataConfig OutputDataConfig Text LanguageCode
- newStartPHIDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartPHIDetectionJob
- data StartPHIDetectionJobResponse = StartPHIDetectionJobResponse' (Maybe Text) Int
- newStartPHIDetectionJobResponse :: Int -> StartPHIDetectionJobResponse
- data StopEntitiesDetectionV2Job = StopEntitiesDetectionV2Job' Text
- newStopEntitiesDetectionV2Job :: Text -> StopEntitiesDetectionV2Job
- data StopEntitiesDetectionV2JobResponse = StopEntitiesDetectionV2JobResponse' (Maybe Text) Int
- newStopEntitiesDetectionV2JobResponse :: Int -> StopEntitiesDetectionV2JobResponse
- data DescribeRxNormInferenceJob = DescribeRxNormInferenceJob' Text
- newDescribeRxNormInferenceJob :: Text -> DescribeRxNormInferenceJob
- data DescribeRxNormInferenceJobResponse = DescribeRxNormInferenceJobResponse' (Maybe ComprehendMedicalAsyncJobProperties) Int
- newDescribeRxNormInferenceJobResponse :: Int -> DescribeRxNormInferenceJobResponse
- data StopICD10CMInferenceJob = StopICD10CMInferenceJob' Text
- newStopICD10CMInferenceJob :: Text -> StopICD10CMInferenceJob
- data StopICD10CMInferenceJobResponse = StopICD10CMInferenceJobResponse' (Maybe Text) Int
- newStopICD10CMInferenceJobResponse :: Int -> StopICD10CMInferenceJobResponse
- data ListEntitiesDetectionV2Jobs = ListEntitiesDetectionV2Jobs' (Maybe Text) (Maybe ComprehendMedicalAsyncJobFilter) (Maybe Natural)
- newListEntitiesDetectionV2Jobs :: ListEntitiesDetectionV2Jobs
- data ListEntitiesDetectionV2JobsResponse = ListEntitiesDetectionV2JobsResponse' (Maybe Text) (Maybe [ComprehendMedicalAsyncJobProperties]) Int
- newListEntitiesDetectionV2JobsResponse :: Int -> ListEntitiesDetectionV2JobsResponse
- data StopRxNormInferenceJob = StopRxNormInferenceJob' Text
- newStopRxNormInferenceJob :: Text -> StopRxNormInferenceJob
- data StopRxNormInferenceJobResponse = StopRxNormInferenceJobResponse' (Maybe Text) Int
- newStopRxNormInferenceJobResponse :: Int -> StopRxNormInferenceJobResponse
- data DetectPHI = DetectPHI' Text
- newDetectPHI :: Text -> DetectPHI
- data DetectPHIResponse = DetectPHIResponse' (Maybe Text) Int [Entity] Text
- newDetectPHIResponse :: Int -> Text -> DetectPHIResponse
- data DetectEntitiesV2 = DetectEntitiesV2' Text
- newDetectEntitiesV2 :: Text -> DetectEntitiesV2
- data DetectEntitiesV2Response = DetectEntitiesV2Response' (Maybe Text) (Maybe [UnmappedAttribute]) Int [Entity] Text
- newDetectEntitiesV2Response :: Int -> Text -> DetectEntitiesV2Response
- data StopPHIDetectionJob = StopPHIDetectionJob' Text
- newStopPHIDetectionJob :: Text -> StopPHIDetectionJob
- data StopPHIDetectionJobResponse = StopPHIDetectionJobResponse' (Maybe Text) Int
- newStopPHIDetectionJobResponse :: Int -> StopPHIDetectionJobResponse
- data StartEntitiesDetectionV2Job = StartEntitiesDetectionV2Job' (Maybe Text) (Maybe Text) (Maybe Text) InputDataConfig OutputDataConfig Text LanguageCode
- newStartEntitiesDetectionV2Job :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartEntitiesDetectionV2Job
- data StartEntitiesDetectionV2JobResponse = StartEntitiesDetectionV2JobResponse' (Maybe Text) Int
- newStartEntitiesDetectionV2JobResponse :: Int -> StartEntitiesDetectionV2JobResponse
- data ListRxNormInferenceJobs = ListRxNormInferenceJobs' (Maybe Text) (Maybe ComprehendMedicalAsyncJobFilter) (Maybe Natural)
- newListRxNormInferenceJobs :: ListRxNormInferenceJobs
- data ListRxNormInferenceJobsResponse = ListRxNormInferenceJobsResponse' (Maybe Text) (Maybe [ComprehendMedicalAsyncJobProperties]) Int
- newListRxNormInferenceJobsResponse :: Int -> ListRxNormInferenceJobsResponse
- newtype AttributeName where
- AttributeName' { }
- pattern AttributeName_DIAGNOSIS :: AttributeName
- pattern AttributeName_NEGATION :: AttributeName
- pattern AttributeName_SIGN :: AttributeName
- pattern AttributeName_SYMPTOM :: AttributeName
- newtype EntitySubType where
- EntitySubType' { }
- pattern EntitySubType_ACUITY :: EntitySubType
- pattern EntitySubType_ADDRESS :: EntitySubType
- pattern EntitySubType_AGE :: EntitySubType
- pattern EntitySubType_BRAND_NAME :: EntitySubType
- pattern EntitySubType_CONTACT_POINT :: EntitySubType
- pattern EntitySubType_DATE :: EntitySubType
- pattern EntitySubType_DIRECTION :: EntitySubType
- pattern EntitySubType_DOSAGE :: EntitySubType
- pattern EntitySubType_DURATION :: EntitySubType
- pattern EntitySubType_EMAIL :: EntitySubType
- pattern EntitySubType_FORM :: EntitySubType
- pattern EntitySubType_FREQUENCY :: EntitySubType
- pattern EntitySubType_GENERIC_NAME :: EntitySubType
- pattern EntitySubType_IDENTIFIER :: EntitySubType
- pattern EntitySubType_NAME :: EntitySubType
- pattern EntitySubType_PROCEDURE_NAME :: EntitySubType
- pattern EntitySubType_PROFESSION :: EntitySubType
- pattern EntitySubType_QUALITY :: EntitySubType
- pattern EntitySubType_QUANTITY :: EntitySubType
- pattern EntitySubType_RATE :: EntitySubType
- pattern EntitySubType_ROUTE_OR_MODE :: EntitySubType
- pattern EntitySubType_STRENGTH :: EntitySubType
- pattern EntitySubType_SYSTEM_ORGAN_SITE :: EntitySubType
- pattern EntitySubType_TEST_NAME :: EntitySubType
- pattern EntitySubType_TEST_UNITS :: EntitySubType
- pattern EntitySubType_TEST_VALUE :: EntitySubType
- pattern EntitySubType_TIME_EXPRESSION :: EntitySubType
- pattern EntitySubType_TIME_TO_DX_NAME :: EntitySubType
- pattern EntitySubType_TIME_TO_MEDICATION_NAME :: EntitySubType
- pattern EntitySubType_TIME_TO_PROCEDURE_NAME :: EntitySubType
- pattern EntitySubType_TIME_TO_TEST_NAME :: EntitySubType
- pattern EntitySubType_TIME_TO_TREATMENT_NAME :: EntitySubType
- pattern EntitySubType_TREATMENT_NAME :: EntitySubType
- pattern EntitySubType_URL :: EntitySubType
- newtype EntityType where
- EntityType' { }
- pattern EntityType_ANATOMY :: EntityType
- pattern EntityType_MEDICAL_CONDITION :: EntityType
- pattern EntityType_MEDICATION :: EntityType
- pattern EntityType_PROTECTED_HEALTH_INFORMATION :: EntityType
- pattern EntityType_TEST_TREATMENT_PROCEDURE :: EntityType
- pattern EntityType_TIME_EXPRESSION :: EntityType
- newtype ICD10CMAttributeType where
- ICD10CMAttributeType' { }
- pattern ICD10CMAttributeType_ACUITY :: ICD10CMAttributeType
- pattern ICD10CMAttributeType_DIRECTION :: ICD10CMAttributeType
- pattern ICD10CMAttributeType_QUALITY :: ICD10CMAttributeType
- pattern ICD10CMAttributeType_QUANTITY :: ICD10CMAttributeType
- pattern ICD10CMAttributeType_SYSTEM_ORGAN_SITE :: ICD10CMAttributeType
- pattern ICD10CMAttributeType_TIME_EXPRESSION :: ICD10CMAttributeType
- pattern ICD10CMAttributeType_TIME_TO_DX_NAME :: ICD10CMAttributeType
- newtype ICD10CMEntityCategory where
- newtype ICD10CMEntityType where
- newtype ICD10CMRelationshipType where
- newtype ICD10CMTraitName where
- ICD10CMTraitName' { }
- pattern ICD10CMTraitName_DIAGNOSIS :: ICD10CMTraitName
- pattern ICD10CMTraitName_NEGATION :: ICD10CMTraitName
- pattern ICD10CMTraitName_SIGN :: ICD10CMTraitName
- pattern ICD10CMTraitName_SYMPTOM :: ICD10CMTraitName
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_COMPLETED :: JobStatus
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_IN_PROGRESS :: JobStatus
- pattern JobStatus_PARTIAL_SUCCESS :: JobStatus
- pattern JobStatus_STOPPED :: JobStatus
- pattern JobStatus_STOP_REQUESTED :: JobStatus
- pattern JobStatus_SUBMITTED :: JobStatus
- newtype LanguageCode where
- LanguageCode' { }
- pattern LanguageCode_En :: LanguageCode
- newtype RelationshipType where
- RelationshipType' { }
- pattern RelationshipType_ACUITY :: RelationshipType
- pattern RelationshipType_ADMINISTERED_VIA :: RelationshipType
- pattern RelationshipType_DIRECTION :: RelationshipType
- pattern RelationshipType_DOSAGE :: RelationshipType
- pattern RelationshipType_DURATION :: RelationshipType
- pattern RelationshipType_EVERY :: RelationshipType
- pattern RelationshipType_FOR :: RelationshipType
- pattern RelationshipType_FORM :: RelationshipType
- pattern RelationshipType_FREQUENCY :: RelationshipType
- pattern RelationshipType_NEGATIVE :: RelationshipType
- pattern RelationshipType_OVERLAP :: RelationshipType
- pattern RelationshipType_RATE :: RelationshipType
- pattern RelationshipType_ROUTE_OR_MODE :: RelationshipType
- pattern RelationshipType_STRENGTH :: RelationshipType
- pattern RelationshipType_SYSTEM_ORGAN_SITE :: RelationshipType
- pattern RelationshipType_TEST_UNITS :: RelationshipType
- pattern RelationshipType_TEST_VALUE :: RelationshipType
- pattern RelationshipType_WITH_DOSAGE :: RelationshipType
- newtype RxNormAttributeType where
- RxNormAttributeType' { }
- pattern RxNormAttributeType_DOSAGE :: RxNormAttributeType
- pattern RxNormAttributeType_DURATION :: RxNormAttributeType
- pattern RxNormAttributeType_FORM :: RxNormAttributeType
- pattern RxNormAttributeType_FREQUENCY :: RxNormAttributeType
- pattern RxNormAttributeType_RATE :: RxNormAttributeType
- pattern RxNormAttributeType_ROUTE_OR_MODE :: RxNormAttributeType
- pattern RxNormAttributeType_STRENGTH :: RxNormAttributeType
- newtype RxNormEntityCategory where
- newtype RxNormEntityType where
- RxNormEntityType' { }
- pattern RxNormEntityType_BRAND_NAME :: RxNormEntityType
- pattern RxNormEntityType_GENERIC_NAME :: RxNormEntityType
- newtype RxNormTraitName where
- RxNormTraitName' { }
- pattern RxNormTraitName_NEGATION :: RxNormTraitName
- data Attribute = Attribute' (Maybe Double) (Maybe Int) (Maybe Text) (Maybe EntityType) (Maybe Double) (Maybe [Trait]) (Maybe RelationshipType) (Maybe Int) (Maybe Int) (Maybe EntitySubType)
- newAttribute :: Attribute
- data ComprehendMedicalAsyncJobFilter = ComprehendMedicalAsyncJobFilter' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe JobStatus)
- newComprehendMedicalAsyncJobFilter :: ComprehendMedicalAsyncJobFilter
- data ComprehendMedicalAsyncJobProperties = ComprehendMedicalAsyncJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newComprehendMedicalAsyncJobProperties :: ComprehendMedicalAsyncJobProperties
- data Entity = Entity' (Maybe Int) (Maybe Text) (Maybe EntityType) (Maybe Double) (Maybe [Trait]) (Maybe [Attribute]) (Maybe Int) (Maybe Int) (Maybe EntitySubType)
- newEntity :: Entity
- data ICD10CMAttribute = ICD10CMAttribute' (Maybe Double) (Maybe Int) (Maybe Text) (Maybe ICD10CMEntityType) (Maybe Double) (Maybe [ICD10CMTrait]) (Maybe ICD10CMRelationshipType) (Maybe Int) (Maybe Int) (Maybe ICD10CMAttributeType)
- newICD10CMAttribute :: ICD10CMAttribute
- data ICD10CMConcept = ICD10CMConcept' (Maybe Double) (Maybe Text) (Maybe Text)
- newICD10CMConcept :: ICD10CMConcept
- data ICD10CMEntity = ICD10CMEntity' (Maybe [ICD10CMConcept]) (Maybe Int) (Maybe Text) (Maybe ICD10CMEntityCategory) (Maybe Double) (Maybe [ICD10CMTrait]) (Maybe [ICD10CMAttribute]) (Maybe Int) (Maybe Int) (Maybe ICD10CMEntityType)
- newICD10CMEntity :: ICD10CMEntity
- data ICD10CMTrait = ICD10CMTrait' (Maybe Double) (Maybe ICD10CMTraitName)
- newICD10CMTrait :: ICD10CMTrait
- data InputDataConfig = InputDataConfig' (Maybe Text) Text
- newInputDataConfig :: Text -> InputDataConfig
- data OutputDataConfig = OutputDataConfig' (Maybe Text) Text
- newOutputDataConfig :: Text -> OutputDataConfig
- data RxNormAttribute = RxNormAttribute' (Maybe Double) (Maybe Int) (Maybe Text) (Maybe Double) (Maybe [RxNormTrait]) (Maybe Int) (Maybe Int) (Maybe RxNormAttributeType)
- newRxNormAttribute :: RxNormAttribute
- data RxNormConcept = RxNormConcept' (Maybe Double) (Maybe Text) (Maybe Text)
- newRxNormConcept :: RxNormConcept
- data RxNormEntity = RxNormEntity' (Maybe [RxNormConcept]) (Maybe Int) (Maybe Text) (Maybe RxNormEntityCategory) (Maybe Double) (Maybe [RxNormTrait]) (Maybe [RxNormAttribute]) (Maybe Int) (Maybe Int) (Maybe RxNormEntityType)
- newRxNormEntity :: RxNormEntity
- data RxNormTrait = RxNormTrait' (Maybe Double) (Maybe RxNormTraitName)
- newRxNormTrait :: RxNormTrait
- data Trait = Trait' (Maybe Double) (Maybe AttributeName)
- newTrait :: Trait
- data UnmappedAttribute = UnmappedAttribute' (Maybe Attribute) (Maybe EntityType)
- newUnmappedAttribute :: UnmappedAttribute
Service Configuration
defaultService :: Service Source #
API version 2018-10-30
of the Amazon Comprehend Medical SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ComprehendMedical
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.
InvalidRequestException
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
InvalidEncodingException
_InvalidEncodingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An internal server error occurred. Retry your request.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.
TextSizeLimitExceededException
_TextSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeEntitiesDetectionV2Job
data DescribeEntitiesDetectionV2Job Source #
See: newDescribeEntitiesDetectionV2Job
smart constructor.
Instances
newDescribeEntitiesDetectionV2Job Source #
Create a value of DescribeEntitiesDetectionV2Job
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeEntitiesDetectionV2Job'
, describeEntitiesDetectionV2Job_jobId
- The identifier that Amazon Comprehend Medical generated for the job. The
StartEntitiesDetectionV2Job
operation returns this identifier in its
response.
data DescribeEntitiesDetectionV2JobResponse Source #
See: newDescribeEntitiesDetectionV2JobResponse
smart constructor.
Instances
newDescribeEntitiesDetectionV2JobResponse Source #
Create a value of DescribeEntitiesDetectionV2JobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comprehendMedicalAsyncJobProperties:DescribeEntitiesDetectionV2JobResponse'
, describeEntitiesDetectionV2JobResponse_comprehendMedicalAsyncJobProperties
- An object that contains the properties associated with a detection job.
$sel:httpStatus:DescribeEntitiesDetectionV2JobResponse'
, describeEntitiesDetectionV2JobResponse_httpStatus
- The response's http status code.
DescribePHIDetectionJob
data DescribePHIDetectionJob Source #
See: newDescribePHIDetectionJob
smart constructor.
Instances
newDescribePHIDetectionJob Source #
Create a value of DescribePHIDetectionJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribePHIDetectionJob'
, describePHIDetectionJob_jobId
- The identifier that Amazon Comprehend Medical generated for the job. The
StartPHIDetectionJob
operation returns this identifier in its
response.
data DescribePHIDetectionJobResponse Source #
See: newDescribePHIDetectionJobResponse
smart constructor.
Instances
newDescribePHIDetectionJobResponse Source #
Create a value of DescribePHIDetectionJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comprehendMedicalAsyncJobProperties:DescribePHIDetectionJobResponse'
, describePHIDetectionJobResponse_comprehendMedicalAsyncJobProperties
- An object that contains the properties associated with a detection job.
$sel:httpStatus:DescribePHIDetectionJobResponse'
, describePHIDetectionJobResponse_httpStatus
- The response's http status code.
ListICD10CMInferenceJobs
data ListICD10CMInferenceJobs Source #
See: newListICD10CMInferenceJobs
smart constructor.
Instances
newListICD10CMInferenceJobs :: ListICD10CMInferenceJobs Source #
Create a value of ListICD10CMInferenceJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListICD10CMInferenceJobs'
, listICD10CMInferenceJobs_nextToken
- Identifies the next page of results to return.
$sel:filter':ListICD10CMInferenceJobs'
, listICD10CMInferenceJobs_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.
$sel:maxResults:ListICD10CMInferenceJobs'
, listICD10CMInferenceJobs_maxResults
- The maximum number of results to return in each page. The default is
100.
data ListICD10CMInferenceJobsResponse Source #
See: newListICD10CMInferenceJobsResponse
smart constructor.
Instances
newListICD10CMInferenceJobsResponse Source #
Create a value of ListICD10CMInferenceJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListICD10CMInferenceJobs'
, listICD10CMInferenceJobsResponse_nextToken
- Identifies the next page of results to return.
$sel:comprehendMedicalAsyncJobPropertiesList:ListICD10CMInferenceJobsResponse'
, listICD10CMInferenceJobsResponse_comprehendMedicalAsyncJobPropertiesList
- A list containing the properties of each job that is returned.
$sel:httpStatus:ListICD10CMInferenceJobsResponse'
, listICD10CMInferenceJobsResponse_httpStatus
- The response's http status code.
InferICD10CM
data InferICD10CM Source #
See: newInferICD10CM
smart constructor.
Instances
Create a value of InferICD10CM
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:InferICD10CM'
, inferICD10CM_text
- The input text used for analysis. The input for InferICD10CM is a string
from 1 to 10000 characters.
data InferICD10CMResponse Source #
See: newInferICD10CMResponse
smart constructor.
Instances
newInferICD10CMResponse Source #
Create a value of InferICD10CMResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:InferICD10CMResponse'
, inferICD10CMResponse_paginationToken
- If the result of the previous request to InferICD10CM
was truncated,
include the PaginationToken
to fetch the next page of medical
condition entities.
$sel:modelVersion:InferICD10CMResponse'
, inferICD10CMResponse_modelVersion
- The version of the model used to analyze the documents, in the format
n.n.n You can use this information to track the model used for a
particular batch of documents.
$sel:httpStatus:InferICD10CMResponse'
, inferICD10CMResponse_httpStatus
- The response's http status code.
$sel:entities:InferICD10CMResponse'
, inferICD10CMResponse_entities
- The medical conditions detected in the text linked to ICD-10-CM
concepts. If the action is successful, the service sends back an HTTP
200 response, as well as the entities detected.
InferRxNorm
data InferRxNorm Source #
See: newInferRxNorm
smart constructor.
Instances
Create a value of InferRxNorm
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:InferRxNorm'
, inferRxNorm_text
- The input text used for analysis. The input for InferRxNorm is a string
from 1 to 10000 characters.
data InferRxNormResponse Source #
See: newInferRxNormResponse
smart constructor.
Instances
newInferRxNormResponse Source #
Create a value of InferRxNormResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:InferRxNormResponse'
, inferRxNormResponse_paginationToken
- If the result of the previous request to InferRxNorm
was truncated,
include the PaginationToken
to fetch the next page of medication
entities.
$sel:modelVersion:InferRxNormResponse'
, inferRxNormResponse_modelVersion
- The version of the model used to analyze the documents, in the format
n.n.n You can use this information to track the model used for a
particular batch of documents.
$sel:httpStatus:InferRxNormResponse'
, inferRxNormResponse_httpStatus
- The response's http status code.
$sel:entities:InferRxNormResponse'
, inferRxNormResponse_entities
- The medication entities detected in the text linked to RxNorm concepts.
If the action is successful, the service sends back an HTTP 200
response, as well as the entities detected.
StartICD10CMInferenceJob
data StartICD10CMInferenceJob Source #
See: newStartICD10CMInferenceJob
smart constructor.
StartICD10CMInferenceJob' (Maybe Text) (Maybe Text) (Maybe Text) InputDataConfig OutputDataConfig Text LanguageCode |
Instances
newStartICD10CMInferenceJob Source #
Create a value of StartICD10CMInferenceJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:StartICD10CMInferenceJob'
, startICD10CMInferenceJob_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.
$sel:jobName:StartICD10CMInferenceJob'
, startICD10CMInferenceJob_jobName
- The identifier of the job.
$sel:clientRequestToken:StartICD10CMInferenceJob'
, startICD10CMInferenceJob_clientRequestToken
- A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one.
$sel:inputDataConfig:StartICD10CMInferenceJob'
, startICD10CMInferenceJob_inputDataConfig
- Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartICD10CMInferenceJob'
, startICD10CMInferenceJob_outputDataConfig
- Specifies where to send the output files.
$sel:dataAccessRoleArn:StartICD10CMInferenceJob'
, startICD10CMInferenceJob_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.
$sel:languageCode:StartICD10CMInferenceJob'
, startICD10CMInferenceJob_languageCode
- The language of the input documents. All documents must be in the same
language.
data StartICD10CMInferenceJobResponse Source #
See: newStartICD10CMInferenceJobResponse
smart constructor.
Instances
Eq StartICD10CMInferenceJobResponse Source # | |
Read StartICD10CMInferenceJobResponse Source # | |
Show StartICD10CMInferenceJobResponse Source # | |
Generic StartICD10CMInferenceJobResponse Source # | |
NFData StartICD10CMInferenceJobResponse Source # | |
Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob rnf :: StartICD10CMInferenceJobResponse -> () # | |
type Rep StartICD10CMInferenceJobResponse Source # | |
Defined in Amazonka.ComprehendMedical.StartICD10CMInferenceJob type Rep StartICD10CMInferenceJobResponse = D1 ('MetaData "StartICD10CMInferenceJobResponse" "Amazonka.ComprehendMedical.StartICD10CMInferenceJob" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "StartICD10CMInferenceJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStartICD10CMInferenceJobResponse Source #
Create a value of StartICD10CMInferenceJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartICD10CMInferenceJobResponse'
, startICD10CMInferenceJobResponse_jobId
- The identifier generated for the job. To get the status of a job, use
this identifier with the StartICD10CMInferenceJob
operation.
$sel:httpStatus:StartICD10CMInferenceJobResponse'
, startICD10CMInferenceJobResponse_httpStatus
- The response's http status code.
StartRxNormInferenceJob
data StartRxNormInferenceJob Source #
See: newStartRxNormInferenceJob
smart constructor.
StartRxNormInferenceJob' (Maybe Text) (Maybe Text) (Maybe Text) InputDataConfig OutputDataConfig Text LanguageCode |
Instances
newStartRxNormInferenceJob Source #
Create a value of StartRxNormInferenceJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:StartRxNormInferenceJob'
, startRxNormInferenceJob_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.
$sel:jobName:StartRxNormInferenceJob'
, startRxNormInferenceJob_jobName
- The identifier of the job.
$sel:clientRequestToken:StartRxNormInferenceJob'
, startRxNormInferenceJob_clientRequestToken
- A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one.
$sel:inputDataConfig:StartRxNormInferenceJob'
, startRxNormInferenceJob_inputDataConfig
- Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartRxNormInferenceJob'
, startRxNormInferenceJob_outputDataConfig
- Specifies where to send the output files.
$sel:dataAccessRoleArn:StartRxNormInferenceJob'
, startRxNormInferenceJob_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.
$sel:languageCode:StartRxNormInferenceJob'
, startRxNormInferenceJob_languageCode
- The language of the input documents. All documents must be in the same
language.
data StartRxNormInferenceJobResponse Source #
See: newStartRxNormInferenceJobResponse
smart constructor.
Instances
Eq StartRxNormInferenceJobResponse Source # | |
Read StartRxNormInferenceJobResponse Source # | |
Show StartRxNormInferenceJobResponse Source # | |
Generic StartRxNormInferenceJobResponse Source # | |
NFData StartRxNormInferenceJobResponse Source # | |
Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob rnf :: StartRxNormInferenceJobResponse -> () # | |
type Rep StartRxNormInferenceJobResponse Source # | |
Defined in Amazonka.ComprehendMedical.StartRxNormInferenceJob type Rep StartRxNormInferenceJobResponse = D1 ('MetaData "StartRxNormInferenceJobResponse" "Amazonka.ComprehendMedical.StartRxNormInferenceJob" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "StartRxNormInferenceJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStartRxNormInferenceJobResponse Source #
Create a value of StartRxNormInferenceJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartRxNormInferenceJobResponse'
, startRxNormInferenceJobResponse_jobId
- The identifier of the job.
$sel:httpStatus:StartRxNormInferenceJobResponse'
, startRxNormInferenceJobResponse_httpStatus
- The response's http status code.
ListPHIDetectionJobs
data ListPHIDetectionJobs Source #
See: newListPHIDetectionJobs
smart constructor.
Instances
newListPHIDetectionJobs :: ListPHIDetectionJobs Source #
Create a value of ListPHIDetectionJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPHIDetectionJobs'
, listPHIDetectionJobs_nextToken
- Identifies the next page of results to return.
$sel:filter':ListPHIDetectionJobs'
, listPHIDetectionJobs_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.
$sel:maxResults:ListPHIDetectionJobs'
, listPHIDetectionJobs_maxResults
- The maximum number of results to return in each page. The default is
100.
data ListPHIDetectionJobsResponse Source #
See: newListPHIDetectionJobsResponse
smart constructor.
Instances
newListPHIDetectionJobsResponse Source #
Create a value of ListPHIDetectionJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPHIDetectionJobs'
, listPHIDetectionJobsResponse_nextToken
- Identifies the next page of results to return.
$sel:comprehendMedicalAsyncJobPropertiesList:ListPHIDetectionJobsResponse'
, listPHIDetectionJobsResponse_comprehendMedicalAsyncJobPropertiesList
- A list containing the properties of each job returned.
$sel:httpStatus:ListPHIDetectionJobsResponse'
, listPHIDetectionJobsResponse_httpStatus
- The response's http status code.
DescribeICD10CMInferenceJob
data DescribeICD10CMInferenceJob Source #
See: newDescribeICD10CMInferenceJob
smart constructor.
Instances
newDescribeICD10CMInferenceJob Source #
Create a value of DescribeICD10CMInferenceJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeICD10CMInferenceJob'
, describeICD10CMInferenceJob_jobId
- The identifier that Amazon Comprehend Medical generated for the job.
The StartICD10CMInferenceJob
operation returns this identifier in its
response.
data DescribeICD10CMInferenceJobResponse Source #
See: newDescribeICD10CMInferenceJobResponse
smart constructor.
Instances
newDescribeICD10CMInferenceJobResponse Source #
Create a value of DescribeICD10CMInferenceJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comprehendMedicalAsyncJobProperties:DescribeICD10CMInferenceJobResponse'
, describeICD10CMInferenceJobResponse_comprehendMedicalAsyncJobProperties
- An object that contains the properties associated with a detection job.
$sel:httpStatus:DescribeICD10CMInferenceJobResponse'
, describeICD10CMInferenceJobResponse_httpStatus
- The response's http status code.
StartPHIDetectionJob
data StartPHIDetectionJob Source #
See: newStartPHIDetectionJob
smart constructor.
StartPHIDetectionJob' (Maybe Text) (Maybe Text) (Maybe Text) InputDataConfig OutputDataConfig Text LanguageCode |
Instances
newStartPHIDetectionJob Source #
Create a value of StartPHIDetectionJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:StartPHIDetectionJob'
, startPHIDetectionJob_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.
$sel:jobName:StartPHIDetectionJob'
, startPHIDetectionJob_jobName
- The identifier of the job.
$sel:clientRequestToken:StartPHIDetectionJob'
, startPHIDetectionJob_clientRequestToken
- A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one.
$sel:inputDataConfig:StartPHIDetectionJob'
, startPHIDetectionJob_inputDataConfig
- Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartPHIDetectionJob'
, startPHIDetectionJob_outputDataConfig
- Specifies where to send the output files.
$sel:dataAccessRoleArn:StartPHIDetectionJob'
, startPHIDetectionJob_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.
$sel:languageCode:StartPHIDetectionJob'
, startPHIDetectionJob_languageCode
- The language of the input documents. All documents must be in the same
language.
data StartPHIDetectionJobResponse Source #
See: newStartPHIDetectionJobResponse
smart constructor.
Instances
newStartPHIDetectionJobResponse Source #
Create a value of StartPHIDetectionJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartPHIDetectionJobResponse'
, startPHIDetectionJobResponse_jobId
- The identifier generated for the job. To get the status of a job, use
this identifier with the DescribePHIDetectionJob
operation.
$sel:httpStatus:StartPHIDetectionJobResponse'
, startPHIDetectionJobResponse_httpStatus
- The response's http status code.
StopEntitiesDetectionV2Job
data StopEntitiesDetectionV2Job Source #
See: newStopEntitiesDetectionV2Job
smart constructor.
Instances
newStopEntitiesDetectionV2Job Source #
Create a value of StopEntitiesDetectionV2Job
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopEntitiesDetectionV2Job'
, stopEntitiesDetectionV2Job_jobId
- The identifier of the medical entities job to stop.
data StopEntitiesDetectionV2JobResponse Source #
See: newStopEntitiesDetectionV2JobResponse
smart constructor.
Instances
newStopEntitiesDetectionV2JobResponse Source #
Create a value of StopEntitiesDetectionV2JobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopEntitiesDetectionV2Job'
, stopEntitiesDetectionV2JobResponse_jobId
- The identifier of the medical entities detection job that was stopped.
$sel:httpStatus:StopEntitiesDetectionV2JobResponse'
, stopEntitiesDetectionV2JobResponse_httpStatus
- The response's http status code.
DescribeRxNormInferenceJob
data DescribeRxNormInferenceJob Source #
See: newDescribeRxNormInferenceJob
smart constructor.
Instances
newDescribeRxNormInferenceJob Source #
Create a value of DescribeRxNormInferenceJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:DescribeRxNormInferenceJob'
, describeRxNormInferenceJob_jobId
- The identifier that Amazon Comprehend Medical generated for the job. The
StartRxNormInferenceJob operation returns this identifier in its
response.
data DescribeRxNormInferenceJobResponse Source #
See: newDescribeRxNormInferenceJobResponse
smart constructor.
Instances
newDescribeRxNormInferenceJobResponse Source #
Create a value of DescribeRxNormInferenceJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comprehendMedicalAsyncJobProperties:DescribeRxNormInferenceJobResponse'
, describeRxNormInferenceJobResponse_comprehendMedicalAsyncJobProperties
- An object that contains the properties associated with a detection job.
$sel:httpStatus:DescribeRxNormInferenceJobResponse'
, describeRxNormInferenceJobResponse_httpStatus
- The response's http status code.
StopICD10CMInferenceJob
data StopICD10CMInferenceJob Source #
See: newStopICD10CMInferenceJob
smart constructor.
Instances
newStopICD10CMInferenceJob Source #
Create a value of StopICD10CMInferenceJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopICD10CMInferenceJob'
, stopICD10CMInferenceJob_jobId
- The identifier of the job.
data StopICD10CMInferenceJobResponse Source #
See: newStopICD10CMInferenceJobResponse
smart constructor.
Instances
Eq StopICD10CMInferenceJobResponse Source # | |
Read StopICD10CMInferenceJobResponse Source # | |
Show StopICD10CMInferenceJobResponse Source # | |
Generic StopICD10CMInferenceJobResponse Source # | |
NFData StopICD10CMInferenceJobResponse Source # | |
Defined in Amazonka.ComprehendMedical.StopICD10CMInferenceJob rnf :: StopICD10CMInferenceJobResponse -> () # | |
type Rep StopICD10CMInferenceJobResponse Source # | |
Defined in Amazonka.ComprehendMedical.StopICD10CMInferenceJob type Rep StopICD10CMInferenceJobResponse = D1 ('MetaData "StopICD10CMInferenceJobResponse" "Amazonka.ComprehendMedical.StopICD10CMInferenceJob" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "StopICD10CMInferenceJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStopICD10CMInferenceJobResponse Source #
Create a value of StopICD10CMInferenceJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopICD10CMInferenceJob'
, stopICD10CMInferenceJobResponse_jobId
- The identifier generated for the job. To get the status of job, use this
identifier with the DescribeICD10CMInferenceJob
operation.
$sel:httpStatus:StopICD10CMInferenceJobResponse'
, stopICD10CMInferenceJobResponse_httpStatus
- The response's http status code.
ListEntitiesDetectionV2Jobs
data ListEntitiesDetectionV2Jobs Source #
See: newListEntitiesDetectionV2Jobs
smart constructor.
Instances
newListEntitiesDetectionV2Jobs :: ListEntitiesDetectionV2Jobs Source #
Create a value of ListEntitiesDetectionV2Jobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEntitiesDetectionV2Jobs'
, listEntitiesDetectionV2Jobs_nextToken
- Identifies the next page of results to return.
$sel:filter':ListEntitiesDetectionV2Jobs'
, listEntitiesDetectionV2Jobs_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.
$sel:maxResults:ListEntitiesDetectionV2Jobs'
, listEntitiesDetectionV2Jobs_maxResults
- The maximum number of results to return in each page. The default is
100.
data ListEntitiesDetectionV2JobsResponse Source #
See: newListEntitiesDetectionV2JobsResponse
smart constructor.
Instances
newListEntitiesDetectionV2JobsResponse Source #
Create a value of ListEntitiesDetectionV2JobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListEntitiesDetectionV2Jobs'
, listEntitiesDetectionV2JobsResponse_nextToken
- Identifies the next page of results to return.
$sel:comprehendMedicalAsyncJobPropertiesList:ListEntitiesDetectionV2JobsResponse'
, listEntitiesDetectionV2JobsResponse_comprehendMedicalAsyncJobPropertiesList
- A list containing the properties of each job returned.
$sel:httpStatus:ListEntitiesDetectionV2JobsResponse'
, listEntitiesDetectionV2JobsResponse_httpStatus
- The response's http status code.
StopRxNormInferenceJob
data StopRxNormInferenceJob Source #
See: newStopRxNormInferenceJob
smart constructor.
Instances
newStopRxNormInferenceJob Source #
Create a value of StopRxNormInferenceJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopRxNormInferenceJob'
, stopRxNormInferenceJob_jobId
- The identifier of the job.
data StopRxNormInferenceJobResponse Source #
See: newStopRxNormInferenceJobResponse
smart constructor.
Instances
Eq StopRxNormInferenceJobResponse Source # | |
Read StopRxNormInferenceJobResponse Source # | |
Show StopRxNormInferenceJobResponse Source # | |
Generic StopRxNormInferenceJobResponse Source # | |
NFData StopRxNormInferenceJobResponse Source # | |
Defined in Amazonka.ComprehendMedical.StopRxNormInferenceJob rnf :: StopRxNormInferenceJobResponse -> () # | |
type Rep StopRxNormInferenceJobResponse Source # | |
Defined in Amazonka.ComprehendMedical.StopRxNormInferenceJob type Rep StopRxNormInferenceJobResponse = D1 ('MetaData "StopRxNormInferenceJobResponse" "Amazonka.ComprehendMedical.StopRxNormInferenceJob" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "StopRxNormInferenceJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStopRxNormInferenceJobResponse Source #
Create a value of StopRxNormInferenceJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopRxNormInferenceJob'
, stopRxNormInferenceJobResponse_jobId
- The identifier generated for the job. To get the status of job, use this
identifier with the DescribeRxNormInferenceJob
operation.
$sel:httpStatus:StopRxNormInferenceJobResponse'
, stopRxNormInferenceJobResponse_httpStatus
- The response's http status code.
DetectPHI
See: newDetectPHI
smart constructor.
Instances
Create a value of DetectPHI
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DetectPHI'
, detectPHI_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.
data DetectPHIResponse Source #
See: newDetectPHIResponse
smart constructor.
Instances
:: Int | |
-> Text | |
-> DetectPHIResponse |
Create a value of DetectPHIResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:DetectPHIResponse'
, detectPHIResponse_paginationToken
- If the result of the previous request to DetectPHI
was truncated,
include the PaginationToken
to fetch the next page of PHI entities.
$sel:httpStatus:DetectPHIResponse'
, detectPHIResponse_httpStatus
- The response's http status code.
$sel:entities:DetectPHIResponse'
, detectPHIResponse_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.
$sel:modelVersion:DetectPHIResponse'
, detectPHIResponse_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.
DetectEntitiesV2
data DetectEntitiesV2 Source #
See: newDetectEntitiesV2
smart constructor.
Instances
Create a value of DetectEntitiesV2
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DetectEntitiesV2'
, detectEntitiesV2_text
- A UTF-8 string containing the clinical content being examined for
entities. Each string must contain fewer than 20,000 bytes of
characters.
data DetectEntitiesV2Response Source #
See: newDetectEntitiesV2Response
smart constructor.
Instances
newDetectEntitiesV2Response Source #
:: Int | |
-> Text | |
-> DetectEntitiesV2Response |
Create a value of DetectEntitiesV2Response
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:DetectEntitiesV2Response'
, detectEntitiesV2Response_paginationToken
- If the result to the DetectEntitiesV2
operation was truncated, include
the PaginationToken
to fetch the next page of entities.
$sel:unmappedAttributes:DetectEntitiesV2Response'
, detectEntitiesV2Response_unmappedAttributes
- Attributes extracted from the input text that couldn't be related to an
entity.
$sel:httpStatus:DetectEntitiesV2Response'
, detectEntitiesV2Response_httpStatus
- The response's http status code.
$sel:entities:DetectEntitiesV2Response'
, detectEntitiesV2Response_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.
$sel:modelVersion:DetectEntitiesV2Response'
, detectEntitiesV2Response_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.
StopPHIDetectionJob
data StopPHIDetectionJob Source #
See: newStopPHIDetectionJob
smart constructor.
Instances
newStopPHIDetectionJob Source #
Create a value of StopPHIDetectionJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopPHIDetectionJob'
, stopPHIDetectionJob_jobId
- The identifier of the PHI detection job to stop.
data StopPHIDetectionJobResponse Source #
See: newStopPHIDetectionJobResponse
smart constructor.
Instances
newStopPHIDetectionJobResponse Source #
Create a value of StopPHIDetectionJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StopPHIDetectionJob'
, stopPHIDetectionJobResponse_jobId
- The identifier of the PHI detection job that was stopped.
$sel:httpStatus:StopPHIDetectionJobResponse'
, stopPHIDetectionJobResponse_httpStatus
- The response's http status code.
StartEntitiesDetectionV2Job
data StartEntitiesDetectionV2Job Source #
See: newStartEntitiesDetectionV2Job
smart constructor.
StartEntitiesDetectionV2Job' (Maybe Text) (Maybe Text) (Maybe Text) InputDataConfig OutputDataConfig Text LanguageCode |
Instances
newStartEntitiesDetectionV2Job Source #
Create a value of StartEntitiesDetectionV2Job
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:StartEntitiesDetectionV2Job'
, startEntitiesDetectionV2Job_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.
$sel:jobName:StartEntitiesDetectionV2Job'
, startEntitiesDetectionV2Job_jobName
- The identifier of the job.
$sel:clientRequestToken:StartEntitiesDetectionV2Job'
, startEntitiesDetectionV2Job_clientRequestToken
- A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend Medical generates one.
$sel:inputDataConfig:StartEntitiesDetectionV2Job'
, startEntitiesDetectionV2Job_inputDataConfig
- Specifies the format and location of the input data for the job.
$sel:outputDataConfig:StartEntitiesDetectionV2Job'
, startEntitiesDetectionV2Job_outputDataConfig
- Specifies where to send the output files.
$sel:dataAccessRoleArn:StartEntitiesDetectionV2Job'
, startEntitiesDetectionV2Job_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.
$sel:languageCode:StartEntitiesDetectionV2Job'
, startEntitiesDetectionV2Job_languageCode
- The language of the input documents. All documents must be in the same
language.
data StartEntitiesDetectionV2JobResponse Source #
See: newStartEntitiesDetectionV2JobResponse
smart constructor.
Instances
newStartEntitiesDetectionV2JobResponse Source #
Create a value of StartEntitiesDetectionV2JobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartEntitiesDetectionV2JobResponse'
, startEntitiesDetectionV2JobResponse_jobId
- The identifier generated for the job. To get the status of a job, use
this identifier with the DescribeEntitiesDetectionV2Job
operation.
$sel:httpStatus:StartEntitiesDetectionV2JobResponse'
, startEntitiesDetectionV2JobResponse_httpStatus
- The response's http status code.
ListRxNormInferenceJobs
data ListRxNormInferenceJobs Source #
See: newListRxNormInferenceJobs
smart constructor.
Instances
newListRxNormInferenceJobs :: ListRxNormInferenceJobs Source #
Create a value of ListRxNormInferenceJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListRxNormInferenceJobs'
, listRxNormInferenceJobs_nextToken
- Identifies the next page of results to return.
$sel:filter':ListRxNormInferenceJobs'
, listRxNormInferenceJobs_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.
$sel:maxResults:ListRxNormInferenceJobs'
, listRxNormInferenceJobs_maxResults
- Identifies the next page of results to return.
data ListRxNormInferenceJobsResponse Source #
See: newListRxNormInferenceJobsResponse
smart constructor.
Instances
newListRxNormInferenceJobsResponse Source #
Create a value of ListRxNormInferenceJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListRxNormInferenceJobs'
, listRxNormInferenceJobsResponse_nextToken
- Identifies the next page of results to return.
$sel:comprehendMedicalAsyncJobPropertiesList:ListRxNormInferenceJobsResponse'
, listRxNormInferenceJobsResponse_comprehendMedicalAsyncJobPropertiesList
- The maximum number of results to return in each page. The default is
100.
$sel:httpStatus:ListRxNormInferenceJobsResponse'
, listRxNormInferenceJobsResponse_httpStatus
- The response's http status code.
Types
AttributeName
newtype AttributeName Source #
pattern AttributeName_DIAGNOSIS :: AttributeName | |
pattern AttributeName_NEGATION :: AttributeName | |
pattern AttributeName_SIGN :: AttributeName | |
pattern AttributeName_SYMPTOM :: AttributeName |
Instances
EntitySubType
newtype EntitySubType Source #
Instances
EntityType
newtype EntityType Source #
pattern EntityType_ANATOMY :: EntityType | |
pattern EntityType_MEDICAL_CONDITION :: EntityType | |
pattern EntityType_MEDICATION :: EntityType | |
pattern EntityType_PROTECTED_HEALTH_INFORMATION :: EntityType | |
pattern EntityType_TEST_TREATMENT_PROCEDURE :: EntityType | |
pattern EntityType_TIME_EXPRESSION :: EntityType |
Instances
ICD10CMAttributeType
newtype ICD10CMAttributeType Source #
Instances
ICD10CMEntityCategory
newtype ICD10CMEntityCategory Source #
Instances
ICD10CMEntityType
newtype ICD10CMEntityType Source #
pattern ICD10CMEntityType_DX_NAME :: ICD10CMEntityType | |
pattern ICD10CMEntityType_TIME_EXPRESSION :: ICD10CMEntityType |
Instances
ICD10CMRelationshipType
newtype ICD10CMRelationshipType Source #
pattern ICD10CMRelationshipType_OVERLAP :: ICD10CMRelationshipType | |
pattern ICD10CMRelationshipType_SYSTEM_ORGAN_SITE :: ICD10CMRelationshipType |
Instances
ICD10CMTraitName
newtype ICD10CMTraitName Source #
pattern ICD10CMTraitName_DIAGNOSIS :: ICD10CMTraitName | |
pattern ICD10CMTraitName_NEGATION :: ICD10CMTraitName | |
pattern ICD10CMTraitName_SIGN :: ICD10CMTraitName | |
pattern ICD10CMTraitName_SYMPTOM :: ICD10CMTraitName |
Instances
JobStatus
pattern JobStatus_COMPLETED :: JobStatus | |
pattern JobStatus_FAILED :: JobStatus | |
pattern JobStatus_IN_PROGRESS :: JobStatus | |
pattern JobStatus_PARTIAL_SUCCESS :: JobStatus | |
pattern JobStatus_STOPPED :: JobStatus | |
pattern JobStatus_STOP_REQUESTED :: JobStatus | |
pattern JobStatus_SUBMITTED :: JobStatus |
Instances
LanguageCode
newtype LanguageCode Source #
pattern LanguageCode_En :: LanguageCode |
Instances
RelationshipType
newtype RelationshipType Source #
pattern RelationshipType_ACUITY :: RelationshipType | |
pattern RelationshipType_ADMINISTERED_VIA :: RelationshipType | |
pattern RelationshipType_DIRECTION :: RelationshipType | |
pattern RelationshipType_DOSAGE :: RelationshipType | |
pattern RelationshipType_DURATION :: RelationshipType | |
pattern RelationshipType_EVERY :: RelationshipType | |
pattern RelationshipType_FOR :: RelationshipType | |
pattern RelationshipType_FORM :: RelationshipType | |
pattern RelationshipType_FREQUENCY :: RelationshipType | |
pattern RelationshipType_NEGATIVE :: RelationshipType | |
pattern RelationshipType_OVERLAP :: RelationshipType | |
pattern RelationshipType_RATE :: RelationshipType | |
pattern RelationshipType_ROUTE_OR_MODE :: RelationshipType | |
pattern RelationshipType_STRENGTH :: RelationshipType | |
pattern RelationshipType_SYSTEM_ORGAN_SITE :: RelationshipType | |
pattern RelationshipType_TEST_UNITS :: RelationshipType | |
pattern RelationshipType_TEST_VALUE :: RelationshipType | |
pattern RelationshipType_WITH_DOSAGE :: RelationshipType |
Instances
RxNormAttributeType
newtype RxNormAttributeType Source #
pattern RxNormAttributeType_DOSAGE :: RxNormAttributeType | |
pattern RxNormAttributeType_DURATION :: RxNormAttributeType | |
pattern RxNormAttributeType_FORM :: RxNormAttributeType | |
pattern RxNormAttributeType_FREQUENCY :: RxNormAttributeType | |
pattern RxNormAttributeType_RATE :: RxNormAttributeType | |
pattern RxNormAttributeType_ROUTE_OR_MODE :: RxNormAttributeType | |
pattern RxNormAttributeType_STRENGTH :: RxNormAttributeType |
Instances
RxNormEntityCategory
newtype RxNormEntityCategory Source #
Instances
RxNormEntityType
newtype RxNormEntityType Source #
pattern RxNormEntityType_BRAND_NAME :: RxNormEntityType | |
pattern RxNormEntityType_GENERIC_NAME :: RxNormEntityType |
Instances
RxNormTraitName
newtype RxNormTraitName Source #
pattern RxNormTraitName_NEGATION :: RxNormTraitName |
Instances
Attribute
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.
See: newAttribute
smart constructor.
Attribute' (Maybe Double) (Maybe Int) (Maybe Text) (Maybe EntityType) (Maybe Double) (Maybe [Trait]) (Maybe RelationshipType) (Maybe Int) (Maybe Int) (Maybe EntitySubType) |
Instances
newAttribute :: Attribute Source #
Create a value of Attribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relationshipScore:Attribute'
, attribute_relationshipScore
- The level of confidence that Amazon Comprehend Medical has that this
attribute is correctly related to this entity.
$sel:beginOffset:Attribute'
, attribute_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.
$sel:text:Attribute'
, attribute_text
- The segment of input text extracted as this attribute.
$sel:category:Attribute'
, attribute_category
- The category of attribute.
$sel:score:Attribute'
, attribute_score
- The level of confidence that Amazon Comprehend Medical has that the
segment of text is correctly recognized as an attribute.
$sel:traits:Attribute'
, attribute_traits
- Contextual information for this attribute.
$sel:relationshipType:Attribute'
, attribute_relationshipType
- The type of relationship between the entity and attribute. Type for the
relationship is OVERLAP
, indicating that the entity occurred at the
same time as the Date_Expression
.
$sel:endOffset:Attribute'
, attribute_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.
$sel:id:Attribute'
, attribute_id
- The numeric identifier for this attribute. This is a monotonically
increasing id unique within this response rather than a global unique
identifier.
$sel:type':Attribute'
, attribute_type
- The type of attribute.
ComprehendMedicalAsyncJobFilter
data ComprehendMedicalAsyncJobFilter Source #
Provides information for filtering a list of detection jobs.
See: newComprehendMedicalAsyncJobFilter
smart constructor.
Instances
newComprehendMedicalAsyncJobFilter :: ComprehendMedicalAsyncJobFilter Source #
Create a value of ComprehendMedicalAsyncJobFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:submitTimeAfter:ComprehendMedicalAsyncJobFilter'
, comprehendMedicalAsyncJobFilter_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.
$sel:submitTimeBefore:ComprehendMedicalAsyncJobFilter'
, comprehendMedicalAsyncJobFilter_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.
$sel:jobName:ComprehendMedicalAsyncJobFilter'
, comprehendMedicalAsyncJobFilter_jobName
- Filters on the name of the job.
$sel:jobStatus:ComprehendMedicalAsyncJobFilter'
, comprehendMedicalAsyncJobFilter_jobStatus
- Filters the list of jobs based on job status. Returns only jobs with the
specified status.
ComprehendMedicalAsyncJobProperties
data ComprehendMedicalAsyncJobProperties Source #
Provides information about a detection job.
See: newComprehendMedicalAsyncJobProperties
smart constructor.
ComprehendMedicalAsyncJobProperties' (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InputDataConfig) (Maybe POSIX) (Maybe OutputDataConfig) (Maybe Text) (Maybe Text) (Maybe JobStatus) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newComprehendMedicalAsyncJobProperties :: ComprehendMedicalAsyncJobProperties Source #
Create a value of ComprehendMedicalAsyncJobProperties
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:languageCode:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_languageCode
- The language code of the input documents.
$sel:kmsKey:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_kmsKey
- The AWS Key Management Service key, if any, used to encrypt the output
files.
$sel:jobId:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_jobId
- The identifier assigned to the detection job.
$sel:jobName:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_jobName
- The name that you assigned to the detection job.
$sel:manifestFilePath:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_manifestFilePath
- The path to the file that describes the results of a batch job.
$sel:inputDataConfig:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_inputDataConfig
- The input data configuration that you supplied when you created the
detection job.
$sel:endTime:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_endTime
- The time that the detection job completed.
$sel:outputDataConfig:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_outputDataConfig
- The output data configuration that you supplied when you created the
detection job.
$sel:modelVersion:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_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.
$sel:dataAccessRoleArn:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_dataAccessRoleArn
- The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read
access to your input data.
$sel:jobStatus:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_jobStatus
- The current status of the detection job. If the status is FAILED
, the
Message
field shows the reason for the failure.
$sel:message:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_message
- A description of the status of a job.
$sel:expirationTime:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_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.
$sel:submitTime:ComprehendMedicalAsyncJobProperties'
, comprehendMedicalAsyncJobProperties_submitTime
- The time that the detection job was submitted for processing.
Entity
Provides information about an extracted medical entity.
See: newEntity
smart constructor.
Entity' (Maybe Int) (Maybe Text) (Maybe EntityType) (Maybe Double) (Maybe [Trait]) (Maybe [Attribute]) (Maybe Int) (Maybe Int) (Maybe EntitySubType) |
Instances
Create a value of Entity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:beginOffset:Entity'
, entity_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.
$sel:text:Entity'
, entity_text
- The segment of input text extracted as this entity.
$sel:category:Entity'
, entity_category
- The category of the entity.
$sel:score:Entity'
, entity_score
- The level of confidence that Amazon Comprehend Medical has in the
accuracy of the detection.
$sel:traits:Entity'
, entity_traits
- Contextual information for the entity.
$sel:attributes:Entity'
, entity_attributes
- The extracted attributes that relate to this entity.
$sel:endOffset:Entity'
, entity_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.
$sel:id:Entity'
, entity_id
- The numeric identifier for the entity. This is a monotonically
increasing id unique within this response rather than a global unique
identifier.
$sel:type':Entity'
, entity_type
- Describes the specific type of entity with category of entities.
ICD10CMAttribute
data ICD10CMAttribute Source #
The detected attributes that relate to an entity. This includes an
extracted segment of the text that is an attribute of an entity, or
otherwise related to an entity. InferICD10CM detects the following
attributes: Direction
, System, Organ or Site
, and Acuity
.
See: newICD10CMAttribute
smart constructor.
ICD10CMAttribute' (Maybe Double) (Maybe Int) (Maybe Text) (Maybe ICD10CMEntityType) (Maybe Double) (Maybe [ICD10CMTrait]) (Maybe ICD10CMRelationshipType) (Maybe Int) (Maybe Int) (Maybe ICD10CMAttributeType) |
Instances
newICD10CMAttribute :: ICD10CMAttribute Source #
Create a value of ICD10CMAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relationshipScore:ICD10CMAttribute'
, iCD10CMAttribute_relationshipScore
- The level of confidence that Amazon Comprehend Medical has that this
attribute is correctly related to this entity.
$sel:beginOffset:ICD10CMAttribute'
, iCD10CMAttribute_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.
$sel:text:ICD10CMAttribute'
, iCD10CMAttribute_text
- The segment of input text which contains the detected attribute.
$sel:category:ICD10CMAttribute'
, iCD10CMAttribute_category
- The category of attribute. Can be either of DX_NAME
or
TIME_EXPRESSION
.
$sel:score:ICD10CMAttribute'
, iCD10CMAttribute_score
- The level of confidence that Amazon Comprehend Medical has that the
segment of text is correctly recognized as an attribute.
$sel:traits:ICD10CMAttribute'
, iCD10CMAttribute_traits
- The contextual information for the attribute. The traits recognized by
InferICD10CM are DIAGNOSIS
, SIGN
, SYMPTOM
, and NEGATION
.
$sel:relationshipType:ICD10CMAttribute'
, iCD10CMAttribute_relationshipType
- The type of relationship between the entity and attribute. Type for the
relationship can be either of OVERLAP
or SYSTEM_ORGAN_SITE
.
$sel:endOffset:ICD10CMAttribute'
, iCD10CMAttribute_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.
$sel:id:ICD10CMAttribute'
, iCD10CMAttribute_id
- The numeric identifier for this attribute. This is a monotonically
increasing id unique within this response rather than a global unique
identifier.
$sel:type':ICD10CMAttribute'
, iCD10CMAttribute_type
- The type of attribute. InferICD10CM detects entities of the type
DX_NAME
.
ICD10CMConcept
data ICD10CMConcept Source #
The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
See: newICD10CMConcept
smart constructor.
Instances
newICD10CMConcept :: ICD10CMConcept Source #
Create a value of ICD10CMConcept
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:score:ICD10CMConcept'
, iCD10CMConcept_score
- The level of confidence that Amazon Comprehend Medical has that the
entity is accurately linked to an ICD-10-CM concept.
$sel:code:ICD10CMConcept'
, iCD10CMConcept_code
- The ICD-10-CM code that identifies the concept found in the knowledge
base from the Centers for Disease Control.
$sel:description:ICD10CMConcept'
, iCD10CMConcept_description
- The long description of the ICD-10-CM code in the ontology.
ICD10CMEntity
data ICD10CMEntity Source #
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.
See: newICD10CMEntity
smart constructor.
ICD10CMEntity' (Maybe [ICD10CMConcept]) (Maybe Int) (Maybe Text) (Maybe ICD10CMEntityCategory) (Maybe Double) (Maybe [ICD10CMTrait]) (Maybe [ICD10CMAttribute]) (Maybe Int) (Maybe Int) (Maybe ICD10CMEntityType) |
Instances
newICD10CMEntity :: ICD10CMEntity Source #
Create a value of ICD10CMEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iCD10CMConcepts:ICD10CMEntity'
, iCD10CMEntity_iCD10CMConcepts
- The ICD-10-CM concepts that the entity could refer to, along with a
score indicating the likelihood of the match.
$sel:beginOffset:ICD10CMEntity'
, iCD10CMEntity_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.
$sel:text:ICD10CMEntity'
, iCD10CMEntity_text
- The segment of input text that is matched to the detected entity.
$sel:category:ICD10CMEntity'
, iCD10CMEntity_category
- The category of the entity. InferICD10CM detects entities in the
MEDICAL_CONDITION
category.
$sel:score:ICD10CMEntity'
, iCD10CMEntity_score
- The level of confidence that Amazon Comprehend Medical has in the
accuracy of the detection.
$sel:traits:ICD10CMEntity'
, iCD10CMEntity_traits
- Provides Contextual information for the entity. The traits recognized by
InferICD10CM are DIAGNOSIS
, SIGN
, SYMPTOM
, and NEGATION.
$sel:attributes:ICD10CMEntity'
, iCD10CMEntity_attributes
- The detected attributes that relate to the entity. An extracted segment
of the text that is an attribute of an entity, or otherwise related to
an entity, such as the nature of a medical condition.
$sel:endOffset:ICD10CMEntity'
, iCD10CMEntity_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.
$sel:id:ICD10CMEntity'
, iCD10CMEntity_id
- The numeric identifier for the entity. This is a monotonically
increasing id unique within this response rather than a global unique
identifier.
$sel:type':ICD10CMEntity'
, iCD10CMEntity_type
- Describes the specific type of entity with category of entities.
InferICD10CM detects entities of the type DX_NAME
and
TIME_EXPRESSION
.
ICD10CMTrait
data ICD10CMTrait Source #
Contextual information for the entity. The traits recognized by
InferICD10CM are DIAGNOSIS
, SIGN
, SYMPTOM
, and NEGATION
.
See: newICD10CMTrait
smart constructor.
Instances
newICD10CMTrait :: ICD10CMTrait Source #
Create a value of ICD10CMTrait
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:score:ICD10CMTrait'
, iCD10CMTrait_score
- The level of confidence that Amazon Comprehend Medical has that the
segment of text is correctly recognized as a trait.
$sel:name:ICD10CMTrait'
, iCD10CMTrait_name
- Provides a name or contextual description about the trait.
InputDataConfig
data InputDataConfig Source #
The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed.
See: newInputDataConfig
smart constructor.
Instances
Create a value of InputDataConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Key:InputDataConfig'
, inputDataConfig_s3Key
- The path to the input data files in the S3 bucket.
$sel:s3Bucket:InputDataConfig'
, inputDataConfig_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.
OutputDataConfig
data OutputDataConfig Source #
The output properties for a detection job.
See: newOutputDataConfig
smart constructor.
Instances
Create a value of OutputDataConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Key:OutputDataConfig'
, outputDataConfig_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.
$sel:s3Bucket:OutputDataConfig'
, outputDataConfig_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.
RxNormAttribute
data RxNormAttribute Source #
The extracted attributes that relate to this entity. The attributes
recognized by InferRxNorm are DOSAGE
, DURATION
, FORM
, FREQUENCY
,
RATE
, ROUTE_OR_MODE
.
See: newRxNormAttribute
smart constructor.
RxNormAttribute' (Maybe Double) (Maybe Int) (Maybe Text) (Maybe Double) (Maybe [RxNormTrait]) (Maybe Int) (Maybe Int) (Maybe RxNormAttributeType) |
Instances
newRxNormAttribute :: RxNormAttribute Source #
Create a value of RxNormAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:relationshipScore:RxNormAttribute'
, rxNormAttribute_relationshipScore
- The level of confidence that Amazon Comprehend Medical has that the
attribute is accurately linked to an entity.
$sel:beginOffset:RxNormAttribute'
, rxNormAttribute_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.
$sel:text:RxNormAttribute'
, rxNormAttribute_text
- The segment of input text which corresponds to the detected attribute.
$sel:score:RxNormAttribute'
, rxNormAttribute_score
- The level of confidence that Comprehend Medical has that the segment of
text is correctly recognized as an attribute.
$sel:traits:RxNormAttribute'
, rxNormAttribute_traits
- Contextual information for the attribute. InferRxNorm recognizes the
trait NEGATION
for attributes, i.e. that the patient is not taking a
specific dose or form of a medication.
$sel:endOffset:RxNormAttribute'
, rxNormAttribute_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.
$sel:id:RxNormAttribute'
, rxNormAttribute_id
- The numeric identifier for this attribute. This is a monotonically
increasing id unique within this response rather than a global unique
identifier.
$sel:type':RxNormAttribute'
, rxNormAttribute_type
- The type of attribute. The types of attributes recognized by InferRxNorm
are BRAND_NAME
and GENERIC_NAME
.
RxNormConcept
data RxNormConcept Source #
The RxNorm concept that the entity could refer to, along with a score indicating the likelihood of the match.
See: newRxNormConcept
smart constructor.
Instances
newRxNormConcept :: RxNormConcept Source #
Create a value of RxNormConcept
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:score:RxNormConcept'
, rxNormConcept_score
- The level of confidence that Amazon Comprehend Medical has that the
entity is accurately linked to the reported RxNorm concept.
$sel:code:RxNormConcept'
, rxNormConcept_code
- RxNorm concept ID, also known as the RxCUI.
$sel:description:RxNormConcept'
, rxNormConcept_description
- The description of the RxNorm concept.
RxNormEntity
data RxNormEntity Source #
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.
See: newRxNormEntity
smart constructor.
RxNormEntity' (Maybe [RxNormConcept]) (Maybe Int) (Maybe Text) (Maybe RxNormEntityCategory) (Maybe Double) (Maybe [RxNormTrait]) (Maybe [RxNormAttribute]) (Maybe Int) (Maybe Int) (Maybe RxNormEntityType) |
Instances
newRxNormEntity :: RxNormEntity Source #
Create a value of RxNormEntity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rxNormConcepts:RxNormEntity'
, rxNormEntity_rxNormConcepts
- The RxNorm concepts that the entity could refer to, along with a score
indicating the likelihood of the match.
$sel:beginOffset:RxNormEntity'
, rxNormEntity_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.
$sel:text:RxNormEntity'
, rxNormEntity_text
- The segment of input text extracted from which the entity was detected.
$sel:category:RxNormEntity'
, rxNormEntity_category
- The category of the entity. The recognized categories are GENERIC
or
BRAND_NAME
.
$sel:score:RxNormEntity'
, rxNormEntity_score
- The level of confidence that Amazon Comprehend Medical has in the
accuracy of the detected entity.
$sel:traits:RxNormEntity'
, rxNormEntity_traits
- Contextual information for the entity.
$sel:attributes:RxNormEntity'
, rxNormEntity_attributes
- The extracted attributes that relate to the entity. The attributes
recognized by InferRxNorm are DOSAGE
, DURATION
, FORM
, FREQUENCY
,
RATE
, ROUTE_OR_MODE
, and STRENGTH
.
$sel:endOffset:RxNormEntity'
, rxNormEntity_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.
$sel:id:RxNormEntity'
, rxNormEntity_id
- The numeric identifier for the entity. This is a monotonically
increasing id unique within this response rather than a global unique
identifier.
$sel:type':RxNormEntity'
, rxNormEntity_type
- Describes the specific type of entity. For InferRxNorm, the recognized
entity type is MEDICATION
.
RxNormTrait
data RxNormTrait Source #
The contextual information for the entity. InferRxNorm recognizes the
trait NEGATION
, which is any indication that the patient is not taking
a medication.
See: newRxNormTrait
smart constructor.
Instances
newRxNormTrait :: RxNormTrait Source #
Create a value of RxNormTrait
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:score:RxNormTrait'
, rxNormTrait_score
- The level of confidence that Amazon Comprehend Medical has in the
accuracy of the detected trait.
$sel:name:RxNormTrait'
, rxNormTrait_name
- Provides a name or contextual description about the trait.
Trait
Provides contextual information about the extracted entity.
See: newTrait
smart constructor.
Instances
Eq Trait Source # | |
Read Trait Source # | |
Show Trait Source # | |
Generic Trait Source # | |
NFData Trait Source # | |
Defined in Amazonka.ComprehendMedical.Types.Trait | |
Hashable Trait Source # | |
Defined in Amazonka.ComprehendMedical.Types.Trait | |
FromJSON Trait Source # | |
type Rep Trait Source # | |
Defined in Amazonka.ComprehendMedical.Types.Trait type Rep Trait = D1 ('MetaData "Trait" "Amazonka.ComprehendMedical.Types.Trait" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "Trait'" 'PrefixI 'True) (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeName)))) |
Create a value of Trait
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:score:Trait'
, trait_score
- The level of confidence that Amazon Comprehend Medical has in the
accuracy of this trait.
$sel:name:Trait'
, trait_name
- Provides a name or contextual description about the trait.
UnmappedAttribute
data UnmappedAttribute Source #
An attribute that we extracted, but were unable to relate to an entity.
See: newUnmappedAttribute
smart constructor.
Instances
newUnmappedAttribute :: UnmappedAttribute Source #
Create a value of UnmappedAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attribute:UnmappedAttribute'
, unmappedAttribute_attribute
- The specific attribute that has been extracted but not mapped to an
entity.
$sel:type':UnmappedAttribute'
, unmappedAttribute_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".