libZSservicesZSamazonka-personalizeZSamazonka-personalize
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Personalize.CreateFilter

Description

Creates a recommendation filter. For more information, see filter.

Synopsis

Creating a Request

data CreateFilter Source #

See: newCreateFilter smart constructor.

Constructors

CreateFilter' 

Fields

  • name :: Text

    The name of the filter to create.

  • datasetGroupArn :: Text

    The ARN of the dataset group that the filter will belong to.

  • filterExpression :: Sensitive Text

    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.

Instances

Instances details
Eq CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

(==) :: CreateFilter -> CreateFilter -> Bool #

(/=) :: CreateFilter -> CreateFilter -> Bool #

Show CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

showsPrec :: Int -> CreateFilter -> ShowS #

show :: CreateFilter -> String #

showList :: [CreateFilter] -> ShowS #

Generic CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Associated Types

type Rep CreateFilter :: Type -> Type #

Methods

from :: CreateFilter -> Rep CreateFilter x #

to :: Rep CreateFilter x -> CreateFilter #

NFData CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

rnf :: CreateFilter -> () #

Hashable CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

hashWithSalt :: Int -> CreateFilter -> Int #

hash :: CreateFilter -> Int #

ToJSON CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

toJSON :: CreateFilter -> Value #

toEncoding :: CreateFilter -> Encoding #

toJSONList :: [CreateFilter] -> Value #

toEncodingList :: [CreateFilter] -> Encoding #

AWSRequest CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Associated Types

type AWSResponse CreateFilter #

Methods

request :: CreateFilter -> Request CreateFilter #

response :: MonadResource m => Logger -> Service -> Proxy CreateFilter -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFilter))) #

ToHeaders CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

toHeaders :: CreateFilter -> [Header] #

ToPath CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

toPath :: CreateFilter -> ByteString #

ToQuery CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

toQuery :: CreateFilter -> QueryString #

type Rep CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

type Rep CreateFilter = D1 ('MetaData "CreateFilter" "Amazonka.Personalize.CreateFilter" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "filterExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))
type AWSResponse CreateFilter Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

type AWSResponse CreateFilter = CreateFilterResponse

newCreateFilter Source #

Arguments

:: Text

$sel:name:CreateFilter'

-> Text

$sel:datasetGroupArn:CreateFilter'

-> Text

$sel:filterExpression:CreateFilter'

-> 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:name:CreateFilter', createFilter_name - The name of the filter to create.

$sel:datasetGroupArn:CreateFilter', createFilter_datasetGroupArn - The ARN of the dataset group that the filter will belong to.

$sel:filterExpression: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_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

Instances details
Eq CreateFilterResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

(==) :: CreateFilterResponse -> CreateFilterResponse -> Bool #

(/=) :: CreateFilterResponse -> CreateFilterResponse -> Bool #

Read CreateFilterResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

readsPrec :: Int -> ReadS CreateFilterResponse #

readList :: ReadS [CreateFilterResponse] #

readPrec :: ReadPrec CreateFilterResponse #

readListPrec :: ReadPrec [CreateFilterResponse] #

Show CreateFilterResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

showsPrec :: Int -> CreateFilterResponse -> ShowS #

show :: CreateFilterResponse -> String #

showList :: [CreateFilterResponse] -> ShowS #

Generic CreateFilterResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Associated Types

type Rep CreateFilterResponse :: Type -> Type #

Methods

from :: CreateFilterResponse -> Rep CreateFilterResponse x #

to :: Rep CreateFilterResponse x -> CreateFilterResponse #

NFData CreateFilterResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

Methods

rnf :: CreateFilterResponse -> () #

type Rep CreateFilterResponse Source # 
Instance details

Defined in Amazonka.Personalize.CreateFilter

type Rep CreateFilterResponse = D1 ('MetaData "CreateFilterResponse" "Amazonka.Personalize.CreateFilter" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateFilterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateFilterResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateFilterResponse'

-> 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:

$sel:filterArn: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.