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.ResilienceHub.ListAppAssessments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- appArn :: Maybe Text
- assessmentName :: Maybe Text
- assessmentStatus :: Maybe (NonEmpty AssessmentStatus)
- complianceStatus :: Maybe ComplianceStatus
- invoker :: Maybe AssessmentInvoker
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- reverseOrder :: Maybe Bool
}
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' {
- nextToken :: Maybe Text
- httpStatus :: Int
- assessmentSummaries :: [AppAssessmentSummary]
}
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.

Constructors

ListAppAssessments'

Fields

appArn :: Maybe Text
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.
assessmentName :: Maybe Text
The name for the assessment.
assessmentStatus :: Maybe (NonEmpty AssessmentStatus)
The current status of the assessment for the resiliency policy.
complianceStatus :: Maybe ComplianceStatus
The current status of compliance for the resiliency policy.
invoker :: Maybe AssessmentInvoker
Specifies the entity that invoked a specific assessment, either a User or the System.
maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
Null, or the token from a previous call to get the next set of results.
reverseOrder :: Maybe Bool
The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

Instances

Instances details

ToHeaders ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Methods toHeaders :: ListAppAssessments -> [Header] #
ToPath ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Methods toPath :: ListAppAssessments -> ByteString #
ToQuery ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Methods toQuery :: ListAppAssessments -> QueryString #
AWSRequest ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Associated Types type AWSResponse ListAppAssessments # Methods request :: (Service -> Service) -> ListAppAssessments -> Request ListAppAssessments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAppAssessments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAppAssessments))) #
Generic ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Associated Types type Rep ListAppAssessments :: Type -> Type # Methods from :: ListAppAssessments -> Rep ListAppAssessments x # to :: Rep ListAppAssessments x -> ListAppAssessments #
Read ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Methods readsPrec :: Int -> ReadS ListAppAssessments # readList :: ReadS [ListAppAssessments] # readPrec :: ReadPrec ListAppAssessments # readListPrec :: ReadPrec [ListAppAssessments] #
Show ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Methods showsPrec :: Int -> ListAppAssessments -> ShowS # show :: ListAppAssessments -> String # showList :: [ListAppAssessments] -> ShowS #
NFData ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Methods rnf :: ListAppAssessments -> () #
Eq ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Methods (==) :: ListAppAssessments -> ListAppAssessments -> Bool # (/=) :: ListAppAssessments -> ListAppAssessments -> Bool #
Hashable ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments Methods hashWithSalt :: Int -> ListAppAssessments -> Int # hash :: ListAppAssessments -> Int #
type AWSResponse ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments type AWSResponse ListAppAssessments = ListAppAssessmentsResponse
type Rep ListAppAssessments Source #
Instance details Defined in Amazonka.ResilienceHub.ListAppAssessments type Rep ListAppAssessments = D1 ('MetaData "ListAppAssessments" "Amazonka.ResilienceHub.ListAppAssessments" "amazonka-resiliencehub-2.0-EsKgNhAb0B96cCxrYtrBzG" 'False) (C1 ('MetaCons "ListAppAssessments'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "appArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "assessmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "assessmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AssessmentStatus))) :: S1 ('MetaSel ('Just "complianceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComplianceStatus)))) :: ((S1 ('MetaSel ('Just "invoker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssessmentInvoker)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reverseOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

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.

Constructors

ListAppAssessmentsResponse'

Fields

nextToken :: Maybe Text
The token for the next set of results, or null if there are no more results.
httpStatus :: Int
The response's http status code.
assessmentSummaries :: [AppAssessmentSummary]
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.

Instances

Instances details

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

newListAppAssessmentsResponse Source #

Arguments

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

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.