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 a basic image vulnerability scan.

A basic image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. You can start up to 100,000 basic scans per 24 hours. This limit includes both scans on initial push and scans initiated by the StartImageScan API. For more information, see Basic scanning in the Amazon Elastic Container Registry User Guide.

Note:

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

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

Syntax

C#
public abstract StartImageScanResponse StartImageScan(
         StartImageScanRequest request
)

Parameters

request
Type: Amazon.ECR.Model.StartImageScanRequest

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

Return Value


The response from the StartImageScan service method, as returned by ECR.

Exceptions

ExceptionCondition
ImageNotFoundException The image requested does not exist in the specified repository.
InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
LimitExceededException The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.
RepositoryNotFoundException The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
ServerException These errors are usually caused by a server-side issue.
UnsupportedImageTypeException The image is of a type that cannot be scanned.
ValidationException There was an exception validating this request.

Version Information

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

See Also