Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeFilter

Describes a filter's properties.

Request Syntax


{
   "filterArn": "string"
}

Request Parameters

The request accepts the following data in JSON format.

filterArn

The ARN of the filter to describe.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

Response Syntax


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

filter

The filter's details.

Type: Filter object

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

ResourceNotFoundException

Could not find the specified resource.

HTTP Status Code: 400