{ "version": "1.0", "examples": { "CancelImageCreation": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE77777", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE77777", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "requestId": "fead325f-72d9-42b5-b2ed-c5294984c6a9" }, "description": "The following example cancels a build that is in progress for the specified image build version.", "id": "cancel-an-image-build", "title": "Cancel an image build" } ], "CancelLifecycleExecution": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE97531", "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503" }, "output": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503" }, "description": "The following example cancels the scheduled resource state update associated with the specified lifecycle execution ID before it runs.", "id": "cancel-a-lifecycle-execution", "title": "Cancel a lifecycle execution" } ], "CreateComponent": [ { "input": { "name": "my-example-component", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "data": "name: InstallMyApp\ndescription: Installs my application\nschemaVersion: 1.0\nphases:\n - name: build\n steps:\n - name: InstallApp\n action: ExecuteBash\n inputs:\n commands:\n - sudo yum -y install my-app\n", "description": "Installs the latest version of my application", "platform": "Linux", "semanticVersion": "1.0.0" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/x.x.x" }, "requestId": "e769f240-fb6a-4253-88d1-20a80cbe787d" }, "description": "The following example creates a build component from a YAML document provided inline in the request.", "id": "create-a-component-from-an-inline-document", "title": "Create a component from an inline document" }, { "input": { "name": "my-example-parameterized-component", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE10101", "description": "Installs a configurable version of my application", "platform": "Linux", "semanticVersion": "1.0.0", "uri": "s3://amzn-s3-demo-bucket/components/install-my-app.yaml" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE10101", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.0/1", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/x.x.x" }, "requestId": "0cec8e32-a5c6-4aeb-ac3a-6471c8a2a8a9" }, "description": "The following example creates a component from a YAML definition document that's stored in an Amazon S3 bucket. The definition document for this component includes an AppVersion parameter that recipes can set when they include the component.", "id": "create-a-component-from-a-document-stored-in-amazon-s3", "title": "Create a component from a document stored in Amazon S3" } ], "CreateContainerRecipe": [ { "input": { "name": "my-example-container-recipe", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE99999", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-container-component/1.0.0/1" } ], "containerType": "DOCKER", "dockerfileTemplateData": "FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}\n", "parentImage": "amazonlinux:latest", "semanticVersion": "1.0.0", "targetRepository": { "repositoryName": "my-example-container-repo", "service": "ECR" } }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE99999", "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/x.x.x" }, "requestId": "20b16948-45a4-4b3a-9a17-d54779847365" }, "description": "The following example creates a Docker container recipe that applies one build component, using the latest Amazon Linux container image as the parent and an existing ECR repository as the target.", "id": "create-a-container-recipe-with-an-inline-dockerfile-template", "title": "Create a container recipe with an inline Dockerfile template" }, { "input": { "name": "my-example-container-recipe", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE40404", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-container-component/1.0.0/1" } ], "containerType": "DOCKER", "description": "A container recipe that builds on an ECS-optimized instance image with a larger build volume", "dockerfileTemplateData": "FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}\n", "instanceConfiguration": { "blockDeviceMappings": [ { "deviceName": "/dev/xvda", "ebs": { "deleteOnTermination": true, "volumeSize": 40, "volumeType": "gp3" } } ], "image": "ami-1234567890abcdef0" }, "parentImage": "amazonlinux:latest", "semanticVersion": "1.1.0", "targetRepository": { "repositoryName": "my-example-container-repo", "service": "ECR" } }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE40404", "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.1.0", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.1.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.1.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/x.x.x" }, "requestId": "4b6fc7f3-5b6b-4086-858e-22d4c7f9a37f" }, "description": "The following example creates a container recipe that customizes the Amazon EC2 instance that builds the container image. The build instance launches from an Amazon ECS-optimized instance image and uses a 40 GiB gp3 volume.", "id": "create-a-container-recipe-with-a-custom-build-instance-configuration", "title": "Create a container recipe with a custom build instance configuration" } ], "CreateDistributionConfiguration": [ { "input": { "name": "my-example-distribution", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "description": "Copies the output AMI to a second Region", "distributions": [ { "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" }, "region": "us-west-2" }, { "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" }, "region": "us-east-1" } ] }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "requestId": "ca5312ad-a273-4c8c-817e-042941a5762d" }, "description": "The following example creates a distribution configuration that distributes the output AMI to two Regions. The AMI name includes the build date, so that repeated builds create unique AMI names.", "id": "create-a-distribution-configuration", "title": "Create a distribution configuration" }, { "input": { "name": "my-example-distribution", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE56789", "description": "Distributes the output AMI to two Regions and shares it with another account", "distributions": [ { "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" }, "launchTemplateConfigurations": [ { "launchTemplateId": "lt-1234567890abcdef0", "setDefaultVersion": true } ], "region": "us-west-2" }, { "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}", "launchPermission": { "userIds": [ "444455556666" ] } }, "region": "us-east-1" } ] }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE56789", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "requestId": "13c97ae8-8e39-4e12-af78-25e70def0933" }, "description": "The following example creates a distribution configuration that distributes the output AMI to two Regions. In us-east-1, it shares the AMI with another AWS account. In us-west-2, it sets the new AMI as the default version of your launch template.", "id": "create-a-distribution-configuration-with-launch-permissions-and-a-launch-template-update", "title": "Create a distribution configuration with launch permissions and a launch template update" } ], "CreateImage": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEeeeee", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEeeeee", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/x.x.x" }, "requestId": "62e9b43f-a9fd-4272-89fb-ce6235d07ab4" }, "description": "The following example creates a new image from the specified image recipe and infrastructure configuration.", "id": "create-an-image", "title": "Create an image" }, { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE01234", "executionRole": "arn:aws:iam::111122223333:role/aws-service-role/imagebuilder.amazonaws.com/AWSServiceRoleForImageBuilder", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "workflows": [ { "workflowArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" }, { "parallelGroup": "post-build-tests", "workflowArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/test/my-example-integration-tests/1.0.0/1" }, { "parallelGroup": "post-build-tests", "workflowArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/test/my-example-compliance-tests/1.0.0/1" } ] }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE01234", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/x.x.x" }, "requestId": "359f18b1-814f-4857-987f-924214970897" }, "description": "The following example creates an image that uses your custom build and test workflows. It uses the Image Builder service-linked role as the execution role. Both test workflows are in the same parallel group, so they can run at the same time after the build workflow completes.", "id": "create-an-image-with-custom-build-and-parallel-test-workflows", "title": "Create an image with custom build and parallel test workflows" } ], "CreateImagePipeline": [ { "input": { "name": "my-example-pipeline", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", "description": "Builds a new version of my image every Sunday", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "schedule": { "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE", "scheduleExpression": "cron(0 9 ? * SUN *)" }, "status": "ENABLED" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE55555", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "requestId": "db0a9329-35ef-4b53-98d0-a34385e44e28" }, "description": "The following example creates a pipeline that builds a new image version every Sunday at 9:00 AM UTC, if the base image or components have updates.", "id": "create-an-image-pipeline", "title": "Create an image pipeline" }, { "input": { "name": "my-example-pipeline", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE30303", "description": "Builds a scanned image with my custom build workflow on Sunday mornings when dependency updates are available", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "executionRole": "arn:aws:iam::111122223333:role/aws-service-role/imagebuilder.amazonaws.com/AWSServiceRoleForImageBuilder", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.1.0", "imageScanningConfiguration": { "imageScanningEnabled": true }, "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "schedule": { "autoDisablePolicy": { "failureCount": 3 }, "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE", "scheduleExpression": "cron(0 9 ? * SUN *)", "timezone": "America/Los_Angeles" }, "status": "ENABLED", "workflows": [ { "workflowArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" } ] }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE30303", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "requestId": "f8da3ec9-4b76-4aa3-817a-c35a90f59dca" }, "description": "The following example creates a pipeline that uses your custom build workflow and enables image scanning. The schedule evaluates its cron expression in the America/Los_Angeles time zone. The auto-disable policy disables the pipeline after 3 consecutive failed scheduled builds.", "id": "create-an-image-pipeline-with-scanning-custom-workflows-and-an-auto-disable-policy", "title": "Create an image pipeline with scanning, custom workflows, and an auto-disable policy" } ], "CreateImageRecipe": [ { "input": { "name": "my-example-recipe", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" } ], "description": "An image recipe that installs my application on Amazon Linux 2023", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x", "semanticVersion": "1.0.0" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/x.x.x" }, "requestId": "89f4af2f-4f28-45e6-a9d8-abeba591df6a" }, "description": "The following example creates an image recipe that applies a custom component on top of the latest Amazon Linux 2023 base image.", "id": "create-an-image-recipe", "title": "Create an image recipe" }, { "input": { "name": "my-example-recipe", "blockDeviceMappings": [ { "deviceName": "/dev/xvda", "ebs": { "deleteOnTermination": true, "encrypted": true, "volumeSize": 30, "volumeType": "gp3" } } ], "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE20202", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-parameterized-component/1.0.0/1", "parameters": [ { "name": "AppVersion", "value": [ "2.5.0" ] } ] } ], "description": "Installs a specific version of my application on Amazon Linux 2023 with a larger encrypted root volume", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x", "semanticVersion": "1.1.0" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE20202", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.1.0", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.1.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.1.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/x.x.x" }, "requestId": "e3bdc054-d12e-4578-a847-68a18da724ca" }, "description": "The following example creates an image recipe that configures its components and storage. The AppVersion component parameter selects the application version to install. The block device mapping increases the root volume to an encrypted 30 GiB gp3 volume.", "id": "create-an-image-recipe-with-component-parameters-and-block-device-mappings", "title": "Create an image recipe with component parameters and block device mappings" } ], "CreateInfrastructureConfiguration": [ { "input": { "name": "my-example-infrastructure", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "description": "An infrastructure configuration for Amazon Linux builds", "instanceProfileName": "EC2InstanceProfileForImageBuilder", "instanceTypes": [ "t3.medium", "t3.large" ], "terminateInstanceOnFailure": true }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "requestId": "67082698-415b-4d9f-8be0-84a58380b93f" }, "description": "The following example creates an infrastructure configuration that gives Image Builder a choice of two instance types for its build and test instances.", "id": "create-an-infrastructure-configuration", "title": "Create an infrastructure configuration" }, { "input": { "name": "my-example-infrastructure", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE98765", "description": "An infrastructure configuration that pins build instances to one Availability Zone and requires IMDSv2", "instanceMetadataOptions": { "httpPutResponseHopLimit": 2, "httpTokens": "required" }, "instanceProfileName": "my-example-instance-role", "placement": { "availabilityZone": "us-west-2a" }, "resourceTags": { "CostCenter": "12345", "Environment": "test" }, "terminateInstanceOnFailure": true }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE98765", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "requestId": "b96b54d8-daa6-4fdf-b25a-7b570bc2ab25" }, "description": "The following example creates an infrastructure configuration. It places your build and test instances in a single Availability Zone and requires IMDSv2 for instance metadata requests. It also applies resource tags to the resources that Image Builder creates during the build.", "id": "create-an-infrastructure-configuration-with-instance-placement-and-metadata-options", "title": "Create an infrastructure configuration with instance placement and metadata options" } ], "CreateLifecyclePolicy": [ { "input": { "name": "my-example-lifecycle-policy", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE13579", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "policyDetails": [ { "action": { "type": "DELETE" }, "filter": { "type": "AGE", "value": 6, "unit": "MONTHS" } } ], "resourceSelection": { "tagMap": { "Environment": "test" } }, "resourceType": "AMI_IMAGE" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE13579", "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" }, "description": "The following example creates a lifecycle policy that deletes AMI-based images six months after they were created, selecting the images that match the specified resource tags.", "id": "create-a-lifecycle-policy", "title": "Create a lifecycle policy" }, { "input": { "name": "my-example-lifecycle-policy", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE43210", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "policyDetails": [ { "action": { "type": "DELETE" }, "exclusionRules": { "amis": { "lastLaunched": { "value": 30, "unit": "DAYS" }, "tagMap": { "Retention": "keep" } } }, "filter": { "type": "AGE", "value": 6, "unit": "MONTHS" } } ], "resourceSelection": { "recipes": [ { "name": "my-example-recipe", "semanticVersion": "1.0.0" } ] }, "resourceType": "AMI_IMAGE" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE43210", "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" }, "description": "The following example creates a lifecycle policy that deletes images created from the specified recipe version after six months. The policy excludes images whose AMIs launched an instance within the last 30 days or are tagged to be retained.", "id": "create-a-lifecycle-policy-with-exclusion-rules", "title": "Create a lifecycle policy with exclusion rules" } ], "CreateWorkflow": [ { "input": { "name": "my-example-workflow", "type": "BUILD", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE54321", "data": "name: my-example-workflow\ndescription: Workflow to build an AMI\nschemaVersion: 1.0\nsteps:\n - name: LaunchBuildInstance\n action: LaunchInstance\n onFailure: Abort\n inputs:\n waitFor: ssmAgent\n - name: ApplyBuildComponents\n action: ExecuteComponents\n onFailure: Abort\n inputs:\n instanceId.$: $.stepOutputs.LaunchBuildInstance.instanceId\n - name: CreateOutputAMI\n action: CreateImage\n onFailure: Abort\n inputs:\n instanceId.$: $.stepOutputs.LaunchBuildInstance.instanceId\n - name: TerminateBuildInstance\n action: TerminateInstance\n onFailure: Continue\n inputs:\n instanceId.$: $.stepOutputs.LaunchBuildInstance.instanceId\n", "description": "Workflow to build an AMI", "semanticVersion": "1.0.0" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE54321", "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/x.x.x" }, "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" }, "description": "The following example creates a build workflow from a YAML workflow document provided inline in the request.", "id": "create-a-build-workflow-from-an-inline-document", "title": "Create a build workflow from an inline document" } ], "DeleteComponent": [ { "input": { "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" }, "output": { "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1", "requestId": "c75a1764-2ca3-4cb4-9ce9-6d49f87942b0" }, "description": "The following example deletes the specified component build version.", "id": "delete-a-component-build-version", "title": "Delete a component build version" } ], "DeleteContainerRecipe": [ { "input": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0" }, "output": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "requestId": "988e934a-b785-4705-aff1-4d9840a165aa" }, "description": "The following example deletes the specified container recipe.", "id": "delete-a-container-recipe", "title": "Delete a container recipe" } ], "DeleteDistributionConfiguration": [ { "input": { "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration" }, "output": { "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration", "requestId": "2b752b77-2038-40f4-996a-0a6da1be5e92" }, "description": "The following example deletes the specified distribution configuration.", "id": "delete-a-distribution-configuration", "title": "Delete a distribution configuration" } ], "DeleteImage": [ { "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "requestId": "fd45526c-ec37-4345-8843-329e4268e00e" }, "description": "The following example deletes the Image Builder image record for the specified build version - EC2 AMIs or ECR container images that the build created aren't removed.", "id": "delete-an-image-build-version", "title": "Delete an image build version" } ], "DeleteImagePipeline": [ { "input": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" }, "output": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "requestId": "0536e4e9-5331-493a-921e-e8f86d367043" }, "description": "The following example deletes an image pipeline.", "id": "delete-an-image-pipeline", "title": "Delete an image pipeline" } ], "DeleteImageRecipe": [ { "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0" }, "output": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "requestId": "a27ae6de-0adc-4cbb-9705-a4b8751857b8" }, "description": "The following example deletes the specified image recipe version.", "id": "delete-an-image-recipe", "title": "Delete an image recipe" } ], "DeleteInfrastructureConfiguration": [ { "input": { "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure" }, "output": { "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "requestId": "fbae57f4-59fc-48ab-a25e-c67b0d9b454c" }, "description": "The following example deletes the infrastructure configuration with the specified ARN.", "id": "delete-an-infrastructure-configuration", "title": "Delete an infrastructure configuration" } ], "DeleteLifecyclePolicy": [ { "input": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" }, "output": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" }, "description": "The following example deletes the specified lifecycle policy.", "id": "delete-a-lifecycle-policy", "title": "Delete a lifecycle policy" } ], "DeleteWorkflow": [ { "input": { "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" }, "output": { "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" }, "description": "The following example deletes the workflow build version that the ARN specifies.", "id": "delete-a-workflow-build-version", "title": "Delete a workflow build version" } ], "DistributeImage": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE86420", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration", "executionRole": "arn:aws:iam::111122223333:role/aws-service-role/imagebuilder.amazonaws.com/AWSServiceRoleForImageBuilder", "sourceImage": "ami-1234567890abcdef0" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE86420", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-source-ami/1.0.0/1" }, "description": "The following example distributes an AMI that you own to the targets defined in the specified distribution configuration. It returns the ARN of a new Image Builder image resource that you can use with GetImage to monitor distribution progress.", "id": "distribute-an-existing-ami", "title": "Distribute an existing AMI" } ], "GetComponent": [ { "input": { "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" }, "output": { "component": { "version": "1.0.0", "name": "my-example-component", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1", "changeDescription": "Initial version", "data": "name: InstallMyApp\ndescription: Installs my application\nschemaVersion: 1.0\nphases:\n - name: build\n steps:\n - name: InstallApp\n action: ExecuteBash\n inputs:\n commands:\n - sudo yum -y install my-app\n", "dateCreated": "2026-09-09T18:31:30.404Z", "description": "Installs the latest version of my application", "encrypted": true, "owner": "111122223333", "platform": "Linux", "state": { "status": "ACTIVE" } }, "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/x.x.x" }, "requestId": "f5401098-035f-4be2-9eee-784c388ed04b" }, "description": "The following example retrieves a component build version. The data field in the response contains the YAML document that defines the component.", "id": "get-the-details-of-a-component-build-version", "title": "Get the details of a component build version" } ], "GetComponentPolicy": [ { "input": { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1" }, "output": { "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetComponent\", \"imagebuilder:ListComponents\"], \"Resource\": [\"arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1\"]}]}", "requestId": "cb458998-6e6f-442a-9325-78c730b80895" }, "description": "The following example retrieves the resource policy that's applied to a component that the owner shared with another account.", "id": "get-the-resource-policy-for-a-component", "title": "Get the resource policy for a component" } ], "GetContainerRecipe": [ { "input": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0" }, "output": { "containerRecipe": { "version": "1.0.0", "name": "my-example-container-recipe", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-container-component/1.0.0/1" } ], "containerType": "DOCKER", "dateCreated": "2026-09-09T19:32:53.983Z", "description": "A container recipe that installs my application on Amazon Linux", "dockerfileTemplateData": "FROM {{{ imagebuilder:parentImage }}}\n{{{ imagebuilder:environments }}}\n{{{ imagebuilder:components }}}\n", "encrypted": true, "owner": "111122223333", "parentImage": "amazonlinux:latest", "platform": "Linux", "targetRepository": { "repositoryName": "my-example-container-repo", "service": "ECR" } }, "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/x.x.x" }, "requestId": "15b03ca7-050f-46d4-945e-00232cff6b19" }, "description": "The following example retrieves the details of the specified container recipe.", "id": "get-the-details-of-a-container-recipe", "title": "Get the details of a container recipe" } ], "GetContainerRecipePolicy": [ { "input": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0" }, "output": { "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Sid\": \"AllowSharedAccountContainerRecipeAccess\", \"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetContainerRecipe\", \"imagebuilder:ListContainerRecipes\"], \"Resource\": \"arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0\"}]}", "requestId": "1b8334a0-5ae7-4c3c-8092-5d589dab7a2b" }, "description": "The following example retrieves the resource policy for a container recipe that you shared with another AWS account. The policy property contains the resource-based policy document as a JSON-encoded string.", "id": "get-the-policy-attached-to-a-container-recipe", "title": "Get the policy attached to a container recipe" } ], "GetDistributionConfiguration": [ { "input": { "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution" }, "output": { "distributionConfiguration": { "name": "my-example-distribution", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "dateCreated": "2026-09-09T19:37:37.231Z", "description": "Copies the output AMI to a second Region", "distributions": [ { "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" }, "region": "us-west-2" }, { "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" }, "region": "us-east-1" } ], "timeoutMinutes": 720 }, "requestId": "2d0a8dc0-99d5-4d7a-af7a-d1aeafd71c2e" }, "description": "The following example retrieves a distribution configuration that distributes the output AMI to two Regions.", "id": "get-the-details-of-a-distribution-configuration", "title": "Get the details of a distribution configuration" } ], "GetImage": [ { "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "image": { "version": "1.0.0/1", "name": "my-example-recipe", "type": "AMI", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "dateCreated": "2026-09-03T05:44:21.121Z", "enhancedImageMetadataEnabled": true, "platform": "Linux", "sourcePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "state": { "status": "BUILDING" } }, "requestId": "4be892f0-e1d1-47f9-8bc1-d08ec5dec640" }, "description": "The following example retrieves an image build version to check its status while the build is running. The response is shortened to show a subset of the fields that Image Builder returns.", "id": "check-the-status-of-an-image-build", "title": "Check the status of an image build" } ], "GetImagePipeline": [ { "input": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" }, "output": { "imagePipeline": { "name": "my-example-pipeline", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "dateCreated": "2026-09-09T19:38:26.574Z", "dateUpdated": "2026-09-09T19:38:26.574Z", "description": "Builds an Amazon Linux 2023 image every Sunday", "enhancedImageMetadataEnabled": true, "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 720 }, "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "platform": "Linux", "schedule": { "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE", "scheduleExpression": "cron(0 0 ? * SUN *)" }, "status": "ENABLED" }, "requestId": "b7e58d62-36dc-43a5-87ff-546e04cdabf1" }, "description": "The following example retrieves an image pipeline that builds a new image every Sunday, including the image tests configuration and schedule start condition defaults that Image Builder applied at creation.", "id": "get-the-details-of-an-image-pipeline", "title": "Get the details of an image pipeline" } ], "GetImagePolicy": [ { "input": { "imageArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetImage\", \"imagebuilder:ListImages\"], \"Resource\": [\"arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1\"]}]}", "requestId": "bc0c8348-c0d9-452a-af20-2640430df585" }, "description": "The following example retrieves the resource policy for an image build version that was shared with account 444455556666.", "id": "retrieve-the-resource-policy-for-an-image", "title": "Retrieve the resource policy for an image" } ], "GetImageRecipe": [ { "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.0.0" }, "output": { "imageRecipe": { "version": "1.0.0", "name": "my-example-app-recipe", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.0.0", "components": [ { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-app/1.0.0/1" } ], "dateCreated": "2026-09-09T19:30:21.183Z", "description": "An image recipe that installs my application on Amazon Linux 2023", "owner": "111122223333", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x", "platform": "Linux", "workingDirectory": "/tmp" }, "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-app-recipe/x.x.x" }, "requestId": "adb3ff9a-df84-4b4e-8ecf-11d38281ead7" }, "description": "The following example retrieves the full definition of an image recipe, including the components it applies and the base image it builds on.", "id": "get-the-details-of-an-image-recipe", "title": "Get the details of an image recipe" } ], "GetImageRecipePolicy": [ { "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0" }, "output": { "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetImageRecipe\", \"imagebuilder:ListImageRecipes\"], \"Resource\": \"arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0\"}]}", "requestId": "0cf42efc-4b2c-4ba3-b6e3-542a796fffaf" }, "description": "The following example retrieves the resource policy that's applied to the specified image recipe.", "id": "get-the-resource-policy-for-an-image-recipe", "title": "Get the resource policy for an image recipe" } ], "GetInfrastructureConfiguration": [ { "input": { "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure-configuration" }, "output": { "infrastructureConfiguration": { "name": "my-example-infrastructure-configuration", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure-configuration", "dateCreated": "2026-09-09T19:36:48.933Z", "description": "Infrastructure configuration for my application image builds", "instanceMetadataOptions": { "httpPutResponseHopLimit": 2, "httpTokens": "required" }, "instanceProfileName": "EC2InstanceProfileForImageBuilder", "instanceTypes": [ "m5.large", "m5.xlarge" ], "resourceTags": { "CostCenter": "12345" }, "tags": { "Environment": "test" }, "terminateInstanceOnFailure": true }, "requestId": "7ba25cd0-0735-4f44-bc67-2f231e96503f" }, "description": "The following example retrieves an infrastructure configuration that specifies the instance types, instance profile, and instance metadata options that Image Builder uses for build and test instances.", "id": "get-the-details-of-an-infrastructure-configuration", "title": "Get the details of an infrastructure configuration" } ], "GetLifecycleExecution": [ { "input": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503" }, "output": { "lifecycleExecution": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "resourcesImpactedSummary": { "hasImpactedResources": false }, "startTime": "2026-09-09T21:42:29Z", "state": { "status": "IN_PROGRESS" } } }, "description": "The following example retrieves the runtime status of the specified lifecycle execution. If the execution was started by StartResourceStateUpdate rather than a lifecycle policy run, the response doesn't include the lifecyclePolicyArn field.", "id": "get-the-details-of-a-lifecycle-execution", "title": "Get the details of a lifecycle execution" } ], "GetLifecyclePolicy": [ { "input": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy" }, "output": { "lifecyclePolicy": { "name": "my-example-lifecycle-policy", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-lifecycle-policy", "dateCreated": "2026-09-09T19:34:38Z", "description": "Deletes AMIs and snapshots for builds older than six months, keeping at least the five most recent", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "policyDetails": [ { "action": { "type": "DELETE", "includeResources": { "amis": true, "snapshots": true } }, "filter": { "type": "AGE", "value": 6, "retainAtLeast": 5, "unit": "MONTHS" } } ], "resourceSelection": { "tagMap": { "Environment": "my-example-environment" } }, "resourceType": "AMI_IMAGE", "status": "ENABLED" } }, "description": "The following example retrieves the full definition of the specified lifecycle policy.", "id": "get-the-details-of-a-lifecycle-policy", "title": "Get the details of a lifecycle policy" } ], "GetWorkflow": [ { "input": { "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1" }, "output": { "latestVersionReferences": { "latestMajorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.x.x", "latestMinorVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.x", "latestPatchVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0", "latestVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/x.x.x" }, "workflow": { "version": "1.0.0", "name": "my-example-workflow", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1", "changeDescription": "Initial version", "data": "name: my-example-workflow\ndescription: Workflow to build an AMI, then wait for an external action before it completes\nschemaVersion: 1.0\n\nparameters:\n - name: waitForActionAtEnd\n type: boolean\n default: true\n\nsteps:\n - name: LaunchBuildInstance\n action: LaunchInstance\n onFailure: Abort\n inputs:\n waitFor: \"ssmAgent\"\n\n - name: ApplyBuildComponents\n action: ExecuteComponents\n onFailure: Abort\n inputs:\n instanceId.$: \"$.stepOutputs.LaunchBuildInstance.instanceId\"\n\n - name: CreateOutputAMI\n action: CreateImage\n onFailure: Abort\n inputs:\n instanceId.$: \"$.stepOutputs.LaunchBuildInstance.instanceId\"\n\n - name: TerminateBuildInstance\n action: TerminateInstance\n onFailure: Continue\n inputs:\n instanceId.$: \"$.stepOutputs.LaunchBuildInstance.instanceId\"\n\n - name: WaitForActionAtEnd\n action: WaitForAction\n if:\n booleanEquals: true\n value: \"$.parameters.waitForActionAtEnd\"\n", "dateCreated": "2026-09-09T19:55:55.731Z", "description": "Builds an AMI, and then waits for an external action before the workflow completes", "owner": "111122223333", "parameters": [ { "name": "waitForActionAtEnd", "type": "boolean", "defaultValue": [ "true" ] } ] } }, "description": "The following example retrieves a workflow build version. The response includes the YAML workflow document in the data field and the parameters that Image Builder extracted from it when the workflow was created.", "id": "get-the-details-of-a-workflow-build-version", "title": "Get the details of a workflow build version" } ], "GetWorkflowExecution": [ { "input": { "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908" }, "output": { "type": "BUILD", "endTime": "2026-09-09T19:19:06.158Z", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "requestId": "cd69c813-51c3-4261-8e59-382a1af96f73", "startTime": "2026-09-09T19:12:23.175Z", "status": "COMPLETED", "totalStepCount": 7, "totalStepsFailed": 0, "totalStepsSkipped": 2, "totalStepsSucceeded": 5, "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1", "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908" }, "description": "The following example retrieves runtime status and step counts for the build workflow that ran for an image build version, using the workflow execution ID returned by ListWorkflowExecutions.", "id": "get-the-runtime-details-for-a-workflow-execution", "title": "Get the runtime details for a workflow execution" } ], "GetWorkflowStepExecution": [ { "input": { "stepExecutionId": "step-2e6fef0d-657c-4b7e-8706-ff24da9afa01" }, "output": { "name": "LaunchBuildInstance", "action": "LaunchInstance", "endTime": "2026-09-09T19:14:50.822Z", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "inputs": "{\"waitFor\": \"ssmAgent\"}", "onFailure": "Abort", "outputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "requestId": "9ba63d27-9568-4ea3-bfed-6b1ad4c09200", "startTime": "2026-09-09T19:12:23.418Z", "status": "COMPLETED", "stepExecutionId": "step-2e6fef0d-657c-4b7e-8706-ff24da9afa01", "timeoutSeconds": 4500, "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1", "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908" }, "description": "The following example retrieves runtime details for the step that launched the build instance during an image build, with the step's input parameters and output values returned as JSON-encoded strings.", "id": "get-the-runtime-details-of-a-workflow-step", "title": "Get the runtime details of a workflow step" } ], "ImportComponent": [ { "input": { "name": "my-example-imported-component", "type": "BUILD", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE88888", "data": "sudo yum update -y\nsudo yum -y install my-app\n", "description": "Installs my application from an imported shell script", "format": "SHELL", "platform": "Linux", "semanticVersion": "1.0.0" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE88888", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-imported-component/1.0.0/1", "requestId": "e62cb87f-e291-4fb2-9305-54a7878c3b99" }, "description": "The following example imports a plain shell script as a Linux build component.", "id": "import-a-component-from-a-shell-script", "title": "Import a component from a shell script" } ], "ImportDiskImage": [ { "input": { "name": "my-example-imported-image", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE12345", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "osVersion": "Microsoft Windows 11", "platform": "Windows", "semanticVersion": "1.0.0", "uri": "s3://amzn-s3-demo-bucket/Win11_23H2_English_x64.iso" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE12345", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-imported-image/1.0.0/1" }, "description": "The following example starts an image build that converts a Windows 11 ISO disk file stored in Amazon S3 into an AMI; the imageBuildVersionArn in the response identifies the Image Builder image resource that tracks the build, not the output AMI.", "id": "import-a-windows-11-iso-disk-image", "title": "Import a Windows 11 ISO disk image" } ], "ImportVmImage": [ { "input": { "name": "my-example-imported-image", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE00000", "osVersion": "Amazon Linux 2", "platform": "Linux", "semanticVersion": "1.0.0", "vmImportTaskId": "import-ami-1234567890abcdef0" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE00000", "imageArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-imported-image/1.0.0/1", "requestId": "f8a1d0ce-42b7-4d6a-9b12-3c84a02e5f19" }, "description": "The following example registers the output of an EC2 VM Import/Export task (import-ami) as a new Image Builder image, so you can use the imported virtual machine as a base image.", "id": "import-a-virtual-machine-as-an-image-builder-image", "title": "Import a virtual machine as an Image Builder image" } ], "ListComponentBuildVersions": [ { "input": { "componentVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0" }, "output": { "componentSummaryList": [ { "version": "1.0.0", "name": "my-example-component", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/2", "changeDescription": "Updated the install command to use dnf", "dateCreated": "2026-09-09T18:35:23.098Z", "description": "Installs the latest version of my application", "owner": "111122223333", "platform": "Linux", "state": { "status": "ACTIVE" }, "supportedOsVersions": [ "Amazon Linux 2023" ], "tags": { "Environment": "Production" } }, { "version": "1.0.0", "name": "my-example-component", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1", "changeDescription": "Initial version", "dateCreated": "2026-09-09T18:35:20.731Z", "description": "Installs the latest version of my application", "owner": "111122223333", "platform": "Linux", "state": { "status": "ACTIVE" }, "supportedOsVersions": [ "Amazon Linux 2023" ], "tags": { "Environment": "Production" } } ], "requestId": "1d8693f0-26e1-42d7-ba35-d95ace1ce7e0" }, "description": "The following example lists the build versions that exist for version 1.0.0 of the specified component. The list returns the most recent build version first.", "id": "list-the-build-versions-of-a-component", "title": "List the build versions of a component" } ], "ListComponents": [ { "input": { "filters": [ { "name": "platform", "values": [ "Linux" ] } ], "owner": "Self" }, "output": { "componentVersionList": [ { "version": "1.0.0", "name": "my-example-component", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0", "dateCreated": "2026-09-09T18:31:49.661Z", "description": "Installs my example application", "owner": "111122223333", "platform": "Linux", "status": "ACTIVE", "supportedOsVersions": [ "Amazon Linux 2023" ] }, { "version": "1.0.0", "name": "my-example-imported-component", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-imported-component/1.0.0", "dateCreated": "2026-09-09T18:31:21.941Z", "description": "Installs my application from an imported shell script", "owner": "111122223333", "platform": "Linux", "status": "ACTIVE" }, { "version": "1.0.0", "name": "my-example-test-component", "type": "TEST", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-test-component/1.0.0", "dateCreated": "2026-09-09T18:31:52.888Z", "description": "Verifies that my example application is installed", "owner": "111122223333", "platform": "Linux", "status": "ACTIVE" } ], "requestId": "fc51d989-ca0a-4ac7-9ca6-fb7786e70955" }, "description": "The following example lists the component versions that your account owns, filtered to components for the Linux platform.", "id": "list-components-that-you-own", "title": "List components that you own" } ], "ListContainerRecipes": [ { "input": { "owner": "Self" }, "output": { "containerRecipeSummaryList": [ { "name": "my-example-container-recipe", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe/1.0.0", "containerType": "DOCKER", "dateCreated": "2026-09-09T19:31:26.363Z", "owner": "111122223333", "parentImage": "amazonlinux:latest", "platform": "Linux" } ], "requestId": "883e6f0e-8883-4c1a-9710-791afb74be0d" }, "description": "The following example lists the container recipes that you own.", "id": "list-the-container-recipes-you-own", "title": "List the container recipes you own" } ], "ListDistributionConfigurations": [ { "input": { "filters": [ { "name": "name", "values": [ "my-example-distribution-configuration" ] } ] }, "output": { "distributionConfigurationSummaryList": [ { "name": "my-example-distribution-configuration", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution-configuration", "dateCreated": "2026-09-09T21:09:02.581Z", "description": "Distributes AMIs to us-west-2", "regions": [ "us-west-2" ] } ], "requestId": "1057325c-6b4a-4e16-ac6e-12f1d8fcc6f9" }, "description": "The following example lists the distribution configurations whose name matches the filter value.", "id": "list-distribution-configurations-that-match-a-name-filter", "title": "List distribution configurations that match a name filter" } ], "ListImageBuildVersions": [ { "input": { "imageVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0" }, "output": { "imageSummaryList": [ { "version": "1.0.0/1", "name": "my-example-recipe", "type": "AMI", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "buildType": "USER_INITIATED", "dateCreated": "2026-09-09T19:12:18.677Z", "osVersion": "Amazon Linux 2023", "outputResources": { "amis": [ { "name": "my-example-recipe 2026-09-09T19-19-08.103311Z", "accountId": "111122223333", "image": "ami-1234567890abcdef0", "region": "us-west-2" } ] }, "owner": "111122223333", "platform": "Linux", "state": { "status": "AVAILABLE" } } ], "requestId": "b4808907-dcad-4951-ada5-dd151e93135a" }, "description": "The following example lists the build versions that exist for version 1.0.0 of the specified image, with the output AMI that each build produced.", "id": "list-the-build-versions-of-an-image", "title": "List the build versions of an image" } ], "ListImagePackages": [ { "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "imagePackageList": [ { "packageName": "passwd", "packageVersion": "0.80" }, { "packageName": "dracut-config-ec2", "packageVersion": "3.1" }, { "packageName": "libsolv", "packageVersion": "0.7.22" }, { "packageName": "libxcrypt", "packageVersion": "4.4.33" }, { "packageName": "python3-policycoreutils", "packageVersion": "3.4" } ], "requestId": "0363bd96-1a54-4736-a307-7ac6095744e0" }, "description": "The following example lists the operating system packages that Image Builder detected in the specified image build version.", "id": "list-the-packages-in-an-image-build-version", "title": "List the packages in an image build version" } ], "ListImagePipelineImages": [ { "input": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" }, "output": { "imageSummaryList": [ { "version": "1.0.0/1", "name": "my-example-recipe", "type": "AMI", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "buildType": "USER_INITIATED", "dateCreated": "2026-09-09T19:39:20.458Z", "outputResources": { "amis": [] }, "owner": "111122223333", "platform": "Linux", "state": { "status": "BUILDING" } } ], "requestId": "071a0ecb-b07d-4485-832c-e6b88de8ebed" }, "description": "The following example lists the images that the specified pipeline created, including a build that is still in progress.", "id": "list-the-images-that-an-image-pipeline-created", "title": "List the images that an image pipeline created" } ], "ListImagePipelines": [ { "input": { "filters": [ { "name": "name", "values": [ "my-example-pipeline" ] } ] }, "output": { "imagePipelineList": [ { "name": "my-example-pipeline", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "dateCreated": "2026-09-09T19:52:05.146Z", "dateUpdated": "2026-09-09T19:52:05.146Z", "description": "Builds a new version of my image every Sunday", "enhancedImageMetadataEnabled": true, "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 720 }, "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "platform": "Linux", "schedule": { "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE", "scheduleExpression": "cron(0 9 ? * SUN *)" }, "status": "ENABLED" } ], "requestId": "b818f3f9-b851-4de7-95f3-8fabed4e1841" }, "description": "The following example lists the image pipelines in your account, using a filter to match a specific pipeline name.", "id": "list-image-pipelines-filtered-by-name", "title": "List image pipelines filtered by name" } ], "ListImageRecipes": [ { "input": { "owner": "Self" }, "output": { "imageRecipeSummaryList": [ { "name": "my-example-linux-recipe", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-linux-recipe/1.0.0", "dateCreated": "2026-09-09T19:30:33.064Z", "owner": "111122223333", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/amazon-linux-2023-x86/x.x.x", "platform": "Linux" }, { "name": "my-example-windows-recipe", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-windows-recipe/1.0.0", "dateCreated": "2026-09-09T19:30:35.110Z", "owner": "111122223333", "parentImage": "arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2022-english-full-base-x86/x.x.x", "platform": "Windows" } ], "requestId": "4b036f1a-3716-441d-a401-419249f6569e" }, "description": "The following example lists the image recipes that you own.", "id": "list-the-image-recipes-that-you-own", "title": "List the image recipes that you own" } ], "ListImageScanFindingAggregations": [ { "input": { "filter": { "name": "imagePipelineArn", "values": [ "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" ] } }, "output": { "aggregationType": "imagePipelineArn", "requestId": "b1c9dd23-7a9c-4a52-a1f7-3b8e9e17b2c4", "responses": [ { "imagePipelineAggregation": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "severityCounts": { "all": 25, "critical": 1, "high": 7, "medium": 12 } } } ] }, "description": "The following example aggregates vulnerability findings for images that the specified pipeline created, with counts grouped by severity level.", "id": "list-image-scan-finding-aggregations-for-an-image-pipeline", "title": "List image scan finding aggregations for an image pipeline" } ], "ListImageScanFindings": [ { "input": { "filters": [ { "name": "imageBuildVersionArn", "values": [ "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" ] } ] }, "output": { "findings": [ { "type": "PACKAGE_VULNERABILITY", "awsAccountId": "111122223333", "description": "In the Linux kernel, the following vulnerability has been resolved:\n\nvirtio: break and reset virtio devices on device_shutdown()", "firstObservedAt": "2026-01-06T20:12:57Z", "fixAvailable": "YES", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "inspectorScore": 7.0, "inspectorScoreDetails": { "adjustedCvss": { "version": "3.1", "adjustments": [], "cvssSource": "AMAZON_CVE", "score": 7.0, "scoreSource": "AMAZON_CVE", "scoringVector": "CVSS:3.1/AV:L/AC:H/PR:L/UI:N/S:U/C:H/I:H/A:H" } }, "packageVulnerabilityDetails": { "cvss": [ { "version": "3.1", "baseScore": 7.0, "scoringVector": "CVSS:3.1/AV:L/AC:H/PR:L/UI:N/S:U/C:H/I:H/A:H", "source": "AMAZON_CVE" } ], "referenceUrls": [ "https://alas.aws.amazon.com/AL2/ALAS2-2025-2955.html", "https://alas.aws.amazon.com/AL2023/ALAS2023-2025-1130.html" ], "relatedVulnerabilities": [ "ALAS2-2025-2955", "ALAS2023-2025-1130" ], "source": "AMAZON_CVE", "sourceUrl": "https://alas.aws.amazon.com/cve/json/v1/CVE-2025-38064.json", "vendorCreatedAt": "2025-06-18T00:00:00Z", "vendorSeverity": "Important", "vendorUpdatedAt": "2025-06-25T00:00:00Z", "vulnerabilityId": "CVE-2025-38064", "vulnerablePackages": [ { "version": "4.14.355", "name": "kernel", "arch": "X86_64", "epoch": 0, "fixedInVersion": "0:5.15.189-131.202.amzn2", "packageManager": "OS", "release": "280.652.amzn2", "remediation": "yum update kernel" } ] }, "remediation": { "recommendation": { "text": "None Provided" } }, "severity": "HIGH", "title": "CVE-2025-38064 - kernel", "updatedAt": "2026-01-06T20:12:57Z" } ], "requestId": "233de8e7-3b58-4319-a6af-f6774cf7d371" }, "description": "The following example lists the vulnerability findings that Amazon Inspector detected for the specified image build version.", "id": "list-vulnerability-findings-for-an-image-build", "title": "List vulnerability findings for an image build" } ], "ListImages": [ { "input": { "byName": false, "owner": "Self" }, "output": { "imageVersionList": [ { "version": "1.0.0", "name": "my-example-recipe", "type": "AMI", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0", "buildType": "USER_INITIATED", "dateCreated": "2026-09-09T19:12:18.677Z", "osVersion": "Amazon Linux 2023", "owner": "111122223333", "platform": "Linux" }, { "version": "1.0.0", "name": "my-example-windows-image", "type": "AMI", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-windows-image/1.0.0", "buildType": "USER_INITIATED", "dateCreated": "2026-03-10T19:57:27.323Z", "osVersion": "Microsoft Windows Server 2025", "owner": "111122223333", "platform": "Windows" }, { "version": "1.0.1", "name": "my-example-windows-image", "type": "AMI", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-windows-image/1.0.1", "buildType": "USER_INITIATED", "dateCreated": "2026-03-10T20:32:31.795Z", "osVersion": "Microsoft Windows Server 2025", "owner": "111122223333", "platform": "Windows" } ], "requestId": "19794296-a45f-4079-8741-e00d3c916318" }, "description": "The following example lists the image versions that you own. Setting byName to false returns each image version as its own entry, instead of grouping build versions under their image name.", "id": "list-images-that-you-own", "title": "List images that you own" } ], "ListInfrastructureConfigurations": [ { "input": { "filters": [ { "name": "name", "values": [ "my-example-infrastructure-configuration" ] } ] }, "output": { "infrastructureConfigurationSummaryList": [ { "name": "my-example-infrastructure-configuration", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure-configuration", "dateCreated": "2026-09-09T19:37:17.350Z", "description": "An example infrastructure configuration for Amazon Linux builds", "instanceProfileName": "EC2InstanceProfileForImageBuilder", "instanceTypes": [ "m5.large", "m5.xlarge" ], "tags": { "Environment": "test" } } ], "requestId": "dbadaf86-3a9d-48fc-8e34-6062ef0a70f2" }, "description": "The following example lists your infrastructure configurations, filtered to a specific resource name.", "id": "list-infrastructure-configurations-by-name", "title": "List infrastructure configurations by name" } ], "ListLifecycleExecutionResources": [ { "input": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503" }, "output": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "lifecycleExecutionState": { "status": "IN_PROGRESS" }, "resources": [] }, "description": "The following example lists the resources that the specified lifecycle execution acted on. For a scheduled resource state update that hasn't started to apply changes yet, the resources list is empty.", "id": "list-the-resources-that-a-lifecycle-execution-acted-on", "title": "List the resources that a lifecycle execution acted on" } ], "ListLifecycleExecutions": [ { "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "lifecycleExecutions": [ { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "resourcesImpactedSummary": { "hasImpactedResources": false }, "startTime": "2026-09-09T21:42:29Z", "state": { "status": "IN_PROGRESS" } } ] }, "description": "The following example lists the lifecycle executions that have run against the specified image build version. The execution shown was started with StartResourceStateUpdate rather than a lifecycle policy, so it has no lifecyclePolicyArn.", "id": "list-lifecycle-executions-for-an-image-build-version", "title": "List lifecycle executions for an image build version" } ], "ListLifecyclePolicies": [ { "input": { "filters": [ { "name": "status", "values": [ "ENABLED" ] } ] }, "output": { "lifecyclePolicySummaryList": [ { "name": "my-example-ami-policy", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-ami-policy", "dateCreated": "2026-09-09T19:36:17Z", "description": "Deletes AMI image builds after they reach 6 months old", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "resourceType": "AMI_IMAGE", "status": "ENABLED" }, { "name": "my-example-container-policy", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-container-policy", "dateCreated": "2026-09-09T19:36:19Z", "description": "Deletes container image builds after they reach 6 months old", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "resourceType": "CONTAINER_IMAGE", "status": "ENABLED" } ] }, "description": "The following example lists the lifecycle policies in your account that have ENABLED status.", "id": "list-enabled-lifecycle-policies", "title": "List enabled lifecycle policies" } ], "ListTagsForResource": [ { "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-component/1.0.0/1" }, "output": { "tags": { "CostCenter": "12345", "Environment": "Production" } }, "description": "The following example lists the tags that are assigned to an existing component build version.", "id": "list-the-tags-for-a-resource", "title": "List the tags for a resource" } ], "ListWaitingWorkflowSteps": [ { "input": { "maxResults": 25 }, "output": { "steps": [ { "name": "WaitForApproval", "action": "WaitForAction", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-wait-recipe/1.0.0/1", "startTime": "2026-09-09T20:02:59.931Z", "stepExecutionId": "step-8eb24d7a-036e-46b5-94a3-90a5d8b5ac4a", "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-wait-workflow/1.0.0/1", "workflowExecutionId": "wf-782460a6-8dc5-4262-90ff-0509eef0053c" } ] }, "description": "The following example lists the workflow steps in your account that are paused at a WaitForAction step, waiting for you to resume or stop the workflow with SendWorkflowStepAction.", "id": "list-workflow-steps-that-are-waiting-for-an-action", "title": "List workflow steps that are waiting for an action" } ], "ListWorkflowBuildVersions": [ { "input": { "workflowVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0" }, "output": { "workflowSummaryList": [ { "version": "1.0.0", "name": "my-example-workflow", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/2", "changeDescription": "Added a step to collect image metadata from the build instance", "dateCreated": "2026-09-09T19:56:38.339Z", "description": "Workflow to build my example image", "owner": "111122223333" }, { "version": "1.0.0", "name": "my-example-workflow", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-workflow/1.0.0/1", "changeDescription": "Initial version", "dateCreated": "2026-09-09T19:41:14.997Z", "description": "Workflow to build my example image", "owner": "111122223333" } ] }, "description": "The following example lists the build versions that exist for version 1.0.0 of the specified workflow, with the most recent build version first and the change description for each build version showing what changed.", "id": "list-the-build-versions-of-a-workflow", "title": "List the build versions of a workflow" } ], "ListWorkflowExecutions": [ { "input": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "requestId": "c78ef9a3-cce8-4e7d-ae96-426fb7e59f5d", "workflowExecutions": [ { "type": "BUILD", "endTime": "2026-09-09T19:19:06.158Z", "retried": false, "startTime": "2026-09-09T19:12:23.175Z", "status": "COMPLETED", "totalStepCount": 7, "totalStepsFailed": 0, "totalStepsSkipped": 2, "totalStepsSucceeded": 5, "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1", "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908" }, { "type": "TEST", "endTime": "2026-09-09T19:21:47.830Z", "retried": false, "startTime": "2026-09-09T19:19:11.709Z", "status": "COMPLETED", "totalStepCount": 4, "totalStepsFailed": 0, "totalStepsSkipped": 2, "totalStepsSucceeded": 2, "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/test/test-image/1.0.3/1", "workflowExecutionId": "wf-1a3639b8-1366-4b73-8347-706874020dad" } ] }, "description": "The following example lists the workflow runtime instances that ran for the specified image build version, which was built with the Image Builder default build and test workflows.", "id": "list-the-workflow-runtime-instances-for-an-image-build-version", "title": "List the workflow runtime instances for an image build version" } ], "ListWorkflowStepExecutions": [ { "input": { "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908" }, "output": { "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "requestId": "c6258beb-bc78-40dc-8bf9-fa5a8a93d3f3", "steps": [ { "name": "LaunchBuildInstance", "action": "LaunchInstance", "endTime": "2026-09-09T19:14:50.822Z", "inputs": "{\"waitFor\": \"ssmAgent\"}", "outputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "startTime": "2026-09-09T19:12:23.418Z", "status": "COMPLETED", "stepExecutionId": "step-2e6fef0d-657c-4b7e-8706-ff24da9afa01" }, { "name": "ApplyBuildComponents", "action": "ExecuteComponents", "endTime": "2026-09-09T19:14:51.229Z", "inputs": "{\"instanceId.$\": \"$.stepOutputs.LaunchBuildInstance.instanceId\"}", "startTime": "2026-09-09T19:14:51.229Z", "status": "SKIPPED", "stepExecutionId": "step-f76c24fe-dc70-435b-8dc1-987a0ca6d5a5" }, { "name": "InventoryCollection", "action": "CollectImageMetadata", "endTime": "2026-09-09T19:16:26.267Z", "inputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "outputs": "{\"osVersion\": \"Amazon Linux 2023\", \"associationId\": \"7416ce2e-4ee8-4660-8c42-a09a03f61010\"}", "startTime": "2026-09-09T19:14:51.818Z", "status": "COMPLETED", "stepExecutionId": "step-aa880a39-e72c-4561-aa05-eb3de860441a" }, { "name": "RunSanitizeScript", "action": "SanitizeInstance", "endTime": "2026-09-09T19:16:36.559Z", "outputs": "{\"status\": \"Success\", \"output\": \"Skipping cleanup\\n\", \"runCommandId\": \"9eef9fe1-12e8-4c97-8e9a-4e79632864f4\"}", "startTime": "2026-09-09T19:16:26.742Z", "status": "COMPLETED", "stepExecutionId": "step-572bdd17-25c4-4729-9f2e-7fd611807751" }, { "name": "RunSysPrepScript", "action": "RunSysPrep", "endTime": "2026-09-09T19:16:36.973Z", "inputs": "{\"instanceId.$\": \"$.stepOutputs.LaunchBuildInstance.instanceId\"}", "startTime": "2026-09-09T19:16:36.973Z", "status": "SKIPPED", "stepExecutionId": "step-06026579-939d-4b1b-b36e-fa58cb712a48" }, { "name": "CreateOutputAMI", "action": "CreateImage", "endTime": "2026-09-09T19:19:02.135Z", "inputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "outputs": "{\"imageId\": \"ami-1234567890abcdef0\"}", "startTime": "2026-09-09T19:16:37.499Z", "status": "COMPLETED", "stepExecutionId": "step-50e4312d-400c-453e-957c-714cbee6961c" }, { "name": "TerminateBuildInstance", "action": "TerminateInstance", "endTime": "2026-09-09T19:19:06.132Z", "inputs": "{\"instanceId\": \"i-1234567890abcdef0\"}", "startTime": "2026-09-09T19:19:02.546Z", "status": "COMPLETED", "stepExecutionId": "step-22673db0-e280-4948-b9b5-789791531c34" } ], "workflowBuildVersionArn": "arn:aws:imagebuilder:us-west-2:aws:workflow/build/build-image/1.0.3/1", "workflowExecutionId": "wf-165b1cb6-3a62-4618-a021-94ddcbe32908" }, "description": "The following example lists runtime details for each step in the specified runtime instance of a workflow, in this case the build workflow from an image build.", "id": "list-the-steps-that-ran-in-a-workflow-execution", "title": "List the steps that ran in a workflow execution" } ], "ListWorkflows": [ { "input": { "owner": "Self" }, "output": { "workflowVersionList": [ { "version": "1.0.0", "name": "my-example-build-workflow", "type": "BUILD", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/build/my-example-build-workflow/1.0.0", "dateCreated": "2026-09-09T19:56:09.033Z", "description": "Builds my example image", "owner": "111122223333" }, { "version": "1.0.0", "name": "my-example-test-workflow", "type": "TEST", "arn": "arn:aws:imagebuilder:us-west-2:111122223333:workflow/test/my-example-test-workflow/1.0.0", "dateCreated": "2026-09-09T19:56:12.440Z", "description": "Tests my example image", "owner": "111122223333" } ] }, "description": "The following example lists the workflow versions that you own.", "id": "list-workflows-that-you-own", "title": "List workflows that you own" } ], "PutComponentPolicy": [ { "input": { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetComponent\", \"imagebuilder:ListComponents\"], \"Resource\": [\"arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1\"]}]}" }, "output": { "componentArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-shared-component/1.0.0/1", "requestId": "ad5a3a66-95c0-4eb5-b34e-f28980256275" }, "description": "The following example applies a resource policy that grants another account permission to get and list the component.", "id": "share-a-component-with-another-account", "title": "Share a component with another account" } ], "PutContainerRecipePolicy": [ { "input": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Sid\": \"AllowSharedAccountContainerRecipeAccess\", \"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetContainerRecipe\", \"imagebuilder:ListContainerRecipes\"], \"Resource\": \"arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0\"}]}" }, "output": { "containerRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:container-recipe/my-example-container-recipe-shared/1.0.0", "requestId": "dd917975-9d5d-49ce-9d94-daa753088dec" }, "description": "The following example applies a resource policy that grants another AWS account permission to view and use the specified container recipe.", "id": "share-a-container-recipe-with-another-account", "title": "Share a container recipe with another account" } ], "PutImagePolicy": [ { "input": { "imageArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetImage\", \"imagebuilder:ListImages\"], \"Resource\": [\"arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1\"]}]}" }, "output": { "imageArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "requestId": "7bbf7e76-0f08-430d-b77e-17c161725825" }, "description": "The following example applies a resource policy to an image build version that grants another AWS account permission to view the image.", "id": "share-an-image-with-another-aws-account", "title": "Share an image with another AWS account" } ], "PutImageRecipePolicy": [ { "input": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{\"Effect\": \"Allow\", \"Principal\": {\"AWS\": \"arn:aws:iam::444455556666:root\"}, \"Action\": [\"imagebuilder:GetImageRecipe\", \"imagebuilder:ListImageRecipes\"], \"Resource\": \"arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0\"}]}" }, "output": { "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "requestId": "3a27bb63-329e-40ab-88f2-c1638504bd35" }, "description": "The following example applies a resource policy that grants another AWS account permission to view the specified image recipe.", "id": "share-an-image-recipe-with-another-account", "title": "Share an image recipe with another account" } ], "RetryImage": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEfffff", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEfffff", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "description": "The following example retries a cancelled image build, which resumes in place from the phase where it stopped.", "id": "retry-an-image-build", "title": "Retry an image build" } ], "SendWorkflowStepAction": [ { "input": { "action": "STOP", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE67890", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-wait-recipe/1.0.0/1", "stepExecutionId": "step-8eb24d7a-036e-46b5-94a3-90a5d8b5ac4a" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE67890", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-wait-recipe/1.0.0/1", "stepExecutionId": "step-8eb24d7a-036e-46b5-94a3-90a5d8b5ac4a" }, "description": "The following example sends the STOP action to a workflow step that has paused the image build, identified by the step execution ID that ListWaitingWorkflowSteps returns.", "id": "stop-a-workflow-step-that-is-waiting-for-action", "title": "Stop a workflow step that is waiting for action" } ], "StartImagePipelineExecution": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline" }, "output": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE66666", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "requestId": "f477f64c-9ece-4478-977d-5821f8ed051b" }, "description": "The following example starts a build for the specified pipeline. The response returns the ARN of the new image build version.", "id": "start-a-pipeline-build-manually", "title": "Start a pipeline build manually" } ], "StartResourceStateUpdate": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE24680", "executionRole": "arn:aws:iam::111122223333:role/my-example-state-update-role", "includeResources": { "amis": true }, "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1", "state": { "status": "DEPRECATED" }, "updateAt": "2026-09-11T21:20:00Z" }, "output": { "lifecycleExecutionId": "lce-401aefc3-a829-46f6-8fc2-91497988a503", "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:image/my-example-recipe/1.0.0/1" }, "description": "The following example schedules the specified image build version and its AMI to move to the DEPRECATED state at the requested future time. It returns the ID of the lifecycle execution that applies the update.", "id": "schedule-an-image-build-version-for-deprecation", "title": "Schedule an image build version for deprecation" } ], "TagResource": [ { "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-tagged-component/1.0.0/1", "tags": { "CostCenter": "12345", "Environment": "Production" } }, "output": {}, "description": "The following example adds two tags to a component build version.", "id": "add-tags-to-a-component-build-version", "title": "Add tags to a component build version" } ], "UntagResource": [ { "input": { "resourceArn": "arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-tagged-component/1.0.0/1", "tagKeys": [ "CostCenter" ] }, "output": {}, "description": "The following example removes the CostCenter tag key from the specified component build version.", "id": "remove-a-tag-from-a-resource", "title": "Remove a tag from a resource" } ], "UpdateDistributionConfiguration": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "distributions": [ { "amiDistributionConfiguration": { "name": "my-example-image-{{ imagebuilder:buildDate }}" }, "region": "us-west-2" } ] }, "output": { "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:distribution-configuration/my-example-distribution", "requestId": "97d5c3e8-93d6-424c-90e0-bab18b20bf54" }, "description": "The following example replaces the distribution settings for the specified configuration with a single distribution that names the output AMI with the build date.", "id": "update-a-distribution-configuration", "title": "Update a distribution configuration" } ], "UpdateImagePipeline": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEddddd", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-recipe/my-example-recipe/1.0.0", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "schedule": { "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE", "scheduleExpression": "cron(0 6 * * ? *)" }, "status": "ENABLED" }, "output": { "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:111122223333:image-pipeline/my-example-pipeline", "requestId": "7a414b2d-e462-4850-ae7a-fe25a1223e0f" }, "description": "The following example changes the pipeline's schedule to build every day at 6:00 AM UTC.", "id": "update-an-image-pipeline", "title": "Update an image pipeline" } ], "UpdateInfrastructureConfiguration": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", "description": "An infrastructure configuration for Amazon Linux builds", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "instanceProfileName": "EC2InstanceProfileForImageBuilder", "instanceTypes": [ "t3.large", "t3.xlarge" ], "terminateInstanceOnFailure": false }, "output": { "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:111122223333:infrastructure-configuration/my-example-infrastructure", "requestId": "ffe990d5-7720-4061-a8d6-da6a7c4a6a3e" }, "description": "The following example updates an infrastructure configuration to use larger instance types and to keep the build instance running when the image build fails.", "id": "update-an-infrastructure-configuration", "title": "Update an infrastructure configuration" } ], "UpdateLifecyclePolicy": [ { "input": { "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "description": "Deletes AMI images and their snapshots after 12 months, retaining the 3 most recent", "executionRole": "arn:aws:iam::111122223333:role/my-example-lifecycle-role", "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-policy", "policyDetails": [ { "action": { "type": "DELETE", "includeResources": { "amis": true, "snapshots": true } }, "filter": { "type": "AGE", "value": 12, "retainAtLeast": 3, "unit": "MONTHS" } } ], "resourceSelection": { "tagMap": { "environment": "production" } }, "resourceType": "AMI_IMAGE", "status": "ENABLED" }, "output": { "lifecyclePolicyArn": "arn:aws:imagebuilder:us-west-2:111122223333:lifecycle-policy/my-example-policy" }, "description": "The following example updates a lifecycle policy to delete AMI images and their associated snapshots after 12 months, retaining the 3 most recent images.", "id": "update-a-lifecycle-policy", "title": "Update a lifecycle policy" } ] } }