Skip to content

List Images

imagebuilder_list_images R Documentation

Returns the list of images that you have access to

Description

Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.

Usage

imagebuilder_list_images(owner, filters, byName, maxResults, nextToken,
  includeDeprecated)

Arguments

owner

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.

filters

Use the following filters to streamline results:

  • name

  • osVersion

  • platform

  • type

  • version

byName

Requests a list of images with a specific recipe name.

maxResults

The maximum items to return in a request.

nextToken

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

includeDeprecated

Includes deprecated images in the response list.

Value

A list with the following syntax: 

list(
  requestId = "string",
  imageVersionList = list(
    list(
      arn = "string",
      name = "string",
      type = "AMI"|"DOCKER",
      version = "string",
      platform = "Windows"|"Linux",
      osVersion = "string",
      owner = "string",
      dateCreated = "string",
      buildType = "USER_INITIATED"|"SCHEDULED"|"IMPORT",
      imageSource = "AMAZON_MANAGED"|"AWS_MARKETPLACE"|"IMPORTED"|"CUSTOM"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_images(
  owner = "Self"|"Shared"|"Amazon"|"ThirdParty",
  filters = list(
    list(
      name = "string",
      values = list(
        "string"
      )
    )
  ),
  byName = TRUE|FALSE,
  maxResults = 123,
  nextToken = "string",
  includeDeprecated = TRUE|FALSE
)