[ aws . personalize ]

describe-filter

Description

Describes a filter’s properties.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-filter
--filter-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--filter-arn (string)

The ARN of the filter to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

filter -> (structure)

The filter’s details.

name -> (string)

The name of the filter.

filterArn -> (string)

The ARN of the filter.

creationDateTime -> (timestamp)

The time at which the filter was created.

lastUpdatedDateTime -> (timestamp)

The time at which the filter was last updated.

datasetGroupArn -> (string)

The ARN of the dataset group to which the filter belongs.

failureReason -> (string)

If the filter failed, the reason for its failure.

filterExpression -> (string)

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions .

status -> (string)

The status of the filter.