imagebuilder / Client / get_container_recipe



Retrieves a container recipe.

See also: AWS API Documentation

Request Syntax

response = client.get_container_recipe(

containerRecipeArn (string) –


The Amazon Resource Name (ARN) of the container recipe to retrieve.

Return type:



Response Syntax

    'requestId': 'string',
    'containerRecipe': {
        'arn': 'string',
        'containerType': 'DOCKER',
        'name': 'string',
        'description': 'string',
        'platform': 'Windows'|'Linux',
        'owner': 'string',
        'version': 'string',
        'components': [
                'componentArn': 'string',
                'parameters': [
                        'name': 'string',
                        'value': [
        'instanceConfiguration': {
            'image': 'string',
            'blockDeviceMappings': [
                    'deviceName': 'string',
                    'ebs': {
                        'encrypted': True|False,
                        'deleteOnTermination': True|False,
                        'iops': 123,
                        'kmsKeyId': 'string',
                        'snapshotId': 'string',
                        'volumeSize': 123,
                        'volumeType': 'standard'|'io1'|'io2'|'gp2'|'gp3'|'sc1'|'st1',
                        'throughput': 123
                    'virtualName': 'string',
                    'noDevice': 'string'
        'dockerfileTemplateData': 'string',
        'kmsKeyId': 'string',
        'encrypted': True|False,
        'parentImage': 'string',
        'dateCreated': 'string',
        'tags': {
            'string': 'string'
        'workingDirectory': 'string',
        'targetRepository': {
            'service': 'ECR',
            'repositoryName': 'string'

Response Structure

  • (dict) –

    • requestId (string) –

      The request ID that uniquely identifies this request.

    • containerRecipe (dict) –

      The container recipe object that is returned.

      • arn (string) –

        The Amazon Resource Name (ARN) of the container recipe.


        Semantic versioning is included in each object’s Amazon Resource Name (ARN), at the level that applies to that object as follows:

        • Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

        • Version ARNs have only the first three nodes: <major>.<minor>.<patch>

        • Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

      • containerType (string) –

        Specifies the type of container, such as Docker.

      • name (string) –

        The name of the container recipe.

      • description (string) –

        The description of the container recipe.

      • platform (string) –

        The system platform for the container, such as Windows or Linux.

      • owner (string) –

        The owner of the container recipe.

      • version (string) –

        The semantic version of the container recipe.


        The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

        Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

        Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

        Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

      • components (list) –

        Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

        • (dict) –

          Configuration details of the component.

          • componentArn (string) –

            The Amazon Resource Name (ARN) of the component.

          • parameters (list) –

            A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

            • (dict) –

              Contains a key/value pair that sets the named component parameter.

              • name (string) –

                The name of the component parameter to set.

              • value (list) –

                Sets the value for the named component parameter.

                • (string) –

      • instanceConfiguration (dict) –

        A group of options that can be used to configure an instance for building and testing container images.

        • image (string) –

          The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

        • blockDeviceMappings (list) –

          Defines the block devices to attach for building an instance from this Image Builder AMI.

          • (dict) –

            Defines block device mappings for the instance used to configure your image.

            • deviceName (string) –

              The device to which these mappings apply.

            • ebs (dict) –

              Use to manage Amazon EBS-specific configuration for this mapping.

              • encrypted (boolean) –

                Use to configure device encryption.

              • deleteOnTermination (boolean) –

                Use to configure delete on termination of the associated device.

              • iops (integer) –

                Use to configure device IOPS.

              • kmsKeyId (string) –

                Use to configure the KMS key to use when encrypting the device.

              • snapshotId (string) –

                The snapshot that defines the device contents.

              • volumeSize (integer) –

                Use to override the device’s volume size.

              • volumeType (string) –

                Use to override the device’s volume type.

              • throughput (integer) –

                For GP3 volumes only – The throughput in MiB/s that the volume supports.

            • virtualName (string) –

              Use to manage instance ephemeral devices.

            • noDevice (string) –

              Use to remove a mapping from the base image.

      • dockerfileTemplateData (string) –

        Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

      • kmsKeyId (string) –

        Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

      • encrypted (boolean) –

        A flag that indicates if the target container is encrypted.

      • parentImage (string) –

        The base image for the container recipe.

      • dateCreated (string) –

        The date when this container recipe was created.

      • tags (dict) –

        Tags that are attached to the container recipe.

        • (string) –

          • (string) –

      • workingDirectory (string) –

        The working directory for use during build and test workflows.

      • targetRepository (dict) –

        The destination repository for the container image.

        • service (string) –

          Specifies the service in which this image was registered.

        • repositoryName (string) –

          The name of the container repository where the output container image is stored. This name is prefixed by the repository location.


  • imagebuilder.Client.exceptions.ServiceException

  • imagebuilder.Client.exceptions.ClientException

  • imagebuilder.Client.exceptions.ServiceUnavailableException

  • imagebuilder.Client.exceptions.InvalidRequestException

  • imagebuilder.Client.exceptions.ForbiddenException

  • imagebuilder.Client.exceptions.CallRateLimitExceededException