DESCRIBEKEYPAIRS()`¶

About DescribeKeyPairs¶

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon EC2 User Guide.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBEKEYPAIRS
  IMPORTING
    !IT_KEYNAMES TYPE /AWS1/CL_EC2KEYNAMESTRLIST_W=>TT_KEYNAMESTRINGLIST OPTIONAL
    !IT_KEYPAIRIDS TYPE /AWS1/CL_EC2KEYPAIRIDSTRLIST_W=>TT_KEYPAIRIDSTRINGLIST OPTIONAL
    !IV_INCLUDEPUBLICKEY TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2descrkeypairsrslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_keynames` `TYPE /AWS1/CL_EC2KEYNAMESTRLIST_W=>TT_KEYNAMESTRINGLIST` `TT_KEYNAMESTRINGLIST`¶

The key pair names.

Default: Describes all of your key pairs.

`it_keypairids` `TYPE /AWS1/CL_EC2KEYPAIRIDSTRLIST_W=>TT_KEYPAIRIDSTRINGLIST` `TT_KEYPAIRIDSTRINGLIST`¶

The IDs of the key pairs.

`iv_includepublickey` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

If true, the public key material is included in the response.

Default: false

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

`it_filters` `TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

The filters.

key-pair-id - The ID of the key pair.

fingerprint - The fingerprint of the key pair.

key-name - The name of the key pair.

tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2descrkeypairsrslt` `/AWS1/CL_EC2DESCRKEYPAIRSRSLT`¶

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->describekeypairs(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_keynames = VALUE /aws1/cl_ec2keynamestrlist_w=>tt_keynamestringlist(
    ( new /aws1/cl_ec2keynamestrlist_w( |string| ) )
  )
  it_keypairids = VALUE /aws1/cl_ec2keypairidstrlist_w=>tt_keypairidstringlist(
    ( new /aws1/cl_ec2keypairidstrlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_includepublickey = ABAP_TRUE
).

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_keypairs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_keypairid( ).
      lv_keytype = lo_row_1->get_keytype( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_key( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_publickey( ).
      lv_milliseconddatetime = lo_row_1->get_createtime( ).
      lv_string = lo_row_1->get_keyname( ).
      lv_string = lo_row_1->get_keyfingerprint( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To display a key pair¶

This example displays the fingerprint for the specified key.

DATA(lo_result) = lo_client->describekeypairs(
  it_keynames = VALUE /aws1/cl_ec2keynamestrlist_w=>tt_keynamestringlist(
    ( new /aws1/cl_ec2keynamestrlist_w( |my-key-pair| ) )
  )
).

/AWS1/IF_EC2=>DESCRIBEKEYPAIRS()¶