Skip to content

List Image Pipeline Images

imagebuilder_list_image_pipeline_images R Documentation

Returns a list of images created by the specified pipeline

Description

Returns a list of images created by the specified pipeline.

Usage

imagebuilder_list_image_pipeline_images(imagePipelineArn, filters,
  maxResults, nextToken)

Arguments

imagePipelineArn

[required] The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

filters

Use the following filters to streamline results:

  • name

  • version

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.

Value

A list with the following syntax:

list(
  requestId = "string",
  imageSummaryList = list(
    list(
      arn = "string",
      name = "string",
      type = "AMI"|"DOCKER",
      version = "string",
      platform = "Windows"|"Linux",
      osVersion = "string",
      state = list(
        status = "PENDING"|"CREATING"|"BUILDING"|"TESTING"|"DISTRIBUTING"|"INTEGRATING"|"AVAILABLE"|"CANCELLED"|"FAILED"|"DEPRECATED"|"DELETED"|"DISABLED",
        reason = "string"
      ),
      owner = "string",
      dateCreated = "string",
      outputResources = list(
        amis = list(
          list(
            region = "string",
            image = "string",
            name = "string",
            description = "string",
            state = list(
              status = "PENDING"|"CREATING"|"BUILDING"|"TESTING"|"DISTRIBUTING"|"INTEGRATING"|"AVAILABLE"|"CANCELLED"|"FAILED"|"DEPRECATED"|"DELETED"|"DISABLED",
              reason = "string"
            ),
            accountId = "string"
          )
        ),
        containers = list(
          list(
            region = "string",
            imageUris = list(
              "string"
            )
          )
        )
      ),
      tags = list(
        "string"
      ),
      buildType = "USER_INITIATED"|"SCHEDULED"|"IMPORT",
      imageSource = "AMAZON_MANAGED"|"AWS_MARKETPLACE"|"IMPORTED"|"CUSTOM",
      deprecationTime = as.POSIXct(
        "2015-01-01"
      ),
      lifecycleExecutionId = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_image_pipeline_images(
  imagePipelineArn = "string",
  filters = list(
    list(
      name = "string",
      values = list(
        "string"
      )
    )
  ),
  maxResults = 123,
  nextToken = "string"
)