Skip to content

DescribeHumanLoopResponse

Source code in docs_src/capo_sagemaker_a2i_runtime/types/describe_human_loop_response.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class DescribeHumanLoopResponse(TypedDict, closed=True):
    creation_time: NotRequired["capo_sagemaker_a2i_runtime.types.timestamp.Timestamp"]
    """<p>The creation time when Amazon Augmented AI created the human loop.</p>"""
    failure_reason: NotRequired["capo_sagemaker_a2i_runtime.types.string.String"]
    """<p>The reason why a human loop failed. The failure reason is returned when the status of the human loop is <code>Failed</code>.</p>"""
    failure_code: NotRequired["capo_sagemaker_a2i_runtime.types.string.String"]
    """<p>A failure code that identifies the type of failure.</p> <p>Possible values: <code>ValidationError</code>, <code>Expired</code>, <code>InternalError</code> </p>"""
    human_loop_status: NotRequired[
        "capo_sagemaker_a2i_runtime.types.human_loop_status.HumanLoopStatus"
    ]
    """<p>The status of the human loop. </p>"""
    human_loop_name: NotRequired[
        "capo_sagemaker_a2i_runtime.types.human_loop_name.HumanLoopName"
    ]
    """<p>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).</p>"""
    human_loop_arn: NotRequired[
        "capo_sagemaker_a2i_runtime.types.human_loop_arn.HumanLoopArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the human loop.</p>"""
    flow_definition_arn: NotRequired[
        "capo_sagemaker_a2i_runtime.types.flow_definition_arn.FlowDefinitionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the flow definition.</p>"""
    human_loop_output: NotRequired[
        "capo_sagemaker_a2i_runtime.types.human_loop_output.HumanLoopOutput"
    ]
    """<p>An object that contains information about the output of the human loop.</p>"""

creation_time instance-attribute 

creation_time: NotRequired[Timestamp]

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

failure_code instance-attribute 

failure_code: NotRequired[String]

A failure code that identifies the type of failure.

Possible values: ValidationError, Expired, InternalError

failure_reason instance-attribute 

failure_reason: NotRequired[String]

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

flow_definition_arn instance-attribute 

flow_definition_arn: NotRequired[FlowDefinitionArn]

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

human_loop_arn instance-attribute 

human_loop_arn: NotRequired[HumanLoopArn]

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

human_loop_name instance-attribute 

human_loop_name: NotRequired[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).

human_loop_output instance-attribute 

human_loop_output: NotRequired[HumanLoopOutput]

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

human_loop_status instance-attribute 

human_loop_status: NotRequired[HumanLoopStatus]

The status of the human loop.