VerifiedPermissions / Client / delete_policy_store_alias

delete_policy_store_alias¶

VerifiedPermissions.Client.delete_policy_store_alias(**kwargs)¶

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.

Warning

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.

Request Syntax

response = client.delete_policy_store_alias(
    aliasName='string',
    deletionMode='SoftDelete'|'HardDelete'
)

Parameters:

aliasName (string) –
[REQUIRED]

Specifies the name of the policy store alias that you want to delete.

Note
The alias name must always be prefixed with policy-store-alias/.
deletionMode (string) –
Specifies the deletion mode for the policy store alias. The valid values are:
- SoftDelete – The policy store alias enters the PendingDeletion state. This is the default behavior when no deletionMode is specified.
- HardDelete – The policy store alias is immediately deleted, bypassing the PendingDeletion state.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

VerifiedPermissions.Client.exceptions.ValidationException
VerifiedPermissions.Client.exceptions.InvalidStateException
VerifiedPermissions.Client.exceptions.AccessDeniedException
VerifiedPermissions.Client.exceptions.ThrottlingException
VerifiedPermissions.Client.exceptions.InternalServerException