VerifiedPermissions / Client / get_policy_store_alias

get_policy_store_alias¶

VerifiedPermissions.Client.get_policy_store_alias(**kwargs)¶

Retrieves details about the specified policy store alias.

Request Syntax

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

Parameters:

aliasName (string) –

[REQUIRED]

Specifies the name of the policy store alias that you want information about.

Note

The alias name must always be prefixed with policy-store-alias/.

Return type:

dict

Returns:

Response Syntax

{
    'aliasName': 'string',
    'policyStoreId': 'string',
    'aliasArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'state': 'Active'|'PendingDeletion'
}

Response Structure

(dict) –
- aliasName (string) –
  
  The name of the policy store alias.
- policyStoreId (string) –
  
  The ID of the policy store associated with the alias.
- aliasArn (string) –
  
  The Amazon Resource Name (ARN) of the policy store alias.
- createdAt (datetime) –
  
  The date and time the policy store alias was created.
- state (string) –
  
  The state of the policy store alias. Policy Store Aliases in the Active state can be used normally. When a policy store alias is deleted, it enters the PendingDeletion state. Policy Store Aliases in the PendingDeletion cannot be used, and creating a policy store alias with the same alias name will fail.

Exceptions

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