Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1453422.6 KB

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

get/human-loops/{HumanLoopName}

Path parameters

HumanLoopNamestring required

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

Response

Success

CreationTimestring date-time required

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

FailureReasonstring

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

FailureCodestring
<p>A failure code that identifies the type of failure.</p> <p>Possible values: <code>ValidationError</code>, <code>Expired</code>, <code>InternalError</code> </p>
HumanLoopStatus'InProgress' | 'Failed' | 'Completed' | 'Stopped' | 'Stopping' required

The status of the human loop.

HumanLoopNamestring required

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

HumanLoopArnstring required

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

FlowDefinitionArnstring required

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