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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a workflow.

Synopsis

data CreateWorkflow = CreateWorkflow' {
- definitionUri :: Maybe Text
- definitionZip :: Maybe Base64
- description :: Maybe Text
- engine :: Maybe WorkflowEngine
- main :: Maybe Text
- name :: Maybe Text
- parameterTemplate :: Maybe (HashMap Text WorkflowParameter)
- storageCapacity :: Maybe Natural
- tags :: Maybe (HashMap Text Text)
- requestId :: Text
}
newCreateWorkflow :: Text -> CreateWorkflow
createWorkflow_definitionUri :: Lens' CreateWorkflow (Maybe Text)
createWorkflow_definitionZip :: Lens' CreateWorkflow (Maybe ByteString)
createWorkflow_description :: Lens' CreateWorkflow (Maybe Text)
createWorkflow_engine :: Lens' CreateWorkflow (Maybe WorkflowEngine)
createWorkflow_main :: Lens' CreateWorkflow (Maybe Text)
createWorkflow_name :: Lens' CreateWorkflow (Maybe Text)
createWorkflow_parameterTemplate :: Lens' CreateWorkflow (Maybe (HashMap Text WorkflowParameter))
createWorkflow_storageCapacity :: Lens' CreateWorkflow (Maybe Natural)
createWorkflow_tags :: Lens' CreateWorkflow (Maybe (HashMap Text Text))
createWorkflow_requestId :: Lens' CreateWorkflow Text
data CreateWorkflowResponse = CreateWorkflowResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- status :: Maybe WorkflowStatus
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newCreateWorkflowResponse :: Int -> CreateWorkflowResponse
createWorkflowResponse_arn :: Lens' CreateWorkflowResponse (Maybe Text)
createWorkflowResponse_id :: Lens' CreateWorkflowResponse (Maybe Text)
createWorkflowResponse_status :: Lens' CreateWorkflowResponse (Maybe WorkflowStatus)
createWorkflowResponse_tags :: Lens' CreateWorkflowResponse (Maybe (HashMap Text Text))
createWorkflowResponse_httpStatus :: Lens' CreateWorkflowResponse Int

Creating a Request

data CreateWorkflow Source #

See: newCreateWorkflow smart constructor.

Constructors

CreateWorkflow'

Fields

definitionUri :: Maybe Text
The URI of a definition for the workflow.
definitionZip :: Maybe Base64
A ZIP archive for the workflow.
description :: Maybe Text
A description for the workflow.
engine :: Maybe WorkflowEngine
An engine for the workflow.
main :: Maybe Text
The path of the main definition file for the workflow.
name :: Maybe Text
A name for the workflow.
parameterTemplate :: Maybe (HashMap Text WorkflowParameter)
A parameter template for the workflow.
storageCapacity :: Maybe Natural
A storage capacity for the workflow.
tags :: Maybe (HashMap Text Text)
Tags for the workflow.
requestId :: Text
A request ID for the workflow.

Instances

Instances details

