DESCRIBECERTIFICATE()`¶

About DescribeCertificate¶

Describes the certificate that's identified by the CertificateId.

Transfer Family automatically publishes a Amazon CloudWatch metric called DaysUntilExpiry for imported certificates. This metric tracks the number of days until the certificate expires based on the InactiveDate. The metric is available in the AWS/Transfer namespace and includes the CertificateId as a dimension.

Method Signature¶

METHODS /AWS1/IF_TRN~DESCRIBECERTIFICATE
  IMPORTING
    !IV_CERTIFICATEID TYPE /AWS1/TRNCERTIFICATEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trndescrcertresponse
  RAISING
    /AWS1/CX_TRNINTERNALSVCERROR
    /AWS1/CX_TRNINVALIDREQUESTEX
    /AWS1/CX_TRNRESOURCENOTFOUNDEX
    /AWS1/CX_TRNSERVICEUNAVAILEX
    /AWS1/CX_TRNCLIENTEXC
    /AWS1/CX_TRNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_certificateid` `TYPE /AWS1/TRNCERTIFICATEID` `/AWS1/TRNCERTIFICATEID`¶

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trndescrcertresponse` `/AWS1/CL_TRNDESCRCERTRESPONSE`¶

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->describecertificate( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_describedcertificate = lo_result->get_certificate( ).
  IF lo_describedcertificate IS NOT INITIAL.
    lv_arn = lo_describedcertificate->get_arn( ).
    lv_certificateid = lo_describedcertificate->get_certificateid( ).
    lv_certificateusagetype = lo_describedcertificate->get_usage( ).
    lv_certificatestatustype = lo_describedcertificate->get_status( ).
    lv_certificatebodytype = lo_describedcertificate->get_certificate( ).
    lv_certificatechaintype = lo_describedcertificate->get_certificatechain( ).
    lv_certdate = lo_describedcertificate->get_activedate( ).
    lv_certdate = lo_describedcertificate->get_inactivedate( ).
    lv_certserial = lo_describedcertificate->get_serial( ).
    lv_certdate = lo_describedcertificate->get_notbeforedate( ).
    lv_certdate = lo_describedcertificate->get_notafterdate( ).
    lv_certificatetype = lo_describedcertificate->get_type( ).
    lv_description = lo_describedcertificate->get_description( ).
    LOOP AT lo_describedcertificate->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_tagkey = lo_row_1->get_key( ).
        lv_tagvalue = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_TRN=>DESCRIBECERTIFICATE()¶