ListFilters - Amazon Personalize
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ListFilters

Lists all filters that belong to a given dataset group.

Request Syntax

{ "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" }

Request Parameters

The request accepts the following data in JSON format.

datasetGroupArn

The ARN of the dataset group that contains the filters.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Required: No

maxResults

The maximum number of filters to return.

Type: Integer

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

Required: No

nextToken

A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).

Type: String

Length Constraints: Maximum length of 1500.

Pattern: \p{ASCII}{0,1500}

Required: No

Response Syntax

{ "Filters": [ { "creationDateTime": number, "datasetGroupArn": "string", "failureReason": "string", "filterArn": "string", "lastUpdatedDateTime": number, "name": "string", "status": "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.

Filters

A list of returned filters.

Type: Array of FilterSummary objects

Array Members: Maximum number of 100 items.

nextToken

A token for getting the next set of filters (if they exist).

Type: String

Length Constraints: Maximum length of 1500.

Pattern: \p{ASCII}{0,1500}

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

InvalidNextTokenException

The token is not valid.

HTTP Status Code: 400

See Also

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