/AWS1/CL_SGADESCRIBEHLRESPONSE¶
DescribeHumanLoopResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_creationtime TYPE /AWS1/SGATIMESTAMP /AWS1/SGATIMESTAMP¶
The creation time when Amazon Augmented AI created the human loop.
iv_humanloopstatus TYPE /AWS1/SGAHUMANLOOPSTATUS /AWS1/SGAHUMANLOOPSTATUS¶
The status of the human loop.
iv_humanloopname TYPE /AWS1/SGAHUMANLOOPNAME /AWS1/SGAHUMANLOOPNAME¶
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).
iv_humanlooparn TYPE /AWS1/SGAHUMANLOOPARN /AWS1/SGAHUMANLOOPARN¶
The Amazon Resource Name (ARN) of the human loop.
iv_flowdefinitionarn TYPE /AWS1/SGAFLOWDEFINITIONARN /AWS1/SGAFLOWDEFINITIONARN¶
The Amazon Resource Name (ARN) of the flow definition.
Optional arguments:¶
iv_failurereason TYPE /AWS1/SGASTRING /AWS1/SGASTRING¶
The reason why a human loop failed. The failure reason is returned when the status of the human loop is
Failed.
iv_failurecode TYPE /AWS1/SGASTRING /AWS1/SGASTRING¶
A failure code that identifies the type of failure.
Possible values:
ValidationError,Expired,InternalError
io_humanloopoutput TYPE REF TO /AWS1/CL_SGAHUMANLOOPOUTPUT /AWS1/CL_SGAHUMANLOOPOUTPUT¶
An object that contains information about the output of the human loop.
Queryable Attributes¶
CreationTime¶
The creation time when Amazon Augmented AI created the human loop.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
FailureReason¶
The reason why a human loop failed. The failure reason is returned when the status of the human loop is
Failed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASON() |
Getter for FAILUREREASON, with configurable default |
ASK_FAILUREREASON() |
Getter for FAILUREREASON w/ exceptions if field has no value |
HAS_FAILUREREASON() |
Determine if FAILUREREASON has a value |
FailureCode¶
A failure code that identifies the type of failure.
Possible values:
ValidationError,Expired,InternalError
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILURECODE() |
Getter for FAILURECODE, with configurable default |
ASK_FAILURECODE() |
Getter for FAILURECODE w/ exceptions if field has no value |
HAS_FAILURECODE() |
Determine if FAILURECODE has a value |
HumanLoopStatus¶
The status of the human loop.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HUMANLOOPSTATUS() |
Getter for HUMANLOOPSTATUS, with configurable default |
ASK_HUMANLOOPSTATUS() |
Getter for HUMANLOOPSTATUS w/ exceptions if field has no val |
HAS_HUMANLOOPSTATUS() |
Determine if HUMANLOOPSTATUS has a value |
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).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HUMANLOOPNAME() |
Getter for HUMANLOOPNAME, with configurable default |
ASK_HUMANLOOPNAME() |
Getter for HUMANLOOPNAME w/ exceptions if field has no value |
HAS_HUMANLOOPNAME() |
Determine if HUMANLOOPNAME has a value |
HumanLoopArn¶
The Amazon Resource Name (ARN) of the human loop.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HUMANLOOPARN() |
Getter for HUMANLOOPARN, with configurable default |
ASK_HUMANLOOPARN() |
Getter for HUMANLOOPARN w/ exceptions if field has no value |
HAS_HUMANLOOPARN() |
Determine if HUMANLOOPARN has a value |
FlowDefinitionArn¶
The Amazon Resource Name (ARN) of the flow definition.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FLOWDEFINITIONARN() |
Getter for FLOWDEFINITIONARN, with configurable default |
ASK_FLOWDEFINITIONARN() |
Getter for FLOWDEFINITIONARN w/ exceptions if field has no v |
HAS_FLOWDEFINITIONARN() |
Determine if FLOWDEFINITIONARN has a value |
HumanLoopOutput¶
An object that contains information about the output of the human loop.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HUMANLOOPOUTPUT() |
Getter for HUMANLOOPOUTPUT |