AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartAssessmentRun and EndStartAssessmentRun.

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

Syntax

C#
public virtual Task<StartAssessmentRunResponse> StartAssessmentRunAsync(
         StartAssessmentRunRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Inspector.Model.StartAssessmentRunRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


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

Exceptions

ExceptionCondition
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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also