ToJSON CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods toJSON :: CreateWorkflow -> Value # toEncoding :: CreateWorkflow -> Encoding # toJSONList :: [CreateWorkflow] -> Value # toEncodingList :: [CreateWorkflow] -> Encoding #
ToHeaders CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods toHeaders :: CreateWorkflow -> [Header] #
ToPath CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods toPath :: CreateWorkflow -> ByteString #
ToQuery CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods toQuery :: CreateWorkflow -> QueryString #
AWSRequest CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Associated Types type AWSResponse CreateWorkflow # Methods request :: (Service -> Service) -> CreateWorkflow -> Request CreateWorkflow # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWorkflow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkflow))) #
Generic CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Associated Types type Rep CreateWorkflow :: Type -> Type # Methods from :: CreateWorkflow -> Rep CreateWorkflow x # to :: Rep CreateWorkflow x -> CreateWorkflow #
Read CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods readsPrec :: Int -> ReadS CreateWorkflow # readList :: ReadS [CreateWorkflow] # readPrec :: ReadPrec CreateWorkflow # readListPrec :: ReadPrec [CreateWorkflow] #
Show CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods showsPrec :: Int -> CreateWorkflow -> ShowS # show :: CreateWorkflow -> String # showList :: [CreateWorkflow] -> ShowS #
NFData CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods rnf :: CreateWorkflow -> () #
Eq CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods (==) :: CreateWorkflow -> CreateWorkflow -> Bool # (/=) :: CreateWorkflow -> CreateWorkflow -> Bool #
Hashable CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow Methods hashWithSalt :: Int -> CreateWorkflow -> Int # hash :: CreateWorkflow -> Int #
type AWSResponse CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow type AWSResponse CreateWorkflow = CreateWorkflowResponse
type Rep CreateWorkflow Source #
Instance details Defined in Amazonka.Omics.CreateWorkflow type Rep CreateWorkflow = D1 ('MetaData "CreateWorkflow" "Amazonka.Omics.CreateWorkflow" "amazonka-omics-2.0-9t5CXL0ZQCvGfVWhQWVGKJ" 'False) (C1 ('MetaCons "CreateWorkflow'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "definitionUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "definitionZip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowEngine)) :: S1 ('MetaSel ('Just "main") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameterTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text WorkflowParameter)))) :: (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 "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateWorkflow Source #

Arguments

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

Create a value of CreateWorkflow 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:definitionUri:CreateWorkflow', createWorkflow_definitionUri - The URI of a definition for the workflow.

$sel:definitionZip:CreateWorkflow', createWorkflow_definitionZip - A ZIP archive for the workflow.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

CreateWorkflow, createWorkflow_description - A description for the workflow.

$sel:engine:CreateWorkflow', createWorkflow_engine - An engine for the workflow.

$sel:main:CreateWorkflow', createWorkflow_main - The path of the main definition file for the workflow.

CreateWorkflow, createWorkflow_name - A name for the workflow.

$sel:parameterTemplate:CreateWorkflow', createWorkflow_parameterTemplate - A parameter template for the workflow.

CreateWorkflow, createWorkflow_storageCapacity - A storage capacity for the workflow.

CreateWorkflow, createWorkflow_tags - Tags for the workflow.

$sel:requestId:CreateWorkflow', createWorkflow_requestId - A request ID for the workflow.

Request Lenses

createWorkflow_definitionUri :: Lens' CreateWorkflow (Maybe Text) Source #

The URI of a definition for the workflow.

createWorkflow_definitionZip :: Lens' CreateWorkflow (Maybe ByteString) Source #

A ZIP archive for the workflow.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

createWorkflow_description :: Lens' CreateWorkflow (Maybe Text) Source #

A description for the workflow.

createWorkflow_engine :: Lens' CreateWorkflow (Maybe WorkflowEngine) Source #

An engine for the workflow.

createWorkflow_main :: Lens' CreateWorkflow (Maybe Text) Source #

The path of the main definition file for the workflow.

createWorkflow_name :: Lens' CreateWorkflow (Maybe Text) Source #

A name for the workflow.

createWorkflow_parameterTemplate :: Lens' CreateWorkflow (Maybe (HashMap Text WorkflowParameter)) Source #

A parameter template for the workflow.

createWorkflow_storageCapacity :: Lens' CreateWorkflow (Maybe Natural) Source #

A storage capacity for the workflow.

createWorkflow_tags :: Lens' CreateWorkflow (Maybe (HashMap Text Text)) Source #

Tags for the workflow.

createWorkflow_requestId :: Lens' CreateWorkflow Text Source #

A request ID for the workflow.

Destructuring the Response

data CreateWorkflowResponse Source #

See: newCreateWorkflowResponse smart constructor.

Constructors

CreateWorkflowResponse'
Fields arn :: Maybe Text The workflow's ARN. id :: Maybe Text The workflow's ID. status :: Maybe WorkflowStatus The workflow's status. tags :: Maybe (HashMap Text Text) The workflow's tags. httpStatus :: Int The response's http status code.

Instances

Instances details

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