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]

  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 guide.

• maxResults (integer) – 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 (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',
                    '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': {
                'disruptionScore': {
                    'string': 123.0
                },
                'score': 123.0
            },
            'status': 'PolicyBreached'|'PolicyMet'
        },
    ],
    '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) –

        The 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) –

              The RPO reference identifier.

            • rtoDescription (string) –

              The RTO description.

            • rtoReferenceId (string) –

              The RTO reference identifier.

      • 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.

        • disruptionScore (dict) –

          The disruption score for a valid key.

          • (string) –

            • (float) –

        • score (float) –

          The outage score for a valid key.

      • status (string) –

        The status of the action.

  • nextToken (string) –

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

Exceptions

• ResilienceHub.Client.exceptions.InternalServerException

• ResilienceHub.Client.exceptions.ResourceNotFoundException

• ResilienceHub.Client.exceptions.ThrottlingException

• ResilienceHub.Client.exceptions.ValidationException

• ResilienceHub.Client.exceptions.AccessDeniedException