Retrieves an image recipe¶

Description¶

Retrieves an image recipe.

Usage¶

imagebuilder_get_image_recipe(imageRecipeArn)

Arguments¶

imageRecipeArn

[required] The Amazon Resource Name (ARN) of the image recipe that you want to retrieve. You can use the x wildcard in trailing version positions to retrieve the latest matching version, for example x.x.x or 1.x.x.

Value¶

A list with the following syntax:

list(
  requestId = "string",
  imageRecipe = list(
    arn = "string",
    type = "AMI"|"DOCKER",
    name = "string",
    description = "string",
    platform = "Windows"|"Linux"|"macOS",
    owner = "string",
    version = "string",
    components = list(
      list(
        componentArn = "string",
        parameters = list(
          list(
            name = "string",
            value = list(
              "string"
            )
          )
        )
      )
    ),
    parentImage = "string",
    blockDeviceMappings = list(
      list(
        deviceName = "string",
        ebs = list(
          encrypted = TRUE|FALSE,
          deleteOnTermination = TRUE|FALSE,
          iops = 123,
          kmsKeyId = "string",
          snapshotId = "string",
          volumeSize = 123,
          volumeType = "standard"|"io1"|"io2"|"gp2"|"gp3"|"sc1"|"st1",
          throughput = 123
        ),
        virtualName = "string",
        noDevice = "string"
      )
    ),
    dateCreated = "string",
    tags = list(
      "string"
    ),
    workingDirectory = "string",
    additionalInstanceConfiguration = list(
      systemsManagerAgent = list(
        uninstallAfterBuild = TRUE|FALSE
      ),
      userDataOverride = "string"
    ),
    amiTags = list(
      "string"
    ),
    amiWatermarks = list(
      "string"
    )
  ),
  latestVersionReferences = list(
    latestVersionArn = "string",
    latestMajorVersionArn = "string",
    latestMinorVersionArn = "string",
    latestPatchVersionArn = "string"
  )
)

Request syntax¶

svc$get_image_recipe(
  imageRecipeArn = "string"
)