StopAssessmentRun
Stops the assessment run that is specified by the ARN of the assessment run.
Request Syntax
{
"assessmentRunArn": "string",
"stopAction": "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.
- assessmentRunArn
-
The ARN of the assessment run that you want to stop.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
- 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.
Type: String
Valid Values:
START_EVALUATION | SKIP_EVALUATIONRequired: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidInputException
-
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
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
- ServiceTemporarilyUnavailableException
-
The serice is temporary unavailable.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of StopAssessmentRun.
Sample Request
POST / HTTP/1.1
Host: inspector.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 117
X-Amz-Target: InspectorService.StopAssessmentRun
X-Amz-Date: 20160331T183401Z
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
{
"assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 23e1a935-f76f-11e5-92d3-7ba54a65df23
Content-Type: application/x-amz-json-1.1
Content-Length: 0
Date: Thu, 31 Mar 2016 18:34:02 GMT
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
