Start Image Scan

ecr_start_image_scan

R Documentation

Starts an image vulnerability scan¶

Description¶

Starts an image vulnerability scan. An 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. For more information, see Image 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",
    description = "string"
  )
)

Request syntax¶

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