SageMaker / Client / create_image

create_image#

SageMaker.Client.create_image(**kwargs)#

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image.

See also: AWS API Documentation

Request Syntax

response = client.create_image(
    Description='string',
    DisplayName='string',
    ImageName='string',
    RoleArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Description (string) – The description of the image.

  • DisplayName (string) – The display name of the image. If not provided, ImageName is displayed.

  • ImageName (string) –

    [REQUIRED]

    The name of the image. Must be unique to your account.

  • RoleArn (string) –

    [REQUIRED]

    The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

  • Tags (list) –

    A list of tags to apply to the image.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'ImageArn': 'string'
}

Response Structure

  • (dict) –

    • ImageArn (string) –

      The ARN of the image.

Exceptions

  • SageMaker.Client.exceptions.ResourceInUse

  • SageMaker.Client.exceptions.ResourceLimitExceeded