/human-loops#FlowDefinitionArn

http://a2i-runtime.sagemaker.{region}.amazonaws.com/human-loops#FlowDefinitionArn

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

Access Token Required: API Key

Query Params

CreationTimeAfterstring

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

CreationTimeBeforestring

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

FlowDefinitionArnstringrequired

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

SortOrderstring

Optional. The order for displaying results. Valid values: <code>Ascending</code> and <code>Descending</code>.

Allowed:

NextTokenstring

A token to display the next page of results.

MaxResultsinteger

The total number of items to return. If the total number of available items is more than the value specified in <code>MaxResults</code>, then a <code>NextToken</code> is returned in the output. You can use this token to display the next page of results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://a2i-runtime.sagemaker.{region}.amazonaws.com/human-loops#FlowDefinitionArn' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET