/AWS1/IF_FRM=>DESCRIBETYPE()

About DescribeType

Returns detailed information about an extension from the CloudFormation registry in your current account and Region.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

Method Signature

METHODS /AWS1/IF_FRM~DESCRIBETYPE
  IMPORTING
    !IV_TYPE TYPE /AWS1/FRMREGISTRYTYPE OPTIONAL
    !IV_TYPENAME TYPE /AWS1/FRMTYPENAME OPTIONAL
    !IV_ARN TYPE /AWS1/FRMTYPEARN OPTIONAL
    !IV_VERSIONID TYPE /AWS1/FRMTYPEVERSIONID OPTIONAL
    !IV_PUBLISHERID TYPE /AWS1/FRMPUBLISHERID OPTIONAL
    !IV_PUBLICVERSIONNUMBER TYPE /AWS1/FRMPUBLICVERSIONNUMBER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmdescribetypeoutput
  RAISING
    /AWS1/CX_FRMCFNREGISTRYEX
    /AWS1/CX_FRMTYPENOTFOUNDEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_type TYPE /AWS1/FRMREGISTRYTYPE /AWS1/FRMREGISTRYTYPE

The kind of extension.

Conditional: You must specify either TypeName and Type, or Arn.

iv_typename TYPE /AWS1/FRMTYPENAME /AWS1/FRMTYPENAME

The name of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

iv_arn TYPE /AWS1/FRMTYPEARN /AWS1/FRMTYPEARN

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify either TypeName and Type, or Arn.

iv_versionid TYPE /AWS1/FRMTYPEVERSIONID /AWS1/FRMTYPEVERSIONID

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

iv_publisherid TYPE /AWS1/FRMPUBLISHERID /AWS1/FRMPUBLISHERID

The publisher ID of the extension publisher.

Extensions provided by Amazon Web Services are not assigned a publisher ID.

iv_publicversionnumber TYPE /AWS1/FRMPUBLICVERSIONNUMBER /AWS1/FRMPUBLICVERSIONNUMBER

The version number of a public third-party extension.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmdescribetypeoutput /AWS1/CL_FRMDESCRIBETYPEOUTPUT

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->describetype(
  iv_arn = |string|
  iv_publicversionnumber = |string|
  iv_publisherid = |string|
  iv_type = |string|
  iv_typename = |string|
  iv_versionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_typearn = lo_result->get_arn( ).
  lv_registrytype = lo_result->get_type( ).
  lv_typename = lo_result->get_typename( ).
  lv_typeversionid = lo_result->get_defaultversionid( ).
  lv_isdefaultversion = lo_result->get_isdefaultversion( ).
  lv_typetestsstatus = lo_result->get_typetestsstatus( ).
  lv_typetestsstatusdescript = lo_result->get_typetestsstatusdesc( ).
  lv_description = lo_result->get_description( ).
  lv_typeschema = lo_result->get_schema( ).
  lv_provisioningtype = lo_result->get_provisioningtype( ).
  lv_deprecatedstatus = lo_result->get_deprecatedstatus( ).
  lo_loggingconfig = lo_result->get_loggingconfig( ).
  IF lo_loggingconfig IS NOT INITIAL.
    lv_rolearn2 = lo_loggingconfig->get_logrolearn( ).
    lv_loggroupname = lo_loggingconfig->get_loggroupname( ).
  ENDIF.
  LOOP AT lo_result->get_requiredactivatedtypes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_typename = lo_row_1->get_typenamealias( ).
      lv_typename = lo_row_1->get_originaltypename( ).
      lv_publisherid = lo_row_1->get_publisherid( ).
      LOOP AT lo_row_1->get_supportedmajorversions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_supportedmajorversion = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_rolearn2 = lo_result->get_executionrolearn( ).
  lv_visibility = lo_result->get_visibility( ).
  lv_optionalsecureurl = lo_result->get_sourceurl( ).
  lv_optionalsecureurl = lo_result->get_documentationurl( ).
  lv_timestamp = lo_result->get_lastupdated( ).
  lv_timestamp = lo_result->get_timecreated( ).
  lv_configurationschema = lo_result->get_configurationschema( ).
  lv_publisherid = lo_result->get_publisherid( ).
  lv_typename = lo_result->get_originaltypename( ).
  lv_typearn = lo_result->get_originaltypearn( ).
  lv_publicversionnumber = lo_result->get_publicversionnumber( ).
  lv_publicversionnumber = lo_result->get_latestpublicversion( ).
  lv_isactivated = lo_result->get_isactivated( ).
  lv_autoupdate = lo_result->get_autoupdate( ).
ENDIF.