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.SageMaker.CreateFlowDefinition

Contents

Description

Creates a flow definition.

Synopsis

Creating a Request

data CreateFlowDefinition Source #

See: newCreateFlowDefinition smart constructor.

Constructors

CreateFlowDefinition'

Fields

humanLoopActivationConfig :: Maybe HumanLoopActivationConfig
An object containing information about the events that trigger a human workflow.
humanLoopRequestSource :: Maybe HumanLoopRequestSource
Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
tags :: Maybe [Tag]
An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.
flowDefinitionName :: Text
The name of your flow definition.
humanLoopConfig :: HumanLoopConfig
An object containing information about the tasks the human reviewers will perform.
outputConfig :: FlowDefinitionOutputConfig
An object containing information about where the human review results will be uploaded.
roleArn :: Text
The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

Instances

Instances details

ToJSON CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods toJSON :: CreateFlowDefinition -> Value # toEncoding :: CreateFlowDefinition -> Encoding # toJSONList :: [CreateFlowDefinition] -> Value # toEncodingList :: [CreateFlowDefinition] -> Encoding #
ToHeaders CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods toHeaders :: CreateFlowDefinition -> [Header] #
ToPath CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods toPath :: CreateFlowDefinition -> ByteString #
ToQuery CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods toQuery :: CreateFlowDefinition -> QueryString #
AWSRequest CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Associated Types type AWSResponse CreateFlowDefinition # Methods request :: (Service -> Service) -> CreateFlowDefinition -> Request CreateFlowDefinition # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFlowDefinition -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFlowDefinition))) #
Generic CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Associated Types type Rep CreateFlowDefinition :: Type -> Type # Methods from :: CreateFlowDefinition -> Rep CreateFlowDefinition x # to :: Rep CreateFlowDefinition x -> CreateFlowDefinition #
Read CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods readsPrec :: Int -> ReadS CreateFlowDefinition # readList :: ReadS [CreateFlowDefinition] # readPrec :: ReadPrec CreateFlowDefinition # readListPrec :: ReadPrec [CreateFlowDefinition] #
Show CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods showsPrec :: Int -> CreateFlowDefinition -> ShowS # show :: CreateFlowDefinition -> String # showList :: [CreateFlowDefinition] -> ShowS #
NFData CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods rnf :: CreateFlowDefinition -> () #
Eq CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods (==) :: CreateFlowDefinition -> CreateFlowDefinition -> Bool # (/=) :: CreateFlowDefinition -> CreateFlowDefinition -> Bool #
Hashable CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods hashWithSalt :: Int -> CreateFlowDefinition -> Int # hash :: CreateFlowDefinition -> Int #
type AWSResponse CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition type AWSResponse CreateFlowDefinition = CreateFlowDefinitionResponse
type Rep CreateFlowDefinition Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition type Rep CreateFlowDefinition = D1 ('MetaData "CreateFlowDefinition" "Amazonka.SageMaker.CreateFlowDefinition" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateFlowDefinition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "humanLoopActivationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopActivationConfig)) :: (S1 ('MetaSel ('Just "humanLoopRequestSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopRequestSource)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: ((S1 ('MetaSel ('Just "flowDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "humanLoopConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HumanLoopConfig)) :: (S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FlowDefinitionOutputConfig) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateFlowDefinition Source #

Arguments

:: Text	`CreateFlowDefinition`
-> HumanLoopConfig	`$sel:humanLoopConfig:CreateFlowDefinition'`
-> FlowDefinitionOutputConfig	`CreateFlowDefinition`
-> Text	`CreateFlowDefinition`
-> CreateFlowDefinition

Create a value of CreateFlowDefinition 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:humanLoopActivationConfig:CreateFlowDefinition', createFlowDefinition_humanLoopActivationConfig - An object containing information about the events that trigger a human workflow.

$sel:humanLoopRequestSource:CreateFlowDefinition', createFlowDefinition_humanLoopRequestSource - Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

CreateFlowDefinition, createFlowDefinition_tags - An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

CreateFlowDefinition, createFlowDefinition_flowDefinitionName - The name of your flow definition.

$sel:humanLoopConfig:CreateFlowDefinition', createFlowDefinition_humanLoopConfig - An object containing information about the tasks the human reviewers will perform.

CreateFlowDefinition, createFlowDefinition_outputConfig - An object containing information about where the human review results will be uploaded.

CreateFlowDefinition, createFlowDefinition_roleArn - The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

Request Lenses

createFlowDefinition_humanLoopActivationConfig :: Lens' CreateFlowDefinition (Maybe HumanLoopActivationConfig) Source #

An object containing information about the events that trigger a human workflow.

createFlowDefinition_humanLoopRequestSource :: Lens' CreateFlowDefinition (Maybe HumanLoopRequestSource) Source #

Container for configuring the source of human task requests. Use to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

createFlowDefinition_tags :: Lens' CreateFlowDefinition (Maybe [Tag]) Source #

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

createFlowDefinition_flowDefinitionName :: Lens' CreateFlowDefinition Text Source #

The name of your flow definition.

createFlowDefinition_humanLoopConfig :: Lens' CreateFlowDefinition HumanLoopConfig Source #

An object containing information about the tasks the human reviewers will perform.

createFlowDefinition_outputConfig :: Lens' CreateFlowDefinition FlowDefinitionOutputConfig Source #

An object containing information about where the human review results will be uploaded.

createFlowDefinition_roleArn :: Lens' CreateFlowDefinition Text Source #

The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.

Destructuring the Response

data CreateFlowDefinitionResponse Source #

See: newCreateFlowDefinitionResponse smart constructor.

Constructors

CreateFlowDefinitionResponse'
Fields httpStatus :: Int The response's http status code. flowDefinitionArn :: Text The Amazon Resource Name (ARN) of the flow definition you create.

Instances

Instances details

Generic CreateFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Associated Types type Rep CreateFlowDefinitionResponse :: Type -> Type # Methods from :: CreateFlowDefinitionResponse -> Rep CreateFlowDefinitionResponse x # to :: Rep CreateFlowDefinitionResponse x -> CreateFlowDefinitionResponse #
Read CreateFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods readsPrec :: Int -> ReadS CreateFlowDefinitionResponse # readList :: ReadS [CreateFlowDefinitionResponse] # readPrec :: ReadPrec CreateFlowDefinitionResponse # readListPrec :: ReadPrec [CreateFlowDefinitionResponse] #
Show CreateFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods showsPrec :: Int -> CreateFlowDefinitionResponse -> ShowS # show :: CreateFlowDefinitionResponse -> String # showList :: [CreateFlowDefinitionResponse] -> ShowS #
NFData CreateFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods rnf :: CreateFlowDefinitionResponse -> () #
Eq CreateFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition Methods (==) :: CreateFlowDefinitionResponse -> CreateFlowDefinitionResponse -> Bool # (/=) :: CreateFlowDefinitionResponse -> CreateFlowDefinitionResponse -> Bool #
type Rep CreateFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateFlowDefinition type Rep CreateFlowDefinitionResponse = D1 ('MetaData "CreateFlowDefinitionResponse" "Amazonka.SageMaker.CreateFlowDefinition" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateFlowDefinitionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "flowDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateFlowDefinitionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateFlowDefinitionResponse'`
-> Text	`CreateFlowDefinitionResponse`
-> CreateFlowDefinitionResponse

Create a value of CreateFlowDefinitionResponse 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:httpStatus:CreateFlowDefinitionResponse', createFlowDefinitionResponse_httpStatus - The response's http status code.

CreateFlowDefinitionResponse, createFlowDefinitionResponse_flowDefinitionArn - The Amazon Resource Name (ARN) of the flow definition you create.

Response Lenses

createFlowDefinitionResponse_httpStatus :: Lens' CreateFlowDefinitionResponse Int Source #

The response's http status code.

createFlowDefinitionResponse_flowDefinitionArn :: Lens' CreateFlowDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the flow definition you create.