Skip to content

Stop Assessment Run

inspector_stop_assessment_run R Documentation

Stops the assessment run that is specified by the ARN of the assessment run

Description

Stops the assessment run that is specified by the ARN of the assessment run.

Usage

inspector_stop_assessment_run(assessmentRunArn, stopAction)

Arguments

assessmentRunArn

[required] The ARN of the assessment run that you want to stop.

stopAction

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

Value

An empty list.

Request syntax

svc$stop_assessment_run(
  assessmentRunArn = "string",
  stopAction = "START_EVALUATION"|"SKIP_EVALUATION"
)

Examples

## Not run: 
# Stops the assessment run that is specified by the ARN of the assessment
# run.
svc$stop_assessment_run(
  assessmentRunArn = "arn:aws:inspector:us-west-2:123456789012:target/0-nvg..."
)

## End(Not run)