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.StartRun

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a run.

Synopsis

data StartRun = StartRun' {
- logLevel :: Maybe RunLogLevel
- name :: Maybe Text
- outputUri :: Maybe Text
- parameters :: Maybe RunParameters
- priority :: Maybe Natural
- runGroupId :: Maybe Text
- runId :: Maybe Text
- storageCapacity :: Maybe Natural
- tags :: Maybe (HashMap Text Text)
- workflowId :: Maybe Text
- workflowType :: Maybe WorkflowType
- requestId :: Text
- roleArn :: Text
}
newStartRun :: Text -> Text -> StartRun
startRun_logLevel :: Lens' StartRun (Maybe RunLogLevel)
startRun_name :: Lens' StartRun (Maybe Text)
startRun_outputUri :: Lens' StartRun (Maybe Text)
startRun_parameters :: Lens' StartRun (Maybe RunParameters)
startRun_priority :: Lens' StartRun (Maybe Natural)
startRun_runGroupId :: Lens' StartRun (Maybe Text)
startRun_runId :: Lens' StartRun (Maybe Text)
startRun_storageCapacity :: Lens' StartRun (Maybe Natural)
startRun_tags :: Lens' StartRun (Maybe (HashMap Text Text))
startRun_workflowId :: Lens' StartRun (Maybe Text)
startRun_workflowType :: Lens' StartRun (Maybe WorkflowType)
startRun_requestId :: Lens' StartRun Text
startRun_roleArn :: Lens' StartRun Text
data StartRunResponse = StartRunResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- status :: Maybe RunStatus
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newStartRunResponse :: Int -> StartRunResponse
startRunResponse_arn :: Lens' StartRunResponse (Maybe Text)
startRunResponse_id :: Lens' StartRunResponse (Maybe Text)
startRunResponse_status :: Lens' StartRunResponse (Maybe RunStatus)
startRunResponse_tags :: Lens' StartRunResponse (Maybe (HashMap Text Text))
startRunResponse_httpStatus :: Lens' StartRunResponse Int

Creating a Request

data StartRun Source #

See: newStartRun smart constructor.

Constructors

StartRun'

Fields

logLevel :: Maybe RunLogLevel
A log level for the run.
name :: Maybe Text
A name for the run.
outputUri :: Maybe Text
An output URI for the run.
parameters :: Maybe RunParameters
Parameters for the run.
priority :: Maybe Natural
A priority for the run.
runGroupId :: Maybe Text
The run's group ID.
runId :: Maybe Text
The run's ID.
storageCapacity :: Maybe Natural
A storage capacity for the run.
tags :: Maybe (HashMap Text Text)
Tags for the run.
workflowId :: Maybe Text
The run's workflow ID.
workflowType :: Maybe WorkflowType
The run's workflows type.
requestId :: Text
A request ID for the run.
roleArn :: Text
A service role for the run.

Instances

Instances details

ToJSON StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods toJSON :: StartRun -> Value # toEncoding :: StartRun -> Encoding # toJSONList :: [StartRun] -> Value # toEncodingList :: [StartRun] -> Encoding #
ToHeaders StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods toHeaders :: StartRun -> [Header] #
ToPath StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods toPath :: StartRun -> ByteString #
ToQuery StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods toQuery :: StartRun -> QueryString #
AWSRequest StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Associated Types type AWSResponse StartRun # Methods request :: (Service -> Service) -> StartRun -> Request StartRun # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartRun -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartRun))) #
Generic StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Associated Types type Rep StartRun :: Type -> Type # Methods from :: StartRun -> Rep StartRun x # to :: Rep StartRun x -> StartRun #
Read StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods readsPrec :: Int -> ReadS StartRun # readList :: ReadS [StartRun] # readPrec :: ReadPrec StartRun # readListPrec :: ReadPrec [StartRun] #
Show StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods showsPrec :: Int -> StartRun -> ShowS # show :: StartRun -> String # showList :: [StartRun] -> ShowS #
NFData StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods rnf :: StartRun -> () #
Eq StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods (==) :: StartRun -> StartRun -> Bool # (/=) :: StartRun -> StartRun -> Bool #
Hashable StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun Methods hashWithSalt :: Int -> StartRun -> Int # hash :: StartRun -> Int #
type AWSResponse StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun type AWSResponse StartRun = StartRunResponse
type Rep StartRun Source #
Instance details Defined in Amazonka.Omics.StartRun type Rep StartRun = D1 ('MetaData "StartRun" "Amazonka.Omics.StartRun" "amazonka-omics-2.0-9t5CXL0ZQCvGfVWhQWVGKJ" 'False) (C1 ('MetaCons "StartRun'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "logLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RunLogLevel)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "outputUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RunParameters)) :: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "runGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "runId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "storageCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "workflowType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowType))) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newStartRun Source #

Arguments

:: Text	`$sel:requestId:StartRun'`
-> Text	`StartRun`
-> StartRun

Create a value of StartRun 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:logLevel:StartRun', startRun_logLevel - A log level for the run.

StartRun, startRun_name - A name for the run.

$sel:outputUri:StartRun', startRun_outputUri - An output URI for the run.

$sel:parameters:StartRun', startRun_parameters - Parameters for the run.

StartRun, startRun_priority - A priority for the run.

$sel:runGroupId:StartRun', startRun_runGroupId - The run's group ID.

$sel:runId:StartRun', startRun_runId - The run's ID.

StartRun, startRun_storageCapacity - A storage capacity for the run.

StartRun, startRun_tags - Tags for the run.

StartRun, startRun_workflowId - The run's workflow ID.

$sel:workflowType:StartRun', startRun_workflowType - The run's workflows type.

$sel:requestId:StartRun', startRun_requestId - A request ID for the run.

StartRun, startRun_roleArn - A service role for the run.

Request Lenses

startRun_logLevel :: Lens' StartRun (Maybe RunLogLevel) Source #

A log level for the run.

startRun_name :: Lens' StartRun (Maybe Text) Source #

A name for the run.

startRun_outputUri :: Lens' StartRun (Maybe Text) Source #

An output URI for the run.

startRun_parameters :: Lens' StartRun (Maybe RunParameters) Source #

Parameters for the run.

startRun_priority :: Lens' StartRun (Maybe Natural) Source #

A priority for the run.

startRun_runGroupId :: Lens' StartRun (Maybe Text) Source #

The run's group ID.

startRun_runId :: Lens' StartRun (Maybe Text) Source #

The run's ID.

startRun_storageCapacity :: Lens' StartRun (Maybe Natural) Source #

A storage capacity for the run.

startRun_tags :: Lens' StartRun (Maybe (HashMap Text Text)) Source #

Tags for the run.

startRun_workflowId :: Lens' StartRun (Maybe Text) Source #

The run's workflow ID.

startRun_workflowType :: Lens' StartRun (Maybe WorkflowType) Source #

The run's workflows type.

startRun_requestId :: Lens' StartRun Text Source #

A request ID for the run.

startRun_roleArn :: Lens' StartRun Text Source #

A service role for the run.

Destructuring the Response

data StartRunResponse Source #

See: newStartRunResponse smart constructor.

Constructors

StartRunResponse'
Fields arn :: Maybe Text The run's ARN. id :: Maybe Text The run's ID. status :: Maybe RunStatus The run's status. tags :: Maybe (HashMap Text Text) The run's tags. httpStatus :: Int The response's http status code.

Instances

Instances details

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