ListHumanLoops - Amazon Augmented AI Runtime

ListHumanLoops

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

Request Syntax

GET /human-loops?CreationTimeAfter=CreationTimeAfter&CreationTimeBefore=CreationTimeBefore&FlowDefinitionArn=FlowDefinitionArn&MaxResults=MaxResults&NextToken=NextToken&SortOrder=SortOrder HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

CreationTimeAfter

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

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.

FlowDefinitionArn

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

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:flow-definition/.*

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

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

A token to display the next page of results.

Length Constraints: Maximum length of 8192.

Pattern: .*

SortOrder

Optional. The order for displaying results. Valid values: Ascending and Descending.

Valid Values: Ascending | Descending

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "HumanLoopSummaries": [ { "CreationTime": number, "FailureReason": "string", "FlowDefinitionArn": "string", "HumanLoopName": "string", "HumanLoopStatus": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

HumanLoopSummaries

An array of objects that contain information about the human loops.

Type: Array of HumanLoopSummary objects

NextToken

A token to display the next page of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

We couldn't process your request because of an issue with the server. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429

ValidationException

The request isn't valid. Check the syntax and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: