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.SageMakerA2IRuntime.DescribeHumanLoop

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.

Synopsis

data DescribeHumanLoop = DescribeHumanLoop' {
- humanLoopName :: Text
}
newDescribeHumanLoop :: Text -> DescribeHumanLoop
describeHumanLoop_humanLoopName :: Lens' DescribeHumanLoop Text
data DescribeHumanLoopResponse = DescribeHumanLoopResponse' {
- failureCode :: Maybe Text
- failureReason :: Maybe Text
- humanLoopOutput :: Maybe HumanLoopOutput
- httpStatus :: Int
- creationTime :: ISO8601
- humanLoopStatus :: HumanLoopStatus
- humanLoopName :: Text
- humanLoopArn :: Text
- flowDefinitionArn :: Text
}
newDescribeHumanLoopResponse :: Int -> UTCTime -> HumanLoopStatus -> Text -> Text -> Text -> DescribeHumanLoopResponse
describeHumanLoopResponse_failureCode :: Lens' DescribeHumanLoopResponse (Maybe Text)
describeHumanLoopResponse_failureReason :: Lens' DescribeHumanLoopResponse (Maybe Text)
describeHumanLoopResponse_humanLoopOutput :: Lens' DescribeHumanLoopResponse (Maybe HumanLoopOutput)
describeHumanLoopResponse_httpStatus :: Lens' DescribeHumanLoopResponse Int
describeHumanLoopResponse_creationTime :: Lens' DescribeHumanLoopResponse UTCTime
describeHumanLoopResponse_humanLoopStatus :: Lens' DescribeHumanLoopResponse HumanLoopStatus
describeHumanLoopResponse_humanLoopName :: Lens' DescribeHumanLoopResponse Text
describeHumanLoopResponse_humanLoopArn :: Lens' DescribeHumanLoopResponse Text
describeHumanLoopResponse_flowDefinitionArn :: Lens' DescribeHumanLoopResponse Text

Creating a Request

data DescribeHumanLoop Source #

See: newDescribeHumanLoop smart constructor.

Constructors

DescribeHumanLoop'
Fields humanLoopName :: Text The name of the human loop that you want information about.

Instances

Instances details

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

newDescribeHumanLoop Source #

Arguments

:: Text	`DescribeHumanLoop`
-> DescribeHumanLoop

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

DescribeHumanLoop, describeHumanLoop_humanLoopName - The name of the human loop that you want information about.

Request Lenses

describeHumanLoop_humanLoopName :: Lens' DescribeHumanLoop Text Source #

The name of the human loop that you want information about.

Destructuring the Response

data DescribeHumanLoopResponse Source #

See: newDescribeHumanLoopResponse smart constructor.

Constructors

DescribeHumanLoopResponse'

Fields

failureCode :: Maybe Text
A failure code that identifies the type of failure.
Possible values: ValidationError, Expired, InternalError
failureReason :: Maybe Text
The reason why a human loop failed. The failure reason is returned when the status of the human loop is Failed.
humanLoopOutput :: Maybe HumanLoopOutput
An object that contains information about the output of the human loop.
httpStatus :: Int
The response's http status code.
creationTime :: ISO8601
The creation time when Amazon Augmented AI created the human loop.
humanLoopStatus :: HumanLoopStatus
The status of the human loop.
humanLoopName :: Text
The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).
humanLoopArn :: Text
The Amazon Resource Name (ARN) of the human loop.
flowDefinitionArn :: Text
The Amazon Resource Name (ARN) of the flow definition.

Instances

Instances details

