List App Assessments

resiliencehub_list_app_assessments

R Documentation

Lists the assessments for an Resilience Hub application¶

Description¶

Lists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.

Usage¶

resiliencehub_list_app_assessments(appArn, assessmentName,
  assessmentStatus, complianceStatus, invoker, maxResults, nextToken,
  reverseOrder)

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.

assessmentName

The name for the assessment.

assessmentStatus

The current status of the assessment for the resiliency policy.

complianceStatus

The current status of compliance for the resiliency policy.

invoker

Specifies the entity that invoked a specific assessment, either a User or the System.

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.

nextToken

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

reverseOrder

The default is to sort by ascending startTime. To sort by descending startTime, set reverseOrder to true.

Value¶

A list with the following syntax:

list(
  assessmentSummaries = list(
    list(
      appArn = "string",
      appVersion = "string",
      assessmentArn = "string",
      assessmentName = "string",
      assessmentStatus = "Pending"|"InProgress"|"Failed"|"Success",
      complianceStatus = "PolicyBreached"|"PolicyMet"|"NotApplicable"|"MissingPolicy",
      cost = list(
        amount = 123.0,
        currency = "string",
        frequency = "Hourly"|"Daily"|"Monthly"|"Yearly"
      ),
      driftStatus = "NotChecked"|"NotDetected"|"Detected",
      endTime = as.POSIXct(
        "2015-01-01"
      ),
      invoker = "User"|"System",
      message = "string",
      resiliencyScore = 123.0,
      startTime = as.POSIXct(
        "2015-01-01"
      ),
      versionName = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_app_assessments(
  appArn = "string",
  assessmentName = "string",
  assessmentStatus = list(
    "Pending"|"InProgress"|"Failed"|"Success"
  ),
  complianceStatus = "PolicyBreached"|"PolicyMet"|"NotApplicable"|"MissingPolicy",
  invoker = "User"|"System",
  maxResults = 123,
  nextToken = "string",
  reverseOrder = TRUE|FALSE
)