Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ComprehendMedical.StartPHIDetectionJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data StartPHIDetectionJob = StartPHIDetectionJob' {
- clientRequestToken :: Maybe Text
- jobName :: Maybe Text
- kmsKey :: Maybe Text
- inputDataConfig :: InputDataConfig
- outputDataConfig :: OutputDataConfig
- dataAccessRoleArn :: Text
- languageCode :: LanguageCode
}
newStartPHIDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartPHIDetectionJob
startPHIDetectionJob_clientRequestToken :: Lens' StartPHIDetectionJob (Maybe Text)
startPHIDetectionJob_jobName :: Lens' StartPHIDetectionJob (Maybe Text)
startPHIDetectionJob_kmsKey :: Lens' StartPHIDetectionJob (Maybe Text)
startPHIDetectionJob_inputDataConfig :: Lens' StartPHIDetectionJob InputDataConfig
startPHIDetectionJob_outputDataConfig :: Lens' StartPHIDetectionJob OutputDataConfig
startPHIDetectionJob_dataAccessRoleArn :: Lens' StartPHIDetectionJob Text
startPHIDetectionJob_languageCode :: Lens' StartPHIDetectionJob LanguageCode
data StartPHIDetectionJobResponse = StartPHIDetectionJobResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
}
newStartPHIDetectionJobResponse :: Int -> StartPHIDetectionJobResponse
startPHIDetectionJobResponse_jobId :: Lens' StartPHIDetectionJobResponse (Maybe Text)
startPHIDetectionJobResponse_httpStatus :: Lens' StartPHIDetectionJobResponse Int

Creating a Request

data StartPHIDetectionJob Source #

See: newStartPHIDetectionJob smart constructor.

Constructors

StartPHIDetectionJob'

Fields

clientRequestToken :: Maybe Text
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
jobName :: Maybe Text
The identifier of the job.
kmsKey :: Maybe Text
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.
inputDataConfig :: InputDataConfig
Specifies the format and location of the input data for the job.
outputDataConfig :: OutputDataConfig
Specifies where to send the output files.
dataAccessRoleArn :: Text
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
languageCode :: LanguageCode
The language of the input documents. All documents must be in the same language.

Instances

Instances details

