ResilienceHub / Client / list_app_component_compliances

list_app_component_compliances#

ResilienceHub.Client.list_app_component_compliances(**kwargs)#

Lists the compliances for an Resilience Hub Application Component.

See also: AWS API Documentation

Request Syntax

response = client.list_app_component_compliances(
    assessmentArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • assessmentArn (string) –

    [REQUIRED]

    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 Amazon Web Services General Reference guide.

  • maxResults (integer) – 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 (string) – Null, or the token from a previous call to get the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'componentCompliances': [
        {
            'appComponentName': 'string',
            'compliance': {
                'string': {
                    'achievableRpoInSecs': 123,
                    'achievableRtoInSecs': 123,
                    'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy',
                    'currentRpoInSecs': 123,
                    'currentRtoInSecs': 123,
                    'message': 'string',
                    'rpoDescription': 'string',
                    'rpoReferenceId': 'string',
                    'rtoDescription': 'string',
                    'rtoReferenceId': 'string'
                }
            },
            'cost': {
                'amount': 123.0,
                'currency': 'string',
                'frequency': 'Hourly'|'Daily'|'Monthly'|'Yearly'
            },
            'message': 'string',
            'resiliencyScore': {
                'componentScore': {
                    'string': {
                        'excludedCount': 123,
                        'outstandingCount': 123,
                        'possibleScore': 123.0,
                        'score': 123.0
                    }
                },
                'disruptionScore': {
                    'string': 123.0
                },
                'score': 123.0
            },
            'status': 'PolicyBreached'|'PolicyMet'|'NotApplicable'|'MissingPolicy'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • componentCompliances (list) –

      The compliances for an Resilience Hub Application Component, returned as an object. This object contains the names of the Application Components, compliances, costs, resiliency scores, outage scores, and more.

      • (dict) –

        Defines the compliance of an Application Component against the resiliency policy.

        • appComponentName (string) –

          Name of the Application Component.

        • compliance (dict) –

          The compliance of the Application Component against the resiliency policy.

          • (string) –

            • (dict) –

              Defines the compliance against the resiliency policy for a disruption.

              • achievableRpoInSecs (integer) –

                The Recovery Point Objective (RPO) that is achievable, in seconds.

              • achievableRtoInSecs (integer) –

                The Recovery Time Objective (RTO) that is achievable, in seconds

              • complianceStatus (string) –

                The current status of compliance for the resiliency policy.

              • currentRpoInSecs (integer) –

                The current RPO, in seconds.

              • currentRtoInSecs (integer) –

                The current RTO, in seconds.

              • message (string) –

                The disruption compliance message.

              • rpoDescription (string) –

                The RPO description.

              • rpoReferenceId (string) –

                Reference identifier of the RPO .

              • rtoDescription (string) –

                The RTO description.

              • rtoReferenceId (string) –

                Reference identifier of the RTO.

        • cost (dict) –

          The cost for the application.

          • amount (float) –

            The cost amount.

          • currency (string) –

            The cost currency, for example USD.

          • frequency (string) –

            The cost frequency.

        • message (string) –

          The compliance message.

        • resiliencyScore (dict) –

          The current resiliency score for the application.

          • componentScore (dict) –

            The score generated by Resilience Hub for the scoring component after running an assessment.

            For example, if the score is 25 points, it indicates the overall score of your application generated by Resilience Hub after running an assessment.

            • (string) –

              • (dict) –

                Resiliency score of each scoring component. For more information about scoring component, see Calculating resiliency score.

                • excludedCount (integer) –

                  Number of recommendations that were excluded from the assessment.

                  For example, if the excludedCount for Alarms coverage scoring component is 7, it indicates that 7 Amazon CloudWatch alarms are excluded from the assessment.

                • outstandingCount (integer) –

                  Number of recommendations that must be implemented to obtain the maximum possible score for the scoring component. For SOPs, alarms, and tests, these are the number of recommendations that must be implemented. For compliance, these are the number of Application Components that have breached the resiliency policy.

                  For example, if the outstandingCount for Alarms coverage scoring component is 5, it indicates that 5 Amazon CloudWatch alarms need to be implemented to achieve the maximum possible score.

                • possibleScore (float) –

                  Maximum possible score that can be obtained for the scoring component.

                  For example, if the possibleScore is 20 points, it indicates the maximum possible score you can achieve for the scoring component when you run a new assessment after implementing all the Resilience Hub recommendations.

                • score (float) –

                  Resiliency score points given for the scoring component. The score is always less than or equal to the possibleScore.

          • disruptionScore (dict) –

            The disruption score for a valid key.

            • (string) –

              • (float) –

          • score (float) –

            The outage score for a valid key.

        • status (string) –

          Status of the action.

    • nextToken (string) –

      Token for the next set of results, or null if there are no more results.

Exceptions