update_image

update_image(**kwargs)

Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.

See also: AWS API Documentation

Request Syntax

response = client.update_image(
    DeleteProperties=[
        'string',
    ],
    Description='string',
    DisplayName='string',
    ImageName='string',
    RoleArn='string'
)

Parameters

• DeleteProperties (list) --

  A list of properties to delete. Only the Description and DisplayName properties can be deleted.

  • (string) --
• Description (string) -- The new description for the image.
• DisplayName (string) -- The new display name for the image.
• ImageName (string) --

  [REQUIRED]

  The name of the image to update.

• RoleArn (string) -- The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

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.ResourceNotFound