Skip to content

/AWS1/IF_LSA=>IMPORTKEYPAIR()

About ImportKeyPair

Imports a public SSH key from a specific key pair.

Method Signature

METHODS /AWS1/IF_LSA~IMPORTKEYPAIR
  IMPORTING
    !IV_KEYPAIRNAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_PUBLICKEYBASE64 TYPE /AWS1/LSABASE64 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsaimportkeypairrslt
  RAISING
    /AWS1/CX_LSAACCESSDENIEDEX
    /AWS1/CX_LSAACCTSETUPINPRGSSEX
    /AWS1/CX_LSAINVALIDINPUTEX
    /AWS1/CX_LSANOTFOUNDEXCEPTION
    /AWS1/CX_LSAOPERATIONFAILUREEX
    /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

Required arguments:

iv_keypairname TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the key pair for which you want to import the public key.

iv_publickeybase64 TYPE /AWS1/LSABASE64 /AWS1/LSABASE64

A base64-encoded public key of the ssh-rsa type.

RETURNING

oo_output TYPE REF TO /aws1/cl_lsaimportkeypairrslt /AWS1/CL_LSAIMPORTKEYPAIRRSLT

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->importkeypair(
  iv_keypairname = |string|
  iv_publickeybase64 = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_operation = lo_result->get_operation( ).
  IF lo_operation IS NOT INITIAL.
    lv_nonemptystring = lo_operation->get_id( ).
    lv_resourcename = lo_operation->get_resourcename( ).
    lv_resourcetype = lo_operation->get_resourcetype( ).
    lv_isodate = lo_operation->get_createdat( ).
    lo_resourcelocation = lo_operation->get_location( ).
    IF lo_resourcelocation IS NOT INITIAL.
      lv_string = lo_resourcelocation->get_availabilityzone( ).
      lv_regionname = lo_resourcelocation->get_regionname( ).
    ENDIF.
    lv_boolean = lo_operation->get_isterminal( ).
    lv_string = lo_operation->get_operationdetails( ).
    lv_operationtype = lo_operation->get_operationtype( ).
    lv_operationstatus = lo_operation->get_status( ).
    lv_isodate = lo_operation->get_statuschangedat( ).
    lv_string = lo_operation->get_errorcode( ).
    lv_string = lo_operation->get_errordetails( ).
  ENDIF.
ENDIF.