| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Personalize.CreateFilter
Description
Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
Synopsis
- data CreateFilter = CreateFilter' {
- tags :: Maybe [Tag]
- name :: Text
- datasetGroupArn :: Text
- filterExpression :: Sensitive Text
- newCreateFilter :: Text -> Text -> Text -> CreateFilter
- createFilter_tags :: Lens' CreateFilter (Maybe [Tag])
- createFilter_name :: Lens' CreateFilter Text
- createFilter_datasetGroupArn :: Lens' CreateFilter Text
- createFilter_filterExpression :: Lens' CreateFilter Text
- data CreateFilterResponse = CreateFilterResponse' {
- filterArn :: Maybe Text
- httpStatus :: Int
- newCreateFilterResponse :: Int -> CreateFilterResponse
- createFilterResponse_filterArn :: Lens' CreateFilterResponse (Maybe Text)
- createFilterResponse_httpStatus :: Lens' CreateFilterResponse Int
Creating a Request
data CreateFilter Source #
See: newCreateFilter smart constructor.
Constructors
| CreateFilter' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateFilter |
Create a value of CreateFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateFilter', createFilter_tags - A list of
tags
to apply to the filter.
CreateFilter, createFilter_name - The name of the filter to create.
CreateFilter, createFilter_datasetGroupArn - The ARN of the dataset group that the filter will belong to.
CreateFilter, createFilter_filterExpression - The filter expression defines which items are included or excluded from
recommendations. Filter expression must follow specific format rules.
For information about filter expression structure and syntax, see
Filter expressions.
Request Lenses
createFilter_tags :: Lens' CreateFilter (Maybe [Tag]) Source #
A list of tags to apply to the filter.
createFilter_name :: Lens' CreateFilter Text Source #
The name of the filter to create.
createFilter_datasetGroupArn :: Lens' CreateFilter Text Source #
The ARN of the dataset group that the filter will belong to.
createFilter_filterExpression :: Lens' CreateFilter Text Source #
The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
Destructuring the Response
data CreateFilterResponse Source #
See: newCreateFilterResponse smart constructor.
Constructors
| CreateFilterResponse' | |
Fields
| |
Instances
newCreateFilterResponse Source #
Arguments
| :: Int | |
| -> CreateFilterResponse |
Create a value of CreateFilterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFilterResponse, createFilterResponse_filterArn - The ARN of the new filter.
$sel:httpStatus:CreateFilterResponse', createFilterResponse_httpStatus - The response's http status code.
Response Lenses
createFilterResponse_filterArn :: Lens' CreateFilterResponse (Maybe Text) Source #
The ARN of the new filter.
createFilterResponse_httpStatus :: Lens' CreateFilterResponse Int Source #
The response's http status code.