ListHumanTaskUis - Amazon SageMaker Service

ListHumanTaskUis

Returns information about the human task user interfaces in your account.

Request Syntax

{ "CreationTimeAfter": number, "CreationTimeBefore": number, "MaxResults": number, "NextToken": "string", "SortOrder": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreationTimeAfter

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only human task user interfaces that were created before the specified timestamp.

Type: Timestamp

Required: No

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.

Type: Integer

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

Required: No

NextToken

A token to resume pagination.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortOrder

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

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax

{ "HumanTaskUiSummaries": [ { "CreationTime": number, "HumanTaskUiArn": "string", "HumanTaskUiName": "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.

HumanTaskUiSummaries

An array of objects describing the human task user interfaces.

Type: Array of HumanTaskUiSummary objects

NextToken

A token to resume pagination.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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

See Also

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