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.SESV2.ListRecommendations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.

You can execute this operation no more than once per second.

Synopsis

data ListRecommendations = ListRecommendations' {
- filter' :: Maybe (HashMap ListRecommendationsFilterKey Text)
- nextToken :: Maybe Text
- pageSize :: Maybe Int
}
newListRecommendations :: ListRecommendations
listRecommendations_filter :: Lens' ListRecommendations (Maybe (HashMap ListRecommendationsFilterKey Text))
listRecommendations_nextToken :: Lens' ListRecommendations (Maybe Text)
listRecommendations_pageSize :: Lens' ListRecommendations (Maybe Int)
data ListRecommendationsResponse = ListRecommendationsResponse' {
- nextToken :: Maybe Text
- recommendations :: Maybe [Recommendation]
- httpStatus :: Int
}
newListRecommendationsResponse :: Int -> ListRecommendationsResponse
listRecommendationsResponse_nextToken :: Lens' ListRecommendationsResponse (Maybe Text)
listRecommendationsResponse_recommendations :: Lens' ListRecommendationsResponse (Maybe [Recommendation])
listRecommendationsResponse_httpStatus :: Lens' ListRecommendationsResponse Int

Creating a Request

data ListRecommendations Source #

Represents a request to list the existing recommendations for your account.

See: newListRecommendations smart constructor.

Constructors

ListRecommendations'

Fields

filter' :: Maybe (HashMap ListRecommendationsFilterKey Text)
Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE
nextToken :: Maybe Text
A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.
pageSize :: Maybe Int
The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 1, and can be no more than 100.

Instances

Instances details

ToJSON ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods toJSON :: ListRecommendations -> Value # toEncoding :: ListRecommendations -> Encoding # toJSONList :: [ListRecommendations] -> Value # toEncodingList :: [ListRecommendations] -> Encoding #
ToHeaders ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods toHeaders :: ListRecommendations -> [Header] #
ToPath ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods toPath :: ListRecommendations -> ByteString #
ToQuery ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods toQuery :: ListRecommendations -> QueryString #
AWSRequest ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Associated Types type AWSResponse ListRecommendations # Methods request :: (Service -> Service) -> ListRecommendations -> Request ListRecommendations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRecommendations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRecommendations))) #
Generic ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Associated Types type Rep ListRecommendations :: Type -> Type # Methods from :: ListRecommendations -> Rep ListRecommendations x # to :: Rep ListRecommendations x -> ListRecommendations #
Read ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods readsPrec :: Int -> ReadS ListRecommendations # readList :: ReadS [ListRecommendations] # readPrec :: ReadPrec ListRecommendations # readListPrec :: ReadPrec [ListRecommendations] #
Show ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods showsPrec :: Int -> ListRecommendations -> ShowS # show :: ListRecommendations -> String # showList :: [ListRecommendations] -> ShowS #
NFData ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods rnf :: ListRecommendations -> () #
Eq ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods (==) :: ListRecommendations -> ListRecommendations -> Bool # (/=) :: ListRecommendations -> ListRecommendations -> Bool #
Hashable ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods hashWithSalt :: Int -> ListRecommendations -> Int # hash :: ListRecommendations -> Int #
type AWSResponse ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations type AWSResponse ListRecommendations = ListRecommendationsResponse
type Rep ListRecommendations Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations type Rep ListRecommendations = D1 ('MetaData "ListRecommendations" "Amazonka.SESV2.ListRecommendations" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "ListRecommendations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap ListRecommendationsFilterKey Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newListRecommendations :: ListRecommendations Source #

Create a value of ListRecommendations 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:filter':ListRecommendations', listRecommendations_filter - Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

ListRecommendations, listRecommendations_nextToken - A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

$sel:pageSize:ListRecommendations', listRecommendations_pageSize - The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 1, and can be no more than 100.

Request Lenses

listRecommendations_filter :: Lens' ListRecommendations (Maybe (HashMap ListRecommendationsFilterKey Text)) Source #

Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

listRecommendations_nextToken :: Lens' ListRecommendations (Maybe Text) Source #

A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

listRecommendations_pageSize :: Lens' ListRecommendations (Maybe Int) Source #

The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 1, and can be no more than 100.

Destructuring the Response

data ListRecommendationsResponse Source #

Contains the response to your request to retrieve the list of recommendations for your account.

See: newListRecommendationsResponse smart constructor.

Constructors

ListRecommendationsResponse'

Fields

nextToken :: Maybe Text
A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations.
recommendations :: Maybe [Recommendation]
The recommendations applicable to your account.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListRecommendationsResponse Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Associated Types type Rep ListRecommendationsResponse :: Type -> Type # Methods from :: ListRecommendationsResponse -> Rep ListRecommendationsResponse x # to :: Rep ListRecommendationsResponse x -> ListRecommendationsResponse #
Read ListRecommendationsResponse Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods readsPrec :: Int -> ReadS ListRecommendationsResponse # readList :: ReadS [ListRecommendationsResponse] # readPrec :: ReadPrec ListRecommendationsResponse # readListPrec :: ReadPrec [ListRecommendationsResponse] #
Show ListRecommendationsResponse Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods showsPrec :: Int -> ListRecommendationsResponse -> ShowS # show :: ListRecommendationsResponse -> String # showList :: [ListRecommendationsResponse] -> ShowS #
NFData ListRecommendationsResponse Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods rnf :: ListRecommendationsResponse -> () #
Eq ListRecommendationsResponse Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations Methods (==) :: ListRecommendationsResponse -> ListRecommendationsResponse -> Bool # (/=) :: ListRecommendationsResponse -> ListRecommendationsResponse -> Bool #
type Rep ListRecommendationsResponse Source #
Instance details Defined in Amazonka.SESV2.ListRecommendations type Rep ListRecommendationsResponse = D1 ('MetaData "ListRecommendationsResponse" "Amazonka.SESV2.ListRecommendations" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "ListRecommendationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recommendations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Recommendation])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRecommendationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListRecommendationsResponse'`
-> ListRecommendationsResponse

Create a value of ListRecommendationsResponse 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:

ListRecommendations, listRecommendationsResponse_nextToken - A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations.

$sel:recommendations:ListRecommendationsResponse', listRecommendationsResponse_recommendations - The recommendations applicable to your account.

$sel:httpStatus:ListRecommendationsResponse', listRecommendationsResponse_httpStatus - The response's http status code.

Response Lenses

listRecommendationsResponse_nextToken :: Lens' ListRecommendationsResponse (Maybe Text) Source #

A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations.

listRecommendationsResponse_recommendations :: Lens' ListRecommendationsResponse (Maybe [Recommendation]) Source #

The recommendations applicable to your account.

listRecommendationsResponse_httpStatus :: Lens' ListRecommendationsResponse Int Source #

The response's http status code.