DESCRIBEPARTNERAPP()`¶

About DescribePartnerApp¶

Gets information about a SageMaker Partner AI App.

Method Signature¶

METHODS /AWS1/IF_SGM~DESCRIBEPARTNERAPP
  IMPORTING
    !IV_ARN TYPE /AWS1/SGMPARTNERAPPARN OPTIONAL
    !IV_INCLUDEAVAILABLEUPGRADE TYPE /AWS1/SGMBOOLEAN OPTIONAL
  PREFERRED PARAMETER iv_arn
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmdescrpartnerapprsp
  RAISING
    /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 describe.

Optional arguments:¶

`iv_includeavailableupgrade` `TYPE /AWS1/SGMBOOLEAN` `/AWS1/SGMBOOLEAN`¶

When set to TRUE, the response includes available upgrade information for the SageMaker Partner AI App. Default is FALSE.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmdescrpartnerapprsp` `/AWS1/CL_SGMDESCRPARTNERAPPRSP`¶

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->describepartnerapp(
  iv_arn = |string|
  iv_includeavailableupgrade = ABAP_TRUE
).

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( ).
  lv_partnerappname = lo_result->get_name( ).
  lv_partnerapptype = lo_result->get_type( ).
  lv_partnerappstatus = lo_result->get_status( ).
  lv_timestamp = lo_result->get_creationtime( ).
  lv_timestamp = lo_result->get_lastmodifiedtime( ).
  lv_rolearn = lo_result->get_executionrolearn( ).
  lv_kmskeyid = lo_result->get_kmskeyid( ).
  lv_string2048 = lo_result->get_baseurl( ).
  lo_partnerappmaintenanceco = lo_result->get_maintenanceconfig( ).
  IF lo_partnerappmaintenanceco IS NOT INITIAL.
    lv_weeklyscheduletimeforma = lo_partnerappmaintenanceco->get_maintenancewindowstart( ).
  ENDIF.
  lv_nonemptystring64 = lo_result->get_tier( ).
  lv_nonemptystring64 = lo_result->get_version( ).
  lo_partnerappconfig = lo_result->get_applicationconfig( ).
  IF lo_partnerappconfig IS NOT INITIAL.
    LOOP AT lo_partnerappconfig->get_adminusers( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_nonemptystring256 = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_partnerappconfig->get_arguments( ) into ls_row_2.
      lv_key = ls_row_2-key.
      lo_value = ls_row_2-value.
      IF lo_value IS NOT INITIAL.
        lv_string1024 = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_partnerappconfig->get_assignedgrouppatterns( ) into lo_row_3.
      lo_row_4 = lo_row_3.
      IF lo_row_4 IS NOT INITIAL.
        lv_groupnamepattern = lo_row_4->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_partnerappconfig->get_rolegroupassignments( ) into lo_row_5.
      lo_row_6 = lo_row_5.
      IF lo_row_6 IS NOT INITIAL.
        lv_nonemptystring256 = lo_row_6->get_rolename( ).
        LOOP AT lo_row_6->get_grouppatterns( ) into lo_row_7.
          lo_row_8 = lo_row_7.
          IF lo_row_8 IS NOT INITIAL.
            lv_groupnamepattern = lo_row_8->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_partnerappauthtype = lo_result->get_authtype( ).
  lv_boolean = lo_result->get_enableiamsessionbasedid( ).
  lo_errorinfo = lo_result->get_error( ).
  IF lo_errorinfo IS NOT INITIAL.
    lv_nonemptystring64 = lo_errorinfo->get_code( ).
    lv_nonemptystring256 = lo_errorinfo->get_reason( ).
  ENDIF.
  lv_boolean = lo_result->get_enbautominorvrsupgrade( ).
  lv_timestamp = lo_result->get_currentversioneoldate( ).
  lo_availableupgrade = lo_result->get_availableupgrade( ).
  IF lo_availableupgrade IS NOT INITIAL.
    lv_majorminorversion = lo_availableupgrade->get_version( ).
    LOOP AT lo_availableupgrade->get_releasenotes( ) into lo_row_9.
      lo_row_10 = lo_row_9.
      IF lo_row_10 IS NOT INITIAL.
        lv_string1024 = lo_row_10->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_SGM=>DESCRIBEPARTNERAPP()¶