Start Image Scan

ecr_start_image_scan

R Documentation

Starts a basic image vulnerability scan¶

Description¶

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.

Usage¶

ecr_start_image_scan(registryId, repositoryName, imageId)

Arguments¶

registryId: The Amazon Web Services account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed.
repositoryName: [required] The name of the repository that contains the images to scan.
imageId: [required]

Value¶

A list with the following syntax:

list(
  registryId = "string",
  repositoryName = "string",
  imageId = list(
    imageDigest = "string",
    imageTag = "string"
  ),
  imageScanStatus = list(
    status = "IN_PROGRESS"|"COMPLETE"|"FAILED"|"UNSUPPORTED_IMAGE"|"ACTIVE"|"PENDING"|"SCAN_ELIGIBILITY_EXPIRED"|"FINDINGS_UNAVAILABLE"|"LIMIT_EXCEEDED",
    description = "string"
  )
)

Request syntax¶

svc$start_image_scan(
  registryId = "string",
  repositoryName = "string",
  imageId = list(
    imageDigest = "string",
    imageTag = "string"
  )
)