AWS Resilience Hub

2024/10/15 - AWS Resilience Hub - 5 updated api methods

Changes  AWS Resilience Hub now integrates with the myApplications platform, enabling customers to easily assess the resilience of applications defined in myApplications. The new Resiliency widget provides visibility into application resilience and actionable recommendations for improvement.

CreateApp (updated) Link ¶
Changes (request, response)
Request
{'awsApplicationArn': 'string'}
Response
{'app': {'awsApplicationArn': 'string'}}

Creates an Resilience Hub application. An Resilience Hub application is a collection of Amazon Web Services resources structured to prevent and recover Amazon Web Services application disruptions. To describe a Resilience Hub application, you provide an application name, resources from one or more CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service (Amazon EKS) clusters as optional resources. For more information about the number of resources supported per application, see Service quotas.

After you create an Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).

See also: AWS API Documentation

Request Syntax

client.create_app(
    assessmentSchedule='Disabled'|'Daily',
    awsApplicationArn='string',
    clientToken='string',
    description='string',
    eventSubscriptions=[
        {
            'eventType': 'ScheduledAssessmentFailure'|'DriftDetected',
            'name': 'string',
            'snsTopicArn': 'string'
        },
    ],
    name='string',
    permissionModel={
        'crossAccountRoleArns': [
            'string',
        ],
        'invokerRoleName': 'string',
        'type': 'LegacyIAMUser'|'RoleBased'
    },
    policyArn='string',
    tags={
        'string': 'string'
    }
)
type assessmentSchedule

string

param assessmentSchedule

Assessment execution schedule with 'Daily' or 'Disabled' values.

type awsApplicationArn

string

param awsApplicationArn

Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

type clientToken

string

param clientToken

Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

This field is autopopulated if not provided.

type description

string

param description

The optional description for an app.

type eventSubscriptions

list

param eventSubscriptions

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

  • (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) -- [REQUIRED]

      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) -- [REQUIRED]

      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.

type name

string

param name

[REQUIRED]

Name of the application.

type permissionModel

dict

param permissionModel

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) -- [REQUIRED]

    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.

type policyArn

string

param policyArn

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.

type tags

dict

param tags

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

rtype

dict

returns

Response Syntax

