Start App Assessment

resiliencehub_start_app_assessment

R Documentation

Creates a new application assessment for an application

Description

Creates a new application assessment for an application.

Usage

resiliencehub_start_app_assessment(appArn, appVersion, assessmentName,
  clientToken, tags)

Arguments

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.

appVersion

[required] The version of the application.

assessmentName

[required] The name for the assessment.

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.

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.

Value

A list with the following syntax:

list(
  assessment = list(
    appArn = "string",
    appVersion = "string",
    assessmentArn = "string",
    assessmentName = "string",
    assessmentStatus = "Pending"|"InProgress"|"Failed"|"Success",
    compliance = list(
      list(
        achievableRpoInSecs = 123,
        achievableRtoInSecs = 123,
        complianceStatus = "PolicyBreached"|"PolicyMet"|"NotApplicable"|"MissingPolicy",
        currentRpoInSecs = 123,
        currentRtoInSecs = 123,
        message = "string",
        rpoDescription = "string",
        rpoReferenceId = "string",
        rtoDescription = "string",
        rtoReferenceId = "string"
      )
    ),
    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",
    policy = list(
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      dataLocationConstraint = "AnyLocation"|"SameContinent"|"SameCountry",
      estimatedCostTier = "L1"|"L2"|"L3"|"L4",
      policy = list(
        list(
          rpoInSecs = 123,
          rtoInSecs = 123
        )
      ),
      policyArn = "string",
      policyDescription = "string",
      policyName = "string",
      tags = list(
        "string"
      ),
      tier = "MissionCritical"|"Critical"|"Important"|"CoreServices"|"NonCritical"|"NotApplicable"
    ),
    resiliencyScore = list(
      componentScore = list(
        list(
          excludedCount = 123,
          outstandingCount = 123,
          possibleScore = 123.0,
          score = 123.0
        )
      ),
      disruptionScore = list(
        123.0
      ),
      score = 123.0
    ),
    resourceErrorsDetails = list(
      hasMoreErrors = TRUE|FALSE,
      resourceErrors = list(
        list(
          logicalResourceId = "string",
          physicalResourceId = "string",
          reason = "string"
        )
      )
    ),
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    summary = list(
      riskRecommendations = list(
        list(
          appComponents = list(
            "string"
          ),
          recommendation = "string",
          risk = "string"
        )
      ),
      summary = "string"
    ),
    tags = list(
      "string"
    ),
    versionName = "string"
  )
)

Request syntax

svc$start_app_assessment(
  appArn = "string",
  appVersion = "string",
  assessmentName = "string",
  clientToken = "string",
  tags = list(
    "string"
  )
)