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.

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.

Request Syntax

response = client.delete_policy_store_alias(
    aliasName='string'
)

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/.

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