[ aws . imagebuilder ]

list-images

Description

Returns the list of images that you have access to.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-images
[--owner <value>]
[--filters <value>]
[--by-name | --no-by-name]
[--max-results <value>]
[--next-token <value>]
[--include-deprecated | --no-include-deprecated]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--owner (string)

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

Possible values:

  • Self

  • Shared

  • Amazon

--filters (list)

The filters.

(structure)

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

name -> (string)

The name of the filter. Filter names are case-sensitive.

values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "string",
    "values": ["string", ...]
  }
  ...
]

--by-name | --no-by-name (boolean)

Requests a list of images with a specific recipe name.

--max-results (integer)

The maximum items to return in a request.

--next-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

--include-deprecated | --no-include-deprecated (boolean)

Includes deprecated images in the response list.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To list images

The following list-images example lists all of the semantic versions you have access to.

aws imagebuilder list-images

Output:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageVersionList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03",
            "name": "MyBasicRecipe",
            "version": "2019.12.03",
            "platform": "Windows",
            "owner": "123456789012",
            "dateCreated": "2020-02-14T21:29:18.810Z"
        }
    ]
}

For more information, see Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI in the EC2 Image Builder Users Guide.

Output

requestId -> (string)

The request ID that uniquely identifies this request.

imageVersionList -> (list)

The list of image semantic versions.

(structure)

An image semantic version.

arn -> (string)

The Amazon Resource Name (ARN) of the image semantic version.

name -> (string)

The name of the image semantic version.

type -> (string)

Specifies whether this is an AMI or container image.

version -> (string)

The semantic version of the image semantic version.

platform -> (string)

The platform of the image semantic version.

osVersion -> (string)

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

owner -> (string)

The owner of the image semantic version.

dateCreated -> (string)

The date at which this image semantic version was created.

nextToken -> (string)

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.