Amazon Augmented AI Runtime

{'CreationTime': 'timestamp'}

Returns information about the specified human loop.

See also: AWS API Documentation

Request Syntax

client.describe_human_loop(
    HumanLoopName='string'
)

type HumanLoopName:

string

param HumanLoopName:

[REQUIRED]

The unique name of the human loop.

rtype:

dict

returns:

Response Syntax

{
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'FailureCode': 'string',
    'HumanLoopStatus': 'InProgress'|'Failed'|'Completed'|'Stopped'|'Stopping',
    'HumanLoopName': 'string',
    'HumanLoopArn': 'string',
    'FlowDefinitionArn': 'string',
    'HumanLoopOutput': {
        'OutputS3Uri': 'string'
    }
}

Response Structure

• (dict) --

  • CreationTime (datetime) --

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

  • FailureReason (string) --

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

  • FailureCode (string) --

    A failure code denoting a specific type of failure.

  • HumanLoopStatus (string) --

    The status of the human loop. Valid values:

  • HumanLoopName (string) --

    The name of the human loop.

  • HumanLoopArn (string) --

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

  • FlowDefinitionArn (string) --

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

  • HumanLoopOutput (dict) --

    An object containing information about the output of the human loop.

    • OutputS3Uri (string) --

      The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output.

{'FlowDefinitionArn': 'string'}

Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

See also: AWS API Documentation

Request Syntax

client.list_human_loops(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    FlowDefinitionArn='string',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)

type CreationTimeAfter:

datetime

param CreationTimeAfter:

(Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.

type CreationTimeBefore:

datetime

param CreationTimeBefore:

(Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.

type FlowDefinitionArn:

string

param FlowDefinitionArn:

[REQUIRED]

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

type SortOrder:

string

param SortOrder:

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

type NextToken:

string

param NextToken:

A token to resume pagination.

type MaxResults:

integer

param MaxResults:

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

rtype:

dict

returns:

Response Syntax

{
    'HumanLoopSummaries': [
        {
            'HumanLoopName': 'string',
            'HumanLoopStatus': 'InProgress'|'Failed'|'Completed'|'Stopped'|'Stopping',
            'CreationTime': datetime(2015, 1, 1),
            'FailureReason': 'string',
            'FlowDefinitionArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • HumanLoopSummaries (list) --

    An array of objects containing information about the human loops.

    • (dict) --

      Summary information about the human loop.

      • HumanLoopName (string) --

        The name of the human loop.

      • HumanLoopStatus (string) --

        The status of the human loop. Valid values:

      • CreationTime (datetime) --

        When Amazon Augmented AI created the human loop.

      • FailureReason (string) --

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

      • FlowDefinitionArn (string) --

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

  • NextToken (string) --

    A token to resume pagination.