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 recommendation templates for the Resilience Hub applications.
Synopsis
- data ListRecommendationTemplates = ListRecommendationTemplates' {}
- newListRecommendationTemplates :: Text -> ListRecommendationTemplates
- listRecommendationTemplates_maxResults :: Lens' ListRecommendationTemplates (Maybe Natural)
- listRecommendationTemplates_name :: Lens' ListRecommendationTemplates (Maybe Text)
- listRecommendationTemplates_nextToken :: Lens' ListRecommendationTemplates (Maybe Text)
- listRecommendationTemplates_recommendationTemplateArn :: Lens' ListRecommendationTemplates (Maybe Text)
- listRecommendationTemplates_reverseOrder :: Lens' ListRecommendationTemplates (Maybe Bool)
- listRecommendationTemplates_status :: Lens' ListRecommendationTemplates (Maybe (NonEmpty RecommendationTemplateStatus))
- listRecommendationTemplates_assessmentArn :: Lens' ListRecommendationTemplates Text
- data ListRecommendationTemplatesResponse = ListRecommendationTemplatesResponse' {}
- newListRecommendationTemplatesResponse :: Int -> ListRecommendationTemplatesResponse
- listRecommendationTemplatesResponse_nextToken :: Lens' ListRecommendationTemplatesResponse (Maybe Text)
- listRecommendationTemplatesResponse_recommendationTemplates :: Lens' ListRecommendationTemplatesResponse (Maybe [RecommendationTemplate])
- listRecommendationTemplatesResponse_httpStatus :: Lens' ListRecommendationTemplatesResponse Int
Creating a Request
data ListRecommendationTemplates Source #
See: newListRecommendationTemplates
smart constructor.
ListRecommendationTemplates' | |
|
Instances
newListRecommendationTemplates Source #
Create a value of ListRecommendationTemplates
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:maxResults:ListRecommendationTemplates'
, listRecommendationTemplates_maxResults
- The maximum number of results to include in the response. If more
results exist than the specified MaxResults
value, a token is included
in the response so that the remaining results can be retrieved.
ListRecommendationTemplates
, listRecommendationTemplates_name
- The name for one of the listed recommendation templates.
ListRecommendationTemplates
, listRecommendationTemplates_nextToken
- Null, or the token from a previous call to get the next set of results.
ListRecommendationTemplates
, listRecommendationTemplates_recommendationTemplateArn
- The Amazon Resource Name (ARN) for a recommendation template.
$sel:reverseOrder:ListRecommendationTemplates'
, listRecommendationTemplates_reverseOrder
- The default is to sort by ascending startTime. To sort by descending
startTime, set reverseOrder to true
.
ListRecommendationTemplates
, listRecommendationTemplates_status
- The status of the action.
ListRecommendationTemplates
, listRecommendationTemplates_assessmentArn
- The Amazon Resource Name (ARN) of the assessment. The format for this
ARN is:
arn:partition
:resiliencehub:region
:account
:app-assessment/app-id
.
For more information about ARNs, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
Request Lenses
listRecommendationTemplates_maxResults :: Lens' ListRecommendationTemplates (Maybe Natural) Source #
The maximum number of results to include in the response. If more
results exist than the specified MaxResults
value, a token is included
in the response so that the remaining results can be retrieved.
listRecommendationTemplates_name :: Lens' ListRecommendationTemplates (Maybe Text) Source #
The name for one of the listed recommendation templates.
listRecommendationTemplates_nextToken :: Lens' ListRecommendationTemplates (Maybe Text) Source #
Null, or the token from a previous call to get the next set of results.
listRecommendationTemplates_recommendationTemplateArn :: Lens' ListRecommendationTemplates (Maybe Text) Source #
The Amazon Resource Name (ARN) for a recommendation template.
listRecommendationTemplates_reverseOrder :: Lens' ListRecommendationTemplates (Maybe Bool) Source #
The default is to sort by ascending startTime. To sort by descending
startTime, set reverseOrder to true
.
listRecommendationTemplates_status :: Lens' ListRecommendationTemplates (Maybe (NonEmpty RecommendationTemplateStatus)) Source #
The status of the action.
listRecommendationTemplates_assessmentArn :: Lens' ListRecommendationTemplates Text Source #
The Amazon Resource Name (ARN) of the assessment. The format for this
ARN is:
arn:partition
:resiliencehub:region
:account
:app-assessment/app-id
.
For more information about ARNs, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
Destructuring the Response
data ListRecommendationTemplatesResponse Source #
See: newListRecommendationTemplatesResponse
smart constructor.
ListRecommendationTemplatesResponse' | |
|
Instances
newListRecommendationTemplatesResponse Source #
Create a value of ListRecommendationTemplatesResponse
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:
ListRecommendationTemplates
, listRecommendationTemplatesResponse_nextToken
- The token for the next set of results, or null if there are no more
results.
$sel:recommendationTemplates:ListRecommendationTemplatesResponse'
, listRecommendationTemplatesResponse_recommendationTemplates
- The recommendation templates for the Resilience Hub applications.
$sel:httpStatus:ListRecommendationTemplatesResponse'
, listRecommendationTemplatesResponse_httpStatus
- The response's http status code.
Response Lenses
listRecommendationTemplatesResponse_nextToken :: Lens' ListRecommendationTemplatesResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no more results.
listRecommendationTemplatesResponse_recommendationTemplates :: Lens' ListRecommendationTemplatesResponse (Maybe [RecommendationTemplate]) Source #
The recommendation templates for the Resilience Hub applications.
listRecommendationTemplatesResponse_httpStatus :: Lens' ListRecommendationTemplatesResponse Int Source #
The response's http status code.