Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

create_image_version

create_image_version(**kwargs)

Creates a version of the SageMaker image specified by ImageName . The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage .

See also: AWS API Documentation

Request Syntax

response = client.create_image_version(
    BaseImage='string',
    ClientToken='string',
    ImageName='string',
    Aliases=[
        'string',
    ],
    VendorGuidance='NOT_PROVIDED'|'STABLE'|'TO_BE_ARCHIVED'|'ARCHIVED',
    JobType='TRAINING'|'INFERENCE'|'NOTEBOOK_KERNEL',
    MLFramework='string',
    ProgrammingLang='string',
    Processor='CPU'|'GPU',
    Horovod=True|False,
    ReleaseNotes='string'
)
Parameters
  • BaseImage (string) --

    [REQUIRED]

    The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

    <acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
  • ClientToken (string) --

    [REQUIRED]

    A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

    This field is autopopulated if not provided.

  • ImageName (string) --

    [REQUIRED]

    The ImageName of the Image to create a version of.

  • Aliases (list) --

    A list of aliases created with the image version.

    • (string) --
  • VendorGuidance (string) --

    The stability of the image version, specified by the maintainer.

    • NOT_PROVIDED : The maintainers did not provide a status for image version stability.
    • STABLE : The image version is stable.
    • TO_BE_ARCHIVED : The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
    • ARCHIVED : The image version is archived. Archived image versions are not searchable and are no longer actively supported.
  • JobType (string) --

    Indicates SageMaker job type compatibility.

    • TRAINING : The image version is compatible with SageMaker training jobs.
    • INFERENCE : The image version is compatible with SageMaker inference jobs.
    • NOTEBOOK_KERNEL : The image version is compatible with SageMaker notebook kernels.
  • MLFramework (string) -- The machine learning framework vended in the image version.
  • ProgrammingLang (string) -- The supported programming language and its version.
  • Processor (string) --

    Indicates CPU or GPU compatibility.

    • CPU : The image version is compatible with CPU.
    • GPU : The image version is compatible with GPU.
  • Horovod (boolean) -- Indicates Horovod compatibility.
  • ReleaseNotes (string) -- The maintainer description of the image version.
Return type

dict

Returns

Response Syntax

{
    'ImageVersionArn': 'string'
}

Response Structure

  • (dict) --

    • ImageVersionArn (string) --

      The ARN of the image version.

Exceptions

  • SageMaker.Client.exceptions.ResourceInUse
  • SageMaker.Client.exceptions.ResourceLimitExceeded
  • SageMaker.Client.exceptions.ResourceNotFound