AugmentedAIRuntime / Client / list_human_loops

list_human_loops#

AugmentedAIRuntime.Client.list_human_loops(**kwargs)#

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

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

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

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

  • FlowDefinitionArn (string) –

    [REQUIRED]

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

  • SortOrder (string) – Optional. The order for displaying results. Valid values: Ascending and Descending.

  • NextToken (string) – A token to display the next page of results.

  • MaxResults (integer) – 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 is returned in the output. You can use this token to display the next page of results.

Return type:

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 that contain 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.

        • CreationTime (datetime) –

          When Amazon Augmented AI created the human loop.

        • FailureReason (string) –

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

        • FlowDefinitionArn (string) –

          The Amazon Resource Name (ARN) of the flow definition used to configure the human loop.

    • NextToken (string) –

      A token to display the next page of results.

Exceptions

  • AugmentedAIRuntime.Client.exceptions.ValidationException

  • AugmentedAIRuntime.Client.exceptions.ResourceNotFoundException

  • AugmentedAIRuntime.Client.exceptions.ThrottlingException

  • AugmentedAIRuntime.Client.exceptions.InternalServerException