[ aws . imagebuilder ]
get-image-recipe¶
Description¶
Gets an image recipe.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-image-recipe
--image-recipe-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--image-recipe-arn (string)
The Amazon Resource Name (ARN) of the image recipe that you want to retrieve.
--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.
Output¶
requestId -> (string)
The request ID that uniquely identifies this request.
imageRecipe -> (structure)
The image recipe object.
arn -> (string)
The Amazon Resource Name (ARN) of the image recipe.
type -> (string)
Specifies which type of image is created by the recipe - an AMI or a container image.
name -> (string)
The name of the image recipe.
description -> (string)
The description of the image recipe.
platform -> (string)
The platform of the image recipe.
owner -> (string)
The owner of the image recipe.
version -> (string)
The version of the image recipe.
components -> (list)
The components of the image recipe.
(structure)
Configuration details of the component.
componentArn -> (string)
The Amazon Resource Name (ARN) of the component.
parentImage -> (string)
The parent image of the image recipe.
blockDeviceMappings -> (list)
The block device mappings to apply when creating images from this recipe.
(structure)
Defines block device mappings for the instance used to configure your image.
deviceName -> (string)
The device to which these mappings apply.
ebs -> (structure)
Use to manage Amazon EBS-specific configuration for this mapping.
encrypted -> (boolean)
Use to configure device encryption.
deleteOnTermination -> (boolean)
Use to configure delete on termination of the associated device.
iops -> (integer)
Use to configure device IOPS.
kmsKeyId -> (string)
Use to configure the KMS key to use when encrypting the device.
snapshotId -> (string)
The snapshot that defines the device contents.
volumeSize -> (integer)
Use to override the device’s volume size.
volumeType -> (string)
Use to override the device’s volume type.
virtualName -> (string)
Use to manage instance ephemeral devices.
noDevice -> (string)
Use to remove a mapping from the parent image.
dateCreated -> (string)
The date on which this image recipe was created.
tags -> (map)
The tags of the image recipe.
key -> (string)
value -> (string)
workingDirectory -> (string)
The working directory to be used during build and test workflows.