ToJSON StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods toJSON :: StartPHIDetectionJob -> Value # toEncoding :: StartPHIDetectionJob -> Encoding # toJSONList :: [StartPHIDetectionJob] -> Value # toEncodingList :: [StartPHIDetectionJob] -> Encoding #
ToHeaders StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods toHeaders :: StartPHIDetectionJob -> [Header] #
ToPath StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods toPath :: StartPHIDetectionJob -> ByteString #
ToQuery StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods toQuery :: StartPHIDetectionJob -> QueryString #
AWSRequest StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Associated Types type AWSResponse StartPHIDetectionJob # Methods request :: (Service -> Service) -> StartPHIDetectionJob -> Request StartPHIDetectionJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartPHIDetectionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartPHIDetectionJob))) #
Generic StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Associated Types type Rep StartPHIDetectionJob :: Type -> Type # Methods from :: StartPHIDetectionJob -> Rep StartPHIDetectionJob x # to :: Rep StartPHIDetectionJob x -> StartPHIDetectionJob #
Read StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods readsPrec :: Int -> ReadS StartPHIDetectionJob # readList :: ReadS [StartPHIDetectionJob] # readPrec :: ReadPrec StartPHIDetectionJob # readListPrec :: ReadPrec [StartPHIDetectionJob] #
Show StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods showsPrec :: Int -> StartPHIDetectionJob -> ShowS # show :: StartPHIDetectionJob -> String # showList :: [StartPHIDetectionJob] -> ShowS #
NFData StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods rnf :: StartPHIDetectionJob -> () #
Eq StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods (==) :: StartPHIDetectionJob -> StartPHIDetectionJob -> Bool # (/=) :: StartPHIDetectionJob -> StartPHIDetectionJob -> Bool #
Hashable StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods hashWithSalt :: Int -> StartPHIDetectionJob -> Int # hash :: StartPHIDetectionJob -> Int #
type AWSResponse StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob type AWSResponse StartPHIDetectionJob = StartPHIDetectionJobResponse
type Rep StartPHIDetectionJob Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob type Rep StartPHIDetectionJob = D1 ('MetaData "StartPHIDetectionJob" "Amazonka.ComprehendMedical.StartPHIDetectionJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "StartPHIDetectionJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig) :: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig)) :: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))))

newStartPHIDetectionJob Source #

Arguments

:: InputDataConfig	`StartPHIDetectionJob`
-> OutputDataConfig	`StartPHIDetectionJob`
-> Text	`StartPHIDetectionJob`
-> LanguageCode	`StartPHIDetectionJob`
-> StartPHIDetectionJob

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:clientRequestToken:StartPHIDetectionJob', startPHIDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.

StartPHIDetectionJob, startPHIDetectionJob_jobName - The identifier of the job.

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.

StartPHIDetectionJob, startPHIDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

StartPHIDetectionJob, startPHIDetectionJob_outputDataConfig - Specifies where to send the output files.

StartPHIDetectionJob, startPHIDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

StartPHIDetectionJob, startPHIDetectionJob_languageCode - The language of the input documents. All documents must be in the same language.

Request Lenses

startPHIDetectionJob_clientRequestToken :: Lens' StartPHIDetectionJob (Maybe Text) Source #

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

startPHIDetectionJob_jobName :: Lens' StartPHIDetectionJob (Maybe Text) Source #

The identifier of the job.

startPHIDetectionJob_kmsKey :: Lens' StartPHIDetectionJob (Maybe Text) Source #

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.

startPHIDetectionJob_inputDataConfig :: Lens' StartPHIDetectionJob InputDataConfig Source #

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

startPHIDetectionJob_outputDataConfig :: Lens' StartPHIDetectionJob OutputDataConfig Source #

Specifies where to send the output files.

startPHIDetectionJob_dataAccessRoleArn :: Lens' StartPHIDetectionJob Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

startPHIDetectionJob_languageCode :: Lens' StartPHIDetectionJob LanguageCode Source #

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

Destructuring the Response

data StartPHIDetectionJobResponse Source #

See: newStartPHIDetectionJobResponse smart constructor.

Constructors

StartPHIDetectionJobResponse'
Fields jobId :: Maybe Text The identifier generated for the job. To get the status of a job, use this identifier with the `DescribePHIDetectionJob` operation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Associated Types type Rep StartPHIDetectionJobResponse :: Type -> Type # Methods from :: StartPHIDetectionJobResponse -> Rep StartPHIDetectionJobResponse x # to :: Rep StartPHIDetectionJobResponse x -> StartPHIDetectionJobResponse #
Read StartPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods readsPrec :: Int -> ReadS StartPHIDetectionJobResponse # readList :: ReadS [StartPHIDetectionJobResponse] # readPrec :: ReadPrec StartPHIDetectionJobResponse # readListPrec :: ReadPrec [StartPHIDetectionJobResponse] #
Show StartPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods showsPrec :: Int -> StartPHIDetectionJobResponse -> ShowS # show :: StartPHIDetectionJobResponse -> String # showList :: [StartPHIDetectionJobResponse] -> ShowS #
NFData StartPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods rnf :: StartPHIDetectionJobResponse -> () #
Eq StartPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob Methods (==) :: StartPHIDetectionJobResponse -> StartPHIDetectionJobResponse -> Bool # (/=) :: StartPHIDetectionJobResponse -> StartPHIDetectionJobResponse -> Bool #
type Rep StartPHIDetectionJobResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.StartPHIDetectionJob type Rep StartPHIDetectionJobResponse = D1 ('MetaData "StartPHIDetectionJobResponse" "Amazonka.ComprehendMedical.StartPHIDetectionJob" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "StartPHIDetectionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartPHIDetectionJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartPHIDetectionJobResponse'`
-> StartPHIDetectionJobResponse

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:

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.

Response Lenses

startPHIDetectionJobResponse_jobId :: Lens' StartPHIDetectionJobResponse (Maybe Text) Source #

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

startPHIDetectionJobResponse_httpStatus :: Lens' StartPHIDetectionJobResponse Int Source #

The response's http status code.