ResilienceHub / Client / describe_app

describe_app#

ResilienceHub.Client.describe_app(**kwargs)#

Describes an Resilience Hub application.

See also: AWS API Documentation

Request Syntax

response = client.describe_app(
    appArn='string'
)
Parameters:

appArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the Resilience Hub 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 guide.

Return type:

dict

Returns:

Response Syntax

{
    'app': {
        'appArn': 'string',
        'assessmentSchedule': 'Disabled'|'Daily',
        'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
        'creationTime': datetime(2015, 1, 1),
        'description': 'string',
        'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
        'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1),
        'name': 'string',
        'policyArn': 'string',
        'resiliencyScore': 123.0,
        'status': 'Active'|'Deleting',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • app (dict) –

      The specified application, returned as an object with details including compliance status, creation time, description, resiliency score, and more.

      • appArn (string) –

        The Amazon Resource Name (ARN) of the Resilience Hub 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 guide.

      • assessmentSchedule (string) –

        Assessment execution schedule with ‘Daily’ or ‘Disabled’ values.

      • complianceStatus (string) –

        The current status of compliance for the resiliency policy.

      • creationTime (datetime) –

        The timestamp for when the app was created.

      • description (string) –

        The optional description for an app.

      • lastAppComplianceEvaluationTime (datetime) –

        The timestamp for the most recent compliance evaluation.

      • lastResiliencyScoreEvaluationTime (datetime) –

        The timestamp for the most recent resiliency score evaluation.

      • name (string) –

        The name for the application.

      • policyArn (string) –

        The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition:resiliencehub: region: account:resiliency-policy/ policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

      • resiliencyScore (float) –

        The current resiliency score for the application.

      • status (string) –

        The status of the application.

      • tags (dict) –

        The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

        • (string) –

          • (string) –

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException

  • ResilienceHub.Client.exceptions.ResourceNotFoundException

  • ResilienceHub.Client.exceptions.ThrottlingException

  • ResilienceHub.Client.exceptions.ValidationException

  • ResilienceHub.Client.exceptions.AccessDeniedException