Skip to content

/AWS1/IF_SGM=>UPDATEPARTNERAPP()

About UpdatePartnerApp

Updates all of the SageMaker Partner AI Apps in an account.

Method Signature

METHODS /AWS1/IF_SGM~UPDATEPARTNERAPP
  IMPORTING
    !IV_ARN TYPE /AWS1/SGMPARTNERAPPARN OPTIONAL
    !IO_MAINTENANCECONFIG TYPE REF TO /AWS1/CL_SGMPTRAPPMAINTENANC00 OPTIONAL
    !IV_TIER TYPE /AWS1/SGMNONEMPTYSTRING64 OPTIONAL
    !IO_APPLICATIONCONFIG TYPE REF TO /AWS1/CL_SGMPARTNERAPPCONFIG OPTIONAL
    !IV_ENABLEIAMSESSIONBASEDID TYPE /AWS1/SGMBOOLEAN OPTIONAL
    !IV_ENABLEAUTOMINORVRSUPGRADE TYPE /AWS1/SGMBOOLEAN OPTIONAL
    !IV_APPVERSION TYPE /AWS1/SGMMAJORMINORVERSION OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/SGMCLIENTTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmupdateptrapprsp
  RAISING
    /AWS1/CX_SGMCONFLICTEXCEPTION
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_arn TYPE /AWS1/SGMPARTNERAPPARN /AWS1/SGMPARTNERAPPARN

The ARN of the SageMaker Partner AI App to update.

Optional arguments:

io_maintenanceconfig TYPE REF TO /AWS1/CL_SGMPTRAPPMAINTENANC00 /AWS1/CL_SGMPTRAPPMAINTENANC00

Maintenance configuration settings for the SageMaker Partner AI App.

iv_tier TYPE /AWS1/SGMNONEMPTYSTRING64 /AWS1/SGMNONEMPTYSTRING64

Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.

io_applicationconfig TYPE REF TO /AWS1/CL_SGMPARTNERAPPCONFIG /AWS1/CL_SGMPARTNERAPPCONFIG

Configuration settings for the SageMaker Partner AI App.

iv_enableiamsessionbasedid TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.

iv_enableautominorvrsupgrade TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

When set to TRUE, the SageMaker Partner AI App is automatically upgraded to the latest minor version during the next scheduled maintenance window, if one is available.

iv_appversion TYPE /AWS1/SGMMAJORMINORVERSION /AWS1/SGMMAJORMINORVERSION

The semantic version to upgrade the SageMaker Partner AI App to. Must be the same semantic version returned in the AvailableUpgrade field from DescribePartnerApp. Version skipping and downgrades are not supported.

iv_clienttoken TYPE /AWS1/SGMCLIENTTOKEN /AWS1/SGMCLIENTTOKEN

A unique token that guarantees that the call to this API is idempotent.

it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmupdateptrapprsp /AWS1/CL_SGMUPDATEPTRAPPRSP

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->updatepartnerapp(
  io_applicationconfig = new /aws1/cl_sgmpartnerappconfig(
    it_adminusers = VALUE /aws1/cl_sgmptrappadminuserl00=>tt_partnerappadminuserlist(
      ( new /aws1/cl_sgmptrappadminuserl00( |string| ) )
    )
    it_arguments = VALUE /aws1/cl_sgmptrapparguments_w=>tt_partnerapparguments(
      (
        VALUE /aws1/cl_sgmptrapparguments_w=>ts_partnerapparguments_maprow(
          key = |string|
          value = new /aws1/cl_sgmptrapparguments_w( |string| )
        )
      )
    )
    it_assignedgrouppatterns = VALUE /aws1/cl_sgmassignedgrpatsls00=>tt_assignedgrouppatternslist(
      ( new /aws1/cl_sgmassignedgrpatsls00( |string| ) )
    )
    it_rolegroupassignments = VALUE /aws1/cl_sgmrolegrpassignment=>tt_rolegroupassignmentslist(
      (
        new /aws1/cl_sgmrolegrpassignment(
          it_grouppatterns = VALUE /aws1/cl_sgmgrouppatslist_w=>tt_grouppatternslist(
            ( new /aws1/cl_sgmgrouppatslist_w( |string| ) )
          )
          iv_rolename = |string|
        )
      )
    )
  )
  io_maintenanceconfig = new /aws1/cl_sgmptrappmaintenanc00( |string| )
  it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
    (
      new /aws1/cl_sgmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_appversion = |string|
  iv_arn = |string|
  iv_clienttoken = |string|
  iv_enableautominorvrsupgrade = ABAP_TRUE
  iv_enableiamsessionbasedid = ABAP_TRUE
  iv_tier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_partnerapparn = lo_result->get_arn( ).
ENDIF.