Menu
Amazon Inspector
API Reference (API Version 2016-02-16)

StartAssessmentRun

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.

Request Syntax

{
   "assessmentRunName": "string",
   "assessmentTemplateArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 140.

Required: No

assessmentTemplateArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: Yes

Response Syntax

{
   "assessmentRunArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

assessmentRunArn

The ARN of the assessment run that has been started.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have required permissions to access the requested resource.

HTTP Status Code: 400

AgentsAlreadyRunningAssessmentException

You started an assessment run, but one of the instances is already participating in another assessment run.

HTTP Status Code: 400

InternalException

Internal server error.

HTTP Status Code: 500

InvalidCrossAccountRoleException

Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

HTTP Status Code: 400

InvalidInputException

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

HTTP Status Code: 400

NoSuchEntityException

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

HTTP Status Code: 400

Example

Sample Request


               
                  POST / HTTP/1.1
                  Host: inspector.us-west-2.amazonaws.com
                  Accept-Encoding: identity
                  Content-Length: 142
                  X-Amz-Target: InspectorService.StartAssessmentRun
                  X-Amz-Date: 20160331T182519Z
                  User-Agent: aws-cli/1.10.12 Python/2.7.9 Windows/7 botocore/1.4.3
                  Content-Type: application/x-amz-json-1.1
                  Authorization: AUTHPARAMS
                  {
                    "assessmentRunName": "examplerun",
                    "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
                  }
               
            

Sample Response


               
                  HTTP/1.1 200 OK
                  x-amzn-RequestId: ed349455-f76d-11e5-b473-ed8493878c40
                  Content-Type: application/x-amz-json-1.1
                  Content-Length: 116
                  Date: Thu, 31 Mar 2016 18:25:22 GMT
                  {
                    "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY"
                  }
               
            

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: