list_apps

ResilienceHub.Client.list_apps(**kwargs)

Lists your AWS 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',
    maxResults=123,
    name='string',
    nextToken='string'
)

Parameters

• appArn (string) -- The Amazon Resource Name (ARN) of the AWS 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.
• 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.
• 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.

Return type

dict

Returns

Response Syntax

{
    'appSummaries': [
        {
            'appArn': 'string',
            'assessmentSchedule': 'Disabled'|'Daily',
            'complianceStatus': 'PolicyBreached'|'PolicyMet'|'NotAssessed'|'ChangesDetected',
            'creationTime': datetime(2015, 1, 1),
            'description': 'string',
            'name': 'string',
            'resiliencyScore': 123.0,
            'status': 'Active'|'Deleting'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • appSummaries (list) --

    Summaries for the AWS Resilience Hub application.

    • (dict) --

      Defines an application summary.

      • appArn (string) --

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

      • name (string) --

        The name of the application.

      • resiliencyScore (float) --

        The current resiliency score for the application.

      • status (string) --

        The status of the application.

  • 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.ThrottlingException
• ResilienceHub.Client.exceptions.ValidationException
• ResilienceHub.Client.exceptions.AccessDeniedException