Skip to content

List Image Referrers

ecr_list_image_referrers R Documentation

Lists the artifacts associated with a specified subject image

Description

Lists the artifacts associated with a specified subject image.

The IAM principal invoking this operation must have the ecr:BatchGetImage permission.

Usage

ecr_list_image_referrers(registryId, repositoryName, subjectId, filter,
  nextToken, maxResults)

Arguments

registryId

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

[required] The name of the repository that contains the subject image.
subjectId

[required] An object containing the image digest of the subject image for which to retrieve associated artifacts.
filter

The filter key and value with which to filter your list_image_referrers results. If no filter is specified, only artifacts with ACTIVE status are returned.
nextToken

The nextToken value returned from a previous paginated list_image_referrers 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
maxResults

The maximum number of image referrer results returned by list_image_referrers in paginated output. When this parameter is used, list_image_referrers 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 list_image_referrers request with the returned nextToken value. This value can be between 1 and 50. If this parameter is not used, then list_image_referrers returns up to 20 results and a nextToken value, if applicable.

Value

A list with the following syntax:

list(
  referrers = list(
    list(
      digest = "string",
      mediaType = "string",
      artifactType = "string",
      size = 123,
      annotations = list(
        "string"
      ),
      artifactStatus = "ACTIVE"|"ARCHIVED"|"ACTIVATING"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_image_referrers(
  registryId = "string",
  repositoryName = "string",
  subjectId = list(
    imageDigest = "string"
  ),
  filter = list(
    artifactTypes = list(
      "string"
    ),
    artifactStatus = "ACTIVE"|"ARCHIVED"|"ACTIVATING"|"ANY"
  ),
  nextToken = "string",
  maxResults = 123
)