imagebuilder / Client / get_container_recipe

get_container_recipe

imagebuilder.Client.get_container_recipe(**kwargs)

Retrieves a container recipe.

See also: AWS API Documentation

Request Syntax

response = client.get_container_recipe(
    containerRecipeArn='string'
)

Parameters:

containerRecipeArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'containerRecipe': {
        'arn': 'string',
        'containerType': 'DOCKER',
        'name': 'string',
        'description': 'string',
        'platform': 'Windows'|'Linux'|'macOS',
        'owner': 'string',
        'version': 'string',
        'components': [
            {
                'componentArn': 'string',
                'parameters': [
                    {
                        'name': 'string',
                        'value': [
                            'string',
                        ]
                    },
                ]
            },
        ],
        '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'
        }
    },
    'latestVersionReferences': {
        'latestVersionArn': 'string',
        'latestMajorVersionArn': 'string',
        'latestMinorVersionArn': 'string',
        'latestPatchVersionArn': '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.

      Note

      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. Container recipes support only the Linux and Windows platforms.

    • owner (string) –

      The owner of the container recipe.

    • version (string) –

      The semantic version of the container recipe.

      Note

      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. The upper limit is 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: You can 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. 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) –

    • instanceConfiguration (dict) –

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

      • image (string) –

        The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.

        If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

      • blockDeviceMappings (list) –

        Defines the block device mappings for the EC2 instance that Image Builder launches to build and test your container image.

        • (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.

    • dockerfileTemplateData (string) –

      The Dockerfile template that Image Builder uses to build the container image. The template can include contextual variables that Image Builder replaces with build information at build time. For the contextual variables that the template can include, see Create a new version of a container recipe in the EC2 Image Builder User Guide.

    • kmsKeyId (string) –

      The KMS key that Image Builder uses to encrypt the recipe’s Dockerfile template data at rest. 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. If you don’t specify a key, Image Builder encrypts the template data with a KMS key that Image Builder owns. This key isn’t used to encrypt the output container image.

    • encrypted (boolean) –

      Specifies whether the recipe’s Dockerfile template data is encrypted at rest. Image Builder encrypts all Dockerfile template data at rest, so this value is always true. This field is retained for backward compatibility, and doesn’t describe encryption of the output container image.

    • parentImage (string) –

      The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest.

    • 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. Provide the repository name only (a namespace path such as team-a/my-repo is allowed, but not the registry hostname).

  • 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