Returns metadata about the images in a repository¶

Description¶

Returns metadata about the images in a repository.

Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, Docker might return a larger image than the image shown in the Amazon Web Services Management Console.

The new version of Amazon ECR Basic Scanning doesn't use the ImageDetail$imageScanFindingsSummary and ImageDetail$imageScanStatus attributes from the API response to return scan results. Use the describe_image_scan_findings API instead. For more information about Amazon Web Services native basic scanning, see Scan images for software vulnerabilities in Amazon ECR.

Usage¶

ecr_describe_images(registryId, repositoryName, imageIds, nextToken,
  maxResults, filter)

Arguments¶

• registryId

  The Amazon Web Services account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.

• repositoryName

  [required] The repository that contains the images to describe.

• imageIds

  The list of image IDs for the requested repository.

• nextToken

  The nextToken value returned from a previous paginated describe_images request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.

• maxResults

  The maximum number of repository results returned by describe_images in paginated output. When this parameter is used, describe_images only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another describe_images request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then describe_images returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

• filter

  The filter key and value with which to filter your describe_images results.

Value¶

A list with the following syntax:

list(
  imageDetails = list(
    list(
      registryId = "string",
      repositoryName = "string",
      imageDigest = "string",
      imageTags = list(
        "string"
      ),
      imageSizeInBytes = 123,
      imagePushedAt = as.POSIXct(
        "2015-01-01"
      ),
      imageScanStatus = list(
        status = "IN_PROGRESS"|"COMPLETE"|"FAILED"|"UNSUPPORTED_IMAGE"|"ACTIVE"|"PENDING"|"SCAN_ELIGIBILITY_EXPIRED"|"FINDINGS_UNAVAILABLE"|"LIMIT_EXCEEDED"|"IMAGE_ARCHIVED",
        description = "string"
      ),
      imageScanFindingsSummary = list(
        imageScanCompletedAt = as.POSIXct(
          "2015-01-01"
        ),
        vulnerabilitySourceUpdatedAt = as.POSIXct(
          "2015-01-01"
        ),
        findingSeverityCounts = list(
          123
        )
      ),
      imageManifestMediaType = "string",
      artifactMediaType = "string",
      lastRecordedPullTime = as.POSIXct(
        "2015-01-01"
      ),
      subjectManifestDigest = "string",
      imageStatus = "ACTIVE"|"ARCHIVED"|"ACTIVATING",
      lastArchivedAt = as.POSIXct(
        "2015-01-01"
      ),
      lastActivatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$describe_images(
  registryId = "string",
  repositoryName = "string",
  imageIds = list(
    list(
      imageDigest = "string",
      imageTag = "string"
    )
  ),
  nextToken = "string",
  maxResults = 123,
  filter = list(
    tagStatus = "TAGGED"|"UNTAGGED"|"ANY",
    imageStatus = "ACTIVE"|"ARCHIVED"|"ACTIVATING"|"ANY"
  )
)