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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the specified flow definition.

Synopsis

Creating a Request

data DescribeFlowDefinition Source #

See: newDescribeFlowDefinition smart constructor.

Constructors

DescribeFlowDefinition'
Fields flowDefinitionName :: Text The name of the flow definition.

Instances

Instances details

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

newDescribeFlowDefinition Source #

Arguments

:: Text	`DescribeFlowDefinition`
-> DescribeFlowDefinition

Create a value of DescribeFlowDefinition 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:

DescribeFlowDefinition, describeFlowDefinition_flowDefinitionName - The name of the flow definition.

Request Lenses

describeFlowDefinition_flowDefinitionName :: Lens' DescribeFlowDefinition Text Source #

The name of the flow definition.

Destructuring the Response

data DescribeFlowDefinitionResponse Source #

See: newDescribeFlowDefinitionResponse smart constructor.

Constructors

DescribeFlowDefinitionResponse'

Fields

failureReason :: Maybe Text
The reason your flow definition failed.
humanLoopActivationConfig :: Maybe HumanLoopActivationConfig
An object containing information about what triggers a human review workflow.
humanLoopRequestSource :: Maybe HumanLoopRequestSource
Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
httpStatus :: Int
The response's http status code.
flowDefinitionArn :: Text
The Amazon Resource Name (ARN) of the flow defintion.
flowDefinitionName :: Text
The Amazon Resource Name (ARN) of the flow definition.
flowDefinitionStatus :: FlowDefinitionStatus
The status of the flow definition. Valid values are listed below.
creationTime :: POSIX
The timestamp when the flow definition was created.
humanLoopConfig :: HumanLoopConfig
An object containing information about who works on the task, the workforce task price, and other task details.
outputConfig :: FlowDefinitionOutputConfig
An object containing information about the output file.
roleArn :: Text
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

Instances

Instances details

Generic DescribeFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeFlowDefinition Associated Types type Rep DescribeFlowDefinitionResponse :: Type -> Type # Methods from :: DescribeFlowDefinitionResponse -> Rep DescribeFlowDefinitionResponse x # to :: Rep DescribeFlowDefinitionResponse x -> DescribeFlowDefinitionResponse #
Read DescribeFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeFlowDefinition Methods readsPrec :: Int -> ReadS DescribeFlowDefinitionResponse # readList :: ReadS [DescribeFlowDefinitionResponse] # readPrec :: ReadPrec DescribeFlowDefinitionResponse # readListPrec :: ReadPrec [DescribeFlowDefinitionResponse] #
Show DescribeFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeFlowDefinition Methods showsPrec :: Int -> DescribeFlowDefinitionResponse -> ShowS # show :: DescribeFlowDefinitionResponse -> String # showList :: [DescribeFlowDefinitionResponse] -> ShowS #
NFData DescribeFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeFlowDefinition Methods rnf :: DescribeFlowDefinitionResponse -> () #
Eq DescribeFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeFlowDefinition Methods (==) :: DescribeFlowDefinitionResponse -> DescribeFlowDefinitionResponse -> Bool # (/=) :: DescribeFlowDefinitionResponse -> DescribeFlowDefinitionResponse -> Bool #
type Rep DescribeFlowDefinitionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeFlowDefinition type Rep DescribeFlowDefinitionResponse = D1 ('MetaData "DescribeFlowDefinitionResponse" "Amazonka.SageMaker.DescribeFlowDefinition" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeFlowDefinitionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "humanLoopActivationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopActivationConfig))) :: (S1 ('MetaSel ('Just "humanLoopRequestSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopRequestSource)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "flowDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "flowDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "flowDefinitionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FlowDefinitionStatus) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :: (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))))))

newDescribeFlowDefinitionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeFlowDefinitionResponse'`
-> Text	`DescribeFlowDefinitionResponse`
-> Text	`DescribeFlowDefinition`
-> FlowDefinitionStatus	`DescribeFlowDefinitionResponse`
-> UTCTime	`DescribeFlowDefinitionResponse`
-> HumanLoopConfig	`$sel:humanLoopConfig:DescribeFlowDefinitionResponse'`
-> FlowDefinitionOutputConfig	`DescribeFlowDefinitionResponse`
-> Text	`DescribeFlowDefinitionResponse`
-> DescribeFlowDefinitionResponse

Create a value of DescribeFlowDefinitionResponse 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:

DescribeFlowDefinitionResponse, describeFlowDefinitionResponse_failureReason - The reason your flow definition failed.

$sel:humanLoopActivationConfig:DescribeFlowDefinitionResponse', describeFlowDefinitionResponse_humanLoopActivationConfig - An object containing information about what triggers a human review workflow.

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

$sel:httpStatus:DescribeFlowDefinitionResponse', describeFlowDefinitionResponse_httpStatus - The response's http status code.

DescribeFlowDefinitionResponse, describeFlowDefinitionResponse_flowDefinitionArn - The Amazon Resource Name (ARN) of the flow defintion.

DescribeFlowDefinition, describeFlowDefinitionResponse_flowDefinitionName - The Amazon Resource Name (ARN) of the flow definition.

DescribeFlowDefinitionResponse, describeFlowDefinitionResponse_flowDefinitionStatus - The status of the flow definition. Valid values are listed below.

DescribeFlowDefinitionResponse, describeFlowDefinitionResponse_creationTime - The timestamp when the flow definition was created.

$sel:humanLoopConfig:DescribeFlowDefinitionResponse', describeFlowDefinitionResponse_humanLoopConfig - An object containing information about who works on the task, the workforce task price, and other task details.

DescribeFlowDefinitionResponse, describeFlowDefinitionResponse_outputConfig - An object containing information about the output file.

DescribeFlowDefinitionResponse, describeFlowDefinitionResponse_roleArn - The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

Response Lenses

describeFlowDefinitionResponse_failureReason :: Lens' DescribeFlowDefinitionResponse (Maybe Text) Source #

The reason your flow definition failed.

describeFlowDefinitionResponse_humanLoopActivationConfig :: Lens' DescribeFlowDefinitionResponse (Maybe HumanLoopActivationConfig) Source #

An object containing information about what triggers a human review workflow.

describeFlowDefinitionResponse_humanLoopRequestSource :: Lens' DescribeFlowDefinitionResponse (Maybe HumanLoopRequestSource) Source #

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

describeFlowDefinitionResponse_httpStatus :: Lens' DescribeFlowDefinitionResponse Int Source #

The response's http status code.

describeFlowDefinitionResponse_flowDefinitionArn :: Lens' DescribeFlowDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the flow defintion.

describeFlowDefinitionResponse_flowDefinitionName :: Lens' DescribeFlowDefinitionResponse Text Source #

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

describeFlowDefinitionResponse_flowDefinitionStatus :: Lens' DescribeFlowDefinitionResponse FlowDefinitionStatus Source #

The status of the flow definition. Valid values are listed below.

describeFlowDefinitionResponse_creationTime :: Lens' DescribeFlowDefinitionResponse UTCTime Source #

The timestamp when the flow definition was created.

describeFlowDefinitionResponse_humanLoopConfig :: Lens' DescribeFlowDefinitionResponse HumanLoopConfig Source #

An object containing information about who works on the task, the workforce task price, and other task details.

describeFlowDefinitionResponse_outputConfig :: Lens' DescribeFlowDefinitionResponse FlowDefinitionOutputConfig Source #

An object containing information about the output file.

describeFlowDefinitionResponse_roleArn :: Lens' DescribeFlowDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.