GETCERTIFICATES()`¶

About GetCertificates¶

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

Method Signature¶

METHODS /AWS1/IF_LSA~GETCERTIFICATES
  IMPORTING
    !IT_CERTIFICATESTATUSES TYPE /AWS1/CL_LSACERTSTATUSLIST_W=>TT_CERTIFICATESTATUSLIST OPTIONAL
    !IV_INCLUDECERTIFICATEDETAILS TYPE /AWS1/LSAINCLUDECERTDETAILS OPTIONAL
    !IV_CERTIFICATENAME TYPE /AWS1/LSACERTIFICATENAME OPTIONAL
    !IV_PAGETOKEN TYPE /AWS1/LSASTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsagetcertsresult
  RAISING
    /AWS1/CX_LSAACCESSDENIEDEX
    /AWS1/CX_LSAINVALIDINPUTEX
    /AWS1/CX_LSANOTFOUNDEXCEPTION
    /AWS1/CX_LSARGNSETUPINPRGSSEX
    /AWS1/CX_LSASERVICEEXCEPTION
    /AWS1/CX_LSAUNAUTHNTCTDEX
    /AWS1/CX_LSACLIENTEXC
    /AWS1/CX_LSASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_certificatestatuses` `TYPE /AWS1/CL_LSACERTSTATUSLIST_W=>TT_CERTIFICATESTATUSLIST` `TT_CERTIFICATESTATUSLIST`¶

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

`iv_includecertificatedetails` `TYPE /AWS1/LSAINCLUDECERTDETAILS` `/AWS1/LSAINCLUDECERTDETAILS`¶

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

`iv_certificatename` `TYPE /AWS1/LSACERTIFICATENAME` `/AWS1/LSACERTIFICATENAME`¶

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

`iv_pagetoken` `TYPE /AWS1/LSASTRING` `/AWS1/LSASTRING`¶

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lsagetcertsresult` `/AWS1/CL_LSAGETCERTSRESULT`¶

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->getcertificates(
  it_certificatestatuses = VALUE /aws1/cl_lsacertstatuslist_w=>tt_certificatestatuslist(
    ( new /aws1/cl_lsacertstatuslist_w( |string| ) )
  )
  iv_certificatename = |string|
  iv_includecertificatedetails = ABAP_TRUE
  iv_pagetoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_certificates( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptystring = lo_row_1->get_certificatearn( ).
      lv_certificatename = lo_row_1->get_certificatename( ).
      lv_domainname = lo_row_1->get_domainname( ).
      lo_certificate = lo_row_1->get_certificatedetail( ).
      IF lo_certificate IS NOT INITIAL.
        lv_nonemptystring = lo_certificate->get_arn( ).
        lv_certificatename = lo_certificate->get_name( ).
        lv_domainname = lo_certificate->get_domainname( ).
        lv_certificatestatus = lo_certificate->get_status( ).
        lv_serialnumber = lo_certificate->get_serialnumber( ).
        LOOP AT lo_certificate->get_subjectalternativenames( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_domainname = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_certificate->get_domainvalidationrecords( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_domainname = lo_row_5->get_domainname( ).
            lo_resourcerecord = lo_row_5->get_resourcerecord( ).
            IF lo_resourcerecord IS NOT INITIAL.
              lv_string = lo_resourcerecord->get_name( ).
              lv_string = lo_resourcerecord->get_type( ).
              lv_string = lo_resourcerecord->get_value( ).
            ENDIF.
            lo_dnsrecordcreationstate = lo_row_5->get_dnsrecordcreationstate( ).
            IF lo_dnsrecordcreationstate IS NOT INITIAL.
              lv_dnsrecordcreationstatec = lo_dnsrecordcreationstate->get_code( ).
              lv_string = lo_dnsrecordcreationstate->get_message( ).
            ENDIF.
            lv_certificatedomainvalida = lo_row_5->get_validationstatus( ).
          ENDIF.
        ENDLOOP.
        lv_requestfailurereason = lo_certificate->get_requestfailurereason( ).
        lv_inuseresourcecount = lo_certificate->get_inuseresourcecount( ).
        lv_keyalgorithm = lo_certificate->get_keyalgorithm( ).
        lv_isodate = lo_certificate->get_createdat( ).
        lv_isodate = lo_certificate->get_issuedat( ).
        lv_issuerca = lo_certificate->get_issuerca( ).
        lv_isodate = lo_certificate->get_notbefore( ).
        lv_isodate = lo_certificate->get_notafter( ).
        lv_eligibletorenew = lo_certificate->get_eligibletorenew( ).
        lo_renewalsummary = lo_certificate->get_renewalsummary( ).
        IF lo_renewalsummary IS NOT INITIAL.
          LOOP AT lo_renewalsummary->get_domainvalidationrecords( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_domainname = lo_row_5->get_domainname( ).
              lo_resourcerecord = lo_row_5->get_resourcerecord( ).
              IF lo_resourcerecord IS NOT INITIAL.
                lv_string = lo_resourcerecord->get_name( ).
                lv_string = lo_resourcerecord->get_type( ).
                lv_string = lo_resourcerecord->get_value( ).
              ENDIF.
              lo_dnsrecordcreationstate = lo_row_5->get_dnsrecordcreationstate( ).
              IF lo_dnsrecordcreationstate IS NOT INITIAL.
                lv_dnsrecordcreationstatec = lo_dnsrecordcreationstate->get_code( ).
                lv_string = lo_dnsrecordcreationstate->get_message( ).
              ENDIF.
              lv_certificatedomainvalida = lo_row_5->get_validationstatus( ).
            ENDIF.
          ENDLOOP.
          lv_renewalstatus = lo_renewalsummary->get_renewalstatus( ).
          lv_renewalstatusreason = lo_renewalsummary->get_renewalstatusreason( ).
          lv_isodate = lo_renewalsummary->get_updatedat( ).
        ENDIF.
        lv_isodate = lo_certificate->get_revokedat( ).
        lv_revocationreason = lo_certificate->get_revocationreason( ).
        LOOP AT lo_certificate->get_tags( ) into lo_row_6.
          lo_row_7 = lo_row_6.
          IF lo_row_7 IS NOT INITIAL.
            lv_tagkey = lo_row_7->get_key( ).
            lv_tagvalue = lo_row_7->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_string = lo_certificate->get_supportcode( ).
      ENDIF.
      LOOP AT lo_row_1->get_tags( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_tagkey = lo_row_7->get_key( ).
          lv_tagvalue = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nextpagetoken( ).
ENDIF.

/AWS1/IF_LSA=>GETCERTIFICATES()¶