AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ecr ]

list-image-referrers

Description

Lists the artifacts associated with a specified subject image.

Note

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

See also: AWS API Documentation

Synopsis

  list-image-referrers
[--registry-id <value>]
--repository-name <value>
--subject-id <value>
[--filter <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--registry-id (string)

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.

--repository-name (string)

The name of the repository that contains the subject image.

--subject-id (structure)

An object containing the image digest of the subject image for which to retrieve associated artifacts.

imageDigest -> (string)

The digest of the image.

Shorthand Syntax:

imageDigest=string

JSON Syntax:

{
  "imageDigest": "string"
}

--filter (structure)

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

artifactTypes -> (list)

The artifact types with which to filter your ListImageReferrers results.

(string)

artifactStatus -> (string)

The artifact status with which to filter your ListImageReferrers results. Valid values are ACTIVE , ARCHIVED , ACTIVATING , or ANY . If not specified, only artifacts with ACTIVE status are returned.

Shorthand Syntax:

artifactTypes=string,string,artifactStatus=string

JSON Syntax:

{
  "artifactTypes": ["string", ...],
  "artifactStatus": "ACTIVE"|"ARCHIVED"|"ACTIVATING"|"ANY"
}

--next-token (string)

The nextToken value returned from a previous paginated ListImageReferrers 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.

Note

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.

--max-results (integer)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

referrers -> (list)

The list of artifacts associated with the subject image.

(structure)

An object representing an artifact associated with a subject image.

digest -> (string)

The digest of the artifact manifest.

mediaType -> (string)

The media type of the artifact manifest.

artifactType -> (string)

A string identifying the type of artifact.

size -> (long)

The size, in bytes, of the artifact.

annotations -> (map)

A map of annotations associated with the artifact.

key -> (string)

value -> (string)

artifactStatus -> (string)

The status of the artifact. Valid values are ACTIVE , ARCHIVED , or ACTIVATING .

nextToken -> (string)

The nextToken value to include in a future ListImageReferrers request. When the results of a ListImageReferrers request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.