imagebuilder / Client / get_image_recipe

get_image_recipe

imagebuilder.Client.get_image_recipe(**kwargs)

Retrieves an image recipe.

See also: AWS API Documentation

Request Syntax

response = client.get_image_recipe(
    imageRecipeArn='string'
)

Parameters:

imageRecipeArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'imageRecipe': {
        'arn': 'string',
        'type': 'AMI'|'DOCKER',
        'name': 'string',
        'description': 'string',
        'platform': 'Windows'|'Linux'|'macOS',
        'owner': 'string',
        'version': 'string',
        'components': [
            {
                'componentArn': 'string',
                'parameters': [
                    {
                        'name': 'string',
                        'value': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        'parentImage': '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'
            },
        ],
        'dateCreated': 'string',
        'tags': {
            'string': 'string'
        },
        'workingDirectory': 'string',
        'additionalInstanceConfiguration': {
            'systemsManagerAgent': {
                'uninstallAfterBuild': True|False
            },
            'userDataOverride': 'string'
        },
        'amiTags': {
            'string': 'string'
        },
        'amiWatermarks': [
            'string',
        ]
    },
    'latestVersionReferences': {
        'latestVersionArn': 'string',
        'latestMajorVersionArn': 'string',
        'latestMinorVersionArn': 'string',
        'latestPatchVersionArn': 'string'
    }
}

Response Structure

• (dict) –

  • requestId (string) –

    The request ID that uniquely identifies this request.

  • imageRecipe (dict) –

    The image recipe object.

    • arn (string) –

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

    • type (string) –

      The output image type. For an image recipe, this is always AMI. Container images are built from container recipes, a separate resource. This field isn’t currently returned in responses.

    • name (string) –

      The name of the image recipe.

    • description (string) –

      The description of the image recipe.

    • platform (string) –

      The platform of the image recipe.

    • owner (string) –

      The owner of the image recipe.

    • version (string) –

      The version of the image recipe.

    • components (list) –

      The components that are included in the image recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.

      • (dict) –

        Configuration details of the component. You can specify each component only once in a recipe, regardless of version. Components with a status of DEPRECATED or DISABLED can’t be added to new recipes.

        • componentArn (string) –

          The Amazon Resource Name (ARN) of the component. You can specify a build version ARN, or a component version ARN whose version segments can use x wildcards, for example 1.x.x.

        • parameters (list) –

          A group of parameter settings that Image Builder uses to configure the component for a specific recipe. You must supply a value for every component parameter that has no default value, and you can only supply parameters that the component defines.

          • (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) –

    • parentImage (string) –

      The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:

      • AMI ID

      • Image Builder image Amazon Resource Name (ARN)

      • Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.

      • Amazon Web Services Marketplace product ID

    • blockDeviceMappings (list) –

      The block device mappings to apply when creating images from this recipe.

      • (dict) –

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

        • deviceName (string) –

          The device to which these mappings apply.

        • ebs (dict) –

          The Amazon EBS-specific configuration for this mapping.

          • encrypted (boolean) –

            Specifies whether to encrypt the device.

          • deleteOnTermination (boolean) –

            Specifies whether to delete the associated device on termination.

          • iops (integer) –

            The IOPS value for the device. Required only when volumeType is io1 or io2.

          • kmsKeyId (string) –

            The Amazon Resource Name (ARN) that uniquely identifies the KMS key to use when encrypting the device. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

          • snapshotId (string) –

            The snapshot that defines the device contents.

          • volumeSize (integer) –

            Overrides the volume size for the device.

          • volumeType (string) –

            Overrides the volume type for the device.

          • throughput (integer) –

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

        • virtualName (string) –

          The virtual device name for instance ephemeral devices.

        • noDevice (string) –

          Specifies a mapping to remove from the base image.

    • dateCreated (string) –

      The date on which this image recipe was created.

    • tags (dict) –

      The tags of the image recipe.

      • (string) –

        • (string) –

    • workingDirectory (string) –

      The working directory used during build and test workflows. If you don’t specify a working directory, Image Builder uses /tmp for Linux and macOS build instances, and C:/ for Windows build instances.

    • additionalInstanceConfiguration (dict) –

      Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when Image Builder launches your build instance.

      • systemsManagerAgent (dict) –

        The Systems Manager agent settings for your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.

        • uninstallAfterBuild (boolean) –

          Specifies whether the Systems Manager agent is removed from your final build image before Image Builder creates the new AMI. If true, the agent is removed. If false, the agent is kept, so that it’s included in the AMI. If you don’t set this property, Image Builder removes the agent only if Image Builder installed the agent during the build. An agent that was pre-installed on the base image is kept.

      • userDataOverride (string) –

        Use this property to provide commands or a command script to run when you launch your build instance.

        The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

        Note

        The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg==:

        #!/bin/bash

        mkdir -p /var/bb/

        touch /var

    • amiTags (dict) –

      Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

      • (string) –

        • (string) –

    • amiWatermarks (list) –

      The AMI watermark names attached to the output AMI from this recipe. AMI watermarks are lineage markers that automatically propagate to derivative AMIs when the source AMI is copied or distributed.

      • (string) –

        The name of an AMI watermark. AMI watermarks are lineage markers that Image Builder attaches to output AMIs during the build process. AMI watermarks automatically propagate to derivative AMIs when the source AMI is copied or distributed.

  • latestVersionReferences (dict) –

    A set of wildcard version ARNs that always reference the latest version of the resource. ARNs are included for the latest version overall, and for the latest versions within the same major, minor, and patch levels.

    • latestVersionArn (string) –

      The latest version Amazon Resource Name (ARN) of the Image Builder resource.

    • latestMajorVersionArn (string) –

      The latest version Amazon Resource Name (ARN) with the same major version of the Image Builder resource.

    • latestMinorVersionArn (string) –

      The latest version Amazon Resource Name (ARN) with the same minor version of the Image Builder resource.

    • latestPatchVersionArn (string) –

      The latest version Amazon Resource Name (ARN) with the same patch version of the Image Builder resource.

Exceptions

• imagebuilder.Client.exceptions.ServiceException

• imagebuilder.Client.exceptions.ClientException

• imagebuilder.Client.exceptions.ServiceUnavailableException

• imagebuilder.Client.exceptions.InvalidRequestException

• imagebuilder.Client.exceptions.ForbiddenException

• imagebuilder.Client.exceptions.CallRateLimitExceededException