DescribeHumanLoopCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SageMakerA2IRuntimeClient, DescribeHumanLoopCommand } from "@aws-sdk/client-sagemaker-a2i-runtime"; // ES Modules import
// const { SageMakerA2IRuntimeClient, DescribeHumanLoopCommand } = require("@aws-sdk/client-sagemaker-a2i-runtime"); // CommonJS import
const client = new SageMakerA2IRuntimeClient(config);
const input = { // DescribeHumanLoopRequest
  HumanLoopName: "STRING_VALUE", // required
};
const command = new DescribeHumanLoopCommand(input);
const response = await client.send(command);
// { // DescribeHumanLoopResponse
//   CreationTime: new Date("TIMESTAMP"), // required
//   FailureReason: "STRING_VALUE",
//   FailureCode: "STRING_VALUE",
//   HumanLoopStatus: "InProgress" || "Failed" || "Completed" || "Stopped" || "Stopping", // required
//   HumanLoopName: "STRING_VALUE", // required
//   HumanLoopArn: "STRING_VALUE", // required
//   FlowDefinitionArn: "STRING_VALUE", // required
//   HumanLoopOutput: { // HumanLoopOutput
//     OutputS3Uri: "STRING_VALUE", // required
//   },
// };

DescribeHumanLoopCommand Input

See DescribeHumanLoopCommandInput for more details

Parameter
Type
Description
HumanLoopName
Required
string | undefined

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

DescribeHumanLoopCommand Output

See DescribeHumanLoopCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreationTime
Required
Date | undefined

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

FlowDefinitionArn
Required
string | undefined

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

HumanLoopArn
Required
string | undefined

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

HumanLoopName
Required
string | undefined

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

HumanLoopStatus
Required
HumanLoopStatus | undefined

The status of the human loop.

FailureCode
string | undefined

A failure code that identifies the type of failure.

Possible values: ValidationError, Expired, InternalError

FailureReason
string | undefined

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

HumanLoopOutput
HumanLoopOutput | undefined

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

Throws

Name
Fault
Details
InternalServerException
server

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException
client

We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.

ThrottlingException
client

You exceeded the maximum number of requests.

ValidationException
client

The request isn't valid. Check the syntax and try again.

SageMakerA2IRuntimeServiceException
Base exception class for all service exceptions from SageMakerA2IRuntime service.