List Apps

resiliencehub_list_apps

R Documentation

Lists your Resilience Hub applications¶

Description¶

Lists your Resilience Hub applications.

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

Usage¶

resiliencehub_list_apps(appArn, awsApplicationArn,
  fromLastAssessmentTime, maxResults, name, nextToken, reverseOrder,
  toLastAssessmentTime)

Arguments¶

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.

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.

fromLastAssessmentTime

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

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.

name

The name for the one of the listed applications.

nextToken

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

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.

toLastAssessmentTime

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

Value¶

A list with the following syntax:

list(
  appSummaries = list(
    list(
      appArn = "string",
      assessmentSchedule = "Disabled"|"Daily",
      awsApplicationArn = "string",
      complianceStatus = "PolicyBreached"|"PolicyMet"|"NotAssessed"|"ChangesDetected"|"NotApplicable"|"MissingPolicy",
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      description = "string",
      driftStatus = "NotChecked"|"NotDetected"|"Detected",
      lastAppComplianceEvaluationTime = as.POSIXct(
        "2015-01-01"
      ),
      name = "string",
      resiliencyScore = 123.0,
      rpoInSecs = 123,
      rtoInSecs = 123,
      status = "Active"|"Deleting"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_apps(
  appArn = "string",
  awsApplicationArn = "string",
  fromLastAssessmentTime = as.POSIXct(
    "2015-01-01"
  ),
  maxResults = 123,
  name = "string",
  nextToken = "string",
  reverseOrder = TRUE|FALSE,
  toLastAssessmentTime = as.POSIXct(
    "2015-01-01"
  )
)