Generic DescribeHumanLoopResponse Source #
Instance details Defined in Amazonka.SageMakerA2IRuntime.DescribeHumanLoop Associated Types type Rep DescribeHumanLoopResponse :: Type -> Type # Methods from :: DescribeHumanLoopResponse -> Rep DescribeHumanLoopResponse x # to :: Rep DescribeHumanLoopResponse x -> DescribeHumanLoopResponse #
Read DescribeHumanLoopResponse Source #
Instance details Defined in Amazonka.SageMakerA2IRuntime.DescribeHumanLoop Methods readsPrec :: Int -> ReadS DescribeHumanLoopResponse # readList :: ReadS [DescribeHumanLoopResponse] # readPrec :: ReadPrec DescribeHumanLoopResponse # readListPrec :: ReadPrec [DescribeHumanLoopResponse] #
Show DescribeHumanLoopResponse Source #
Instance details Defined in Amazonka.SageMakerA2IRuntime.DescribeHumanLoop Methods showsPrec :: Int -> DescribeHumanLoopResponse -> ShowS # show :: DescribeHumanLoopResponse -> String # showList :: [DescribeHumanLoopResponse] -> ShowS #
NFData DescribeHumanLoopResponse Source #
Instance details Defined in Amazonka.SageMakerA2IRuntime.DescribeHumanLoop Methods rnf :: DescribeHumanLoopResponse -> () #
Eq DescribeHumanLoopResponse Source #
Instance details Defined in Amazonka.SageMakerA2IRuntime.DescribeHumanLoop Methods (==) :: DescribeHumanLoopResponse -> DescribeHumanLoopResponse -> Bool # (/=) :: DescribeHumanLoopResponse -> DescribeHumanLoopResponse -> Bool #
type Rep DescribeHumanLoopResponse Source #
Instance details Defined in Amazonka.SageMakerA2IRuntime.DescribeHumanLoop type Rep DescribeHumanLoopResponse = D1 ('MetaData "DescribeHumanLoopResponse" "Amazonka.SageMakerA2IRuntime.DescribeHumanLoop" "amazonka-sagemaker-a2i-runtime-2.0-Ab6lubn6uHa1PFNjIvbiiE" 'False) (C1 ('MetaCons "DescribeHumanLoopResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "humanLoopOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HumanLoopOutput)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :: S1 ('MetaSel ('Just "humanLoopStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HumanLoopStatus)) :: (S1 ('MetaSel ('Just "humanLoopName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "humanLoopArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "flowDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribeHumanLoopResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeHumanLoopResponse'`
-> UTCTime	`DescribeHumanLoopResponse`
-> HumanLoopStatus	`DescribeHumanLoopResponse`
-> Text	`DescribeHumanLoop`
-> Text	`$sel:humanLoopArn:DescribeHumanLoopResponse'`
-> Text	`DescribeHumanLoopResponse`
-> DescribeHumanLoopResponse

Create a value of DescribeHumanLoopResponse 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:failureCode:DescribeHumanLoopResponse', describeHumanLoopResponse_failureCode - A failure code that identifies the type of failure.

Possible values: ValidationError, Expired, InternalError

DescribeHumanLoopResponse, describeHumanLoopResponse_failureReason - The reason why a human loop failed. The failure reason is returned when the status of the human loop is Failed.

$sel:humanLoopOutput:DescribeHumanLoopResponse', describeHumanLoopResponse_humanLoopOutput - An object that contains information about the output of the human loop.

$sel:httpStatus:DescribeHumanLoopResponse', describeHumanLoopResponse_httpStatus - The response's http status code.

DescribeHumanLoopResponse, describeHumanLoopResponse_creationTime - The creation time when Amazon Augmented AI created the human loop.

DescribeHumanLoopResponse, describeHumanLoopResponse_humanLoopStatus - The status of the human loop.

DescribeHumanLoop, describeHumanLoopResponse_humanLoopName - The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).

$sel:humanLoopArn:DescribeHumanLoopResponse', describeHumanLoopResponse_humanLoopArn - The Amazon Resource Name (ARN) of the human loop.

DescribeHumanLoopResponse, describeHumanLoopResponse_flowDefinitionArn - The Amazon Resource Name (ARN) of the flow definition.

Response Lenses

describeHumanLoopResponse_failureCode :: Lens' DescribeHumanLoopResponse (Maybe Text) Source #

A failure code that identifies the type of failure.

Possible values: ValidationError, Expired, InternalError

describeHumanLoopResponse_failureReason :: Lens' DescribeHumanLoopResponse (Maybe Text) Source #

The reason why a human loop failed. The failure reason is returned when the status of the human loop is Failed.

describeHumanLoopResponse_humanLoopOutput :: Lens' DescribeHumanLoopResponse (Maybe HumanLoopOutput) Source #

An object that contains information about the output of the human loop.

describeHumanLoopResponse_httpStatus :: Lens' DescribeHumanLoopResponse Int Source #

The response's http status code.

describeHumanLoopResponse_creationTime :: Lens' DescribeHumanLoopResponse UTCTime Source #

The creation time when Amazon Augmented AI created the human loop.

describeHumanLoopResponse_humanLoopStatus :: Lens' DescribeHumanLoopResponse HumanLoopStatus Source #

The status of the human loop.

describeHumanLoopResponse_humanLoopName :: Lens' DescribeHumanLoopResponse Text Source #

The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).

describeHumanLoopResponse_humanLoopArn :: Lens' DescribeHumanLoopResponse Text Source #

The Amazon Resource Name (ARN) of the human loop.

describeHumanLoopResponse_flowDefinitionArn :: Lens' DescribeHumanLoopResponse Text Source #

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