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]

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 Amazon Web Services 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',
        'driftStatus': 'NotChecked'|'NotDetected'|'Detected',
        'eventSubscriptions': [
            {
                'eventType': 'ScheduledAssessmentFailure'|'DriftDetected',
                'name': 'string',
                'snsTopicArn': 'string'
            },
        ],
        'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
        'lastDriftEvaluationTime': datetime(2015, 1, 1),
        'lastResiliencyScoreEvaluationTime': datetime(2015, 1, 1),
        'name': 'string',
        'permissionModel': {
            'crossAccountRoleArns': [
                'string',
            ],
            'invokerRoleName': 'string',
            'type': 'LegacyIAMUser'|'RoleBased'
        },
        'policyArn': 'string',
        'resiliencyScore': 123.0,
        'rpoInSecs': 123,
        'rtoInSecs': 123,
        '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) –

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

    • assessmentSchedule (string) –

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

    • complianceStatus (string) –

      Current status of compliance for the resiliency policy.

    • creationTime (datetime) –

      Date and time when the app was created.

    • description (string) –

      Optional description for an application.

    • driftStatus (string) –

      Indicates if compliance drifts (deviations) were detected while running an assessment for your application.

    • eventSubscriptions (list) –

      The list of events you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

      • (dict) –

        Indicates an event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

        • eventType (string) –

          The type of event you would like to subscribe and get notification for. Currently, Resilience Hub supports notifications only for Drift detected ( DriftDetected) and Scheduled assessment failure ( ScheduledAssessmentFailure) events.

        • name (string) –

          Unique name to identify an event subscription.

        • snsTopicArn (string) –

          Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic. The format for this ARN is: arn:partition:sns:region:account:topic-name. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • lastAppComplianceEvaluationTime (datetime) –

      Date and time the most recent compliance evaluation.

    • lastDriftEvaluationTime (datetime) –

      Indicates the last time that a drift was evaluated.

    • lastResiliencyScoreEvaluationTime (datetime) –

      Date and time the most recent resiliency score evaluation.

    • name (string) –

      Name for the application.

    • permissionModel (dict) –

      Defines the roles and credentials that Resilience Hub would use while creating the application, importing its resources, and running an assessment.

      • crossAccountRoleArns (list) –

        Defines a list of role Amazon Resource Names (ARNs) to be used in other accounts. These ARNs are used for querying purposes while importing resources and assessing your application.

        Note

        • These ARNs are required only when your resources are in other accounts and you have different role name in these accounts. Else, the invoker role name will be used in the other accounts.

        • These roles must have a trust policy with iam:AssumeRole permission to the invoker role in the primary account.

        • (string) –

      • invokerRoleName (string) –

        Existing Amazon Web Services IAM role name in the primary Amazon Web Services account that will be assumed by Resilience Hub Service Principle to obtain a read-only access to your application resources while running an assessment.

        Note

        • You must have iam:passRole permission for this role while creating or updating the application.

        • Currently, invokerRoleName accepts only [A-Za-z0-9_+=,.@-] characters.

      • type (string) –

        Defines how Resilience Hub scans your resources. It can scan for the resources by using a pre-existing role in your Amazon Web Services account, or by using the credentials of the current IAM user.

    • policyArn (string) –

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

    • resiliencyScore (float) –

      Current resiliency score for the application.

    • rpoInSecs (integer) –

      Recovery Point Objective (RPO) in seconds.

    • rtoInSecs (integer) –

      Recovery Time Objective (RTO) in seconds.

    • status (string) –

      Status of the application.

    • tags (dict) –

      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