AmazonInspectorClient.StartAssessmentRun Method (StartAssessmentRunRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StartAssessmentRunAsync.

Namespace: Amazon.Inspector
Assembly: AWSSDK.Inspector.dll
Version: 3.x.y.z

Syntax

public virtual StartAssessmentRunResponse StartAssessmentRun(
         StartAssessmentRunRequest request
)

Parameters

request: Type: Amazon.Inspector.Model.StartAssessmentRunRequest

Container for the necessary parameters to execute the StartAssessmentRun service method.

Return Value

Type: StartAssessmentRunResponse

The response from the StartAssessmentRun service method, as returned by Inspector.

Exceptions

Exception	Condition
AccessDeniedException	You do not have required permissions to access the requested resource.
AgentsAlreadyRunningAssessmentException	You started an assessment run, but one of the instances is already participating in another assessment run.
InternalException	Internal server error.
InvalidCrossAccountRoleException	Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.
InvalidInputException	The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
LimitExceededException	The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
NoSuchEntityException	The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
ServiceTemporarilyUnavailableException	The serice is temporary unavailable.

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.

Start assessment run


var client = new AmazonInspectorClient();
var response = client.StartAssessmentRun(new StartAssessmentRunRequest 
{
    AssessmentRunName = "examplerun",
    AssessmentTemplateArn = "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
});

string assessmentRunArn = response.AssessmentRunArn;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonInspectorClient.StartAssessmentRun (StartAssessmentRunRequest)

Method