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.Omics.StartReadSetExportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a read set export job.

Synopsis

data StartReadSetExportJob = StartReadSetExportJob' {
- clientToken :: Maybe Text
- destination :: Text
- roleArn :: Text
- sequenceStoreId :: Text
- sources :: NonEmpty ExportReadSet
}
newStartReadSetExportJob :: Text -> Text -> Text -> NonEmpty ExportReadSet -> StartReadSetExportJob
startReadSetExportJob_clientToken :: Lens' StartReadSetExportJob (Maybe Text)
startReadSetExportJob_destination :: Lens' StartReadSetExportJob Text
startReadSetExportJob_roleArn :: Lens' StartReadSetExportJob Text
startReadSetExportJob_sequenceStoreId :: Lens' StartReadSetExportJob Text
startReadSetExportJob_sources :: Lens' StartReadSetExportJob (NonEmpty ExportReadSet)
data StartReadSetExportJobResponse = StartReadSetExportJobResponse' {
- httpStatus :: Int
- creationTime :: ISO8601
- destination :: Text
- id :: Text
- sequenceStoreId :: Text
- status :: ReadSetExportJobStatus
}
newStartReadSetExportJobResponse :: Int -> UTCTime -> Text -> Text -> Text -> ReadSetExportJobStatus -> StartReadSetExportJobResponse
startReadSetExportJobResponse_httpStatus :: Lens' StartReadSetExportJobResponse Int
startReadSetExportJobResponse_creationTime :: Lens' StartReadSetExportJobResponse UTCTime
startReadSetExportJobResponse_destination :: Lens' StartReadSetExportJobResponse Text
startReadSetExportJobResponse_id :: Lens' StartReadSetExportJobResponse Text
startReadSetExportJobResponse_sequenceStoreId :: Lens' StartReadSetExportJobResponse Text
startReadSetExportJobResponse_status :: Lens' StartReadSetExportJobResponse ReadSetExportJobStatus

Creating a Request

data StartReadSetExportJob Source #

See: newStartReadSetExportJob smart constructor.

Constructors

StartReadSetExportJob'
Fields clientToken :: Maybe Text To ensure that jobs don't run multiple times, specify a unique token for each job. destination :: Text A location for exported files in Amazon S3. roleArn :: Text A service role for the job. sequenceStoreId :: Text The read set's sequence store ID. sources :: NonEmpty ExportReadSet Sources for the job.

Instances

Instances details

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

newStartReadSetExportJob Source #

Arguments

:: Text	`StartReadSetExportJob`
-> Text	`StartReadSetExportJob`
-> Text	`StartReadSetExportJob`
-> NonEmpty ExportReadSet	`$sel:sources:StartReadSetExportJob'`
-> StartReadSetExportJob

Create a value of StartReadSetExportJob 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:clientToken:StartReadSetExportJob', startReadSetExportJob_clientToken - To ensure that jobs don't run multiple times, specify a unique token for each job.

StartReadSetExportJob, startReadSetExportJob_destination - A location for exported files in Amazon S3.

StartReadSetExportJob, startReadSetExportJob_roleArn - A service role for the job.

StartReadSetExportJob, startReadSetExportJob_sequenceStoreId - The read set's sequence store ID.

$sel:sources:StartReadSetExportJob', startReadSetExportJob_sources - Sources for the job.

Request Lenses

startReadSetExportJob_clientToken :: Lens' StartReadSetExportJob (Maybe Text) Source #

To ensure that jobs don't run multiple times, specify a unique token for each job.

startReadSetExportJob_destination :: Lens' StartReadSetExportJob Text Source #

A location for exported files in Amazon S3.

startReadSetExportJob_roleArn :: Lens' StartReadSetExportJob Text Source #

A service role for the job.

startReadSetExportJob_sequenceStoreId :: Lens' StartReadSetExportJob Text Source #

The read set's sequence store ID.

startReadSetExportJob_sources :: Lens' StartReadSetExportJob (NonEmpty ExportReadSet) Source #

Sources for the job.

Destructuring the Response

data StartReadSetExportJobResponse Source #

See: newStartReadSetExportJobResponse smart constructor.

Constructors

StartReadSetExportJobResponse'
Fields httpStatus :: Int The response's http status code. creationTime :: ISO8601 When the job was created. destination :: Text The job's output location. id :: Text The job's ID. sequenceStoreId :: Text The read set's sequence store ID. status :: ReadSetExportJobStatus The job's status.

Instances

Instances details

Generic StartReadSetExportJobResponse Source #
Instance details Defined in Amazonka.Omics.StartReadSetExportJob Associated Types type Rep StartReadSetExportJobResponse :: Type -> Type # Methods from :: StartReadSetExportJobResponse -> Rep StartReadSetExportJobResponse x # to :: Rep StartReadSetExportJobResponse x -> StartReadSetExportJobResponse #
Read StartReadSetExportJobResponse Source #
Instance details Defined in Amazonka.Omics.StartReadSetExportJob Methods readsPrec :: Int -> ReadS StartReadSetExportJobResponse # readList :: ReadS [StartReadSetExportJobResponse] # readPrec :: ReadPrec StartReadSetExportJobResponse # readListPrec :: ReadPrec [StartReadSetExportJobResponse] #
Show StartReadSetExportJobResponse Source #
Instance details Defined in Amazonka.Omics.StartReadSetExportJob Methods showsPrec :: Int -> StartReadSetExportJobResponse -> ShowS # show :: StartReadSetExportJobResponse -> String # showList :: [StartReadSetExportJobResponse] -> ShowS #
NFData StartReadSetExportJobResponse Source #
Instance details Defined in Amazonka.Omics.StartReadSetExportJob Methods rnf :: StartReadSetExportJobResponse -> () #
Eq StartReadSetExportJobResponse Source #
Instance details Defined in Amazonka.Omics.StartReadSetExportJob Methods (==) :: StartReadSetExportJobResponse -> StartReadSetExportJobResponse -> Bool # (/=) :: StartReadSetExportJobResponse -> StartReadSetExportJobResponse -> Bool #
type Rep StartReadSetExportJobResponse Source #
Instance details Defined in Amazonka.Omics.StartReadSetExportJob type Rep StartReadSetExportJobResponse = D1 ('MetaData "StartReadSetExportJobResponse" "Amazonka.Omics.StartReadSetExportJob" "amazonka-omics-2.0-9t5CXL0ZQCvGfVWhQWVGKJ" 'False) (C1 ('MetaCons "StartReadSetExportJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "sequenceStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReadSetExportJobStatus)))))

newStartReadSetExportJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartReadSetExportJobResponse'`
-> UTCTime	`StartReadSetExportJobResponse`
-> Text	`StartReadSetExportJob`
-> Text	`StartReadSetExportJobResponse`
-> Text	`StartReadSetExportJob`
-> ReadSetExportJobStatus	`StartReadSetExportJobResponse`
-> StartReadSetExportJobResponse