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 assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.
Synopsis
- data ListAppAssessments = ListAppAssessments' {}
- newListAppAssessments :: ListAppAssessments
- listAppAssessments_appArn :: Lens' ListAppAssessments (Maybe Text)
- listAppAssessments_assessmentName :: Lens' ListAppAssessments (Maybe Text)
- listAppAssessments_assessmentStatus :: Lens' ListAppAssessments (Maybe (NonEmpty AssessmentStatus))
- listAppAssessments_complianceStatus :: Lens' ListAppAssessments (Maybe ComplianceStatus)
- listAppAssessments_invoker :: Lens' ListAppAssessments (Maybe AssessmentInvoker)
- listAppAssessments_maxResults :: Lens' ListAppAssessments (Maybe Natural)
- listAppAssessments_nextToken :: Lens' ListAppAssessments (Maybe Text)
- listAppAssessments_reverseOrder :: Lens' ListAppAssessments (Maybe Bool)
- data ListAppAssessmentsResponse = ListAppAssessmentsResponse' {}
- newListAppAssessmentsResponse :: Int -> ListAppAssessmentsResponse
- listAppAssessmentsResponse_nextToken :: Lens' ListAppAssessmentsResponse (Maybe Text)
- listAppAssessmentsResponse_httpStatus :: Lens' ListAppAssessmentsResponse Int
- listAppAssessmentsResponse_assessmentSummaries :: Lens' ListAppAssessmentsResponse [AppAssessmentSummary]
Creating a Request
data ListAppAssessments Source #
See: newListAppAssessments
smart constructor.
ListAppAssessments' | |
|
Instances
newListAppAssessments :: ListAppAssessments Source #
Create a value of ListAppAssessments
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:
ListAppAssessments
, listAppAssessments_appArn
- The Amazon Resource Name (ARN) of the application. The format for this
ARN is: arn:partition
:resiliencehub:region
:account
:app/app-id
.
For more information about ARNs, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
ListAppAssessments
, listAppAssessments_assessmentName
- The name for the assessment.
ListAppAssessments
, listAppAssessments_assessmentStatus
- The current status of the assessment for the resiliency policy.
ListAppAssessments
, listAppAssessments_complianceStatus
- The current status of compliance for the resiliency policy.
ListAppAssessments
, listAppAssessments_invoker
- Specifies the entity that invoked a specific assessment, either a User
or the System
.
$sel:maxResults:ListAppAssessments'
, listAppAssessments_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.
ListAppAssessments
, listAppAssessments_nextToken
- Null, or the token from a previous call to get the next set of results.
$sel:reverseOrder:ListAppAssessments'
, listAppAssessments_reverseOrder
- The default is to sort by ascending startTime. To sort by descending
startTime, set reverseOrder to true
.
Request Lenses
listAppAssessments_appArn :: Lens' ListAppAssessments (Maybe Text) Source #
The Amazon Resource Name (ARN) of the application. The format for this
ARN is: arn:partition
:resiliencehub:region
:account
:app/app-id
.
For more information about ARNs, see
Amazon Resource Names (ARNs)
in the AWS General Reference.
listAppAssessments_assessmentName :: Lens' ListAppAssessments (Maybe Text) Source #
The name for the assessment.
listAppAssessments_assessmentStatus :: Lens' ListAppAssessments (Maybe (NonEmpty AssessmentStatus)) Source #
The current status of the assessment for the resiliency policy.
listAppAssessments_complianceStatus :: Lens' ListAppAssessments (Maybe ComplianceStatus) Source #
The current status of compliance for the resiliency policy.
listAppAssessments_invoker :: Lens' ListAppAssessments (Maybe AssessmentInvoker) Source #
Specifies the entity that invoked a specific assessment, either a User
or the System
.
listAppAssessments_maxResults :: Lens' ListAppAssessments (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.
listAppAssessments_nextToken :: Lens' ListAppAssessments (Maybe Text) Source #
Null, or the token from a previous call to get the next set of results.
listAppAssessments_reverseOrder :: Lens' ListAppAssessments (Maybe Bool) Source #
The default is to sort by ascending startTime. To sort by descending
startTime, set reverseOrder to true
.
Destructuring the Response
data ListAppAssessmentsResponse Source #
See: newListAppAssessmentsResponse
smart constructor.
ListAppAssessmentsResponse' | |
|
Instances
newListAppAssessmentsResponse Source #
Create a value of ListAppAssessmentsResponse
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:
ListAppAssessments
, listAppAssessmentsResponse_nextToken
- The token for the next set of results, or null if there are no more
results.
$sel:httpStatus:ListAppAssessmentsResponse'
, listAppAssessmentsResponse_httpStatus
- The response's http status code.
$sel:assessmentSummaries:ListAppAssessmentsResponse'
, listAppAssessmentsResponse_assessmentSummaries
- The summaries for the specified assessments, returned as an object. This
object includes application versions, associated Amazon Resource Numbers
(ARNs), cost, messages, resiliency scores, and more.
Response Lenses
listAppAssessmentsResponse_nextToken :: Lens' ListAppAssessmentsResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no more results.
listAppAssessmentsResponse_httpStatus :: Lens' ListAppAssessmentsResponse Int Source #
The response's http status code.
listAppAssessmentsResponse_assessmentSummaries :: Lens' ListAppAssessmentsResponse [AppAssessmentSummary] Source #
The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.