/AWS1/IF_VPS=>DELETEPOLICYSTOREALIAS()¶
About DeletePolicyStoreAlias¶
Deletes the specified policy store alias.
This operation is idempotent. If you specify a policy store alias that does not exist, the request response will still return a successful HTTP 200 status code.
By default, when a policy store alias is deleted, it enters the PendingDeletion state. When a policy store alias is in the PendingDeletion state, new policy store aliases cannot be created with the same name. If the policy store alias is used in an API that has a policyStoreId field, the operation will fail with a ResourceNotFound exception.
To immediately delete a policy store alias and bypass the PendingDeletion state, set the deletionMode parameter to HardDelete.
Verified Permissions is eventually consistent. If you hard delete a policy store alias and then immediately recreate it to be associated with a different policy store, requests that reference this alias may continue to be evaluated against the previously associated policy store for a short period of time.
Method Signature¶
METHODS /AWS1/IF_VPS~DELETEPOLICYSTOREALIAS
IMPORTING
!IV_ALIASNAME TYPE /AWS1/VPSALIAS OPTIONAL
!IV_DELETIONMODE TYPE /AWS1/VPSDELETIONMODE OPTIONAL
PREFERRED PARAMETER iv_aliasname
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_vpsdelplystorealias01
RAISING
/AWS1/CX_VPSACCESSDENIEDEX
/AWS1/CX_VPSINTERNALSERVEREX
/AWS1/CX_VPSTHROTTLINGEX
/AWS1/CX_VPSVALIDATIONEX
/AWS1/CX_VPSINVALIDSTATEEX
/AWS1/CX_VPSCLIENTEXC
/AWS1/CX_VPSSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_aliasname TYPE /AWS1/VPSALIAS /AWS1/VPSALIAS¶
Specifies the name of the policy store alias that you want to delete.
The alias name must always be prefixed with
policy-store-alias/.
Optional arguments:¶
iv_deletionmode TYPE /AWS1/VPSDELETIONMODE /AWS1/VPSDELETIONMODE¶
Specifies the deletion mode for the policy store alias. The valid values are:
SoftDelete – The policy store alias enters the
PendingDeletionstate. This is the default behavior when nodeletionModeis specified.HardDelete – The policy store alias is immediately deleted, bypassing the
PendingDeletionstate.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_vpsdelplystorealias01 /AWS1/CL_VPSDELPLYSTOREALIAS01¶
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->deletepolicystorealias(
iv_aliasname = |string|
iv_deletionmode = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.
Soft delete a policy store alias¶
The following example soft deletes the policy store alias with name example-policy-store. The alias enters the PendingDeletion state.
DATA(lo_result) = lo_client->deletepolicystorealias( iv_aliasname = |policy-store-alias/example-policy-store| ) .
Hard delete a policy store alias¶
The following example hard deletes the policy store alias with name example-policy-store. The alias is immediately deleted, bypassing the PendingDeletion state.
DATA(lo_result) = lo_client->deletepolicystorealias(
iv_aliasname = |policy-store-alias/example-policy-store|
iv_deletionmode = |HardDelete|
).