Skip to content

Starts the assessment run specified by the ARN of the assessment template

Description

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

Usage

inspector_start_assessment_run(assessmentTemplateArn, assessmentRunName)

Arguments

  • assessmentTemplateArn

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

  • assessmentRunName

    You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run.

Value

A list with the following syntax:

list(
  assessmentRunArn = "string"
)

Request syntax

svc$start_assessment_run(
  assessmentTemplateArn = "string",
  assessmentRunName = "string"
)

Examples

# Starts the assessment run specified by the ARN of the assessment
# template. For this API to function properly, you must not exceed the
# limit of running up to 500 concurrent agents per AWS account.
svc$start_assessment_run(
  assessmentRunName = "examplerun",
  assessmentTemplateArn = "arn:aws:inspector:us-west-2:123456789012:target/..."
)