Returns the list of images that you have access to¶

Description¶

Returns the list of images that you have access to.

Usage¶

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

Arguments¶

• owner

  Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.

• filters

  Use the following filters to streamline results:

  • name
  • osVersion
  • platform
  • type
  • version

• byName

  Specifies whether to return one entry per image name, with all versions of each image aggregated. Defaults to false, which returns one entry per image version. You can't combine this option with the version filter.

• maxResults

  The maximum number of items to return in a single request.

• nextToken

  A token to specify where to start paginating. Use the nextToken value from a previously truncated response.

• includeDeprecated

  Specifies whether to include deprecated Amazon-managed images in the results. Deprecated images that you own are always returned. Defaults to false.

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"|"macOS",
      osVersion = "string",
      owner = "string",
      dateCreated = "string",
      buildType = "USER_INITIATED"|"SCHEDULED"|"IMPORT"|"IMPORT_ISO",
      imageSource = "AMAZON_MANAGED"|"AWS_MARKETPLACE"|"IMPORTED"|"CUSTOM"
    )
  ),
  nextToken = "string"
)

Request syntax¶

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