{
    'app': {
        'appArn': 'string',
        'assessmentSchedule': 'Disabled'|'Daily',
        'awsApplicationArn': 'string',
        'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected'|'NotApplicable'|'MissingPolicy',
        '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 created 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.

      • awsApplicationArn (string) --

        Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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

DescribeApp (updated) Link ¶
Changes (response)
{'app': {'awsApplicationArn': 'string'}}

Describes an Resilience Hub application.

See also: AWS API Documentation

Request Syntax

client.describe_app(
    appArn='string'
)
type appArn

string

param appArn

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

rtype

dict

returns

Response Syntax

{
    'app': {
        'appArn': 'string',
        'assessmentSchedule': 'Disabled'|'Daily',
        'awsApplicationArn': 'string',
        'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected'|'NotApplicable'|'MissingPolicy',
        '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.

      • awsApplicationArn (string) --

        Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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

DescribeDraftAppVersionResourcesImportStatus (updated) Link ¶
Changes (response)
{'errorDetails': [{'errorMessage': 'string'}]}

Describes the status of importing resources to an application version.

Note

If you get a 404 error with ResourceImportStatusNotFoundAppMetadataException , you must call importResourcesToDraftAppVersion after creating the application and before calling describeDraftAppVersionResourcesImportStatus to obtain the status.

See also: AWS API Documentation

Request Syntax

client.describe_draft_app_version_resources_import_status(
    appArn='string'
)
type appArn

string

param appArn

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

rtype

dict

returns

Response Syntax

{
    'appArn': 'string',
    'appVersion': 'string',
    'errorDetails': [
        {
            'errorMessage': 'string'
        },
    ],
    'errorMessage': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success',
    'statusChangeTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

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

    • appVersion (string) --

      The version of the application.

    • errorDetails (list) --

      List of errors that were encountered while importing resources.

      • (dict) --

        Indicates the error that was encountered while importing a resource.

        • errorMessage (string) --

          Provides additional information about the error.

    • errorMessage (string) --

      The error message returned for the resource request.

    • status (string) --

      Status of the action.

    • statusChangeTime (datetime) --

      The time when the status last changed.

ListApps (updated) Link ¶
Changes (request, response)
Request
{'awsApplicationArn': 'string'}
Response
{'appSummaries': {'awsApplicationArn': 'string'}}

Lists your Resilience Hub applications.

Note

You can filter applications using only one filter at a time or without using any filter. If you try to filter applications using multiple filters, you will get the following error:

An error occurred (ValidationException) when calling the ListApps operation: Only one filter is supported for this operation.

See also: AWS API Documentation

Request Syntax

client.list_apps(
    appArn='string',
    awsApplicationArn='string',
    fromLastAssessmentTime=datetime(2015, 1, 1),
    maxResults=123,
    name='string',
    nextToken='string',
    reverseOrder=True|False,
    toLastAssessmentTime=datetime(2015, 1, 1)
)
type appArn

string

param appArn

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.

type awsApplicationArn

string

param awsApplicationArn

Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

type fromLastAssessmentTime

datetime

param fromLastAssessmentTime

Indicates the lower limit of the range that is used to filter applications based on their last assessment times.

type maxResults

integer

param maxResults

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.

type name

string

param name

The name for the one of the listed applications.

type nextToken

string

param nextToken

Null, or the token from a previous call to get the next set of results.

type reverseOrder

boolean

param reverseOrder

The application list is sorted based on the values of lastAppComplianceEvaluationTime field. By default, application list is sorted in ascending order. To sort the application list in descending order, set this field to True .

type toLastAssessmentTime

datetime

param toLastAssessmentTime

Indicates the upper limit of the range that is used to filter the applications based on their last assessment times.

rtype

dict

returns

Response Syntax

{
    'appSummaries': [
        {
            'appArn': 'string',
            'assessmentSchedule': 'Disabled'|'Daily',
            'awsApplicationArn': 'string',
            'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected'|'NotApplicable'|'MissingPolicy',
            'creationTime': datetime(2015, 1, 1),
            'description': 'string',
            'driftStatus': 'NotChecked'|'NotDetected'|'Detected',
            'lastAppComplianceEvaluationTime': datetime(2015, 1, 1),
            'name': 'string',
            'resiliencyScore': 123.0,
            'rpoInSecs': 123,
            'rtoInSecs': 123,
            'status': 'Active'|'Deleting'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • appSummaries (list) --

      Summaries for the Resilience Hub application.

      • (dict) --

        Defines an application summary.

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

        • awsApplicationArn (string) --

          Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

        • complianceStatus (string) --

          The current status of compliance for the resiliency policy.

        • creationTime (datetime) --

          Date and time when the app was created.

        • description (string) --

          The optional description for an app.

        • driftStatus (string) --

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

        • lastAppComplianceEvaluationTime (datetime) --

          Date and time of the most recent compliance evaluation.

        • name (string) --

          The name of the application.

        • resiliencyScore (float) --

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

    • nextToken (string) --

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

UpdateApp (updated) Link ¶
Changes (response)
{'app': {'awsApplicationArn': 'string'}}

Updates an application.

See also: AWS API Documentation

Request Syntax

client.update_app(
    appArn='string',
    assessmentSchedule='Disabled'|'Daily',
    clearResiliencyPolicyArn=True|False,
    description='string',
    eventSubscriptions=[
        {
            'eventType': 'ScheduledAssessmentFailure'|'DriftDetected',
            'name': 'string',
            'snsTopicArn': 'string'
        },
    ],
    permissionModel={
        'crossAccountRoleArns': [
            'string',
        ],
        'invokerRoleName': 'string',
        'type': 'LegacyIAMUser'|'RoleBased'
    },
    policyArn='string'
)
type appArn

string

param appArn

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

type assessmentSchedule

string

param assessmentSchedule

Assessment execution schedule with 'Daily' or 'Disabled' values.

type clearResiliencyPolicyArn

boolean

param clearResiliencyPolicyArn

Specifies if the resiliency policy ARN should be cleared.

type description

string

param description

The optional description for an app.

type eventSubscriptions

list

param eventSubscriptions

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) -- [REQUIRED]

      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) -- [REQUIRED]

      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.

type permissionModel

dict

param permissionModel

Defines the roles and credentials that Resilience Hub would use while creating an 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) -- [REQUIRED]

    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.

type policyArn

string

param policyArn

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.

rtype

dict

returns

Response Syntax

{
    'app': {
        'appArn': 'string',
        'assessmentSchedule': 'Disabled'|'Daily',
        'awsApplicationArn': 'string',
        'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected'|'NotApplicable'|'MissingPolicy',
        '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.

      • awsApplicationArn (string) --

        Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

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