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.HealthLake.StartFHIRExportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Begins a FHIR export job.

Synopsis

data StartFHIRExportJob = StartFHIRExportJob' {
- jobName :: Maybe Text
- outputDataConfig :: OutputDataConfig
- datastoreId :: Text
- dataAccessRoleArn :: Text
- clientToken :: Text
}
newStartFHIRExportJob :: OutputDataConfig -> Text -> Text -> Text -> StartFHIRExportJob
startFHIRExportJob_jobName :: Lens' StartFHIRExportJob (Maybe Text)
startFHIRExportJob_outputDataConfig :: Lens' StartFHIRExportJob OutputDataConfig
startFHIRExportJob_datastoreId :: Lens' StartFHIRExportJob Text
startFHIRExportJob_dataAccessRoleArn :: Lens' StartFHIRExportJob Text
startFHIRExportJob_clientToken :: Lens' StartFHIRExportJob Text
data StartFHIRExportJobResponse = StartFHIRExportJobResponse' {
- datastoreId :: Maybe Text
- httpStatus :: Int
- jobId :: Text
- jobStatus :: JobStatus
}
newStartFHIRExportJobResponse :: Int -> Text -> JobStatus -> StartFHIRExportJobResponse
startFHIRExportJobResponse_datastoreId :: Lens' StartFHIRExportJobResponse (Maybe Text)
startFHIRExportJobResponse_httpStatus :: Lens' StartFHIRExportJobResponse Int
startFHIRExportJobResponse_jobId :: Lens' StartFHIRExportJobResponse Text
startFHIRExportJobResponse_jobStatus :: Lens' StartFHIRExportJobResponse JobStatus

Creating a Request

data StartFHIRExportJob Source #

See: newStartFHIRExportJob smart constructor.

Constructors

StartFHIRExportJob'

Fields

jobName :: Maybe Text
The user generated name for an export job.
outputDataConfig :: OutputDataConfig
The output data configuration that was supplied when the export job was created.
datastoreId :: Text
The AWS generated ID for the Data Store from which files are being exported for an export job.
dataAccessRoleArn :: Text
The Amazon Resource Name used during the initiation of the job.
clientToken :: Text
An optional user provided token used for ensuring idempotency.

Instances

Instances details

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

newStartFHIRExportJob Source #

Arguments

:: OutputDataConfig	`StartFHIRExportJob`
-> Text	`StartFHIRExportJob`
-> Text	`StartFHIRExportJob`
-> Text	`$sel:clientToken:StartFHIRExportJob'`
-> StartFHIRExportJob

Create a value of StartFHIRExportJob 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:

StartFHIRExportJob, startFHIRExportJob_jobName - The user generated name for an export job.

StartFHIRExportJob, startFHIRExportJob_outputDataConfig - The output data configuration that was supplied when the export job was created.

StartFHIRExportJob, startFHIRExportJob_datastoreId - The AWS generated ID for the Data Store from which files are being exported for an export job.

StartFHIRExportJob, startFHIRExportJob_dataAccessRoleArn - The Amazon Resource Name used during the initiation of the job.

$sel:clientToken:StartFHIRExportJob', startFHIRExportJob_clientToken - An optional user provided token used for ensuring idempotency.

Request Lenses

startFHIRExportJob_jobName :: Lens' StartFHIRExportJob (Maybe Text) Source #

The user generated name for an export job.

startFHIRExportJob_outputDataConfig :: Lens' StartFHIRExportJob OutputDataConfig Source #

The output data configuration that was supplied when the export job was created.

startFHIRExportJob_datastoreId :: Lens' StartFHIRExportJob Text Source #

The AWS generated ID for the Data Store from which files are being exported for an export job.

startFHIRExportJob_dataAccessRoleArn :: Lens' StartFHIRExportJob Text Source #

The Amazon Resource Name used during the initiation of the job.

startFHIRExportJob_clientToken :: Lens' StartFHIRExportJob Text Source #

An optional user provided token used for ensuring idempotency.

Destructuring the Response

data StartFHIRExportJobResponse Source #

See: newStartFHIRExportJobResponse smart constructor.

Constructors

StartFHIRExportJobResponse'
Fields datastoreId :: Maybe Text The AWS generated ID for the Data Store from which files are being exported for an export job. httpStatus :: Int The response's http status code. jobId :: Text The AWS generated ID for an export job. jobStatus :: JobStatus The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

Instances

Instances details

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

newStartFHIRExportJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartFHIRExportJobResponse'`
-> Text	`StartFHIRExportJobResponse`
-> JobStatus	`StartFHIRExportJobResponse`
-> StartFHIRExportJobResponse

Create a value of StartFHIRExportJobResponse 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:

StartFHIRExportJob, startFHIRExportJobResponse_datastoreId - The AWS generated ID for the Data Store from which files are being exported for an export job.

$sel:httpStatus:StartFHIRExportJobResponse', startFHIRExportJobResponse_httpStatus - The response's http status code.

StartFHIRExportJobResponse, startFHIRExportJobResponse_jobId - The AWS generated ID for an export job.

StartFHIRExportJobResponse, startFHIRExportJobResponse_jobStatus - The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

Response Lenses

startFHIRExportJobResponse_datastoreId :: Lens' StartFHIRExportJobResponse (Maybe Text) Source #

The AWS generated ID for the Data Store from which files are being exported for an export job.

startFHIRExportJobResponse_httpStatus :: Lens' StartFHIRExportJobResponse Int Source #

The response's http status code.

startFHIRExportJobResponse_jobId :: Lens' StartFHIRExportJobResponse Text Source #

The AWS generated ID for an export job.

startFHIRExportJobResponse_jobStatus :: Lens' StartFHIRExportJobResponse JobStatus Source #

The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.