VerifiedPermissions / Client / create_policy_store_alias

create_policy_store_alias¶

VerifiedPermissions.Client.create_policy_store_alias(**kwargs)¶

Creates a policy store alias for the specified policy store. A policy store alias is an alternative identifier that you can use to reference a policy store in API operations.

This operation is idempotent. If multiple CreatePolicyStoreAlias requests are made where the aliasName and policyStoreId fields are the same between the requests, subsequent requests will be ignored. For each duplicate CreatePolicyStoreAlias request, a Success response will be returned and a new policy store alias will not be created.

Note

Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.

Request Syntax

response = client.create_policy_store_alias(
    aliasName='string',
    policyStoreId='string'
)

Parameters:

aliasName (string) –
[REQUIRED]

Specifies the name of the policy store alias to create. The name must be unique within your Amazon Web Services account and Amazon Web Services Region.

Note
The alias name must always be prefixed with policy-store-alias/.
policyStoreId (string) –
[REQUIRED]

Specifies the ID of the policy store to associate with the alias.

Note
The associated policy store must be specified using its ID. The alias name cannot be used.

Return type:

dict

Returns:

Response Syntax

{
    'aliasName': 'string',
    'policyStoreId': 'string',
    'aliasArn': 'string',
    'createdAt': datetime(2015, 1, 1)
}

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.

Exceptions

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