GETSSHPUBLICKEY()`¶

About GetSSHPublicKey¶

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_username` `TYPE /AWS1/IAMUSERNAMETYPE` `/AWS1/IAMUSERNAMETYPE`¶

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

`iv_sshpublickeyid` `TYPE /AWS1/IAMPUBLICKEYIDTYPE` `/AWS1/IAMPUBLICKEYIDTYPE`¶

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

`iv_encoding` `TYPE /AWS1/IAMENCODINGTYPE` `/AWS1/IAMENCODINGTYPE`¶

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iamgetsshpublickeyrsp` `/AWS1/CL_IAMGETSSHPUBLICKEYRSP`¶

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->/aws1/if_iam~getsshpublickey(
  iv_encoding = |string|
  iv_sshpublickeyid = |string|
  iv_username = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_sshpublickey = lo_result->get_sshpublickey( ).
  IF lo_sshpublickey IS NOT INITIAL.
    lv_usernametype = lo_sshpublickey->get_username( ).
    lv_publickeyidtype = lo_sshpublickey->get_sshpublickeyid( ).
    lv_publickeyfingerprinttyp = lo_sshpublickey->get_fingerprint( ).
    lv_publickeymaterialtype = lo_sshpublickey->get_sshpublickeybody( ).
    lv_statustype = lo_sshpublickey->get_status( ).
    lv_datetype = lo_sshpublickey->get_uploaddate( ).
  ENDIF.
ENDIF.

/AWS1/CL_IAM=>GETSSHPUBLICKEY()¶