ResilienceHub / Client / list_apps

list_apps

ResilienceHub.Client.list_apps(**kwargs)

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

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

Parameters:

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

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

• fromLastAssessmentTime (datetime) – Lower limit of the range that is used to filter applications based on their last assessment times.

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

• name (string) – The name for the one of the listed applications.

• nextToken (string) – Null, or the token from a previous call to get the next set of results.

• reverseOrder (boolean) – 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.

• toLastAssessmentTime (datetime) – Upper limit of the range that is used to filter the applications based on their last assessment times.

Return type:

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.

Exceptions

• ResilienceHub.Client.exceptions.InternalServerException

• ResilienceHub.Client.exceptions.ThrottlingException

• ResilienceHub.Client.exceptions.ValidationException

• ResilienceHub.Client.exceptions.AccessDeniedException