amazonka-healthlake-2.0: Amazon HealthLake SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.HealthLake.StartFHIRExportJob

Description

Begins a FHIR export job.

Synopsis

Creating a Request

data StartFHIRExportJob Source #

See: newStartFHIRExportJob smart constructor.

Constructors

StartFHIRExportJob' 

Fields

Instances

Instances details
ToJSON StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

ToHeaders StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

ToPath StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

ToQuery StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

AWSRequest StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

Associated Types

type AWSResponse StartFHIRExportJob #

Generic StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

Associated Types

type Rep StartFHIRExportJob :: Type -> Type #

Read StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

Show StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

NFData StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

Methods

rnf :: StartFHIRExportJob -> () #

Eq StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

Hashable StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

type AWSResponse StartFHIRExportJob Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

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 #

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 #

Read StartFHIRExportJobResponse Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

Show StartFHIRExportJobResponse Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

NFData StartFHIRExportJobResponse Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

Eq StartFHIRExportJobResponse Source # 
Instance details

Defined in Amazonka.HealthLake.StartFHIRExportJob

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 #

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_jobStatus :: Lens' StartFHIRExportJobResponse JobStatus Source #

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