Skip to content

/AWS1/IF_FRM=>DEREGISTERTYPE()

About DeregisterType

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use DescribeType.

For more information, see Remove third-party private extensions from your account in the CloudFormation User Guide.

Method Signature

METHODS /AWS1/IF_FRM~DEREGISTERTYPE
  IMPORTING
    !IV_ARN TYPE /AWS1/FRMPRIVATETYPEARN OPTIONAL
    !IV_TYPE TYPE /AWS1/FRMREGISTRYTYPE OPTIONAL
    !IV_TYPENAME TYPE /AWS1/FRMTYPENAME OPTIONAL
    !IV_VERSIONID TYPE /AWS1/FRMTYPEVERSIONID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmderegtypeoutput
  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_arn TYPE /AWS1/FRMPRIVATETYPEARN /AWS1/FRMPRIVATETYPEARN

The Amazon Resource Name (ARN) of the extension.

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

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

RETURNING

oo_output TYPE REF TO /aws1/cl_frmderegtypeoutput /AWS1/CL_FRMDEREGTYPEOUTPUT

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->deregistertype(
  iv_arn = |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.
ENDIF.