Skip to content

Describe Images

ecrpublic_describe_images R Documentation

Description

Returns metadata that's related to the images in a repository in a public registry.

Beginning 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, it might return a larger image size than the image sizes that are returned by describe_images.

Usage

ecrpublic_describe_images(registryId, repositoryName, imageIds,
  nextToken, maxResults)

Arguments

registryId

The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public 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 that's 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. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

maxResults

The maximum number of repository results that's 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. You can see the remaining results of the initial request by sending another describe_images request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then describe_images returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

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"
      ),
      imageManifestMediaType = "string",
      artifactMediaType = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_images(
  registryId = "string",
  repositoryName = "string",
  imageIds = list(
    list(
      imageDigest = "string",
      imageTag = "string"
    )
  ),
  nextToken = "string",
  maxResults = 123
)