View a markdown version of this page

List and view image recipe details - EC2 Image Builder
List image recipesView image recipe detailsGet image recipe policy details

List and view image recipe details

This section describes the various ways that you can find information and view details for your EC2 Image Builder image recipes.

List image recipes

You can list all of your image recipes, or filter the results by owner. Use Self to list the recipes that you own, or Shared to list recipes that other accounts have shared with you.

Console

To see a list of the image recipes created under your account, follow these steps:

  1. Open the EC2 Image Builder console at https://console.aws.amazon.com/imagebuilder/.

  2. Choose Image recipes from the navigation pane. This shows a list of the image recipes that are created under your account.

  3. To view details or create a new recipe version, choose the Recipe name link. This opens the detail view for the recipe.

    Note

    You can also select the check box next to the Recipe name, then choose View details.

AWS CLI

The following example shows how to list all of your image recipes, using the AWS CLI.

aws imagebuilder list-image-recipes

The command returns a summary for each image recipe, shown in the following example output.

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageRecipeSummaryList": [
        {
            "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.0",
            "name": "my-recipe",
            "platform": "Linux",
            "owner": "123456789012",
            "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x",
            "dateCreated": "2024-01-15T10:30:00.000Z",
            "tags": {
                "Environment": "Production"
            }
        }
    ]
}

The following example lists only the recipes that you own:

aws imagebuilder list-image-recipes --owner Self

The following example lists the recipes that other accounts have shared with you:

aws imagebuilder list-image-recipes --owner Shared
PowerShell

The following example shows how to use the Get-EC2IBImageRecipeList cmdlet to list all of your image recipes:

Get-EC2IBImageRecipeList

The following example lists only the recipes that you own:

Get-EC2IBImageRecipeList -Owner Self

The following example lists the recipes that other accounts have shared with you:

Get-EC2IBImageRecipeList -Owner Shared

View image recipe details

Console

To view details for a specific image recipe, select the image recipe to review, and use the steps described in List image recipes.

On the recipe detail page, you can:

AWS CLI

The following example shows how to use an imagebuilder CLI command to get the details of an image recipe by specifying its Amazon Resource Name (ARN).

aws imagebuilder get-image-recipe --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.0

The command returns the full image recipe, shown in the following example output.

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "imageRecipe": {
        "arn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.0",
        "name": "my-recipe",
        "description": "My Linux image recipe",
        "platform": "Linux",
        "version": "1.0.0",
        "components": [
            {
                "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/my-component/1.0.0/1"
            }
        ],
        "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x",
        "dateCreated": "2024-01-15T10:30:00.000Z",
        "tags": {},
        "owner": "123456789012"
    }
}
PowerShell

The following example shows how to use the Get-EC2IBImageRecipe cmdlet to get the details of an image recipe by specifying its Amazon Resource Name (ARN):

Get-EC2IBImageRecipe -ImageRecipeArn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.0

Get image recipe policy details

A recipe policy is a resource-based policy. It controls cross-account access to your recipe. When you share a recipe through AWS Resource Access Manager (AWS RAM), Image Builder creates the policy automatically. You can also set a custom policy with the put-image-recipe-policy command.

Note

If you set the resource policy directly with put-image-recipe-policy, you must then promote the resource to a AWS RAM resource share so that it's visible to the principals you share it with. For more information, see Option 2: Apply a resource policy and promote to an existing resource share.

AWS CLI

The following example shows how to use an imagebuilder CLI command to get the details of an image recipe policy by specifying its ARN. If no policy is attached to the recipe, the response is empty.

aws imagebuilder get-image-recipe-policy --image-recipe-arn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.0
PowerShell

The following example shows how to use the Get-EC2IBImageRecipePolicy cmdlet to get the details of an image recipe policy by specifying its ARN:

Get-EC2IBImageRecipePolicy -ImageRecipeArn arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/my-recipe/1.0.0

The cmdlet returns the policy as a JSON string. If no policy is attached to the recipe, the cmdlet returns {}.