UPDATEIMAGE()`¶

About UpdateImage¶

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

Method Signature¶

METHODS /AWS1/IF_SGM~UPDATEIMAGE
  IMPORTING
    !IT_DELETEPROPERTIES TYPE /AWS1/CL_SGMIMAGEDELPRPLIST_W=>TT_IMAGEDELETEPROPERTYLIST OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SGMIMAGEDESCRIPTION OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/SGMIMAGEDISPLAYNAME OPTIONAL
    !IV_IMAGENAME TYPE /AWS1/SGMIMAGENAME OPTIONAL
    !IV_ROLEARN TYPE /AWS1/SGMROLEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmupdateimagersp
  RAISING
    /AWS1/CX_SGMRESOURCEINUSE
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_imagename` `TYPE /AWS1/SGMIMAGENAME` `/AWS1/SGMIMAGENAME`¶

The name of the image to update.

Optional arguments:¶

`it_deleteproperties` `TYPE /AWS1/CL_SGMIMAGEDELPRPLIST_W=>TT_IMAGEDELETEPROPERTYLIST` `TT_IMAGEDELETEPROPERTYLIST`¶

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

`iv_description` `TYPE /AWS1/SGMIMAGEDESCRIPTION` `/AWS1/SGMIMAGEDESCRIPTION`¶

The new description for the image.

`iv_displayname` `TYPE /AWS1/SGMIMAGEDISPLAYNAME` `/AWS1/SGMIMAGEDISPLAYNAME`¶

The new display name for the image.

`iv_rolearn` `TYPE /AWS1/SGMROLEARN` `/AWS1/SGMROLEARN`¶

The new ARN for the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmupdateimagersp` `/AWS1/CL_SGMUPDATEIMAGERSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updateimage(
  it_deleteproperties = VALUE /aws1/cl_sgmimagedelprplist_w=>tt_imagedeletepropertylist(
    ( new /aws1/cl_sgmimagedelprplist_w( |string| ) )
  )
  iv_description = |string|
  iv_displayname = |string|
  iv_imagename = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_imagearn = lo_result->get_imagearn( ).
ENDIF.

/AWS1/IF_SGM=>UPDATEIMAGE()¶