Skip to content

/AWS1/IF_VPS=>GETPOLICYSTORE()

About GetPolicyStore

Retrieves details about a policy store.

Method Signature

METHODS /AWS1/IF_VPS~GETPOLICYSTORE
  IMPORTING
    !IV_POLICYSTOREID TYPE /AWS1/VPSPOLICYSTOREID OPTIONAL
    !IV_TAGS TYPE /AWS1/VPSBOOLEAN OPTIONAL
  PREFERRED PARAMETER iv_policystoreid
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_vpsgetplystoreoutput
  RAISING
    /AWS1/CX_VPSACCESSDENIEDEX
    /AWS1/CX_VPSINTERNALSERVEREX
    /AWS1/CX_VPSTHROTTLINGEX
    /AWS1/CX_VPSVALIDATIONEX
    /AWS1/CX_VPSRESOURCENOTFOUNDEX
    /AWS1/CX_VPSCLIENTEXC
    /AWS1/CX_VPSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_policystoreid TYPE /AWS1/VPSPOLICYSTOREID /AWS1/VPSPOLICYSTOREID

Specifies the policy store that you want information about.

To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

  • ID: PSEXAMPLEabcdefg111111

  • Alias name: policy-store-alias/example-policy-store

To view aliases, use ListPolicyStoreAliases.

Optional arguments:

iv_tags TYPE /AWS1/VPSBOOLEAN /AWS1/VPSBOOLEAN

Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.

If this parameter is included in the API call but there are no tags attached to the policy store, the tags response parameter is omitted from the response.

RETURNING

oo_output TYPE REF TO /aws1/cl_vpsgetplystoreoutput /AWS1/CL_VPSGETPLYSTOREOUTPUT

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->getpolicystore(
  iv_policystoreid = |string|
  iv_tags = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_policystoreid = lo_result->get_policystoreid( ).
  lv_resourcearn = lo_result->get_arn( ).
  lo_validationsettings = lo_result->get_validationsettings( ).
  IF lo_validationsettings IS NOT INITIAL.
    lv_validationmode = lo_validationsettings->get_mode( ).
  ENDIF.
  lv_timestampformat = lo_result->get_createddate( ).
  lv_timestampformat = lo_result->get_lastupdateddate( ).
  lv_policystoredescription = lo_result->get_description( ).
  lv_deletionprotection = lo_result->get_deletionprotection( ).
  lo_encryptionstate = lo_result->get_encryptionstate( ).
  IF lo_encryptionstate IS NOT INITIAL.
    lo_kmsencryptionstate = lo_encryptionstate->get_kmsencryptionstate( ).
    IF lo_kmsencryptionstate IS NOT INITIAL.
      lv_kmskey = lo_kmsencryptionstate->get_key( ).
      LOOP AT lo_kmsencryptionstate->get_encryptioncontext( ) into ls_row.
        lv_key = ls_row-key.
        lo_value = ls_row-value.
        IF lo_value IS NOT INITIAL.
          lv_encryptioncontextvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_unit = lo_encryptionstate->get_default( ).
    IF lo_unit IS NOT INITIAL.
    ENDIF.
  ENDIF.
  lv_cedarversion = lo_result->get_cedarversion( ).
  LOOP AT lo_result->get_tags( ) into ls_row_1.
    lv_key_1 = ls_row_1-key.
    lo_value_1 = ls_row_1-value.
    IF lo_value_1 IS NOT INITIAL.
      lv_tagvalue = lo_value_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

GetPolicyStore

The following example retrieves details about the specified policy store.

DATA(lo_result) = lo_client->getpolicystore( iv_policystoreid = |C7v5xMplfFH3i3e4Jrzb1a| ) .

GetPolicyStore that is encrypted

The following example retrieves details about the specified encrypted policy store.

DATA(lo_result) = lo_client->getpolicystore( iv_policystoreid = |C7v5xMplfFH3i3e4Jrzb1a| ) .