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 |
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' {}
- 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' {}
- 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.
ListRecommendations' | |
|
Instances
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.
ListRecommendationsResponse' | |
|
Instances
newListRecommendationsResponse Source #
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.